chef 10.12.0 → 10.14.0.beta.1

data/spec/unit/resource_definition_spec.rb

@@ -0,0 +1,119 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 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 'spec_helper'
+
+describe Chef::ResourceDefinition do
+  before(:each) do
+    @def = Chef::ResourceDefinition.new()
+  end
+  
+  describe "initialize" do
+    it "should be a Chef::ResourceDefinition" do
+      @def.should be_a_kind_of(Chef::ResourceDefinition)
+    end
+    
+    it "should not initialize a new node if one is not provided" do
+      @def.node.should eql(nil)
+    end
+    
+    it "should accept a node as an argument" do
+      node = Chef::Node.new
+      node.name("bobo")
+      @def = Chef::ResourceDefinition.new(node)
+      @def.node.name.should == "bobo"
+    end
+  end
+  
+  describe "node" do
+    it "should set the node with node=" do
+      node = Chef::Node.new
+      node.name("bobo")
+      @def.node = node
+      @def.node.name.should == "bobo"
+    end
+    
+    it "should return the node" do
+      @def.node = Chef::Node.new
+      @def.node.should be_a_kind_of(Chef::Node)
+    end
+  end
+  
+  it "should accept a new definition with a symbol for a name" do
+    lambda { 
+      @def.define :smoke do 
+      end
+    }.should_not raise_error(ArgumentError)
+    lambda { 
+      @def.define "george washington" do
+      end 
+    }.should raise_error(ArgumentError)
+    @def.name.should eql(:smoke)
+  end
+  
+  it "should accept a new definition with a hash" do
+    lambda { 
+      @def.define :smoke, :cigar => "cuban", :cigarette => "marlboro" do
+      end
+    }.should_not raise_error(ArgumentError)
+  end
+  
+  it "should expose the prototype hash params in the params hash" do
+    @def.define :smoke, :cigar => "cuban", :cigarette => "marlboro" do; end
+    @def.params[:cigar].should eql("cuban")
+    @def.params[:cigarette].should eql("marlboro")
+  end
+
+  it "should store the block passed to define as a proc under recipe" do
+    @def.define :smoke do
+      "I am what I am"
+    end
+    @def.recipe.should be_a_kind_of(Proc)
+    @def.recipe.call.should eql("I am what I am")
+  end
+  
+  it "should set paramaters based on method_missing" do
+    @def.mind "to fly"
+    @def.params[:mind].should eql("to fly")
+  end
+  
+  it "should raise an exception if prototype_params is not a hash" do
+    lambda {
+      @def.define :monkey, Array.new do
+      end
+    }.should raise_error(ArgumentError)
+  end
+  
+  it "should raise an exception if define is called without a block" do
+    lambda { 
+      @def.define :monkey
+    }.should raise_error(ArgumentError)
+  end
+  
+  it "should load a description from a file" do
+    @def.from_file(File.join(CHEF_SPEC_DATA, "definitions", "test.rb"))
+    @def.name.should eql(:rico_suave)
+    @def.params[:rich].should eql("smooth")
+  end  
+  
+  it "should turn itself into a string based on the name with to_s" do
+    @def.name = :woot
+    @def.to_s.should eql("woot")
+  end
+  
+end

data/spec/unit/resource_platform_map_spec.rb

@@ -0,0 +1,164 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2011 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 'spec_helper'
+
+describe Chef::Resource::PlatformMap do
+
+  before(:each) do
+    @platform_map = Chef::Resource::PlatformMap.new({
+      :windows => {
+        "6.1" => {
+          :file => "softiefile",
+          :else => "thing"
+        },
+        :default => {
+          :file => Chef::Resource::File,
+          :ping => "pong",
+          :cat => "nice"
+        }
+      },
+      :pop_tron => {
+      },
+      :default => {
+        :soundwave => "lazerbeak",
+        :directory => Chef::Resource::Directory,
+      }
+    })
+  end
+
+  describe 'filtering the map' do
+    it "returns resources for platform and version" do
+      pmap = @platform_map.filter("Windows", "6.1")
+      pmap.should be_a_kind_of(Hash)
+      pmap[:file].should eql("softiefile")
+    end
+
+    it "returns platform default resources if version does not exist" do
+      pmap = @platform_map.filter("windows", "1")
+      pmap.should be_a_kind_of(Hash)
+      pmap[:file].should eql(Chef::Resource::File)
+    end
+
+    it "returns global default resources if none exist for plaform" do
+      pmap = @platform_map.filter("pop_tron", "1")
+      pmap.should be_a_kind_of(Hash)
+      pmap[:directory].should eql(Chef::Resource::Directory)
+    end
+
+    it "returns global default resources if platform does not exist" do
+      pmap = @platform_map.filter("BeOS", "1")
+      pmap.should be_a_kind_of(Hash)
+      pmap[:soundwave].should eql("lazerbeak")
+    end
+
+    it "returns a merged map of platform version and plaform default resources" do
+      pmap = @platform_map.filter("Windows", "6.1")
+      pmap[:file].should eql("softiefile")
+      pmap[:ping].should eql("pong")
+    end
+
+    it "returns a merged map of platform specific version and global defaults" do
+      pmap = @platform_map.filter("Windows", "6.1")
+      pmap[:file].should eql("softiefile")
+      pmap[:soundwave].should eql("lazerbeak")
+    end
+  end
+
+  describe 'finding a resource' do
+    it "returns a resource for a platform directly by short name" do
+      @platform_map.get(:file, "windows", "6.1").should eql("softiefile")
+    end
+
+    it "returns a default resource if platform and version don't exist" do
+      @platform_map.get(:remote_file).should eql(Chef::Resource::RemoteFile)
+    end
+
+    it "raises an exception if a resource cannot be found" do
+      lambda { @platform_map.get(:coffee, "windows", "6.1")}.should raise_error(NameError)
+    end
+
+    it "returns a resource with a Chef::Resource object" do
+      kitty = Chef::Resource::Cat.new("loulou")
+      @platform_map.get(kitty, "windows", "6.1").should eql("nice")
+    end
+  end
+
+  describe 'building the map' do
+    it "allows passing of a resource map at creation time" do
+      @new_map = Chef::Resource::PlatformMap.new({:the_dude => {:default => 'abides'}})
+      @new_map.map[:the_dude][:default].should eql("abides")
+    end
+
+    it "defaults to a resource map with :default key" do
+      @new_map = Chef::Resource::PlatformMap.new
+      @new_map.map.has_key?(:default)
+    end
+
+    it "updates the resource map with a map" do
+      @platform_map.set(
+       :platform => :darwin,
+       :version => "9.2.2",
+       :short_name => :file,
+       :resource => "masterful"
+      )
+      @platform_map.map[:darwin]["9.2.2"][:file].should eql("masterful")
+
+      @platform_map.set(
+       :platform => :darwin,
+       :short_name => :file,
+       :resource => "masterful"
+      )
+      @platform_map.map[:darwin][:default][:file].should eql("masterful")
+
+      @platform_map.set(
+       :short_name => :file,
+       :resource => "masterful"
+      )
+      @platform_map.map[:default][:file].should eql("masterful")
+
+      @platform_map.set(
+       :platform => :hero,
+       :version => "9.2.2",
+       :short_name => :file,
+       :resource => "masterful"
+      )
+      @platform_map.map[:hero]["9.2.2"][:file].should eql("masterful")
+
+      @platform_map.set(
+        :short_name => :file,
+        :resource => "masterful"
+      )
+      @platform_map.map[:default][:file].should eql("masterful")
+
+      @platform_map.set(
+       :short_name => :file,
+       :resource => "masterful"
+      )
+      @platform_map.map[:default][:file].should eql("masterful")
+
+      @platform_map.set(
+        :platform => :neurosis,
+        :short_name => :package,
+        :resource => "masterful"
+      )
+      @platform_map.map[:neurosis][:default][:package].should eql("masterful")
+    end
+  end
+
+end

data/spec/unit/resource_reporter_spec.rb

@@ -0,0 +1,425 @@
+#
+# Author:: Daniel DeLeo (<dan@opscode.com>)
+# Author:: Prajakta Purohit (prajakta@opscode.com>)
+#
+# Copyright:: Copyright (c) 2012 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("../../spec_helper", __FILE__)
+require 'chef/resource_reporter'
+
+describe Chef::ResourceReporter do
+
+  before do
+    @rest_client = mock("Chef::REST (mock)")
+    @resource_reporter = Chef::ResourceReporter.new(@rest_client)
+    @new_resource      = Chef::Resource::File.new("/tmp/a-file.txt")
+    @new_resource.cookbook_name = "monkey"
+    @cookbook_version = mock("Cookbook::Version", :version => "1.2.3")
+    @new_resource.stub!(:cookbook_version).and_return(@cookbook_version)
+    @current_resource  = Chef::Resource::File.new("/tmp/a-file.txt")
+  end
+
+  context "when first created" do
+
+    it "has no updated resources" do
+      @resource_reporter.should have(0).updated_resources
+    end
+
+    it "reports a successful run" do
+      @resource_reporter.status.should == "success"
+    end
+
+    it "assumes the resource history feature is supported" do
+      @resource_reporter.reporting_enabled?.should be_true
+    end
+
+  end
+
+  context "after the chef run completes" do
+    before do
+    end
+
+    it "reports a successful run" do
+      pending "refactor how node gets set."
+      @resource_reporter.status.should == "success"
+    end
+  end
+
+  context "when chef fails before converging any resources" do
+    before do
+      @exception = Exception.new
+      @resource_reporter.run_failed(@exception)
+    end
+
+    it "sets the run status to 'failed'" do
+      @resource_reporter.status.should == "failed"
+    end
+
+    it "keeps the exception data" do
+      @resource_reporter.exception.should == @exception
+    end
+
+  end
+
+  context "when a resource fails before loading current state" do
+    before do
+      @exception = Exception.new
+      @resource_reporter.resource_action_start(@new_resource, :create)
+      @resource_reporter.resource_failed(@new_resource, :create, @exception)
+    end
+
+    it "collects the resource as an updated resource" do
+      @resource_reporter.should have(1).updated_resources
+    end
+
+    it "collects the desired state of the resource" do
+      update_record = @resource_reporter.updated_resources.first
+      update_record.new_resource.should == @new_resource
+    end
+
+  end
+
+  # TODO: make sure a resource that is skipped because of `not_if` doesn't
+  # leave us in a bad state.
+
+  context "once the a resource's current state is loaded" do
+    before do
+      @resource_reporter.resource_action_start(@new_resource, :create)
+      @resource_reporter.resource_current_state_loaded(@new_resource, :create, @current_resource)
+    end
+
+    context "and the resource was not updated" do
+      before do
+        @resource_reporter.resource_up_to_date(@new_resource, :create)
+      end
+
+      it "has no updated resources" do
+        @resource_reporter.should have(0).updated_resources
+      end
+    end
+
+    context "and the resource was updated" do
+      before do
+        @new_resource.content("this is the old content")
+        @current_resource.content("this is the new hotness")
+        @resource_reporter.resource_updated(@new_resource, :create)
+      end
+
+      it "collects the updated resource" do
+        @resource_reporter.should have(1).updated_resources
+      end
+
+      it "collects the old state of the resource" do
+        update_record = @resource_reporter.updated_resources.first
+
+        update_record.current_resource.should == @current_resource
+      end
+
+      it "collects the new state of the resource" do
+        update_record = @resource_reporter.updated_resources.first
+
+        update_record.new_resource.should == @new_resource
+      end
+
+      context "and a subsequent resource fails before loading current resource" do
+        before do
+          @next_new_resource = Chef::Resource::Service.new("apache2")
+          @exception = Exception.new
+          @resource_reporter.resource_failed(@next_new_resource, :create, @exception)
+        end
+
+        it "collects the desired state of the failed resource" do
+          failed_resource_update = @resource_reporter.updated_resources.last
+          failed_resource_update.new_resource.should == @next_new_resource
+        end
+
+        it "does not have the current state of the failed resource" do
+          failed_resource_update = @resource_reporter.updated_resources.last
+          failed_resource_update.current_resource.should be_nil
+        end
+      end
+    end
+
+    # Some providers, such as RemoteDirectory and some LWRPs use other
+    # resources for their implementation. These should be hidden from reporting
+    # since we only care about the top-level resource and not the sub-resources
+    # used for implementation.
+    context "and a nested resource is updated" do
+      before do
+        @implementation_resource = Chef::Resource::CookbookFile.new("/preseed-file.txt")
+        @resource_reporter.resource_action_start(@implementation_resource , :create)
+        @resource_reporter.resource_current_state_loaded(@implementation_resource, :create, @implementation_resource)
+        @resource_reporter.resource_updated(@implementation_resource, :create)
+        @resource_reporter.resource_updated(@new_resource, :create)
+      end
+
+      it "does not collect data about the nested resource" do
+        @resource_reporter.should have(1).updated_resources
+      end
+    end
+
+    context "and a nested resource runs but is not updated" do
+      before do
+        @implementation_resource = Chef::Resource::CookbookFile.new("/preseed-file.txt")
+        @resource_reporter.resource_action_start(@implementation_resource , :create)
+        @resource_reporter.resource_current_state_loaded(@implementation_resource, :create, @implementation_resource)
+        @resource_reporter.resource_up_to_date(@implementation_resource, :create)
+        @resource_reporter.resource_updated(@new_resource, :create)
+      end
+
+      it "does not collect data about the nested resource" do
+        @resource_reporter.should have(1).updated_resources
+      end
+    end
+
+    context "and the resource failed to converge" do
+      before do
+        @exception = Exception.new
+        @resource_reporter.resource_failed(@new_resource, :create, @exception)
+      end
+
+      it "collects the resource as an updated resource" do
+        @resource_reporter.should have(1).updated_resources
+      end
+
+      it "collects the desired state of the resource" do
+        update_record = @resource_reporter.updated_resources.first
+        update_record.new_resource.should == @new_resource
+      end
+
+      it "collects the current state of the resource" do
+        update_record = @resource_reporter.updated_resources.first
+        update_record.current_resource.should == @current_resource
+      end
+    end
+
+  end
+
+  describe "when generating a report for the server" do
+
+    context "for a successful client run" do
+      before do
+        # TODO: add inputs to generate expected output.
+
+        # expected_data = {
+        #    "action" : "end",
+        #    "resources" : [
+        #       {
+        #         "type" : "file",
+        #         "id" : "/etc/passwd",
+        #         "name" : "User Defined Resource Block Name",
+        #         "duration" : "1200",
+        #         "result" : "modified",
+        #         "before" : {
+        #              "state" : "exists",
+        #              "group" : "root",
+        #              "owner" : "root",
+        #              "checksum" : "xyz"
+        #         },
+        #         "after" : {
+        #              "state" : "modified",
+        #              "group" : "root",
+        #              "owner" : "root",
+        #              "checksum" : "abc"
+        #         },
+        #         "delta" : ""
+        #      },
+        #      {...}
+        #     ],
+        #    "status" : "success"
+        #    "data" : ""
+        # }
+
+        @node = Chef::Node.new
+        @node.name("spitfire")
+        @resource_reporter.resource_action_start(@new_resource, :create)
+        @resource_reporter.resource_current_state_loaded(@new_resource, :create, @current_resource)
+        @resource_reporter.resource_updated(@new_resource, :create)
+        @report = @resource_reporter.report(@node)
+        @first_update_report = @report["resources"].first
+      end
+
+      it "includes the run's status" do
+        @report.should have_key("status")
+      end
+
+      it "includes a list of updated resources" do
+        @report.should have_key("resources")
+      end
+
+      it "includes an updated resource's type" do
+        @first_update_report.should have_key("type")
+      end
+
+      it "includes an updated resource's initial state" do
+        @first_update_report["before"].should == @current_resource.state
+      end
+
+      it "includes an updated resource's final state" do
+        @first_update_report["after"].should == @new_resource.state
+      end
+
+      it "includes the resource's name" do
+        @first_update_report["name"].should == @new_resource.name
+      end
+
+      it "includes the resource's id attribute" do
+        @first_update_report["id"].should == @new_resource.identity
+      end
+
+      it "includes the elapsed time for the resource to converge" do
+        # TODO: API takes integer number of milliseconds as a string. This
+        # should be an int.
+        @first_update_report.should have_key("duration")
+        @first_update_report["duration"].to_i.should be_within(100).of(0)
+      end
+
+      it "includes the action executed by the resource" do
+        # TODO: rename as "action"
+        @first_update_report["result"].should == "create"
+      end
+
+      it "includes the cookbook name of the resource" do
+        @first_update_report.should have_key("cookbook_name")
+        @first_update_report["cookbook_name"].should == "monkey"
+      end
+
+      it "includes the cookbook version of the resource" do
+        @first_update_report.should have_key("cookbook_version")
+        @first_update_report["cookbook_version"].should == "1.2.3"
+      end
+
+      it "includes the total resource count" do
+        @report.should have_key("total_res_count")
+        @report["total_res_count"].should == "1"
+      end
+
+      it "includes the data hash" do
+        @report.should have_key("data")
+        @report["data"].should == {}
+      end
+
+      it "includes the run_list" do
+        @report.should have_key("run_list")
+        @report["run_list"].should == @node.run_list.to_json
+      end
+    end
+
+    context "for an unsuccessful run" do
+
+      before do
+        @backtrace = "foo.rb:1 in `foo!'\nbar.rb:2 in `bar!\n'baz.rb:3 in `baz!'"
+        @node = Chef::Node.new
+        @node.name("spitfire")
+        @exception = mock("ArgumentError")
+        @exception.should_receive(:inspect).and_return("Net::HTTPServerException")
+        @exception.should_receive(:message).and_return("Object not found")
+        @exception.should_receive(:backtrace).and_return(@backtrace)
+        @resource_reporter.run_failed(@exception)
+        @report = @resource_reporter.report(@node)
+      end
+
+      it "includes the exception type in the event data" do
+        @report.should have_key("exception")
+        @report["exception"].should have_key("class")
+        @report["exception"]["class"].should == "Net::HTTPServerException"
+      end
+
+      it "includes the exception message in the event data" do
+        @report.should have_key("exception")
+        @report["exception"].should have_key("message")
+        @report["exception"]["message"].should == "Object not found"
+      end
+
+      it "includes the exception trace in the event data" do
+        @report.should have_key("exception")
+        @report["exception"].should have_key("backtrace")
+        @report["exception"]["backtrace"].should == @backtrace
+      end
+
+      it "includes the error inspector output in the event data" do
+        @report.should have_key("exception")
+        @report["exception"].should have_key("description")
+      end
+
+    end
+
+  end
+
+  describe "when updating resource history on the server" do
+    before do
+      @node = Chef::Node.new
+      @node.name("spitfire")
+    end
+
+    context "when the server does not support storing resource history" do
+      before do
+        # 404 getting the run_id
+        @response = Net::HTTPNotFound.new("a response body", "404", "Not Found")
+        @error = Net::HTTPServerException.new("404 message", @response)
+        @rest_client.should_receive(:post_rest).
+          with("nodes/spitfire/runs", {:action => :begin}).
+          and_raise(@error)
+        @resource_reporter.node_load_completed(@node, :expanded_run_list, :config)
+      end
+
+      it "assumes the feature is not enabled" do
+        @resource_reporter.reporting_enabled?.should be_false
+      end
+
+      it "does not send a resource report to the server" do
+        @rest_client.should_not_receive(:post_rest)
+        @resource_reporter.run_completed(@node)
+      end
+
+    end
+
+    context "after creating the run history document" do
+      before do
+        response = {"uri"=>"https://example.com/nodes/spitfire/runs/ABC123"}
+        @rest_client.should_receive(:post_rest).
+          with("nodes/spitfire/runs", {:action => :begin}).
+          and_return(response)
+
+        @resource_reporter.node_load_completed(@node, :expanded_run_list, :config)
+      end
+
+      it "creates a run document on the server at the start of the run" do
+        @resource_reporter.run_id.should == "ABC123"
+      end
+
+      it "updates the run document with resource updates at the end of the run" do
+        # update some resources...
+        @resource_reporter.resource_action_start(@new_resource, :create)
+        @resource_reporter.resource_current_state_loaded(@new_resource, :create, @current_resource)
+        @resource_reporter.resource_updated(@new_resource, :create)
+
+        @expected_data = @resource_reporter.report(@node)
+        @expected_data["action"] = "end"
+
+        response = {"result"=>"ok"}
+
+        @rest_client.should_receive(:post_rest).
+          with("nodes/spitfire/runs/ABC123", @expected_data).
+          and_return(response)
+
+        @resource_reporter.run_completed(@node)
+      end
+    end
+  end
+
+end