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

#initializeApplication

Returns a new instance of Application.


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

def initialize
  super

  @chef_client = nil
  @chef_client_json = nil
end

Class Method Details

.debug_stacktrace(e) ⇒ Object


366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
# File 'lib/chef/application.rb', line 366

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("Please provide the contents of the stacktrace.out file if you file a bug report")
  if Chef::Config[:always_dump_stacktrace]
    logger.fatal(message)
  else
    logger.debug(message)
  end
  true
end

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


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

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


394
395
396
397
398
399
400
# File 'lib/chef/application.rb', line 394

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

.loggerObject


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

def self.logger
  Chef::Log
end

.normalize_exit_code(exit_code) ⇒ Object


389
390
391
# File 'lib/chef/application.rb', line 389

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)

47
48
49
# File 'lib/chef/application.rb', line 47

def self.use_separate_defaults?
  true
end

Instance Method Details

#apply_extra_config_options(extra_config_options) ⇒ Object


155
156
157
# File 'lib/chef/application.rb', line 155

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

#check_license_acceptanceObject


244
245
246
247
248
249
250
251
# File 'lib/chef/application.rb', line 244

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


109
110
111
# File 'lib/chef/application.rb', line 109

def chef_config
  Chef::Config
end

#chef_configfetcherObject


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

def chef_configfetcher
  require_relative "config_fetcher"
  Chef::ConfigFetcher
end

#configure_chefObject

Parse configuration (options and config file)


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

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_encodingObject

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


235
236
237
# File 'lib/chef/application.rb', line 235

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

#configure_log_locationObject

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

190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/chef/application.rb', line 190

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_loggingObject


172
173
174
175
176
177
178
179
180
181
182
# File 'lib/chef/application.rb', line 172

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_warningsObject


91
92
93
# File 'lib/chef/application.rb', line 91

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_loggerObject

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.


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

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

#load_config_fileObject

Parse the config file


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

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


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

def logger
  Chef::Log
end

#reconfigureObject

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


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

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

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


226
227
228
229
230
231
232
# File 'lib/chef/application.rb', line 226

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


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

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


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

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


259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'lib/chef/application.rb', line 259

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.


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

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


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

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

#setup_signal_handlersObject


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

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)

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

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