run list expansion with env for env-agnostic run lists; tests

* add tests for multiply nested roles with env specific run lists
* fix env-aware run list expansion to not depend on run lists being
  aware of their environment affiliation.

Author: danielsdeleo

chef/lib/chef/node.rb

@@ -419,15 +419,15 @@ def reset_defaults_and_overrides
     # on the command line)
     #
     # Returns the fully-expanded list of recipes.
-    #
+    #--
     # 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')
+      # This call should only be called on a chef-client run if you're going to save it later
+      expansion = run_list.expand('server', :environment => chef_environment)
       raise Chef::Exceptions::MissingRole if expansion.errors?
 
       self[:tags] = Array.new unless attribute?(:tags)

chef/lib/chef/role.rb

@@ -115,8 +115,8 @@ def run_list(*args)
     alias_method :recipes, :run_list
 
     # For run_list expansion
-    def run_list_for_environment(environment='_default')
-      if env_run_lists[environment].nil? || env_run_lists[environment].empty?
+    def run_list_for(environment='_default')
+      if env_run_lists[environment].nil?
         run_list
       else
         env_run_lists[environment]
@@ -127,18 +127,13 @@ def run_list_for_environment(environment='_default')
     def env_run_lists(env_run_lists=nil)
       if (!env_run_lists.nil? && !env_run_lists.empty?)
         @env_run_lists.clear
-        env_run_lists.each do |k,v|
-          @env_run_lists[k] = Chef::RunList.new(*Array(v)) unless v.nil?
-        end
+        env_run_lists.each { |k,v| @env_run_lists[k] = Chef::RunList.new(*Array(v))}
         @env_run_lists["_default"] = run_list
       end
       @env_run_lists
     end
 
-#     def recipes(*args)
-#       Chef::Log.warn "Chef::Role#recipes method is deprecated.  Please use Chef::Role#run_list"
-#       run_list(*args)
-#     end
+    alias :env_run_list :env_run_lists
 
     def default_attributes(arg=nil)
       set_or_return(

chef/lib/chef/run_list.rb

@@ -130,11 +130,11 @@ def remove(item)
     alias :delete :remove
 
 
-    def expand(data_source='server', couchdb=nil, rest=nil)
+    def expand(data_source='server', expansion_opts={})
       couchdb = couchdb ? couchdb : Chef::CouchDB.new
 
-      expansion = expansion_for_data_source(data_source, :couchdb => couchdb, :rest => rest)
-      expansion.expand(@chef_environment)
+      expansion = expansion_for_data_source(data_source, expansion_opts)
+      expansion.expand(expansion_opts[:environment])
       expansion
     end
 

chef/lib/chef/run_list/run_list_expansion.rb

@@ -75,7 +75,7 @@ def expand(environment='_default')
           when :role
             if role = inflate_role(entry.name)
               apply_role_attributes(role)
-              @run_list_items.insert(index + 1, *role.run_list_for_environment(environment).run_list_items)
+              @run_list_items.insert(index + 1, *role.run_list_for(environment).run_list_items)
             end
           end
         end

chef/spec/unit/role_spec.rb

@@ -202,12 +202,30 @@
     before do
       @role.name("base")
       @role.run_list << "recipe[nagios::client]" << "recipe[tims-acl::bork]"
+      @role.env_run_list["prod"] = Chef::RunList.new(*(@role.run_list.to_a << "recipe[prod-base]"))
+      @role.env_run_list["dev"]  = Chef::RunList.new
     end
 
-    it "returns the default run list when no environment is selected" do
+    it "uses the default run list as *the* run_list" do
       @role.run_list.should == Chef::RunList.new("recipe[nagios::client]", "recipe[tims-acl::bork]")
     end
 
+    it "gives the default run list as the when getting the _default run list" do
+      @role.run_list_for("_default").should == @role.run_list
+    end
+
+    it "gives an environment specific run list" do
+      @role.run_list_for("prod").should == Chef::RunList.new("recipe[nagios::client]", "recipe[tims-acl::bork]", "recipe[prod-base]")
+    end
+
+    it "gives the default run list when no run list exists for the given environment" do
+      @role.run_list_for("qa").should == @role.run_list
+    end
+
+    it "gives the environment specific run list even if it is empty" do
+      @role.run_list_for("dev").should == Chef::RunList.new
+    end
+
   end
 
 end

chef/spec/unit/run_list_spec.rb

@@ -188,6 +188,47 @@
         @rest.should_receive(:get_rest).with("roles/stubby")
         @run_list.expand
       end
+
+      describe "with an environment set" do
+        before do
+          @role.env_run_list["production"] = Chef::RunList.new( "one", "two", "five")
+        end
+
+        it "expands the run list using the environment specific run list" do
+          expansion = @run_list.expand("server", :environment => "production")
+          expansion.recipes.should == %w{one two five kitty}
+        end
+
+        describe "and multiply nested roles" do
+          before do
+            @multiple_rest_requests = mock("Chef::REST")
+
+            @role.env_run_list["production"] << "role[prod-base]"
+
+            @role_prod_base = Chef::Role.new
+            @role_prod_base.name("prod-base")
+            @role_prod_base.env_run_list["production"] = Chef::RunList.new("role[nested-deeper]")
+
+
+            @role_nested_deeper = Chef::Role.new
+            @role_nested_deeper.name("nested-deeper")
+            @role_nested_deeper.env_run_list["production"] = Chef::RunList.new("recipe[prod-secret-sauce]")
+          end
+
+          it "expands the run list using the specified environment for all nested roles" do
+            Chef::REST.stub!(:new).and_return(@multiple_rest_requests)
+            @multiple_rest_requests.should_receive(:get_rest).with("roles/stubby").and_return(@role)
+            @multiple_rest_requests.should_receive(:get_rest).with("roles/prod-base").and_return(@role_prod_base)
+            @multiple_rest_requests.should_receive(:get_rest).with("roles/nested-deeper").and_return(@role_nested_deeper)
+
+            expansion = @run_list.expand("server", :environment => "production")
+            expansion.recipes.should == %w{one two five prod-secret-sauce kitty}
+          end
+
+        end
+
+      end
+
     end
 
     describe "from couchdb" do