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, Client, Knife, Solo

Defined Under Namespace

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Application

Returns a new instance of Application.



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

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 



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/chef/application.rb', line 362

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 



391
392
393
394
 
# File 'lib/chef/application.rb', line 391

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



386
387
388
389
 
# File 'lib/chef/application.rb', line 386

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

.logger ⇒ Object 



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

def self.logger
  Chef::Log
end

.normalize_exit_code(exit_code) ⇒ Object 



381
382
383
 
# File 'lib/chef/application.rb', line 381

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 



149
150
151
152
153
 
# File 'lib/chef/application.rb', line 149

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

Returns:

  • (Boolean) 


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

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

#chef_config ⇒ Object 



104
105
106
 
# File 'lib/chef/application.rb', line 104

def chef_config
  Chef::Config
end

#chef_configfetcher ⇒ Object 



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

def chef_configfetcher
  Chef::ConfigFetcher
end

#configure_chef ⇒ Object

Parse configuration (options and config file)



95
96
97
98
99
100
101
 
# File 'lib/chef/application.rb', line 95

def configure_chef
  parse_options
  load_config_file
  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)



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

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

#configure_log_location ⇒ Object

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



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/chef/application.rb', line 193

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_logging ⇒ Object

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.



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

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_logger ⇒ Object 



211
212
213
214
215
 
# File 'lib/chef/application.rb', line 211

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

#emit_warnings ⇒ Object 



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

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_file ⇒ Object

Parse the config file



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

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.")
  elsif config_fetcher.config_missing?
    logger.warn("*****************************************")
    logger.warn("Did not find config file: #{config[:config_file]}, using command line options.")
    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 



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

def logger
  Chef::Log
end

#reconfigure ⇒ Object

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_level ⇒ Object

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



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

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

#run ⇒ Object

Get this party started



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

def run
  setup_signal_handlers
  reconfigure
  setup_application
  run_application
end

#run_application ⇒ Object

Actually run the application

Raises:



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

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



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

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]
    override_runlist ||= [] if specific_recipes.size > 0
    @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 



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

def set_specific_recipes
  if cli_arguments.respond_to?(:map)
    chef_config[:specific_recipes] =
      cli_arguments.map { |file| File.expand_path(file) }
  end
end

#setup_application ⇒ Object

Called prior to starting the application, by the run method

Raises:



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

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

#setup_signal_handlers ⇒ Object 



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

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

Returns:

  • (Boolean) 


218
219
220
 
# File 'lib/chef/application.rb', line 218

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?

Returns:

  • (Boolean) 


207
208
209
 
# File 'lib/chef/application.rb', line 207

def want_additional_logger?
  !( chef_config[:log_location].is_a?(IO) && chef_config[:log_location].tty? ) && !chef_config[:daemonize]
end