Class: Chef::Application

Inherits:
Object
  • Object
show all
Includes:
Mixlib::CLI
Defined in:
lib/chef/application.rb,
lib/chef/application/exit_code.rb

Direct Known Subclasses

Apply, Base

Defined Under Namespace

Classes: Apply, Base, Client, ExitCode, Solo

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Application

Returns a new instance of Application.



42
43
44
45
46
47
 
# File 'lib/chef/application.rb', line 42

def initialize
  super

  @chef_client = nil
  @chef_client_json = nil
end

Class Method Details

.debug_stacktrace(e) ⇒ Object 



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/chef/application.rb', line 371

def debug_stacktrace(e)
  message = "#{e.class}: #{e}\n#{e.backtrace.join("\n")}"

  cause = e.cause if e.respond_to?(:cause)
  until cause.nil?
    message << "\n\n>>>> Caused by #{cause.class}: #{cause}\n#{cause.backtrace.join("\n")}"
    cause = cause.respond_to?(:cause) ? cause.cause : nil
  end

  chef_stacktrace_out = "Generated at #{Time.now}\n"
  chef_stacktrace_out += message

  Chef::FileCache.store("#{ChefUtils::Dist::Infra::SHORT}-stacktrace.out", chef_stacktrace_out)
  logger.fatal("Stacktrace dumped to #{Chef::FileCache.load("#{ChefUtils::Dist::Infra::SHORT}-stacktrace.out", false)}")
  logger.fatal("---------------------------------------------------------------------------------------")
  logger.fatal("PLEASE PROVIDE THE CONTENTS OF THE stacktrace.out FILE (above) IF YOU FILE A BUG REPORT")
  logger.fatal("---------------------------------------------------------------------------------------")
  if Chef::Config[:always_dump_stacktrace]
    logger.fatal(message)
  else
    logger.debug(message)
  end
  true
end

.exit!(msg, err = nil) ⇒ Object 



409
410
411
412
 
# File 'lib/chef/application.rb', line 409

def exit!(msg, err = nil)
  logger.debug(msg)
  Process.exit(normalize_exit_code(err))
end

.fatal!(msg, err = nil) ⇒ Object

Log a fatal error message to both STDERR and the Logger, exit the application



401
402
403
404
405
406
407
 
# File 'lib/chef/application.rb', line 401

def fatal!(msg, err = nil)
  if Chef::Config[:always_dump_stacktrace]
    msg << "\n#{err.backtrace.join("\n")}"
  end
  logger.fatal(msg)
  Process.exit(normalize_exit_code(err))
end

.logger ⇒ Object 



123
124
125
 
# File 'lib/chef/application.rb', line 123

def self.logger
  Chef::Log
end

.normalize_exit_code(exit_code) ⇒ Object 



396
397
398
 
# File 'lib/chef/application.rb', line 396

def normalize_exit_code(exit_code)
  Chef::Application::ExitCode.normalize_exit_code(exit_code)
end

.use_separate_defaults? ⇒ Boolean

Configure mixlib-cli to always separate defaults from user-supplied CLI options

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/chef/application.rb', line 50

def self.use_separate_defaults?
  true
end

Instance Method Details

#apply_extra_config_options(extra_config_options) ⇒ Object 



160
161
162
 
# File 'lib/chef/application.rb', line 160

def apply_extra_config_options(extra_config_options)
  chef_config.apply_extra_config_options(extra_config_options)
end

#check_license_acceptance ⇒ Object 



249
250
251
252
253
254
255
256
 
# File 'lib/chef/application.rb', line 249

def check_license_acceptance
  LicenseAcceptance::Acceptor.check_and_persist!(
    "infra-client",
    Chef::VERSION.to_s,
    logger: logger,
    provided: Chef::Config[:chef_license]
  )
end

#chef_config ⇒ Object 



114
115
116
 
# File 'lib/chef/application.rb', line 114

def chef_config
  Chef::Config
end

#chef_configfetcher ⇒ Object 



128
129
130
131
 
# File 'lib/chef/application.rb', line 128

def chef_configfetcher
  require_relative "config_fetcher"
  Chef::ConfigFetcher
end

#configure_chef ⇒ Object

Parse configuration (options and config file)



101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/chef/application.rb', line 101

def configure_chef
  parse_options
  begin
    load_config_file
  rescue Exception => e
    Chef::Application.fatal!(e.message, Chef::Exceptions::ConfigurationError.new)
  end
  chef_config.export_proxies
  chef_config.init_openssl
  File.umask chef_config[:umask]
end

#configure_encoding ⇒ Object

Sets the default external encoding to UTF-8 (users can change this, but they shouldn't)



240
241
242
 
# File 'lib/chef/application.rb', line 240

def configure_encoding
  Encoding.default_external = chef_config[:ruby_encoding]
end

#configure_log_location ⇒ Object

merge Chef::Config[:log_location] and config[:log_location_cli]

  • the nil default value of log_location_cli means STDOUT
  • the nil default value of log_location is removed
  • Arrays are supported
  • syslog + winevt are converted to those specific logger objects


195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/chef/application.rb', line 195

def configure_log_location
  log_location_cli = [ config[:log_location_cli] ].flatten.map { |log_location| log_location.nil? ? STDOUT : log_location }

  chef_config[:log_location] = [ chef_config[:log_location], log_location_cli ].flatten.compact.uniq

  chef_config[:log_location].map! do |log_location|
    case log_location
    when :syslog, "syslog"
      force_force_logger
      logger::Syslog.new
    when :win_evt, "win_evt"
      force_force_logger
      logger::WinEvt.new
    else
      # should be a path or STDOUT
      log_location
    end
  end
end

#configure_logging ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/chef/application.rb', line 177

def configure_logging
  configure_log_location
  logger.init(MonoLogger.new(chef_config[:log_location][0]))
  chef_config[:log_location][1..].each do |log_location|
    logger.loggers << MonoLogger.new(log_location)
  end
  logger.level = resolve_log_level
rescue StandardError => error
  logger.fatal("Failed to open or create log file at #{chef_config[:log_location]}: #{error.class} (#{error.message})")
  Chef::Application.fatal!("Aborting due to invalid 'log_location' configuration", error)
end

#emit_warnings ⇒ Object 



96
97
98
 
# File 'lib/chef/application.rb', line 96

def emit_warnings
  logger.warn "chef_config[:zypper_check_gpg] is set to false which disables security checking on zypper packages" unless chef_config[:zypper_check_gpg]
end

#force_force_logger ⇒ Object

Force the logger by default for the :winevt and :syslog loggers. Since we do not and cannot support multiple log levels in a mix-and-match situation with formatters and loggers, and the formatters do not support syslog, we force the formatter off by default and the log level is thus info by default. Users can add --force-formatter -l info to get back formatter output on STDOUT along with syslog logging.



221
222
223
 
# File 'lib/chef/application.rb', line 221

def force_force_logger
  chef_config[:force_logger] = true unless chef_config[:force_formatter]
end

#load_config_file ⇒ Object

Parse the config file



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
 
# File 'lib/chef/application.rb', line 134

def load_config_file
  # apply the default cli options first
  chef_config.merge!(default_config)

  config_fetcher = chef_configfetcher.new(config[:config_file])
  # Some config settings are derived relative to the config file path; if
  # given as a relative path, this is computed relative to cwd, but
  # chef-client will later chdir to root, so we need to get the absolute path
  # here.
  config[:config_file] = config_fetcher.expanded_path

  if config[:config_file].nil?
    logger.warn("No config file found or specified on command line. Using command line options instead.")
  elsif config_fetcher.config_missing?
    logger.warn("*****************************************")
    logger.warn("Did not find config file: #{config[:config_file]}. Using command line options instead.")
    logger.warn("*****************************************")
  else
    config_content = config_fetcher.read_config
    apply_config(config_content, config[:config_file])
  end
  extra_config_options = config.delete(:config_option)
  chef_config.merge!(config)
  apply_extra_config_options(extra_config_options)
end

#logger ⇒ Object 



119
120
121
 
# File 'lib/chef/application.rb', line 119

def logger
  Chef::Log
end

#reconfigure ⇒ Object

Reconfigure the application. You'll want to override and super this method.



55
56
57
58
59
60
61
62
 
# File 'lib/chef/application.rb', line 55

def reconfigure
  # In case any gems were installed for use in the config.
  Gem.clear_paths
  configure_chef
  configure_logging
  configure_encoding
  emit_warnings
end

#resolve_log_level ⇒ Object

The :auto formatter defaults to :warn with the formatter and :info with the logger



231
232
233
234
235
236
237
 
# File 'lib/chef/application.rb', line 231

def resolve_log_level
  if chef_config[:log_level] == :auto
    using_output_formatter? ? :warn : :info
  else
    chef_config[:log_level]
  end
end

#run(enforce_license: false) ⇒ Object

Get this party started



65
66
67
68
69
70
71
72
73
 
# File 'lib/chef/application.rb', line 65

def run(enforce_license: false)
  setup_signal_handlers
  reconfigure
  setup_application
  check_license_acceptance if enforce_license
  Context.switch_to_workstation_entitlement if Context.test_kitchen_context?
  Chef::Licensing.fetch_and_persist if ChefUtils::Dist::Infra::EXEC == "chef"
  run_application
end

#run_application ⇒ Object

Actually run the application

Raises:



259
260
261
 
# File 'lib/chef/application.rb', line 259

def run_application
  raise Chef::Exceptions::Application, "#{self}: you must override run_application"
end

#run_chef_client(specific_recipes = []) ⇒ Object

Initializes Chef::Client instance and runs it



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/chef/application.rb', line 264

def run_chef_client(specific_recipes = [])
  unless specific_recipes.respond_to?(:size)
    raise ArgumentError, "received non-Array like specific_recipes argument"
  end

  Chef::LocalMode.with_server_connectivity do
    override_runlist = config[:override_runlist]
    @chef_client = Chef::Client.new(
      @chef_client_json,
      override_runlist: override_runlist,
      specific_recipes: specific_recipes,
      runlist: config[:runlist],
      logger: logger
    )
    @chef_client_json = nil

    if can_fork?
      fork_chef_client # allowed to run client in forked process
    else
      # Unforked interval runs are disabled, so this runs chef-client
      # once and then exits. If TERM signal is received, will "ignore"
      # the signal to finish converge.
      run_with_graceful_exit_option
    end
    @chef_client = nil
  end
end

#set_specific_recipes ⇒ Object

Set the specific recipes to Chef::Config if the recipes are valid otherwise log a fatal error message and exit the application.



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/chef/application.rb', line 166

def set_specific_recipes
  if cli_arguments.is_a?(Array) &&
      (cli_arguments.empty? || cli_arguments.all? { |file| File.file?(file) } )
    chef_config[:specific_recipes] =
      cli_arguments.map { |file| File.expand_path(file) }
  else
    Chef::Application.fatal!("Invalid argument; could not find the following recipe files: \"" +
      cli_arguments.select { |file| !File.file?(file) }.join('", "') + '"')
  end
end

#setup_application ⇒ Object

Called prior to starting the application, by the run method

Raises:



245
246
247
 
# File 'lib/chef/application.rb', line 245

def setup_application
  raise Chef::Exceptions::Application, "#{self}: you must override setup_application"
end

#setup_signal_handlers ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/chef/application.rb', line 75

def setup_signal_handlers
  trap("INT") do
    Chef::Application.fatal!("SIGINT received, stopping", Chef::Exceptions::SigInt.new)
  end

  trap("TERM") do
    Chef::Application.fatal!("SIGTERM received, stopping", Chef::Exceptions::SigTerm.new)
  end

  unless ChefUtils.windows?
    trap("QUIT") do
      logger.info("SIGQUIT received, call stack:\n  " + caller.join("\n  "))
    end

    trap("HUP") do
      logger.info("SIGHUP received, reconfiguring")
      reconfigure
    end
  end
end

#using_output_formatter? ⇒ Boolean

Use of output formatters is assumed if force_formatter is set or if force_logger is not set

Returns:

  • (Boolean) 


226
227
228
 
# File 'lib/chef/application.rb', line 226

def using_output_formatter?
  chef_config[:force_formatter] || !chef_config[:force_logger]
end