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 



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/chef/application.rb', line 333

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

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



362
363
364
365
 
# File 'lib/chef/application.rb', line 362

def exit!(msg, err = nil)
  Chef::Log.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



357
358
359
360
 
# File 'lib/chef/application.rb', line 357

def fatal!(msg, err = nil)
  Chef::Log.fatal(msg)
  Process.exit(normalize_exit_code(err))
end

.normalize_exit_code(exit_code) ⇒ Object 



352
353
354
 
# File 'lib/chef/application.rb', line 352

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

Instance Method Details

#apply_extra_config_options(extra_config_options) ⇒ Object 



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

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) 


194
195
196
 
# File 'lib/chef/application.rb', line 194

def auto_log_level?
  Chef::Config[:log_level] == :auto
end

#configure_chef ⇒ Object

Parse configuration (options and config file)



88
89
90
91
92
93
94
 
# File 'lib/chef/application.rb', line 88

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)



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

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.



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

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 Chef::Log::Syslog.new
      when :win_evt then Chef::Log::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.



151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/chef/application.rb', line 151

def configure_logging
  configure_log_location
  Chef::Log.init(MonoLogger.new(Chef::Config[:log_location]))
  if want_additional_logger?
    configure_stdout_logger
  end
  Chef::Log.level = resolve_log_level
rescue StandardError => error
  Chef::Log.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 



183
184
185
186
187
 
# File 'lib/chef/application.rb', line 183

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

#emit_warnings ⇒ Object 



83
84
85
 
# File 'lib/chef/application.rb', line 83

def emit_warnings
  Chef::Log.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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/chef/application.rb', line 97

def load_config_file
  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?
    Chef::Log.warn("No config file found or specified on command line, using command line options.")
  elsif config_fetcher.config_missing?
    Chef::Log.warn("*****************************************")
    Chef::Log.warn("Did not find config file: #{config[:config_file]}, using command line options.")
    Chef::Log.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

#reconfigure ⇒ Object

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



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

def reconfigure
  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?



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

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



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

def run
  setup_signal_handlers
  reconfigure
  setup_application
  run_application
end

#run_application ⇒ Object

Actually run the application

Raises:



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

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/chef/application.rb', line 228

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]
    )
    @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 



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

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:



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

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

#setup_signal_handlers ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/chef/application.rb', line 62

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
      Chef::Log.info("SIGQUIT received, call stack:\n  " + caller.join("\n  "))
    end

    trap("HUP") do
      Chef::Log.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) 


190
191
192
 
# File 'lib/chef/application.rb', line 190

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) 


179
180
181
 
# File 'lib/chef/application.rb', line 179

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