chef 0.9.8.rc.0 → 0.9.8

data/lib/chef/mixin/deep_merge.rb

@@ -17,13 +17,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Notice:
-# This code is imported from deep_merge by Steve Midgley. deep_merge is
-# available under the MIT license from
-# http://trac.misuse.org/science/wiki/DeepMerge
-
 class Chef
   module Mixin
+    # == Chef::Mixin::DeepMerge
+    # Implements a deep merging algorithm for nested data structures.
+    # ==== Notice:
+    #   This code is imported from deep_merge by Steve Midgley. deep_merge is
+    #   available under the MIT license from
+    #   http://trac.misuse.org/science/wiki/DeepMerge
     module DeepMerge
       def self.merge(first, second)
         first  = Mash.new(first)  unless first.kind_of?(Mash)

data/lib/chef/mixin/recipe_definition_dsl_core.rb

@@ -1,4 +1,4 @@
-#
+#--
 # Author:: Adam Jacob (<adam@opscode.com>)
 # Author:: Christopher Walters (<cw@opscode.com>)
 # Copyright:: Copyright (c) 2008, 2009 Opscode, Inc.
@@ -21,6 +21,7 @@ require 'chef/resource'
 require 'chef/mixin/convert_to_class_name'
 require 'chef/mixin/language'
 
+#--
 # UGH. this is a circular require that will cause an uninitialized constant
 # error, but this file really does depend on Chef::Recipe. oh well.
 # require 'chef/recipe'

data/lib/chef/mixin/shell_out.rb

@@ -1,4 +1,4 @@
-#
+#--
 # Author:: Daniel DeLeo (<dan@opscode.com>)
 # Copyright:: Copyright (c) 2010 Opscode, Inc.
 # License:: Apache License, Version 2.0

data/lib/chef/mixin/template.rb

@@ -1,4 +1,4 @@
-#
+#--
 # Author:: Adam Jacob (<adam@opscode.com>)
 # Copyright:: Copyright (c) 2008 Opscode, Inc.
 # License:: Apache License, Version 2.0

data/lib/chef/mixin/xml_escape.rb

@@ -1,4 +1,4 @@
-#
+#--
 # Author:: Daniel DeLeo (<dan@opscode.com>)
 # Copyright:: Copyright (c) 2009 Opscode, Inc.
 # Copyright:: Copyright (c) 2005 Sam Ruby
@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-#
+#--
 # Portions of this code are adapted from Sam Ruby's xchar.rb
 # http://intertwingly.net/stories/2005/09/28/xchar.rb 
 #

data/lib/chef/monkey_patches/dir.rb

@@ -16,11 +16,11 @@
 # limitations under the License.
 #
 
-# Adds a Dir.glob to Ruby 1.8.5, for compat
 if RUBY_VERSION < "1.8.6" || RUBY_PLATFORM =~ /mswin|mingw32|windows/
   class Dir 
     class << self 
       alias_method :glob_, :glob 
+      # Adds a Dir.glob to Ruby 1.8.5, for compat
       def glob(pattern, flags=0)
         raise ArgumentError unless (
           !pattern.nil? and (

data/lib/chef/monkey_patches/string.rb

@@ -16,7 +16,8 @@
 # limitations under the License.
 #
 
-# On ruby 1.9, Strings are aware of multibyte characters, so #size and length
+# == String (Patch)
+# On ruby 1.9, Strings are aware of multibyte characters, so +size+ and +length+
 # give the actual number of characters. In Chef::REST, we need the bytesize
 # so we can correctly set the Content-Length headers, but ruby 1.8.6 and lower
 # don't define String#bytesize. Monkey patching time!

data/lib/chef/monkey_patches/tempfile.rb

@@ -16,11 +16,15 @@
 # limitations under the License.
 #
 
+# == Tempfile (Patch)
 # Tempfile has a horrible bug where it causes an IOError: closed stream in its
 # finalizer, leading to intermittent application crashes with confusing stack
 # traces. Here we monkey patch the fix into place. You can track the bug on
 # ruby's redmine: http://redmine.ruby-lang.org/issues/show/3119
-class Tempfile
+#
+# The patch is slightly different for Ruby 1.8 and Ruby 1.9, both patches are
+# included here.
+class Tempfile # :nodoc:
   # Tempfile has changes between 1.8.x and 1.9.x
   # so we monkey patch separately
   if RUBY_VERSION =~ /^1\.8/

data/lib/chef/provider/package/easy_install.rb

@@ -18,22 +18,34 @@
 
 require 'chef/provider/package'
 require 'chef/mixin/command'
+require 'chef/mixin/shell_out'
 require 'chef/resource/package'
+require 'chef/mixin/shell_out'
+
 class Chef
   class Provider
     class Package
       class EasyInstall < Chef::Provider::Package
 
+        include Chef::Mixin::ShellOut
+
         def install_check(name)
-          command = "python -c \"import sys; print sys.path\""
           check = false
-          status = popen4(command) do |pid, stdin, stdout, stderr|
-            stdout.each do |line|
-              if line.include? "#{name}"
-                check = true
-              end
+
+          begin
+            # first check to see if we can import it
+            output = shell_out!("python -c \"import #{name}\"").stderr
+            unless output.include? "ImportError"
+              check = true
+            end
+          rescue
+            # then check to see if its on the path
+            output = shell_out!("python -c \"import sys; print sys.path\"").stdout
+            if output.downcase.include? "#{name.downcase}"
+              check = true
             end
           end
+
           check
         end
 
@@ -50,17 +62,19 @@ class Chef
           # get the currently installed version if installed
           package_version = nil
           if install_check(@new_resource.package_name)
-            command = "python -c \"import #{@new_resource.package_name}; print #{@new_resource.package_name}.__path__\""
-            status = popen4(command) do |pid, stdin, stdout, stderr|
-              install_location = stdout.readline
-              install_location[/\S\S(.*)\/(.*)-(.*)-py(.*).egg\S/]
+            begin
+              output = shell_out!("python -c \"import #{@new_resource.package_name}; print #{@new_resource.package_name}.__version__\"").stdout
+              package_version = output.strip
+            rescue
+              output = shell_out!("python -c \"import #{@new_resource.package_name}; print #{@new_resource.package_name}.__path__\"").stdout
+              output[/\S\S(.*)\/(.*)-(.*)-py(.*).egg\S/]
               package_version = $3
             end
           end
 
           if package_version == @new_resource.version
             Chef::Log.debug("#{@new_resource.package_name} at version #{@new_resource.version}")
-            @current_resource.version(@new_resource.version)
+          @current_resource.version(@new_resource.version)
           else
             Chef::Log.debug("#{@new_resource.package_name} at version #{package_version}")
             @current_resource.version(package_version)
@@ -73,16 +87,9 @@ class Chef
            return @candidate_version if @candidate_version
 
            # do a dry run to get the latest version
-           command = "#{easy_install_binary_path} -n #{@new_resource.package_name}"
-           status  = popen4(command) do |pid, stdin, stdout, stderr|
-             dry_run_output = ""
-             stdout.each do |line|
-               dry_run_output << line
-             end
-             dry_run_output[/(.*)Best match: (.*) (.*)\n/]
-             @candidate_version = $3
-             @candidate_version
-           end
+           result = shell_out!("#{easy_install_binary_path} -n #{@new_resource.package_name}", :returns=>[0,1])
+           @candidate_version = result.stdout[/(.*)Best match: (.*) (.*)$/, 3]
+           @candidate_version
         end
 
         def install_package(name, version)
@@ -104,4 +111,4 @@ class Chef
       end
     end
   end
-end
+end

data/lib/chef/provider/template.rb

@@ -1,4 +1,4 @@
-#
+#--
 # Author:: Adam Jacob (<adam@opscode.com>)
 # Author:: Daniel DeLeo (<dan@opscode.com>)
 # Copyright:: Copyright (c) 2008, 2010 Opscode, Inc.
@@ -22,12 +22,6 @@ require 'chef/mixin/template'
 require 'chef/mixin/checksum'
 require 'chef/file_access_control'
 
-#require 'chef/mixin/find_preferred_file'
-#require 'chef/rest'
-#require 'chef/file_cache'
-#require 'uri'
-#require 'tempfile'
-
 class Chef
   class Provider
 
@@ -35,7 +29,6 @@ class Chef
 
       include Chef::Mixin::Checksum
       include Chef::Mixin::Template
-      #include Chef::Mixin::FindPreferredFile
 
       def load_current_resource
         super
@@ -98,45 +91,8 @@ class Chef
         @new_resource.updated = access_controls.modified?
       end
 
-      # def locate_or_fetch_template
-      #   Chef::Log.debug("looking for template #{@new_resource.source} in cookbook #{cookbook_name.inspect}")
-      # 
-      #   cache_file_name = "cookbooks/#{cookbook_name}/templates/default/#{@new_resource.source}"
-      #   template_cache_name = "#{cookbook_name}_#{@new_resource.source}"
-      # 
-      #   if @new_resource.local
-      #     cache_file_name = @new_resource.source
-      #   elsif Chef::Config[:solo]
-      #     cache_file_name = solo_cache_file_name
-      #   else
-      #     raw_template_file = fetch_template_via_rest(cache_file_name, template_cache_name)
-      #   end
-      # 
-      #   if template_updated?
-      #     Chef::Log.debug("Updating template for #{@new_resource} in the cache")
-      #     Chef::FileCache.move_to(raw_template_file.path, cache_file_name)
-      #   end
-      #   cache_file_name
-      # end
-
       private
 
-      # def template_updated
-      #   @template_updated = true
-      # end
-      # 
-      # def template_not_updated
-      #   @template_updated = false
-      # end
-      # 
-      # def template_updated?
-      #   @template_updated
-      # end
-      # 
-      # def cookbook_name
-      #   @cookbook_name = (@new_resource.cookbook || @new_resource.cookbook_name)
-      # end
-
       def render_with_context(template_location, &block)
         context = {}
         context.merge!(@new_resource.variables)
@@ -144,55 +100,6 @@ class Chef
         render_template(IO.read(template_location), context, &block)
       end
 
-      # def solo_cache_file_name
-      #   filename = find_preferred_file(
-      #     cookbook_name,
-      #     :template,
-      #     @new_resource.source,
-      #     node[:fqdn],
-      #     node[:platform],
-      #     node[:platform_version]
-      #   )
-      #   Chef::Log.debug("Using local file for template:#{filename}")
-      #   Pathname.new(filename).relative_path_from(Pathname.new(Chef::Config[:file_cache_path])).to_s
-      # end
-      # 
-      # def fetch_template_via_rest(cache_file_name, template_cache_name)
-      #   if node.run_state[:template_cache].has_key?(template_cache_name)
-      #     Chef::Log.debug("I have already fetched the template for #{@new_resource} once this run, not checking again.")
-      #     template_not_updated
-      #     return false
-      #   end
-      # 
-      #   r = Chef::REST.new(Chef::Config[:template_url])
-      # 
-      #   current_checksum = nil
-      # 
-      #   if Chef::FileCache.has_key?(cache_file_name)
-      #     current_checksum = self.checksum(Chef::FileCache.load(cache_file_name, false))
-      #   else
-      #     Chef::Log.debug("Template #{@new_resource} is not in the template cache")
-      #   end
-      # 
-      #   template_url = generate_url(@new_resource.source, "templates", :checksum => current_checksum)
-      # 
-      #   begin
-      #     raw_template_file = r.get_rest(template_url, true)
-      #     template_updated
-      #   rescue Net::HTTPRetriableError
-      #     if e.response.kind_of?(Net::HTTPNotModified)
-      #       Chef::Log.debug("Cached template for #{@new_resource} is unchanged")
-      #     else
-      #       raise
-      #     end
-      #   end
-      # 
-      #   # We have checked the cache for this template this run
-      #   node.run_state[:template_cache][template_cache_name] = true
-      # 
-      #   raw_template_file
-      # end
-
     end
   end
 end

data/lib/chef/recipe.rb

@@ -1,4 +1,4 @@
-#
+#--
 # Author:: Adam Jacob (<adam@opscode.com>)
 # Author:: Christopher Walters (<cw@opscode.com>)
 # Copyright:: Copyright (c) 2008, 2009 Opscode, Inc.
@@ -26,6 +26,8 @@ require 'chef/mixin/language_include_recipe'
 require 'chef/mixin/deprecation'
 
 class Chef
+  # == Chef::Recipe
+  # A Recipe object is the context in which Chef recipes are evaluated.
   class Recipe
     
     include Chef::Mixin::FromFile
@@ -42,6 +44,8 @@ class Chef
     # For example:
     #   "aws::elastic_ip" returns [:aws, "elastic_ip"]
     #   "aws" returns [:aws, "default"]
+    #--
+    # TODO: Duplicates functionality of RunListItem
     def self.parse_recipe_name(recipe_name)
       rmatch = recipe_name.match(/(.+?)::(.+)/)
       if rmatch
@@ -65,10 +69,10 @@ class Chef
       run_context.node
     end
     
+    # Used by the DSL to look up resources when executing in the context of a
+    # recipe.
+    #--
     # what does this do? and what is args? TODO 5-14-2010.
-    #
-    # We believe this is used by the DSL when it's executing in the
-    # context of a recipe in order to look up resources.
     def resources(*args)
       run_context.resource_collection.find(*args)
     end
@@ -83,9 +87,9 @@ class Chef
     #
     # === Returns
     # tags<Array>:: The contents of run_context.node[:tags]
-    def tag(*args)
-      if args.length > 0
-        args.each do |tag|
+    def tag(*tags)
+      if tags.length > 0
+        tags.each do |tag|
           run_context.node[:tags] << tag unless run_context.node[:tags].include?(tag)
         end
         run_context.node[:tags]
@@ -94,7 +98,7 @@ class Chef
       end
     end
     
-    # Returns true if the node is tagged with the supplied list of tags.
+    # Returns true if the node is tagged with *all* of the supplied +tags+.
     #
     # === Parameters
     # tags<Array>:: A list of tags
@@ -102,8 +106,8 @@ class Chef
     # === Returns
     # true<TrueClass>:: If all the parameters are present
     # false<FalseClass>:: If any of the parameters are missing
-    def tagged?(*args)
-      args.each do |tag|
+    def tagged?(*tags)
+      tags.each do |tag|
         return false unless run_context.node[:tags].include?(tag)
       end
       true
@@ -116,8 +120,8 @@ class Chef
     #
     # === Returns
     # tags<Array>:: The current list of run_context.node[:tags]
-    def untag(*args)
-      args.each do |tag|
+    def untag(*tags)
+      tags.each do |tag|
         run_context.node[:tags].delete(tag)
       end
     end

data/lib/chef/rest.rb

@@ -1,4 +1,4 @@
-#
+#--
 # Author:: Adam Jacob (<adam@opscode.com>)
 # Author:: Thom May (<thom@clearairturbulence.org>)
 # Author:: Nuo Yan (<nuo@opscode.com>)
@@ -30,10 +30,17 @@ require 'chef/rest/rest_request'
 require 'chef/monkey_patches/string'
 
 class Chef
+  # == Chef::REST
+  # Chef's custom REST client with built-in JSON support and RSA signed header
+  # authentication.
   class REST
     attr_reader :auth_credentials
     attr_accessor :url, :cookies, :sign_on_redirect, :redirect_limit
 
+    # Create a REST client object. The supplied +url+ is used as the base for
+    # all subsequent requests. For example, when initialized with a base url
+    # http://localhost:4000, a call to +get_rest+ with 'nodes' will make an
+    # HTTP GET request to http://localhost:4000/nodes
     def initialize(url, client_name=Chef::Config[:node_name], signing_key_filename=Chef::Config[:client_key], options={})
       @url = url
       @cookies = CookieJar.instance
@@ -90,6 +97,8 @@ class Chef
 
     # Send an HTTP GET request to the path
     #
+    # Using this method to +fetch+ a file is considered deprecated.
+    #
     # === Parameters
     # path:: The path to GET
     # raw:: Whether you want the raw body returned, or JSON inflated.  Defaults
@@ -138,6 +147,9 @@ class Chef
       auth_credentials.sign_requests? && @sign_request
     end
 
+    # ==== DEPRECATED
+    # Use +api_request+ instead
+    #--
     # Actually run an HTTP request.  First argument is the HTTP method,
     # which should be one of :GET, :PUT, :POST or :DELETE.  Next is the
     # URL, then an object to include in the body (which will be converted with
@@ -190,7 +202,7 @@ class Chef
       end
     end
 
-    # Similar to #run_request but only supports JSON APIs. File Download not supported.
+    # Runs an HTTP request to a JSON API. File Download not supported.
     def api_request(method, url, headers={}, data=false)
       json_body = data ? data.to_json : nil
       headers = build_headers(method, url, headers, json_body)
@@ -219,11 +231,11 @@ class Chef
       end
     end
 
-    # similar to #run_request but only supports streaming downloads.
-    # Only supports GET, doesn't speak JSON
+    # Makes a streaming download request. <b>Doesn't speak JSON.</b>
     # Streams the response body to a tempfile. If a block is given, it's
-    # passed to the tempfile, which means that the tempfile will automatically
+    # passed to Tempfile.open(), which means that the tempfile will automatically
     # be unlinked after the block is executed.
+    #
     # If no block is given, the tempfile is returned, which means it's up to
     # you to unlink the tempfile when you're done with it.
     def streaming_request(url, headers, &block)