chef 0.9.18 → 0.10.0.beta.0

data/lib/chef/mash.rb

@@ -0,0 +1,211 @@
+# Copyright (c) 2009 Dan Kubb
+
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# ---
+# ---
+
+# Some portions of blank.rb and mash.rb are verbatim copies of software
+# licensed under the MIT license. That license is included below:
+
+# Copyright (c) 2005-2008 David Heinemeier Hansson
+
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# This class has dubious semantics and we only have it so that people can write
+# params[:key] instead of params['key'].
+class Mash < Hash
+
+  # @param constructor<Object>
+  #   The default value for the mash. Defaults to an empty hash.
+  #
+  # @details [Alternatives]
+  #   If constructor is a Hash, a new mash will be created based on the keys of
+  #   the hash and no default value will be set.
+  def initialize(constructor = {})
+    if constructor.is_a?(Hash)
+      super()
+      update(constructor)
+    else
+      super(constructor)
+    end
+  end
+
+  # @param key<Object> The default value for the mash. Defaults to nil.
+  #
+  # @details [Alternatives]
+  #   If key is a Symbol and it is a key in the mash, then the default value will
+  #   be set to the value matching the key.
+  def default(key = nil)
+    if key.is_a?(Symbol) && include?(key = key.to_s)
+      self[key]
+    else
+      super
+    end
+  end
+
+  alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
+  alias_method :regular_update, :update unless method_defined?(:regular_update)
+
+  # @param key<Object> The key to set.
+  # @param value<Object>
+  #   The value to set the key to.
+  #
+  # @see Mash#convert_key
+  # @see Mash#convert_value
+  def []=(key, value)
+    regular_writer(convert_key(key), convert_value(value))
+  end
+
+  # @param other_hash<Hash>
+  #   A hash to update values in the mash with. The keys and the values will be
+  #   converted to Mash format.
+  #
+  # @return [Mash] The updated mash.
+  def update(other_hash)
+    other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
+    self
+  end
+
+  alias_method :merge!, :update
+
+  # @param key<Object> The key to check for. This will be run through convert_key.
+  #
+  # @return [Boolean] True if the key exists in the mash.
+  def key?(key)
+    super(convert_key(key))
+  end
+
+  # def include? def has_key? def member?
+  alias_method :include?, :key?
+  alias_method :has_key?, :key?
+  alias_method :member?, :key?
+
+  # @param key<Object> The key to fetch. This will be run through convert_key.
+  # @param *extras<Array> Default value.
+  #
+  # @return [Object] The value at key or the default value.
+  def fetch(key, *extras)
+    super(convert_key(key), *extras)
+  end
+
+  # @param *indices<Array>
+  #   The keys to retrieve values for. These will be run through +convert_key+.
+  #
+  # @return [Array] The values at each of the provided keys
+  def values_at(*indices)
+    indices.collect {|key| self[convert_key(key)]}
+  end
+
+  # @param hash<Hash> The hash to merge with the mash.
+  #
+  # @return [Mash] A new mash with the hash values merged in.
+  def merge(hash)
+    self.dup.update(hash)
+  end
+
+  # @param key<Object>
+  #   The key to delete from the mash.\
+  def delete(key)
+    super(convert_key(key))
+  end
+
+  # @param *rejected<Array[(String, Symbol)] The mash keys to exclude.
+  #
+  # @return [Mash] A new mash without the selected keys.
+  #
+  # @example
+  #   { :one => 1, :two => 2, :three => 3 }.except(:one)
+  #     #=> { "two" => 2, "three" => 3 }
+  def except(*keys)
+    super(*keys.map {|k| convert_key(k)})
+  end
+
+  # Used to provide the same interface as Hash.
+  #
+  # @return [Mash] This mash unchanged.
+  def stringify_keys!; self end
+
+  # @return [Hash] The mash as a Hash with symbolized keys.
+  def symbolize_keys
+    h = Hash.new(default)
+    each { |key, val| h[key.to_sym] = val }
+    h
+  end
+
+  # @return [Hash] The mash as a Hash with string keys.
+  def to_hash
+    Hash.new(default).merge(self)
+  end
+
+  # @return [Mash] Convert a Hash into a Mash
+  # The input Hash's default value is maintained
+  def self.from_hash(hash)
+    mash = Mash.new(hash)
+    mash.default = hash.default
+    mash
+  end
+
+  protected
+  # @param key<Object> The key to convert.
+  #
+  # @param [Object]
+  #   The converted key. If the key was a symbol, it will be converted to a
+  #   string.
+  #
+  # @api private
+  def convert_key(key)
+    key.kind_of?(Symbol) ? key.to_s : key
+  end
+
+  # @param value<Object> The value to convert.
+  #
+  # @return [Object]
+  #   The converted value. A Hash or an Array of hashes, will be converted to
+  #   their Mash equivalents.
+  #
+  # @api private
+  def convert_value(value)
+    if value.class == Hash
+      Mash.from_hash(value)
+    elsif value.is_a?(Array)
+      value.collect { |e| convert_value(e) }
+    else
+      value
+    end
+  end
+end

data/lib/chef/mixins.rb

@@ -5,7 +5,6 @@ require 'chef/mixin/command'
 require 'chef/mixin/convert_to_class_name'
 require 'chef/mixin/create_path'
 require 'chef/mixin/deep_merge'
-require 'chef/mixin/find_preferred_file'
 require 'chef/mixin/from_file'
 require 'chef/mixin/language'
 require 'chef/mixin/language_include_attribute'
@@ -13,4 +12,4 @@ require 'chef/mixin/language_include_recipe'
 require 'chef/mixin/params_validate'
 require 'chef/mixin/recipe_definition_dsl_core'
 require 'chef/mixin/template'
-require 'chef/mixin/xml_escape'
+require 'chef/mixin/xml_escape'

data/lib/chef/nil_argument.rb

@@ -0,0 +1,3 @@
+class Chef
+  NIL_ARGUMENT = Object.new
+end

data/lib/chef/node.rb

@@ -3,7 +3,7 @@
 # Author:: Christopher Brown (<cb@opscode.com>)
 # Author:: Christopher Walters (<cw@opscode.com>)
 # Author:: Tim Hinderliter (<tim@opscode.com>)
-# Copyright:: Copyright (c) 2008-2010 Opscode, Inc.
+# Copyright:: Copyright (c) 2008-2011 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,26 +21,28 @@
 
 require 'chef/config'
 require 'chef/cookbook/cookbook_collection'
+require 'chef/nil_argument'
 require 'chef/mixin/check_helper'
 require 'chef/mixin/params_validate'
 require 'chef/mixin/from_file'
 require 'chef/mixin/language_include_attribute'
 require 'chef/mixin/deep_merge'
+require 'chef/environment'
 require 'chef/couchdb'
 require 'chef/rest'
 require 'chef/run_list'
 require 'chef/node/attribute'
 require 'chef/index_queue'
-require 'extlib'
+require 'chef/mash'
 require 'chef/json_compat'
 
 class Chef
   class Node
-    
+
     attr_accessor :recipe_list, :couchdb, :couchdb_rev, :run_state, :run_list
     attr_accessor :override_attrs, :default_attrs, :normal_attrs, :automatic_attrs
     attr_reader :couchdb_id
-    
+
     # TODO: 5/18/2010 cw/timh. cookbook_collection should be removed
     # from here and for any place it's needed, it should be accessed
     # through a Chef::RunContext
@@ -53,7 +55,7 @@ class Chef
     include Chef::IndexQueue::Indexable
 
     DESIGN_DOCUMENT = {
-      "version" => 9,
+      "version" => 11,
       "language" => "javascript",
       "views" => {
         "all" => {
@@ -78,7 +80,7 @@ class Chef
           "map" => <<-EOJS
             function(doc) {
               if (doc.chef_type == "node") {
-                var to_emit = { "name": doc.name };
+                var to_emit = { "name": doc.name, "chef_environment": doc.chef_environment };
                 if (doc["attributes"]["fqdn"]) {
                   to_emit["fqdn"] = doc["attributes"]["fqdn"];
                 } else {
@@ -131,6 +133,16 @@ class Chef
               }
             }
           EOJS
+        },
+        "by_environment" => {
+          "map" => <<-EOJS
+            function(doc) {
+              if (doc.chef_type == "node") {
+                var env = (doc['chef_environment'] == null ? "_default" : doc['chef_environment']);
+                emit(env, doc.name);
+              }
+            }
+          EOJS
         }
       },
     }
@@ -138,7 +150,8 @@ class Chef
     # Create a new Chef::Node object.
     def initialize(couchdb=nil)
       @name = nil
-      
+
+      @chef_environment = '_default'
       @normal_attrs = Mash.new
       @override_attrs = Mash.new
       @default_attrs = Mash.new
@@ -163,7 +176,7 @@ class Chef
       @couchdb_id = value
       @index_id = value
     end
-    
+
     # Used by DSL
     def node
       self
@@ -173,7 +186,7 @@ class Chef
       Chef::REST.new(Chef::Config[:chef_server_url])
     end
 
-    # Find a recipe for this Chef::Node by fqdn.  Will search first for 
+    # Find a recipe for this Chef::Node by fqdn.  Will search first for
     # Chef::Config["node_path"]/fqdn.rb, then hostname.rb, then default.rb.
     #
     # Returns a new Chef::Node object.
@@ -206,11 +219,19 @@ class Chef
       end
     end
 
+    def chef_environment(arg=nil)
+      set_or_return(
+        :chef_environment,
+        arg,
+        { :regex => /^[\-[:alnum:]_]+$/, :kind_of => String }
+      )
+    end
+
     # Used by the DSL
     def attribute
       construct_attributes
     end
-    
+
     def construct_attributes
       Chef::Node::Attribute.new(normal_attrs, default_attrs, override_attrs, automatic_attrs)
     end
@@ -218,7 +239,7 @@ class Chef
     def attribute=(value)
       self.normal_attrs = value
     end
-    
+
     # Return an attribute of this node.  Returns nil if the attribute is not found.
     def [](attrib)
       construct_attributes[attrib]
@@ -235,7 +256,7 @@ class Chef
 
     # Set a normal attribute of this node, but auto-vivifiy any Mashes that
     # might be missing
-    def normal 
+    def normal
       attrs = construct_attributes
       attrs.set_type = :normal
       attrs.auto_vivifiy_on_read = true
@@ -254,10 +275,10 @@ class Chef
       attrs
     end
     alias_method :set_unless, :normal_unless
-  
+
     # Set a default of this node, but auto-vivifiy any Mashes that might
     # be missing
-    def default 
+    def default
       attrs = construct_attributes
       attrs.set_type = :default
       attrs.auto_vivifiy_on_read = true
@@ -276,7 +297,7 @@ class Chef
 
     # Set an override attribute of this node, but auto-vivifiy any Mashes that
     # might be missing
-    def override 
+    def override
       attrs = construct_attributes
       attrs.set_type = :override
       attrs.auto_vivifiy_on_read = true
@@ -330,7 +351,7 @@ class Chef
     def recipe?(recipe_name)
       run_list.include?(recipe_name) || run_state[:seen_recipes].include?(recipe_name)
     end
- 
+
     # Returns true if this Node expects a given role, false if not.
     def role?(role_name)
       run_list.include?("role[#{role_name}]")
@@ -370,7 +391,13 @@ class Chef
       normal_attrs_to_merge = consume_run_list(attrs)
       Chef::Log.debug("Applying attributes from json file")
       @normal_attrs = Chef::Mixin::DeepMerge.merge(@normal_attrs,normal_attrs_to_merge)
-      self[:tags] = Array.new unless attribute?(:tags)
+      self.tags # make sure they're defined
+    end
+
+    # Lazy initializer for tags attribute
+    def tags
+      self[:tags] = [] unless attribute?(:tags)
+      self[:tags]
     end
 
     # Extracts the run list from +attrs+ and applies it. Returns the remaining attributes
@@ -386,37 +413,44 @@ class Chef
       attrs
     end
 
-    # Clear defaults and overrides, so that any deleted attributes between runs are
-    # still gone.
+    # Clear defaults and overrides, so that any deleted attributes
+    # between runs are still gone.
     def reset_defaults_and_overrides
       @default_attrs = Mash.new
       @override_attrs = Mash.new
     end
 
-    # Expands the node's run list and deep merges the default and
-    # override attributes. Also applies stored attributes (from json provided
+    # Expands the node's run list and sets the default and override
+    # attributes. Also applies stored attributes (from json provided
     # on the command line)
     #
-    # Returns the fully-expanded list of recipes.
+    # Returns the fully-expanded list of recipes, a RunListExpansion.
     #
+    #--
     # TODO: timh/cw, 5-14-2010: Should this method exist? Should we
     # instead modify default_attrs and override_attrs whenever our
     # run_list is mutated? Or perhaps do something smarter like
     # on-demand generation of default_attrs and override_attrs,
     # invalidated only when run_list is mutated?
-    def expand!
-      # This call should only be called on a chef-client run.
-      expansion = run_list.expand('server')
+    def expand!(data_source = 'server')
+      expansion = run_list.expand(chef_environment, data_source)
       raise Chef::Exceptions::MissingRole if expansion.errors?
 
-      self[:tags] = Array.new unless attribute?(:tags)
-      @default_attrs = Chef::Mixin::DeepMerge.merge(default_attrs, expansion.default_attrs)
-      @override_attrs = Chef::Mixin::DeepMerge.merge(override_attrs, expansion.override_attrs)
+      self.tags # make sure they're defined
 
       @automatic_attrs[:recipes] = expansion.recipes
       @automatic_attrs[:roles] = expansion.roles
 
-      expansion.recipes
+      expansion
+    end
+
+    # Apply the default and overrides attributes from the expansion
+    # passed in, which came from roles.
+    def apply_expansion_attributes(expansion)
+      @default_attrs = Chef::Mixin::DeepMerge.merge(default_attrs, expansion.default_attrs)
+      environment_attrs = chef_environment == "_default" ? {} : Chef::Environment.load(chef_environment).attributes
+      overrides_before_environments = Chef::Mixin::DeepMerge.merge(override_attrs, expansion.override_attrs)
+      @override_attrs = Chef::Mixin::DeepMerge.merge(overrides_before_environments, environment_attrs)
     end
 
     # Transform the node to a Hash
@@ -424,6 +458,7 @@ class Chef
       index_hash = Hash.new
       index_hash["chef_type"] = "node"
       index_hash["name"] = name
+      index_hash["chef_environment"] = chef_environment
       attribute.each do |key, value|
         index_hash[key] = value
       end
@@ -437,6 +472,7 @@ class Chef
     def to_json(*a)
       result = {
         "name" => name,
+        "chef_environment" => chef_environment,
         'json_class' => self.class.name,
         "automatic" => automatic_attrs,
         "normal" => normal_attrs,
@@ -449,11 +485,21 @@ class Chef
       result.to_json(*a)
     end
 
+    def update_from!(o)
+      run_list.reset!(o.run_list)
+      @automatic_attrs = o.automatic_attrs
+      @normal_attrs = o.normal_attrs
+      @override_attrs = o.override_attrs
+      @default_attrs = o.default_attrs
+      chef_environment(o.chef_environment)
+      self
+    end
+
     # Create a Chef::Node from JSON
     def self.json_create(o)
       node = new
       node.name(o["name"])
-
+      node.chef_environment(o["chef_environment"])
       if o.has_key?("attributes")
         node.normal_attrs = o["attributes"]
       end
@@ -473,6 +519,21 @@ class Chef
       node
     end
 
+    def self.cdb_list_by_environment(environment, inflate=false, couchdb=nil)
+      rs = (couchdb || Chef::CouchDB.new).get_view("nodes", "by_environment", :include_docs => inflate, :startkey => environment, :endkey => environment)
+      inflate ? rs["rows"].collect {|r| r["doc"]} : rs["rows"].collect {|r| r["value"]}
+    end
+
+    def self.list_by_environment(environment, inflate=false)
+      if inflate
+        response = Hash.new
+        Chef::Search::Query.new.search(:node, "chef_environment:#{environment}") {|n| response[n.name] = n unless n.nil?}
+        response
+      else
+        Chef::REST.new(Chef::Config[:chef_server_url]).get_rest("environments/#{environment}/nodes")
+      end
+    end
+
     # List all the Chef::Node objects in the CouchDB.  If inflate is set to true, you will get
     # the full list of all Nodes, fully inflated.
     def self.cdb_list(inflate=false, couchdb=nil)
@@ -517,6 +578,7 @@ class Chef
     def self.build(node_name)
       node = new
       node.name(node_name)
+      node.chef_environment(Chef::Config[:environment]) unless Chef::Config[:environment].nil? || Chef::Config[:environment].chop.empty?
       node
     end
 
@@ -563,11 +625,11 @@ class Chef
     def self.create_design_document(couchdb=nil)
       (couchdb || Chef::CouchDB.new).create_design_document("nodes", DESIGN_DOCUMENT)
     end
-    
+
     def to_s
       "node[#{name}]"
     end
-    
+
     # Load all attribute files for all cookbooks associated with this
     # node.
     def load_attributes
@@ -578,7 +640,7 @@ class Chef
         end
       end
     end
-    
+
     # Used by DSL.
     # Loads the attribute file specified by the short name of the
     # file, e.g., loads specified cookbook's
@@ -588,7 +650,7 @@ class Chef
     def load_attribute_by_short_filename(name, src_cookbook_name)
       src_cookbook = cookbook_collection[src_cookbook_name]
       raise Chef::Exceptions::CookbookNotFound, "could not find cookbook #{src_cookbook_name} while loading attribute #{name}" unless src_cookbook
-      
+
       attribute_filename = src_cookbook.attribute_filenames_by_short_filename[name]
       raise Chef::Exceptions::AttributeNotFound, "could not find filename for attribute #{name} in cookbook #{src_cookbook_name}" unless attribute_filename