environment from file w/ cookbook version dsl

Author: sdelano

chef/lib/chef/environment.rb

@@ -24,6 +24,7 @@ class Chef
   class Environment
 
     include Chef::Mixin::ParamsValidate
+    include Chef::Mixin::FromFile
 
     attr_accessor :couchdb, :couchdb_rev
     attr_reader :couchdb_id
@@ -103,6 +104,17 @@ def cookbook_versions(arg=nil)
       )
     end
 
+    def cookbook(cookbook, version)
+      validate({
+        :version => version
+      },{
+        :version => {
+          :callbacks => { "should be a valid version number" => lambda { |v| Chef::Environment.validate_cookbook_version(v) } }
+        }
+      })
+      @cookbook_versions[cookbook] = version
+    end
+
     def to_hash
       result = {
         "name" => @name,
@@ -199,9 +211,14 @@ def to_s
     def self.validate_cookbook_versions(cv)
       return false unless cv.kind_of?(Hash)
       cv.each do |cookbook, version|
-        return false unless version.kind_of?(String)
+        return false unless Chef::Environment.validate_cookbook_version(version)
       end
       true
     end
+
+    def self.validate_cookbook_version(version)
+      # TODO: check if version syntax is like rubygems syntax
+      version.kind_of?(String)
+    end
   end
 end

chef/lib/chef/knife/environment_from_file.rb

@@ -0,0 +1,39 @@
+#
+# 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 Knife
+    class EnvironmentFromFile < Knife
+
+      banner "knife environment from file FILE (options)"
+
+      def run
+        if @name_args[0].nil?
+          show_usage
+          Chef::Log.fatal("You must specify a file to load")
+          exit 1
+        end
+
+        updated = load_from_file(Chef::Environment, @name_args[0])
+        updated.save
+        output(format_for_display(updated)) if config[:print_after]
+        Chef::Log.warn("Updated Environment #{updated.name}!")
+      end
+    end
+  end
+end

chef/spec/unit/environment_spec.rb

@@ -98,6 +98,18 @@
     end
   end
 
+  describe "cookbook" do
+    it "should set the version of the cookbook in the cookbook_versions hash" do
+      @environment.cookbook("apt", "1.2.3")
+      @environment.cookbook_versions["apt"].should == "1.2.3"
+    end
+
+    it "should validate the cookbook version it is passed" do
+      Chef::Environment.should_receive(:validate_cookbook_version).with("1.2.3").and_return true
+      @environment.cookbook("apt", "1.2.3")
+    end
+  end
+
   describe "to_hash" do
     before(:each) do
       @environment.name("spec")
@@ -180,22 +192,31 @@
       }
     end
 
-    it "should return true when all versions are strings" do
-      Chef::Environment.validate_cookbook_versions(@cookbook_versions).should == true
+    it "should validate the version string of each cookbook" do
+      @cookbook_versions.each do |cookbook, version|
+        Chef::Environment.should_receive(:validate_cookbook_version).with(version).and_return true
+      end
+      Chef::Environment.validate_cookbook_versions(@cookbook_versions)
     end
 
-    it "should return false when anything other than a string is passed as a version" do
-      a = @cookbook_versions.dup.merge :number => 2
-      Chef::Environment.validate_cookbook_versions(a).should == false
-
-      b = @cookbook_versions.dup.merge :hash => {:foo => 'bar'}
-      Chef::Environment.validate_cookbook_versions(b).should == false
+    it "should return false if anything other than a hash is passed as the argument" do
+      Chef::Environment.validate_cookbook_versions(Array.new).should == false
+      Chef::Environment.validate_cookbook_versions(42).should == false
+      Chef::Environment.validate_cookbook_versions(Chef::CookbookVersion.new("meta")).should == false
+      Chef::Environment.validate_cookbook_versions("cookbook => 1.2.3").should == false
+    end
+  end
 
-      c = @cookbook_versions.dup.merge :array => ['this', 'is', 'a', 'bad', 'version']
-      Chef::Environment.validate_cookbook_versions(c).should == false
+  describe "self.validate_cookbook_version" do
+    it "should return true when the value is a string" do
+      Chef::Environment.validate_cookbook_version("1.2.3").should == true
+    end
 
-      d = @cookbook_versions.dup.merge :cookbook_versions => Chef::CookbookVersion.new("meta")
-      Chef::Environment.validate_cookbook_versions(d).should == false
+    it "should return false when anything other than a string is passed as a version" do
+      Chef::Environment.validate_cookbook_version(42).should == false
+      Chef::Environment.validate_cookbook_version(Hash.new).should == false
+      Chef::Environment.validate_cookbook_version(Array.new).should == false
+      Chef::Environment.validate_cookbook_version(Chef::CookbookVersion.new("meta")).should == false
     end
   end
 end

chef/spec/unit/knife/environment_from_file_spec.rb

@@ -0,0 +1,67 @@
+#
+# Author:: Stephen Delano (<stephen@ospcode.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.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+
+describe Chef::Knife::EnvironmentFromFile do
+  before(:each) do
+    @knife = Chef::Knife::EnvironmentFromFile.new
+    @knife.stub!(:msg).and_return true
+    @knife.stub!(:output).and_return true
+    @knife.stub!(:show_usage).and_return true
+    @knife.name_args = [ "spec.rb" ]
+
+    @environment = Chef::Environment.new
+    @environment.name("spec")
+    @environment.description("runs the unit tests")
+    @environment.cookbook_versions({"apt" => "1.2.3"})
+    @environment.stub!(:save).and_return true
+    @knife.stub!(:load_from_file).and_return @environment
+  end
+
+  describe "run" do
+    it "should load from a file" do
+      @knife.should_receive(:load_from_file)
+      @knife.run
+    end
+
+    it "should save the environment" do
+      @environment.should_receive(:save)
+      @knife.run
+    end
+
+    it "should not print the environment" do
+      @knife.should_not_receive(:output)
+      @knife.run
+    end
+
+    it "should show usage and exit if not filename is provided" do
+      @knife.name_args = []
+      @knife.should_receive(:show_usage)
+      lambda { @knife.run }.should raise_error(SystemExit)
+    end
+
+    describe "with --print-after" do
+      it "should pretty print the environment, formatted for display" do
+        @knife.config[:print_after] = true
+        @knife.should_receive(:output)
+        @knife.run
+      end
+    end
+  end
+end