CHEF-151: Additional changes to the Application class, specifications

  Moved Chef.fatal! into the Chef::Application class, updated other
  libraries and specs.

  Added a little consistency to the use of Chef::Config[:log_level] in
  the log#init, so it can be stubbed appropriately

Author: AJ Christensen

chef-server/bin/chef-indexer

@@ -25,7 +25,7 @@ require 'chef/queue'
 require 'chef/search_index'
 require 'chef/daemon'
 
-trap("INT") { Chef.fatal!("SIGINT received, stopping", 2) }
+trap("INT") { Chef::Application.fatal!("SIGINT received, stopping", 2) }
 
 config = {
   :config_file => "/etc/chef/server.rb",
@@ -58,7 +58,7 @@ end
 opts.parse!(ARGV)
 
 unless File.exists?(config[:config_file]) and File.readable?(config[:config_file])
-  Chef.fatal!("I cannot find or read the config file: #{config[:config_file]}", 1)
+  Chef::Application.fatal!("I cannot find or read the config file: #{config[:config_file]}", 1)
 end
 
 Chef::Config.from_file(config[:config_file])

chef/bin/chef-client

@@ -59,15 +59,15 @@ opts = OptionParser.new do |opts|
 end
 opts.parse!(ARGV)
 
-trap("INT") { Chef.fatal!("SIGINT received, stopping", 2) }
+trap("INT") { Chef::Application.fatal!("SIGINT received, stopping", 2) }
 trap("HUP") { 
   Chef::Log.info("SIGHUP received, reloading configuration")
   Chef::Config.from_file(config[:config_file])
   Chef::Config.configure { |c| c.merge!(config) }
 }
 
 unless File.exists?(config[:config_file]) and File.readable?(config[:config_file])
-  Chef.fatal!("I cannot find or read the config file: #{config[:config_file]}", 1)
+  Chef::Application.fatal!("I cannot find or read the config file: #{config[:config_file]}", 1)
 end
 
 if config[:json_attribs]
@@ -78,21 +78,21 @@ if config[:json_attribs]
   begin
     json_io = open(config[:json_attribs])
   rescue SocketError => error
-    Chef.fatal!("I cannot connect to #{config[:json_attribs]}", 2)
+    Chef::Application.fatal!("I cannot connect to #{config[:json_attribs]}", 2)
   rescue Errno::ENOENT => error
-    Chef.fatal!("I cannot find #{config[:json_attribs]}", 2)
+    Chef::Application.fatal!("I cannot find #{config[:json_attribs]}", 2)
   rescue Errno::EACCES => error
-    Chef.fatal!("Permissions are incorrect on #{config[:json_attribs]}. Please chmod a+r #{config[:json_attribs]}", 2)
+    Chef::Application.fatal!("Permissions are incorrect on #{config[:json_attribs]}. Please chmod a+r #{config[:json_attribs]}", 2)
   rescue Exception => error
-    Chef.fatal!("Got an unexpected error reading #{config[:json_attribs]}: #{error.message}", 2)
+    Chef::Application.fatal!("Got an unexpected error reading #{config[:json_attribs]}: #{error.message}", 2)
   end
 
   json_contents = json_io.read
 
   begin
     config[:json_attribs] = JSON.parse(json_contents)
   rescue JSON::ParserError => error
-    Chef.fatal!("Could not parse the provided JSON file (#{config[:json_attribs]})!: " + error.message, 2)
+    Chef::Application.fatal!("Could not parse the provided JSON file (#{config[:json_attribs]})!: " + error.message, 2)
     exit 2
   end
 end

chef/lib/chef.rb

@@ -28,13 +28,6 @@
 
 class Chef
   VERSION = '0.6.2'
-  
-  class << self
-    def fatal!(msg, err = -1)
-      Chef::Log.fatal(msg)
-      exit err
-    end
-  end
 end
 
 # Adds a Dir.glob to Ruby 1.8.5, for compat

chef/lib/chef/application.rb

@@ -18,19 +18,19 @@
 require 'optparse'
 require 'chef'
 require 'chef/exceptions'
-require 'chef/logger'
+require 'chef/log'
 
 class Chef::Application
-  attr_accessor :argv, :config, :options, :opt_parser
 
-  def initialize()
+  attr_accessor :argv, :config, :options  
+    
+  def initialize
     @argv = ARGV.dup
-    @config = { :config_file => "/etc/chef/default.rb" }
-    @options = nil
-    @opt_parser = nil
+    @config = {}
+    @options = {}
 
     trap("INT") do
-       Chef.fatal!("SIGINT received, stopping", 2)
+       Chef::Application.fatal!("SIGINT received, stopping", 2)
     end
 
     trap("HUP") do 
@@ -40,24 +40,26 @@ def initialize()
 
     at_exit do
       # tear down the logger and shit
-    end
-        
+    end  
   end
 
+  # Reconfigure the application. You'll want to override this.
   def reconfigure
     configure_opt_parser
     configure_chef
-    parse_arguments
     configure_logging
   end
 
+  # Kick off the application
   def run
     reconfigure
-    get_this_party_started
+    setup_application
+    run_application
   end
 
+  # Build an Option Parser, merge the default options and then parse the command line arguments into the config hash
   def configure_opt_parser    
-    @opt_parser = OptionParser.new do |opts|
+    OptionParser.new do |opts|
       opts.banner = "Usage: #{$0} (options)"
 
       default_options = { 
@@ -79,53 +81,49 @@ def configure_opt_parser
       }
 
       # just a step to the left
-      @options = default_options.merge(@options) if @options
-
-      # setup our instance config hash
+      @options = default_options.merge(@options)
+      
+      # Add the CLI options into OptionParser
       @options.each do |opt_key, opt_val|
         opts.on(opt_val[:short], opt_val[:long], opt_val[:description]) do |c|
+          # Update our internal Chef::Config hash, to be merged later.
           @config[opt_key] = (opt_val[:proc] && opt_val[:proc].call(c)) || c
         end
       end
 
       opts.on_tail("-h", "--help", "Show this message") do
         puts opts
-        exit 0
+        self.fatal!("Exiting", 0)
       end
-    end
+    end.parse!(@argv)
   end
 
   # Parse the configuration file
   def configure_chef
-    Chef::Config.from_file(@config[:config_file])
+    Chef::Config.from_file(@config[:config_file]) if @config[:config_file]
     Chef::Config.configure { |c| c.merge!(@config).rehash }
   end
 
   # Initialize and configure the logger
   def configure_logging
     Chef::Log.init(Chef::Config[:log_location])
-    Chef::Log.level(Chef::Config[:log_level])
   end
 
-  # Parse ARGV for arguments
-  def parse_arguments
-    raise Chef::Exceptions::Application, "#{self.to_s}: option parser has not been configured" unless @opt_parser
-    @opt_parser.parse!(@argv)
+  class << self
+    # Log a fatal error message and exit the application
+    def fatal!(msg, err = -1)
+      Chef::Log.fatal(msg)
+      Process.exit err
+    end
   end
 
-  # Log a fatal error message and exit the process
-  def fatal!(msg, err = -1)
-    Chef::Log.fatal(msg)
-    exit err
+  # Called prior to starting the application, by the run method
+  def setup_application
+    raise Chef::Exceptions::Application, "#{self.to_s}: you must override setup_application"      
   end
 
-  private
-  
-  def get_this_party_started
-    raise Chef::Exceptions::Application, "#{self.to_s}: you must override get_this_party_started"
+  # Actually run the application
+  def run_application
+    raise Chef::Exceptions::Application, "#{self.to_s}: you must override run_application"  
   end
-
-end
-
-
-Chef::Application.new.run
+end

chef/lib/chef/daemon.rb

@@ -48,10 +48,10 @@ def daemonize(name)
             save_pid_file
             at_exit { remove_pid_file }
           rescue NotImplementedError => e
-            Chef.fatal!("There is no fork: #{e.message}")
+            Chef::Application.fatal!("There is no fork: #{e.message}")
           end
         else
-          Chef.fatal!("Chef is already running pid #{pid}")
+          Chef::Application.fatal!("Chef is already running pid #{pid}")
         end
       end
 
@@ -71,7 +71,7 @@ def running?
       rescue Errno::ESRCH, Errno::ENOENT
         false
       rescue Errno::EACCES => e
-        Chef.fatal!("You don't have access to the PID file at #{pid_file}: #{e.message}")
+        Chef::Application.fatal!("You don't have access to the PID file at #{pid_file}: #{e.message}")
       end
 
       # Gets the pid file for @name
@@ -103,13 +103,13 @@ def save_pid_file
         begin
           FileUtils.mkdir_p(File.dirname(file))
         rescue Errno::EACCES => e
-          Chef.fatal!("Failed store pid in #{File.dirname(file)}, permission denied: #{e.message}")
+          Chef::Application.fatal!("Failed store pid in #{File.dirname(file)}, permission denied: #{e.message}")
         end
 
         begin
           File.open(file, "w") { |f| f.write(Process.pid.to_s) }
         rescue Errno::EACCES => e
-          Chef.fatal!("Couldn't write to pidfile #{file}, permission denied: #{e.message}")
+          Chef::Application.fatal!("Couldn't write to pidfile #{file}, permission denied: #{e.message}")
         end
       end
 
@@ -145,14 +145,14 @@ def _change_privilege(user, group=user)
         begin
           target_uid = Etc.getpwnam(user).uid
         rescue ArgumentError => e
-          Chef.fatal!("Failed to get UID for user #{user}, does it exist? #{e.message}")
+          Chef::Application.fatal!("Failed to get UID for user #{user}, does it exist? #{e.message}")
           return false
         end
 
         begin
           target_gid = Etc.getgrnam(group).gid
         rescue ArgumentError => e
-          Chef.fatal!("Failed to get GID for group #{group}, does it exist? #{e.message}")
+          Chef::Application.fatal!("Failed to get GID for group #{group}, does it exist? #{e.message}")
           return false
         end
 
@@ -163,7 +163,7 @@ def _change_privilege(user, group=user)
         end
         true
       rescue Errno::EPERM => e
-        Chef.fatal!("Permission denied when trying to change #{uid}:#{gid} to #{target_uid}:#{target_gid}. #{e.message}")
+        Chef::Application.fatal!("Permission denied when trying to change #{uid}:#{gid} to #{target_uid}:#{target_gid}. #{e.message}")
       end
     end
   end

chef/lib/chef/log.rb

@@ -44,7 +44,7 @@ def init(*opts)
           @logger = Logger.new(*opts)
         end
         @logger.formatter = Chef::Log::Formatter.new()
-        level(Chef::Config.log_level)
+        level(Chef::Config[:log_level])
       end
 
       # Sets the level for the Logger object by symbol.  Valid arguments are: