summaryrefslogtreecommitdiff
path: root/lib/chef/knife/config_list.rb
blob: 53b3bac57d6b4eac32ee1c014c3e51d1cc26b8a4 (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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
#
# 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_relative "../knife"

class Chef
  class Knife
    class ConfigList < Knife
      banner "knife config list (options)"

      TABLE_HEADER = [" Profile", "Client", "Key", "Server"].freeze

      deps do
        require_relative "../workstation_config_loader"
        require "tty-screen" unless defined?(TTY::Screen)
        require "tty-table" unless defined?(TTY::Table)
      end

      option :ignore_knife_rb,
        short: "-i",
        long: "--ignore-knife-rb",
        description: "Ignore the current config.rb/knife.rb configuration.",
        default: false

      def configure_chef
        apply_computed_config
      end

      def run
        credentials_data = self.class.config_loader.parse_credentials_file
        if credentials_data.nil? || credentials_data.empty?
          # Should this just show the ambient knife.rb config as "default" instead?
          ui.fatal("No profiles found, #{self.class.config_loader.credentials_file_path} does not exist or is empty")
          exit 1
        end

        current_profile = self.class.config_loader.credentials_profile(config[:profile])
        profiles = credentials_data.keys.map do |profile|
          if config[:ignore_knife_rb]
            # Don't do any fancy loading nonsense, just the raw data.
            profile_data = credentials_data[profile]
            {
              profile: profile,
              active: profile == current_profile,
              client_name: profile_data["client_name"] || profile_data["node_name"],
              client_key: profile_data["client_key"],
              server_url: profile_data["chef_server_url"],
            }
          else
            # Fancy loading nonsense so we get what the actual config would be.
            # Note that this modifies the global config, after this, all bets are
            # off as to whats in the config.
            Chef::Config.reset
            wcl = Chef::WorkstationConfigLoader.new(nil, Chef::Log, profile: profile)
            wcl.load
            {
              profile: profile,
              active: profile == current_profile,
              client_name: Chef::Config[:node_name],
              client_key: Chef::Config[:client_key],
              server_url: Chef::Config[:chef_server_url],
            }
          end
        end

        # Try to reset the config.
        unless config[:ignore_knife_rb]
          Chef::Config.reset
          apply_computed_config
        end

        if ui.interchange?
          # Machine-readable output.
          ui.output(profiles)
        else
          # Table output.
          ui.output(render_table(profiles))
        end
      end

      private

      def render_table(profiles, padding: 1)
        rows = []
        # Render the data to a 2D array that will be used for the table.
        profiles.each do |profile|
          # Replace the home dir in the client key path with ~.
          profile[:client_key] = profile[:client_key].to_s.gsub(/^#{Regexp.escape(Dir.home)}/, "~") if profile[:client_key]
          profile[:profile] = "#{profile[:active] ? "*" : " "}#{profile[:profile]}"
          rows << profile.values_at(:profile, :client_name, :client_key, :server_url)
        end

        table = TTY::Table.new(header: TABLE_HEADER, rows: rows)

        # Rotate the table to vertical if the screen width is less than table width.
        if table.width > TTY::Screen.width
          table.orientation = :vertical
          table.rotate
          # Add a new line after each profile record.
          table.render do |renderer|
            renderer.border do
              separator ->(row) { (row + 1) % TABLE_HEADER.size == 0 }
            end
            # Remove the leading space added of the first column.
            renderer.filter = Proc.new do |val, row_index, col_index|
              if col_index == 1 || (row_index) % TABLE_HEADER.size == 0
                val.strip
              else
                val
              end
            end
          end
        else
          table.render do |renderer|
            renderer.border do
              mid   "-"
              style :green
            end
            renderer.padding = [0, padding, 0, 0] # pad right with 2 characters
          end
        end
      end

    end
  end
end