summaryrefslogtreecommitdiff
path: root/lib/chef/application/knife.rb
blob: c719768f11c2817599b8a544fe3da39329f83188 (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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
#
# Author:: Adam Jacob (<adam@chef.io)
# Copyright:: Copyright (c) Chef Software Inc.
# 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"
require_relative "../application"
require "mixlib/log"
require "ohai/config"
require "chef/monkey_patches/net_http.rb"
require_relative "../dist"

class Chef::Application::Knife < Chef::Application

  NO_COMMAND_GIVEN = "You need to pass a sub-command (e.g., knife SUB-COMMAND)\n".freeze

  banner "Usage: knife sub-command (options)"

  option :config_file,
    short: "-c CONFIG",
    long: "--config CONFIG",
    description: "The configuration file to use.",
    proc: lambda { |path| File.expand_path(path, Dir.pwd) }

  option :config_option,
    long: "--config-option OPTION=VALUE",
    description: "Override a single configuration option.",
    proc: lambda { |option, existing|
      (existing ||= []) << option
      existing
    }

  verbosity_level = 0
  option :verbosity,
    short: "-V",
    long: "--verbose",
    description: "More verbose output. Use twice (-VV) for additional verbosity and three times (-VVV) for maximum verbosity.",
    proc: Proc.new { verbosity_level += 1 },
    default: 0

  option :color,
    long: "--[no-]color",
    boolean: true,
    default: true,
    description: "Use colored output, defaults to enabled."

  option :environment,
    short: "-E ENVIRONMENT",
    long: "--environment ENVIRONMENT",
    description: "Set the #{Chef::Dist::PRODUCT} environment (except for in searches, where this will be flagrantly ignored)."

  option :editor,
    short: "-e EDITOR",
    long: "--editor EDITOR",
    description: "Set the editor to use for interactive commands.",
    default: ENV["EDITOR"]

  option :disable_editing,
    short: "-d",
    long: "--disable-editing",
    description: "Do not open EDITOR, just accept the data as is.",
    boolean: true,
    default: false

  option :help,
    short: "-h",
    long: "--help",
    description: "Show this help message.",
    on: :tail,
    boolean: true

  option :node_name,
    short: "-u USER",
    long: "--user USER",
    description: "#{Chef::Dist::SERVER_PRODUCT} API client username."

  option :client_key,
    short: "-k KEY",
    long: "--key KEY",
    description: "#{Chef::Dist::SERVER_PRODUCT} API client key.",
    proc: lambda { |path| File.expand_path(path, Dir.pwd) }

  option :chef_server_url,
    short: "-s URL",
    long: "--server-url URL",
    description: "#{Chef::Dist::SERVER_PRODUCT} URL."

  option :yes,
    short: "-y",
    long: "--yes",
    description: "Say yes to all prompts for confirmation."

  option :defaults,
    long: "--defaults",
    description: "Accept default values for all questions."

  option :print_after,
    long: "--print-after",
    description: "Show the data after a destructive operation."

  option :format,
    short: "-F FORMAT",
    long: "--format FORMAT",
    description: "Which format to use for output.",
    in: %w{summary text json yaml pp},
    default: "summary"

  option :local_mode,
    short: "-z",
    long: "--local-mode",
    description: "Point knife commands at local repository instead of #{Chef::Dist::SERVER_PRODUCT}.",
    boolean: true

  option :chef_zero_host,
    long: "--chef-zero-host HOST",
    description: "Host to start #{Chef::Dist::ZERO} on."

  option :chef_zero_port,
    long: "--chef-zero-port PORT",
    description: "Port (or port range) to start #{Chef::Dist::ZERO} on. Port ranges like 1000,1010 or 8889-9999 will try all given ports until one works."

  option :listen,
    long: "--[no-]listen",
    description: "Whether a local mode (-z) server binds to a port.",
    boolean: false

  option :version,
    short: "-v",
    long: "--version",
    description: "Show #{Chef::Dist::PRODUCT} version.",
    boolean: true,
    proc: lambda { |v| puts "#{Chef::Dist::PRODUCT}: #{::Chef::VERSION}" },
    exit: 0

  option :fips,
    long: "--[no-]fips",
    description: "Enable FIPS mode.",
    boolean: true,
    default: nil

  option :profile,
    long: "--profile PROFILE",
    description: "The credentials profile to select."

  # Run knife
  def run
    ChefConfig::PathHelper.per_tool_home_environment = "KNIFE_HOME"
    Mixlib::Log::Formatter.show_time = false
    validate_and_parse_options
    quiet_traps
    Chef::Knife.run(ARGV, options)
    exit 0
  end

  private

  def quiet_traps
    trap("TERM") do
      exit 1
    end

    trap("INT") do
      exit 2
    end
  end

  def validate_and_parse_options
    # Checking ARGV validity *before* parse_options because parse_options
    # mangles ARGV in some situations
    if no_command_given?
      print_help_and_exit(1, NO_COMMAND_GIVEN)
    elsif no_subcommand_given?
      if want_help? || want_version?
        print_help_and_exit(0)
      else
        print_help_and_exit(2, NO_COMMAND_GIVEN)
      end
    end
  end

  def no_subcommand_given?
    ARGV[0] =~ /^-/
  end

  def no_command_given?
    ARGV.empty?
  end

  def want_help?
    ARGV[0] =~ /^(--help|-h)$/
  end

  def want_version?
    ARGV[0] =~ /^(--version|-v)$/
  end

  def print_help_and_exit(exitcode = 1, fatal_message = nil)
    Chef::Log.error(fatal_message) if fatal_message

    begin
      parse_options
    rescue OptionParser::InvalidOption => e
      puts "#{e}\n"
    end
    puts opt_parser
    puts
    Chef::Knife.list_commands
    exit exitcode
  end

end