Parent

Included Modules

Class/Module Index [+]

Quicksearch

Chef::Application

Public Class Methods

new() click to toggle source
# File lib/chef/application.rb, line 34
def initialize
  super

  @chef_client = nil
  @chef_client_json = nil
  trap("TERM") do
    Chef::Application.fatal!("SIGTERM received, stopping", 1)
  end

  trap("INT") do
    Chef::Application.fatal!("SIGINT received, stopping", 2)
  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

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

Public Instance Methods

configure_chef() click to toggle source

Parse the configuration file

# File lib/chef/application.rb, line 76
def configure_chef
  parse_options

  begin
    case config[:config_file]
    when /^(http|https):\/\//
      Chef::REST.new("", nil, nil).fetch(config[:config_file]) { |f| apply_config(f.path) }
    else
      ::File::open(config[:config_file]) { |f| apply_config(f.path) }
    end
  rescue Errno::ENOENT => error
    Chef::Log.warn("*****************************************")
    Chef::Log.warn("Did not find config file: #{config[:config_file]}, using command line options.")
    Chef::Log.warn("*****************************************")

    Chef::Config.merge!(config)
  rescue SocketError => error
    Chef::Application.fatal!("Error getting config file #{Chef::Config[:config_file]}", 2)
  rescue Chef::Exceptions::ConfigurationError => error
    Chef::Application.fatal!("Error processing config file #{Chef::Config[:config_file]} with error #{error.message}", 2)
  rescue Exception => error
    Chef::Application.fatal!("Unknown error processing config file #{Chef::Config[:config_file]} with error #{error.message}", 2)
  end

end
configure_logging() click to toggle source

Initialize and configure the logger. If the configured log location is not STDOUT, but stdout is a TTY and we're not daemonizing, we set up a secondary logger with output to stdout. This way, we magically do the right thing when the user has configured logging to a file but they're running chef in the shell to debug something.

If the user has configured a formatter, then we skip the magical logger to keep the output pretty.

# File lib/chef/application.rb, line 110
def configure_logging
  require 'pp'
  Chef::Log.init(Chef::Config[:log_location])
  if ( Chef::Config[:log_location] != STDOUT ) && STDOUT.tty? && (!Chef::Config[:daemonize]) && (Chef::Config.formatter == "null")
    stdout_logger = Logger.new(STDOUT)
    STDOUT.sync = true
    stdout_logger.formatter = Chef::Log.logger.formatter
    Chef::Log.loggers <<  stdout_logger
  end
  Chef::Log.level = Chef::Config[:log_level]
end
reconfigure() click to toggle source

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

# File lib/chef/application.rb, line 63
def reconfigure
  configure_chef
  configure_logging
end
run() click to toggle source

Get this party started

# File lib/chef/application.rb, line 69
def run
  reconfigure
  setup_application
  run_application
end
run_application() click to toggle source

Actually run the application

# File lib/chef/application.rb, line 128
def run_application
  raise Chef::Exceptions::Application, "#{self.to_s}: you must override run_application"
end
run_chef_client() click to toggle source

Initializes Chef::Client instance and runs it

# File lib/chef/application.rb, line 133
def run_chef_client
  @chef_client = Chef::Client.new(
    @chef_client_json, 
    :override_runlist => config[:override_runlist]
  )
  @chef_client_json = nil

  @chef_client.run
  @chef_client = nil
end
setup_application() click to toggle source

Called prior to starting the application, by the run method

# File lib/chef/application.rb, line 123
def setup_application
  raise Chef::Exceptions::Application, "#{self.to_s}: you must override setup_application"
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.