tylerrick-chef 0.10.8

data/lib/chef/shef/model_wrapper.rb

@@ -0,0 +1,120 @@
+#--
+# 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 'chef/mixin/convert_to_class_name'
+require 'chef/mixin/language'
+
+module Shef
+  class ModelWrapper
+
+    include Chef::Mixin::ConvertToClassName
+
+    attr_reader :model_symbol
+
+    def initialize(model_class, symbol=nil)
+      @model_class = model_class
+      @model_symbol = symbol || convert_to_snake_case(model_class.name, "Chef").to_sym
+    end
+
+    def search(query)
+      return all if query.to_s == "all"
+      results = []
+      Chef::Search::Query.new.search(@model_symbol, format_query(query)) do |obj|
+        if block_given?
+          results << yield(obj)
+        else
+          results << obj
+        end
+      end
+      results
+    end
+
+    alias :find :search
+
+    def all(&block)
+      all_objects = list_objects
+      block_given? ? all_objects.map(&block) : all_objects
+    end
+
+    alias :list :all
+
+    def show(obj_id)
+      @model_class.load(obj_id)
+    end
+
+    alias :load :show
+
+    def transform(what_to_transform, &block)
+      if what_to_transform == :all
+        objects_to_transform = list_objects
+      else
+        objects_to_transform = search(what_to_transform)
+      end
+      objects_to_transform.each do |obj|
+        if result = yield(obj)
+          obj.save
+        end
+      end
+    end
+
+    alias :bulk_edit :transform
+
+    private
+
+    # paper over inconsistencies in the model classes APIs, and return the objects
+    # the user wanted instead of the URI=>object stuff
+    def list_objects
+      objects = @model_class.method(:list).arity == 0? @model_class.list : @model_class.list(true)
+      objects.map { |obj| Array(obj).find {|o| o.kind_of?(@model_class)} }
+    end
+
+    def format_query(query)
+      if query.respond_to?(:keys)
+        query.map { |key, value| "#{key}:#{value}" }.join(" AND ")
+      else
+        query
+      end
+    end
+  end
+
+  class NamedDataBagWrapper < ModelWrapper
+
+    def initialize(databag_name)
+      @model_symbol = @databag_name = databag_name
+    end
+
+
+    alias :list :all
+
+    def show(item)
+      Chef::DataBagItem.load(@databag_name, item)
+    end
+
+    private
+
+    def list_objects
+      all_items = []
+      Chef::Search::Query.new.search(@databag_name) do |item|
+        all_items << item
+      end
+      all_items
+    end
+
+  end
+
+end

data/lib/chef/shef/shef_rest.rb

@@ -0,0 +1,28 @@
+#--
+# 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.
+#
+
+module Shef
+  class ShefREST < Chef::REST
+
+    alias :get    :get_rest
+    alias :put    :put_rest
+    alias :post   :post_rest
+    alias :delete :delete_rest
+
+  end
+end

data/lib/chef/shef/shef_session.rb

@@ -0,0 +1,285 @@
+#--
+# Author:: Daniel DeLeo (<dan@kallistec.com>)
+# Author:: Tim Hinderliter (<tim@opscode.com>)
+# Copyright:: Copyright (c) 2009 Daniel DeLeo
+# Copyright:: Copyright (c) 2011 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 'chef/recipe'
+require 'chef/run_context'
+require 'chef/config'
+require 'chef/client'
+require 'chef/cookbook/cookbook_collection'
+require 'chef/cookbook_loader'
+require 'chef/run_list/run_list_expansion'
+
+module Shef
+  class ShefSession
+    include Singleton
+
+    def self.session_type(type=nil)
+      @session_type = type if type
+      @session_type
+    end
+
+    attr_accessor :node, :compile, :recipe, :run_context
+    attr_reader :node_attributes, :client
+    def initialize
+      @node_built = false
+    end
+
+    def node_built?
+      !!@node_built
+    end
+
+    def reset!
+      loading do
+        rebuild_node
+        @node = client.node
+        shorten_node_inspect
+        Shef::Extensions.extend_context_node(@node)
+        rebuild_context
+        node.consume_attributes(node_attributes) if node_attributes
+        @recipe = Chef::Recipe.new(nil, nil, run_context)
+        Shef::Extensions.extend_context_recipe(@recipe)
+        @node_built = true
+      end
+    end
+
+    def node_attributes=(attrs)
+      @node_attributes = attrs
+      @node.consume_attributes(@node_attributes)
+    end
+
+    def resource_collection
+      run_context.resource_collection
+    end
+
+    def run_context
+      @run_context ||= rebuild_context
+    end
+
+    def definitions
+      nil
+    end
+
+    def cookbook_loader
+      nil
+    end
+
+    def save_node
+      raise "Not Supported! #{self.class.name} doesn't support #save_node, maybe you need to run shef in client mode?"
+    end
+
+    def rebuild_context
+      raise "Not Implemented! :rebuild_collection should be implemented by subclasses"
+    end
+
+    private
+
+    def loading
+      show_loading_progress
+      begin
+        yield
+      rescue => e
+        loading_complete(false)
+        raise e
+      else
+        loading_complete(true)
+      end
+    end
+
+    def show_loading_progress
+      print "Loading"
+      @loading = true
+      @dot_printer = Thread.new do
+        while @loading
+          print "."
+          sleep 0.5
+        end
+      end
+    end
+
+    def loading_complete(success)
+      @loading = false
+      @dot_printer.join
+      msg = success ? "done.\n\n" : "epic fail!\n\n"
+      print msg
+    end
+
+    def shorten_node_inspect
+      def @node.inspect
+        "<Chef::Node:0x#{self.object_id.to_s(16)} @name=\"#{self.name}\">"
+      end
+    end
+
+    def rebuild_node
+      raise "Not Implemented! :rebuild_node should be implemented by subclasses"
+    end
+
+  end
+
+  class StandAloneSession < ShefSession
+
+    session_type :standalone
+
+    def rebuild_context
+      @run_context = Chef::RunContext.new(@node, {}) # no recipes
+      @run_context.load(Chef::RunList::RunListExpansionFromDisk.new("_default", [])) # empty recipe list
+    end
+
+    private
+
+    def rebuild_node
+      Chef::Config[:solo] = true
+      @client = Chef::Client.new
+      @client.run_ohai
+      @client.build_node
+    end
+
+  end
+
+  class SoloSession < ShefSession
+
+    session_type :solo
+
+    def definitions
+      @run_context.definitions
+    end
+
+    def rebuild_context
+      @run_status = Chef::RunStatus.new(@node)
+      Chef::Cookbook::FileVendor.on_create { |manifest| Chef::Cookbook::FileSystemFileVendor.new(manifest, Chef::Config[:cookbook_path]) }
+      @run_context = Chef::RunContext.new(@node, Chef::CookbookCollection.new(Chef::CookbookLoader.new(Chef::Config[:cookbook_path])))
+      @run_context.load(Chef::RunList::RunListExpansionFromDisk.new("_default", []))
+      @run_status.run_context = run_context
+    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.build_node
+    end
+
+  end
+
+  class ClientSession < SoloSession
+
+    session_type :client
+
+    def save_node
+      @client.save_node
+    end
+
+    def rebuild_context
+      @run_status = Chef::RunStatus.new(@node)
+      Chef::Cookbook::FileVendor.on_create { |manifest| Chef::Cookbook::RemoteFileVendor.new(manifest, Chef::REST.new(Chef::Config[:server_url])) }
+      cookbook_hash = @client.sync_cookbooks
+      @run_context = Chef::RunContext.new(node, Chef::CookbookCollection.new(cookbook_hash))
+      @run_context.load(Chef::RunList::RunListExpansionFromAPI.new("_default", []))
+      @run_status.run_context = run_context
+    end
+
+    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.register
+      @client.build_node
+    end
+
+  end
+
+  class DoppelGangerClient < Chef::Client
+
+    attr_reader :node_name
+
+    def initialize(node_name)
+      @node_name = node_name
+      @ohai = Ohai::System.new
+    end
+
+    # Run the very smallest amount of ohai we can get away with and still
+    # hope to have things work. Otherwise we're not very good doppelgangers
+    def run_ohai
+      @ohai.require_plugin('os')
+    end
+
+    # DoppelGanger implementation of build_node. preserves as many of the node's
+    # attributes, and does not save updates to the server
+    def build_node
+      Chef::Log.debug("Building node object for #{@node_name}")
+
+      @node = Chef::Node.find_or_create(node_name)
+
+      ohai_data = @ohai.data.merge(@node.automatic_attrs)
+
+      @node.consume_external_attrs(ohai_data,nil)
+
+      @node
+    end
+
+    def register
+      @rest = Chef::REST.new(Chef::Config[:chef_server_url], Chef::Config[:node_name], Chef::Config[:client_key])
+    end
+
+  end
+
+  class DoppelGangerSession < ClientSession
+
+    session_type "doppelganger client"
+
+    def save_node
+      puts "A doppelganger should think twice before saving the node"
+    end
+
+    def assume_identity(node_name)
+      Chef::Config[:doppelganger] = @node_name = node_name
+      reset!
+    rescue Exception => e
+      puts "#{e.class.name}: #{e.message}"
+      puts Array(e.backtrace).join("\n")
+      puts
+      puts "* " * 40
+      puts "failed to assume the identity of node '#{node_name}', resetting"
+      puts "* " * 40
+      puts
+      Chef::Config[:doppelganger] = false
+      @node_built = false
+      Shef.session
+    end
+
+    def rebuild_node
+      # Make sure the client knows this is not chef solo
+      Chef::Config[:solo] = false
+      @client = DoppelGangerClient.new(@node_name)
+      @client.run_ohai
+      @client.register
+      @client.build_node
+
+      @client.sync_cookbooks
+    end
+
+  end
+
+end

data/lib/chef/shell_out.rb

@@ -0,0 +1,249 @@
+#--
+# 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'
+require 'fcntl'
+require 'chef/exceptions'
+
+class Chef
+
+  # == Chef::ShellOut
+  # 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 popen4 (in Chef::Mixin::Command)
+  #
+  # === Platform Support
+  # Chef::ShellOut uses Kernel.fork() and is therefore unsuitable for Windows
+  # or jruby.
+  class ShellOut
+    READ_WAIT_TIME = 0.01
+    READ_SIZE = 4096
+    DEFAULT_READ_TIMEOUT = 600
+    DEFAULT_ENVIRONMENT = {'LC_ALL' => 'C'}
+
+    if RUBY_PLATFORM =~ /mswin|mingw32|windows/
+      require 'chef/shell_out/windows'
+      include ShellOut::Windows
+    else
+      require 'chef/shell_out/unix'
+      include ShellOut::Unix
+    end
+
+    attr_accessor :user
+    attr_accessor :group
+    attr_accessor :cwd
+    attr_accessor :valid_exit_codes
+    attr_accessor :live_stream
+    attr_accessor :command_log_level
+    attr_accessor :command_log_prepend
+
+    attr_reader :command, :umask, :environment
+    attr_writer :timeout
+    attr_reader :execution_time
+
+    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.
+    # * +timeout+: a Numeric value for the number of seconds to wait on the
+    #   child process before raising an Exception. This is calculated as the
+    #   total amount of time that ShellOut waited on the child process without
+    #   receiving any output (i.e., IO.select returned nil). Default is 60
+    #   seconds. Note: the stdlib Timeout library is not used.
+    # === Examples:
+    # Invoke find(1) to search for .rb files:
+    #   find = Chef::ShellOut.new("find . -name '*.rb'")
+    #   find.run_command
+    #   # If all went well, the results are on +stdout+
+    #   puts find.stdout
+    #   # find(1) prints diagnostic info to STDERR:
+    #   puts "error messages" + find.stderr
+    #   # Raise an exception if it didn't exit with 0
+    #   find.error!
+    # Run a command as the +www+ user with no extra ENV settings from +/tmp+
+    #   cmd = Chef::ShellOut.new("apachectl", "start", :user => 'www', :env => nil, :cwd => '/tmp')
+    #   cmd.run_command # etc.
+    def initialize(*command_args)
+      @stdout, @stderr = '', ''
+      @live_stream = nil
+      @command_log_level = :debug
+      @command_log_prepend = nil 
+      @environment = DEFAULT_ENVIRONMENT
+      @cwd = nil
+      @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
+
+    # Creates a String showing the output of the command, including a banner
+    # showing the exact command executed. Used by +invalid!+ to show command
+    # results when the command exited with an unexpected status.
+    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
+      if command_log_prepend
+        Chef::Log.send(command_log_level, "#{command_log_prepend} sh(#{@command})")
+      else
+        Chef::Log.send(command_log_level, "sh(#{@command})")
+      end
+      super
+    end
+
+    # Checks the +exitstatus+ against the set of +valid_exit_codes+. If
+    # +exitstatus+ is not in the list of +valid_exit_codes+, calls +invalid!+,
+    # which raises an Exception.
+    # === Returns
+    # nil::: always returns nil when it does not raise
+    # === Raises
+    # Chef::Exceptions::ShellCommandFailed::: via +invalid!+
+    def error!
+      unless Array(valid_exit_codes).include?(exitstatus)
+        invalid!("Expected process to exit with #{valid_exit_codes.inspect}, but received '#{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 'live_stream'
+          self.live_stream = setting
+        when 'command_log_level'
+          self.command_log_level = setting
+        when 'command_log_prepend'
+          self.command_log_prepend = setting
+        when 'environment', 'env'
+          # passing :environment => nil means don't set any new ENV vars
+          @environment = setting.nil? ? {} : @environment.dup.merge!(setting)
+        else
+          raise Chef::Exceptions::InvalidCommandOption, "option '#{option.inspect}' is not a valid option for #{self.class.name}"
+        end
+      end
+    end
+
+
+  end
+end