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

#initialize ⇒ Application

Returns a new instance of Application.



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

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 



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/chef/application.rb', line 352

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::Dist::SHORT}-stacktrace.out", chef_stacktrace_out)
  logger.fatal("Stacktrace dumped to #{Chef::FileCache.load("#{Chef::Dist::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 



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

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



380
381
382
383
384
385
386
 
# File 'lib/chef/application.rb', line 380

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 



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

def self.logger
  Chef::Log
end

.normalize_exit_code(exit_code) ⇒ Object 



375
376
377
 
# File 'lib/chef/application.rb', line 375

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) 


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

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

#check_license_acceptance ⇒ Object 



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

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 



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

def chef_config
  Chef::Config
end

#chef_configfetcher ⇒ Object 



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

def chef_configfetcher
  require_relative "config_fetcher"
  Chef::ConfigFetcher
end

#configure_chef ⇒ Object

Parse configuration (options and config file)



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

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)



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

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

#configure_log_location ⇒ Object

merge Chef::Config and config

- 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



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

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"
      logger::Syslog.new
    when :win_evt, "win_evt"
      logger::WinEvt.new
    else
      # should be a path or STDOUT
      log_location
    end
  end
end

#configure_logging ⇒ Object 



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

def configure_logging
  configure_log_location
  logger.init(MonoLogger.new(chef_config[:log_location][0]))
  chef_config[:log_location][1..-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 



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

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



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

#logger ⇒ Object 



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

def logger
  Chef::Log
end

#reconfigure ⇒ Object

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



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

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



213
214
215
216
217
218
219
 
# File 'lib/chef/application.rb', line 213

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



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

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

#run_application ⇒ Object

Actually run the application

Raises:



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

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/chef/application.rb', line 246

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.



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

Called prior to starting the application, by the run method

Raises:



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

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

#setup_signal_handlers ⇒ Object 



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

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) 


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

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