summaryrefslogtreecommitdiff
path: root/lib/chef/knife/config_get.rb
blob: c687e39a29dbd575a7e6f672e7307d51bf16eff7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
#
# Author:: Joshua Timberman <opensource@housepub.org>
# Copyright:: Copyright (c) 2012, Joshua Timberman
# Copyright:: Copyright (c) 2018, Noah Kantrowitz
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require "chef/knife"

class Chef
  class Knife
    class ConfigGet < Knife
      banner "knife config get [OPTION...] (options)\nDisplays the value of Chef::Config[OPTION] (or all config values)"

      option :all,
             short: "-a",
             long: "--all",
             description: "Include options that are not set in the configuration.",
             default: false

      option :raw,
              short: "-r",
              long: "--raw",
              description: "Display a each value with no formatting.",
              default: false

      def run
        if config[:format] == "summary" && !config[:raw]
          # If using the default, human-readable output, also show which config files are being loaded.
          # Some of this is a bit hacky since it duplicates
          wcl = self.class.config_loader
          if wcl.credentials_found
            loading_from("credentials", ChefConfig::PathHelper.home(".chef", "credentials"))
          end
          if wcl.config_location
            loading_from("configuration", wcl.config_location)
          end
          if Chef::Config[:config_d_dir]
            wcl.find_dot_d(Chef::Config[:config_d_dir]).each do |path|
              loading_from(".d/ configuration", wcl.config_location)
            end
          end
        end

        # Dump the whole config, including defaults is --all was given.
        config_data = Chef::Config.save(config[:all])
        # Two special cases, these are set during knife startup but we don't usually care about them.
        unless config[:all]
          config_data.delete(:color)
          # Only keep these if true, false is much less important because it's the default.
          config_data.delete(:local_mode) unless config_data[:local_mode]
          config_data.delete(:enforce_path_sanity) unless config_data[:enforce_path_sanity]
        end

        # Extract the data to show.
        output_data = {}
        if @name_args.empty?
          output_data = config_data
        else
          @name_args.each do |filter|
            if filter =~ %r{^/(.*)/(i?)$}
              # It's a regex.
              filter_re = Regexp.new($1, $2 ? Regexp::IGNORECASE : 0)
              config_data.each do |key, value|
                output_data[key] = value if key.to_s =~ filter_re
              end
            else
              # It's a dotted path string.
              filter_parts = filter.split(/\./)
              extract = lambda do |memo, filter_part|
                memo.is_a?(Hash) ? memo[filter_part.to_sym] : nil
              end
              # Check against both config_data and all of the data, so that even
              # in non-all mode, if you ask for a key that isn't in the non-all
              # data, it will check against the broader set.
              output_data[filter] = filter_parts.inject(config_data, &extract) || filter_parts.inject(Chef::Config.save(true), &extract)
            end
          end
        end

        # Fix up some values.
        output_data.each do |key, value|
          if value == STDOUT
            output_data[key] = "STDOUT"
          elsif value == STDERR
            output_data[key] = "STDERR"
          end
        end

        # Show the data.
        if config[:raw]
          output_data.each_value do |value|
            ui.msg(value)
          end
        else
          ui.output(output_data)
        end
      end

      private

      # Display a banner about loading from a config file.
      #
      # @api private
      # @param type_of_file [String] Description of the file for the banner.
      # @param path [String] Path of the file.
      # @return [nil]
      def loading_from(type_of_file, path)
        path = Pathname.new(path).realpath
        ui.msg(ui.color("Loading from #{type_of_file} file #{path}", :yellow))
      end
    end
  end
end