chef 0.8.16 → 0.9.0.a3

data/lib/chef/shef.rb

@@ -127,7 +127,7 @@ module Shef
   
   def self.client_type
     type = Shef::StandAloneSession
-    type = Shef::SoloSession   if Chef::Config[:solo]
+    type = Shef::SoloSession   if Chef::Config[:shef_solo]
     type = Shef::ClientSession if Chef::Config[:client]
     type
   end
@@ -161,11 +161,12 @@ module Shef
       :default      => true,
       :boolean      => true
 
-    option :solo,
+    option :shef_solo,
       :short        => "-s",
       :long         => "--solo",
       :description  => "chef-solo shef session",
-      :boolean      => true
+      :boolean      => true,
+      :proc         => proc {Chef::Config[:solo] = true}
 
     option :client,
       :short        => "-z",

data/lib/chef/shef/ext.rb

@@ -61,6 +61,7 @@ module Shef
         banner << "".ljust(80, "=")
         banner << "| " + "Command".ljust(25) + "| " + "Description"
         banner << "".ljust(80, "=")
+
         self.class.all_help_descriptions.each do |cmd, description|
           banner << "| " + cmd.ljust(25) + "| " + description
         end
@@ -86,7 +87,7 @@ module Shef
         end
         
         def all_help_descriptions
-          if sc = superclass
+          if (sc = superclass) && superclass.respond_to?(:help_descriptions)
             help_descriptions + sc.help_descriptions
           else
             help_descriptions
@@ -225,8 +226,7 @@ class Object
   def run_chef
     Chef::Log.level = :debug
     session = Shef.session
-    session.rebuild_collection
-    runrun = Chef::Runner.new(node, session.collection, session.definitions, session.cookbook_loader).converge
+    runrun = Chef::Runner.new(session.run_context).converge
     Chef::Log.level = :info
     runrun
   end
@@ -275,6 +275,14 @@ class Object
   
 end
 
+class String
+  undef_method :version
+end
+
+class NilClass
+  undef_method :version
+end
+
 class Chef
   class Recipe
     
@@ -287,7 +295,7 @@ class Chef
     desc "list all the resources on the current recipe"
     def resources(*args)
       if args.empty?
-        pp collection.instance_variable_get(:@resources_by_name).keys
+        pp run_context.resource_collection.instance_variable_get(:@resources_by_name).keys
       else
         pp resources = original_resources(*args)
         resources

data/lib/chef/shef/shef_session.rb

@@ -19,9 +19,8 @@ module Shef
   class ShefSession
     include Singleton
     
-    attr_accessor :node, :compile, :recipe
+    attr_accessor :node, :compile, :recipe, :run_context
     attr_reader :node_attributes, :client
-    
     def initialize
       @node_built = false
     end
@@ -34,9 +33,10 @@ module Shef
       loading do 
         rebuild_node
         @node = client.node
+        rebuild_context
         node.consume_attributes(node_attributes) if node_attributes
         shorten_node_inspect
-        @recipe = Chef::Recipe.new(nil, nil, @node)
+        @recipe = Chef::Recipe.new(nil, nil, run_context)
         @node_built = true
       end
     end
@@ -46,8 +46,12 @@ module Shef
       @node.consume_attributes(@node_attributes)
     end
     
-    def collection
-      @collection || rebuild_collection
+    def resource_collection
+      run_context.resource_collection
+    end
+
+    def run_context
+      @run_context || rebuild_context
     end
     
     def definitions
@@ -62,7 +66,7 @@ module Shef
       raise "Not Supported! #{self.class.name} doesn't support #save_node, maybe you need to run shef in client mode?"
     end
     
-    def rebuild_collection
+    def rebuild_context
       raise "Not Implemented! :rebuild_collection should be implemented by subclasses"
     end
     
@@ -112,16 +116,18 @@ module Shef
   
   class StandAloneSession < ShefSession
     
-    def rebuild_collection
-      @collection = @recipe.collection
+    def rebuild_context
+      @run_context = Chef::RunContext.new(@node, {}) # no recipes
     end
     
     private
     
     def rebuild_node
+      Chef::Config[:solo] = true
       @client = Chef::Client.new
+      @client.run_ohai
       @client.determine_node_name
-      @client.build_node(@client.node_name, true)
+      @client.build_node #(@client.node_name, true)
     end
     
   end
@@ -129,27 +135,22 @@ module Shef
   class SoloSession < ShefSession
     
     def definitions
-      @compile.definitions
+      @run_context.definitions
     end
     
-    def cookbook_loader
-      @compile.cookbook_loader
-    end
-    
-    def rebuild_collection
-      @compile = Chef::Compile.new(@client.node)
-      
-      @collection = @compile.collection
-      @collection << @recipe.collection.all_resources
-      @collection
+    def rebuild_context
+      @run_context = Chef::RunContext.new(@node, Chef::CookbookCollection.new(Chef::CookbookLoader.new))
     end
     
     private
     
     def rebuild_node
+      # Tell the client we're chef solo so it won't try to contact the server
+      Chef::Config[:solo] = true
       @client = Chef::Client.new
+      @client.run_ohai
       @client.determine_node_name
-      @client.build_node(@client.node_name, true)
+      @client.build_node #(@client.node_name, true)
     end
     
   end
@@ -163,13 +164,16 @@ module Shef
     private
 
     def rebuild_node
+      # Make sure the client knows this is not chef solo
+      Chef::Config[:solo] = false
       @client = Chef::Client.new
+      @client.run_ohai
       @client.determine_node_name
       @client.register
-      @client.build_node(@client.node_name, false)
+      @client.build_node #(@client.node_name, false)
       
       @client.sync_cookbooks
     end
 
   end
-end
+end

data/lib/chef/shell_out.rb

@@ -0,0 +1,375 @@
+#
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Copyright:: Copyright (c) 2010 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'etc'
+require 'tmpdir'
+require 'chef/log'
+
+class Chef
+  
+  # Provides a simplified interface to shelling out yet still collecting both
+  # standard out and standard error and providing full control over environment,
+  # working directory, uid, gid, etc.
+  # 
+  # No means for passing input to the subprocess is provided, nor is there any
+  # way to inspect the output of the command as it is being read. If you need 
+  # to do that, you have to use Chef::Mixin::Command.popen4
+  #
+  # == Platform Support
+  # Chef::ShellOut uses Kernel.fork() and is therefore unsuitable for Windows
+  # or jruby.
+  class ShellOut
+    READ_WAIT_TIME = 0.01
+    DEFAULT_READ_TIMEOUT = 60
+    DEFAULT_ENVIRONMENT = {'LC_ALL' => 'C'}
+    
+    attr_accessor :user, :group, :cwd, :valid_exit_codes
+    attr_reader :command, :umask, :environment
+    attr_writer :timeout
+    
+    attr_reader :stdout, :stderr, :status
+    
+    attr_reader :stdin_pipe, :stdout_pipe, :stderr_pipe, :process_status_pipe
+    
+    # === Arguments:
+    # Takes a single command, or a list of command fragments. These are used
+    # as arguments to Kernel.exec. See the Kernel.exec documentation for more
+    # explanation of how arguments are evaluated. The last argument can be an
+    # options Hash.
+    # === Options:
+    # If the last argument is a Hash, it is removed from the list of args passed
+    # to exec and used as an options hash. The following options are available:
+    # * user: the user the commmand should run as. if an integer is given, it is
+    #   used as a uid. A string is treated as a username and resolved to a uid
+    #   with Etc.getpwnam
+    # * group: the group the command should run as. works similarly to +user+
+    # * cwd: the directory to chdir to before running the command
+    # * umask: a umask to set before running the command. If given as an Integer,
+    #   be sure to use two leading zeros so it's parsed as Octal. A string will
+    #   be treated as an octal integer
+    # * returns:  one or more Integer values to use as valid exit codes for the
+    #   subprocess. This only has an effect if you call +error!+ after
+    #   +run_command+.
+    # * environment: a Hash of environment variables to set before the command
+    #   is run. By default, the environment will *always* be set to 'LC_ALL' => 'C'
+    #   to prevent issues with multibyte characters in Ruby 1.8. To avoid this,
+    #   use :environment => nil for *no* extra environment settings, or
+    #   :environment => {'LC_ALL'=>nil, ...} to set other environment settings
+    #   without changing the locale.
+    def initialize(*command_args)
+      @stdout, @stderr = '', ''
+      @environment = DEFAULT_ENVIRONMENT
+      @cwd = Dir.tmpdir
+      @valid_exit_codes = [0]
+
+      if command_args.last.is_a?(Hash)
+        parse_options(command_args.pop)
+      end
+      
+      @command = command_args.size == 1 ? command_args.first : command_args
+    end
+    
+    def umask=(new_umask)
+      @umask = (new_umask.respond_to?(:oct) ? new_umask.oct : new_umask.to_i) & 007777
+    end
+    
+    def uid
+      return nil unless user
+      user.kind_of?(Integer) ? user : Etc.getpwnam(user.to_s).uid
+    end
+    
+    def gid
+      return nil unless group
+      group.kind_of?(Integer) ? group : Etc.getgrnam(group.to_s).gid
+    end
+    
+    def timeout
+      @timeout || DEFAULT_READ_TIMEOUT
+    end
+    
+    def format_for_exception
+      msg = ""
+      msg << "---- Begin output of #{command} ----\n"
+      msg << "STDOUT: #{stdout.strip}\n"
+      msg << "STDERR: #{stderr.strip}\n"
+      msg << "---- End output of #{command} ----\n"
+      msg << "Ran #{command} returned #{status.exitstatus}" if status
+      msg
+    end
+    
+    def exitstatus
+      @status && @status.exitstatus
+    end
+    
+    # Run the command, writing the command's standard out and standard error
+    # to +stdout+ and +stderr+, and saving its exit status object to +status+
+    # === Returns
+    # returns   +self+; +stdout+, +stderr+, +status+, and +exitstatus+ will be
+    # populated with results of the command
+    # === Raises
+    # * Errno::EACCES   when you are not privileged to execute the command
+    # * Errno::ENOENT   when the command is not available on the system (or not
+    #   in the current $PATH)
+    # * Chef::Exceptions::CommandTimeout when the command does not complete
+    #                                  within +timeout+ seconds (default: 60s)
+    def run_command
+      Chef::Log.debug("sh(#{@command})")
+      
+      @child_pid = fork_subprocess
+      
+      configure_parent_process_file_descriptors
+      propagate_pre_exec_failure
+        
+      @result = nil
+      read_time = 0
+     
+      until @status
+        ready = IO.select(open_pipes, nil, nil, READ_WAIT_TIME)
+        unless ready
+          read_time += READ_WAIT_TIME
+          if read_time >= timeout && !@result
+            raise Chef::Exceptions::CommandTimeout, "command timed out:\n#{format_for_exception}"
+          end
+        end
+        
+        if ready && ready.first.include?(child_stdout)
+          read_stdout_to_buffer
+        end
+        if ready && ready.first.include?(child_stderr)
+          read_stderr_to_buffer
+        end
+        
+        unless @status
+          # make one more pass to get the last of the output after the
+          # child process dies
+          if results = Process.waitpid2(@child_pid, Process::WNOHANG)
+            @status = results.last
+            redo
+          end
+        end
+      end
+      self
+    rescue Exception
+      # do our best to kill zombies
+      Process.waitpid2(@child_pid, Process::WNOHANG) rescue nil
+      raise
+    ensure
+      close_all_pipes
+    end
+    
+    def error!
+      unless Array(valid_exit_codes).include?(exitstatus)
+        invalid!("Expected process to exit 0, but it exited with #{exitstatus}")
+      end
+    end
+
+    # Raises a Chef::Exceptions::ShellCommandFailed exception, appending the
+    # command's stdout, stderr, and exitstatus to the exception message.
+    # === Arguments
+    # +msg+     A String to use as the basis of the exception message. The 
+    #           default explanation is very generic, providing a more 
+    #           informative message is highly encouraged.
+    # === Raises
+    # Chef::Exceptions::ShellCommandFailed  always
+    def invalid!(msg=nil)
+      msg ||= "Command produced unexpected results"
+      raise Chef::Exceptions::ShellCommandFailed, msg + "\n" + format_for_exception
+    end
+    
+    def inspect
+      "<#{self.class.name}##{object_id}: command: '#@command' process_status: #{@status.inspect} " +
+      "stdout: '#{stdout.strip}' stderr: '#{stderr.strip}' child_pid: #{@child_pid.inspect} " + 
+      "environment: #{@environment.inspect} timeout: #{timeout} user: #@user group: #@group working_dir: #@cwd >"
+    end
+
+    private
+    
+    def parse_options(opts)
+      opts.each do |option, setting|
+        case option.to_s
+        when 'cwd'
+          self.cwd = setting
+        when 'user'
+          self.user = setting
+        when 'group'
+          self.group = setting
+        when 'umask'
+          self.umask = setting
+        when 'timeout'
+          self.timeout = setting
+        when 'returns'
+          self.valid_exit_codes = Array(setting)
+        when 'environment', 'env'
+          # passing :environment => nil means don't set any new ENV vars
+          setting.nil? ? @environment = {} : @environment.merge!(setting)
+        else
+          raise Chef::Exceptions::InvalidCommandOption, "option '#{option.inspect}' is not a valid option for #{self.class.name}"
+        end
+      end
+    end
+    
+    def set_user
+      if user
+        Process.euid = uid
+        Process.uid = uid
+      end
+    end 
+    
+    def set_group
+      if group
+        Process.egid = gid
+        Process.gid = gid
+      end
+    end
+    
+    def set_environment
+      environment.each do |env_var,value|
+        ENV[env_var] = value
+      end
+    end
+    
+    def set_umask
+      File.umask(umask) if umask
+    end
+    
+    def initialize_ipc
+      @stdout_pipe, @stderr_pipe, @process_status_pipe = IO.pipe, IO.pipe, IO.pipe
+      @process_status_pipe.last.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+    end
+    
+    def child_stdout
+      @stdout_pipe[0]
+    end
+    
+    def child_stderr
+      @stderr_pipe[0]
+    end
+    
+    def child_process_status
+      @process_status_pipe[0]
+    end
+    
+    def close_all_pipes
+      child_stdout.close  unless child_stdout.closed?
+      child_stderr.close  unless child_stderr.closed?
+      child_process_status.close unless child_process_status.closed?
+    #rescue NoMethodError # we blew up before IPC was setup
+    end
+    
+    # replace stdout, and stderr with pipes to the parent, and close the
+    # reader side of the error marshaling side channel. Close STDIN so when we
+    # exec, the new program will no it's never getting input ever.
+    def configure_subprocess_file_descriptors
+      process_status_pipe.first.close
+      
+      # HACK: for some reason, just STDIN.close isn't good enough when running
+      # under ruby 1.9.2, so make it good enough:
+      stdin_reader, stdin_writer = IO.pipe
+      stdin_writer.close
+      STDIN.reopen stdin_reader
+      stdin_reader.close
+
+      stdout_pipe.first.close
+      STDOUT.reopen stdout_pipe.last
+      stdout_pipe.last.close
+
+      stderr_pipe.first.close
+      STDERR.reopen stderr_pipe.last
+      stderr_pipe.last.close
+
+      STDOUT.sync = STDERR.sync = true
+    end
+    
+    def configure_parent_process_file_descriptors
+      # Close the sides of the pipes we don't care about
+      stdout_pipe.last.close
+      stderr_pipe.last.close
+      process_status_pipe.last.close
+      # Get output as it happens rather than buffered
+      child_stdout.sync = true
+      child_stderr.sync = true
+      # Set file descriptors to non-blocking IO. man(2) fcntl
+      child_stdout.fcntl(Fcntl::F_SETFL, child_stdout.fcntl(Fcntl::F_GETFL) | Fcntl::O_NONBLOCK)
+      child_stderr.fcntl(Fcntl::F_SETFL, child_stderr.fcntl(Fcntl::F_GETFL) | Fcntl::O_NONBLOCK)
+      true
+    end
+    
+    # Some patch levels of ruby in wide use (in particular the ruby 1.8.6 on OSX)
+    # segfault when you IO.select a pipe that's reached eof. Weak sauce.
+    def open_pipes
+      @open_pipes ||= [child_stdout, child_stderr]
+    end
+
+    def read_stdout_to_buffer
+      while chunk = child_stdout.read(16 * 1024)
+        @stdout << chunk
+      end
+    rescue Errno::EAGAIN
+    rescue EOFError
+      open_pipes.delete_at(0)
+    end
+    
+    def read_stderr_to_buffer
+      while chunk = child_stderr.read(16 * 1024)
+        @stderr << chunk
+      end
+    rescue Errno::EAGAIN
+    rescue EOFError
+      open_pipes.delete_at(1)
+    end
+    
+    def fork_subprocess
+      initialize_ipc
+      
+      fork do
+        configure_subprocess_file_descriptors
+        
+        set_user
+        set_group
+        set_environment
+        set_umask
+
+        begin
+          command.kind_of?(Array) ? exec(*command) : exec(command)
+          
+          raise 'forty-two' # Should never get here
+        rescue Exception => e
+          Marshal.dump(e, process_status_pipe.last)
+          process_status_pipe.last.flush
+        end
+        process_status_pipe.last.close unless (process_status_pipe.last.closed?)
+        exit!
+      end
+    end
+    
+    # Attempt to get a Marshaled error from the side-channel.
+    # If it's there, un-marshal it and raise. If it's not there,
+    # assume everything went well.
+    def propagate_pre_exec_failure
+      begin
+        e = Marshal.load child_process_status
+        raise(Exception === e ? e : "unknown failure: #{e.inspect}")
+      rescue EOFError # If we get an EOF error, then the exec was successful
+        true
+      ensure
+        child_process_status.close
+      end
+    end
+    
+  end
+end