check for version conflicts in run_list expansion

Author: sdelano

chef/lib/chef/exceptions.rb

@@ -62,5 +62,8 @@ class ResourceNotFound < RuntimeError; end
     class InvalidResourceSpecification < ArgumentError; end
     class SolrConnectionError < RuntimeError; end
     class IllegalChecksumRevert < RuntimeError; end
+    class RecipeVersionConflict < StandardError; end
+    class CookbookVersionConflict < StandardError; end
+    class CookbookVersionNameMismatch < ArgumentError; end
   end
 end

chef/lib/chef/run_list.rb

@@ -20,6 +20,7 @@
 
 require 'chef/run_list/run_list_item'
 require 'chef/run_list/run_list_expansion'
+require 'chef/run_list/versioned_recipe_list'
 require 'chef/mixin/params_validate'
 
 class Chef

chef/lib/chef/run_list/run_list_expansion.rb

@@ -53,7 +53,7 @@ def initialize(run_list_items, source=nil)
         @default_attrs = Mash.new
         @override_attrs = Mash.new
 
-        @recipes = []
+        @recipes = Chef::RunList::VersionedRecipeList.new
 
         @applied_roles = {}
       end
@@ -71,7 +71,7 @@ def expand(environment='_default')
         @run_list_items.each_with_index do |entry, index|
           case entry.type
           when :recipe
-            recipes << entry.name unless recipes.include?(entry.name)
+            recipes.add_recipe entry.name, entry.version
           when :role
             if role = inflate_role(entry.name)
               apply_role_attributes(role)

chef/lib/chef/run_list/versioned_recipe_list.rb

@@ -0,0 +1,42 @@
+#
+# Author:: Stephen Delano (<stephen@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.
+
+class Chef
+  class RunList
+    class VersionedRecipeList < Array
+
+      def initialize
+        super
+        @versions = Hash.new
+      end
+
+      def add_recipe(name, version=nil)
+        if version && @versions.has_key?(name)
+          unless Gem::Version.new(@versions[name]) == Gem::Version.new(version)
+            raise Chef::Exceptions::RecipeVersionConflict, "Run list requires recipe #{name} at versions #{@versions[name]} and #{version}"
+          end
+        end
+        @versions[name] = version if version
+        self << name unless self.include?(name)
+      end
+
+      def with_versions
+        self.map {|i| {:name => i, :version => @versions[i]}}
+      end
+    end
+  end
+end

chef/spec/unit/run_list/versioned_recipe_list_spec.rb

@@ -0,0 +1,99 @@
+#
+# Author:: Stephen Delano (<stephen@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 File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Chef::RunList::VersionedRecipeList do
+
+  describe "initialize" do
+    it "should create an empty array" do
+      l = Chef::RunList::VersionedRecipeList.new
+      l.should == []
+    end
+  end
+
+  describe "add_recipe" do
+    before(:each) do
+      @list = Chef::RunList::VersionedRecipeList.new
+      @list << "apt"
+      @list << "god"
+      @list << "apache2"
+    end
+
+    it "should append the recipe to the end of the list" do
+      @list.add_recipe "rails"
+      @list.should == ["apt", "god", "apache2", "rails"]
+    end
+
+    it "should not duplicate entries" do
+      @list.add_recipe "apt"
+      @list.should == ["apt", "god", "apache2"]
+    end
+
+    it "should allow you to specify a version" do
+      @list.add_recipe "rails", "1.0.0"
+      @list.should == ["apt", "god", "apache2", "rails"]
+      @list.with_versions.should include({:name => "rails", :version => "1.0.0"})
+    end
+
+    it "should allow you to specify a version for a recipe that already exists" do
+      @list.add_recipe "apt", "1.2.3"
+      @list.should == ["apt", "god", "apache2"]
+      @list.with_versions.should include({:name => "apt", :version => "1.2.3"})
+    end
+
+    it "should allow you to specify the same version of a recipe twice" do
+      @list.add_recipe "rails", "1.0.0"
+      @list.add_recipe "rails", "1.0.0"
+      @list.with_versions.should include({:name => "rails", :version => "1.0.0"})
+    end
+
+    it "should allow you to spcify no version, even when a version already exists" do
+      @list.add_recipe "rails", "1.0.0"
+      @list.add_recipe "rails"
+      @list.with_versions.should include({:name => "rails", :version => "1.0.0"})
+    end
+
+    it "should not allow multiple versions of the same recipe" do
+      @list.add_recipe "rails", "1.0.0"
+      lambda {@list.add_recipe "rails", "0.1.0"}.should raise_error Chef::Exceptions::RecipeVersionConflict
+    end
+  end
+
+  describe "with_versions" do
+    before(:each) do
+      @recipes = [
+        {:name => "apt", :version => "1.0.0"},
+        {:name => "god", :version => nil},
+        {:name => "apache2", :version => "0.0.1"}
+      ]
+      @list = Chef::RunList::VersionedRecipeList.new
+      @recipes.each {|i| @list.add_recipe i[:name], i[:version]}
+    end
+
+    it "should return an array of hashes with :name and :version" do
+      @list.with_versions.should == @recipes
+    end
+
+    it "should retain the same order as the version-less list" do
+      with_versions = @list.with_versions
+      @list.each_with_index do |item, index|
+        with_versions[index][:name].should == item
+      end
+    end
+  end
+end