Class: Chef::Application

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

Direct Known Subclasses

Apply, Base, Knife

Defined Under Namespace

Classes: Apply, Base, Client, ExitCode, Knife, Solo, WindowsService, WindowsServiceManager

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeApplication


38
39
40
41
42
43
44
45
46
# File 'lib/chef/application.rb', line 38

def initialize
  super

  @chef_client = nil
  @chef_client_json = nil

  # Always switch to a readable directory. Keeps subsequent Dir.chdir() {}
  # from failing due to permissions when launched as a less privileged user.
end

Class Method Details

.debug_stacktrace(e) ⇒ Object


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
# File 'lib/chef/application.rb', line 380

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("chef-stacktrace.out", chef_stacktrace_out)
  logger.fatal("Stacktrace dumped to #{Chef::FileCache.load("chef-stacktrace.out", false)}")
  logger.fatal("Please provide the contents of the stacktrace.out file if you file a bug report")
  logger.debug(message)
  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


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

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

.loggerObject


116
117
118
# File 'lib/chef/application.rb', line 116

def self.logger
  Chef::Log
end

.normalize_exit_code(exit_code) ⇒ Object


399
400
401
# File 'lib/chef/application.rb', line 399

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


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

def self.use_separate_defaults?
  true
end

Instance Method Details

#apply_extra_config_options(extra_config_options) ⇒ Object


152
153
154
155
156
# File 'lib/chef/application.rb', line 152

def apply_extra_config_options(extra_config_options)
  chef_config.apply_extra_config_options(extra_config_options)
rescue ChefConfig::UnparsableConfigOption => e
  Chef::Application.fatal!(e.message)
end

#auto_log_level?Boolean


231
232
233
# File 'lib/chef/application.rb', line 231

def auto_log_level?
  chef_config[:log_level] == :auto
end

#check_license_acceptanceObject


259
260
261
262
263
264
265
266
# File 'lib/chef/application.rb', line 259

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

#chef_configObject


107
108
109
# File 'lib/chef/application.rb', line 107

def chef_config
  Chef::Config
end

#chef_configfetcherObject


121
122
123
# File 'lib/chef/application.rb', line 121

def chef_configfetcher
  Chef::ConfigFetcher
end

#configure_chefObject

Parse configuration (options and config file)


98
99
100
101
102
103
104
# File 'lib/chef/application.rb', line 98

def configure_chef
  parse_options
  load_config_file
  chef_config.export_proxies
  chef_config.init_openssl
  File.umask chef_config[:umask]
end

#configure_encodingObject

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


250
251
252
# File 'lib/chef/application.rb', line 250

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

#configure_log_locationObject

Turn `log_location :syslog` and `log_location :win_evt` into the appropriate loggers.


202
203
204
205
206
207
208
209
210
211
212
# File 'lib/chef/application.rb', line 202

def configure_log_location
  log_location = chef_config[:log_location]
  return unless log_location.respond_to?(:to_sym)

  chef_config[:log_location] =
    case log_location.to_sym
      when :syslog then logger::Syslog.new
      when :win_evt then logger::WinEvt.new
      else log_location # Probably a path; let MonoLogger sort it out
    end
end

#configure_loggingObject

Initialize and configure the logger.

Loggers and Formatters

In Chef 10.x and previous, the Logger was the primary/only way that Chef communicated information to the user. In Chef 10.14, a new system, “output formatters” was added, and in Chef 11.0+ it is the default when running chef in a console (detected by `STDOUT.tty?`). Because output formatters are more complex than the logger system and users have less experience with them, the config option `force_logger` is provided to restore the Chef 10.x behavior.

Conversely, for users who want formatter output even when chef is running unattended, the `force_formatter` option is provided.

Auto Log Level

The `log_level` of `:auto` means `:warn` in the formatter and `:info` in the logger.


188
189
190
191
192
193
194
195
196
197
198
# File 'lib/chef/application.rb', line 188

def configure_logging
  configure_log_location
  logger.init(MonoLogger.new(chef_config[:log_location]))
  if want_additional_logger?
    configure_stdout_logger
  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

#configure_stdout_loggerObject


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

def configure_stdout_logger
  stdout_logger = MonoLogger.new(STDOUT)
  stdout_logger.formatter = logger.logger.formatter
  logger.loggers << stdout_logger
end

#emit_warningsObject


93
94
95
# File 'lib/chef/application.rb', line 93

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

#load_config_fileObject

Parse the config file


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

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

#loggerObject


112
113
114
# File 'lib/chef/application.rb', line 112

def logger
  Chef::Log
end

#reconfigureObject

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


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

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_levelObject

if log_level is `:auto`, convert it to :warn (when using output formatter) or :info (no output formatter). See also using_output_formatter?


237
238
239
240
241
242
243
244
245
246
247
# File 'lib/chef/application.rb', line 237

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

#run(enforce_license: false) ⇒ Object

Get this party started


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

def run(enforce_license: false)
  setup_signal_handlers
  reconfigure
  setup_application
  check_license_acceptance if enforce_license
  run_application
end

#run_applicationObject

Actually run the application


269
270
271
# File 'lib/chef/application.rb', line 269

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


274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/chef/application.rb', line 274

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_recipesObject

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


160
161
162
163
164
165
166
167
168
169
# File 'lib/chef/application.rb', line 160

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_applicationObject

Called prior to starting the application, by the run method


255
256
257
# File 'lib/chef/application.rb', line 255

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

#setup_signal_handlersObject


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

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 Chef::Platform.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


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

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

#want_additional_logger?Boolean

Based on config and whether or not STDOUT is a tty, should we setup a secondary logger for stdout?


216
217
218
# File 'lib/chef/application.rb', line 216

def want_additional_logger?
  ( Chef::Config[:log_location].class != IO ) && STDOUT.tty? && !Chef::Config[:daemonize]
end