Merge pull request #1111 from opscode/lcg/OC-10380

OC-10380: skip checksumming for no-content files

10 files changed, 243 insertions, 55 deletions

diff --git a/lib/chef/provider/cookbook_file.rb b/lib/chef/provider/cookbook_file.rb
index d59950780f..18af70d415 100644
--- a/lib/chef/provider/cookbook_file.rb
+++ b/lib/chef/provider/cookbook_file.rb
@@ -38,6 +38,14 @@ class Chef
         super
       end
 
+      private
+
+      def managing_content?
+        return true if @new_resource.checksum
+        return true if !@new_resource.source.nil? && @action != :create_if_missing
+        false
+      end
+
     end
   end
 end
diff --git a/lib/chef/provider/directory.rb b/lib/chef/provider/directory.rb
index e3d2b89f2e..067737b9d4 100644
--- a/lib/chef/provider/directory.rb
+++ b/lib/chef/provider/directory.rb
@@ -123,6 +123,13 @@ class Chef
           end
         end
       end
+
+      private
+
+      def managing_content?
+        false
+      end
+
     end
   end
 end
diff --git a/lib/chef/provider/file.rb b/lib/chef/provider/file.rb
index e727aa9ec1..b2127d7c87 100644
--- a/lib/chef/provider/file.rb
+++ b/lib/chef/provider/file.rb
@@ -75,7 +75,8 @@ class Chef
         @current_resource ||= Chef::Resource::File.new(@new_resource.name)
         @current_resource.path(@new_resource.path)
         if ::File.exists?(@current_resource.path) && ::File.file?(::File.realpath(@current_resource.path))
-          if @action != :create_if_missing && @current_resource.respond_to?(:checksum)
+          if managing_content?
+            Chef::Log.debug("#{@new_resource} checksumming file at #{@new_resource.path}.")
             @current_resource.checksum(checksum(@current_resource.path))
           end
           load_resource_attributes_from_file(@current_resource)
@@ -159,6 +160,15 @@ class Chef
 
       private
 
+      # What to check in this resource to see if we're going to be actively managing
+      # content (for things like doing checksums in load_current_resource).  Expected to
+      # be overridden in subclasses.
+      def managing_content?
+        return true if @new_resource.checksum
+        return true if !@new_resource.content.nil? && @action != :create_if_missing
+        false
+      end
+
       # Handles resource requirements for action :create when some fs entry
       # already exists at the destination path. For actions other than create,
       # we don't care what kind of thing is at the destination path because:
@@ -240,8 +250,8 @@ class Chef
 
       def content
         @content ||= begin
-           load_current_resource if @current_resource.nil?
-           @content_class.new(@new_resource, @current_resource, @run_context)
+          load_current_resource if @current_resource.nil?
+          @content_class.new(@new_resource, @current_resource, @run_context)
         end
       end
 
@@ -330,7 +340,9 @@ class Chef
         do_backup unless file_created?
         deployment_strategy.deploy(tempfile.path, ::File.realpath(@new_resource.path))
         Chef::Log.info("#{@new_resource} updated file contents #{@new_resource.path}")
-        @new_resource.checksum(checksum(@new_resource.path)) # for reporting
+        if managing_content?
+          @new_resource.checksum(checksum(@new_resource.path)) # for reporting
+        end
       end
 
       def do_contents_changes
@@ -379,6 +391,7 @@ class Chef
       end
 
       def contents_changed?
+        Chef::Log.debug "calculating checksum of #{tempfile.path} to compare with #{@current_resource.checksum}"
         checksum(tempfile.path) != @current_resource.checksum
       end
 
diff --git a/lib/chef/provider/remote_file.rb b/lib/chef/provider/remote_file.rb
index d62f4aa13c..ed99c0bb84 100644
--- a/lib/chef/provider/remote_file.rb
+++ b/lib/chef/provider/remote_file.rb
@@ -39,6 +39,14 @@ class Chef
         super
       end
 
+      private
+
+      def managing_content?
+        return true if @new_resource.checksum
+        return true if !@new_resource.source.nil? && @action != :create_if_missing
+        false
+      end
+
     end
   end
 end
diff --git a/lib/chef/provider/template.rb b/lib/chef/provider/template.rb
index 217f9e56ec..555f4f14f0 100644
--- a/lib/chef/provider/template.rb
+++ b/lib/chef/provider/template.rb
@@ -52,6 +52,14 @@ class Chef
         end
       end
 
+      private
+
+      def managing_content?
+        return true if @new_resource.checksum
+        return true if !@new_resource.source.nil? && @action != :create_if_missing
+        false
+      end
+
     end
   end
 end
diff --git a/spec/support/shared/unit/provider/file.rb b/spec/support/shared/unit/provider/file.rb
index 11e991d830..72dda3c07a 100644
--- a/spec/support/shared/unit/provider/file.rb
+++ b/spec/support/shared/unit/provider/file.rb
@@ -35,46 +35,75 @@ def normalized_path
   File.expand_path(resource_path)
 end
 
+# forwards-vs-reverse slashes on windows sucks
+def windows_path
+  windows? ? normalized_path.gsub(/\\/, '/') : normalized_path
+end
+
+# this is all getting a bit stupid, CHEF-4802 cut to remove all this
 def setup_normal_file
-  File.stub!(:exists?).with(resource_path).and_return(true)
-  File.stub!(:directory?).with(resource_path).and_return(false)
-  File.stub!(:directory?).with(enclosing_directory).and_return(true)
-  File.stub!(:writable?).with(resource_path).and_return(true)
-  file_symlink_class.stub!(:symlink?).with(resource_path).and_return(false)
-  file_symlink_class.stub!(:symlink?).with(normalized_path).and_return(false)
+  [ resource_path, normalized_path, windows_path].each do |path|
+    File.stub(:file?).with(path).and_return(true)
+    File.stub(:exists?).with(path).and_return(true)
+    File.stub(:exist?).with(path).and_return(true)
+    File.stub(:directory?).with(path).and_return(false)
+    File.stub(:writable?).with(path).and_return(true)
+    file_symlink_class.stub(:symlink?).with(path).and_return(false)
+    File.stub(:realpath?).with(path).and_return(normalized_path)
+  end
+  File.stub(:directory?).with(enclosing_directory).and_return(true)
 end
 
 def setup_missing_file
-  File.stub!(:exists?).with(resource_path).and_return(false)
-  File.stub!(:directory?).with(resource_path).and_return(false)
-  File.stub!(:directory?).with(enclosing_directory).and_return(true)
-  File.stub!(:writable?).with(resource_path).and_return(false)
-  file_symlink_class.stub!(:symlink?).with(resource_path).and_return(false)
+  [ resource_path, normalized_path, windows_path].each do |path|
+    File.stub(:file?).with(path).and_return(false)
+    File.stub(:realpath?).with(path).and_return(resource_path)
+    File.stub(:exists?).with(path).and_return(false)
+    File.stub(:exist?).with(path).and_return(false)
+    File.stub(:directory?).with(path).and_return(false)
+    File.stub(:writable?).with(path).and_return(false)
+    file_symlink_class.stub(:symlink?).with(path).and_return(false)
+  end
+  File.stub(:directory?).with(enclosing_directory).and_return(true)
 end
 
 def setup_symlink
-  File.stub!(:exists?).with(resource_path).and_return(true)
-  File.stub!(:directory?).with(normalized_path).and_return(false)
-  File.stub!(:directory?).with(enclosing_directory).and_return(true)
-  File.stub!(:writable?).with(resource_path).and_return(true)
-  file_symlink_class.stub!(:symlink?).with(resource_path).and_return(true)
-  file_symlink_class.stub!(:symlink?).with(normalized_path).and_return(true)
+  [ resource_path, normalized_path, windows_path].each do |path|
+    File.stub(:file?).with(path).and_return(true)
+    File.stub(:realpath?).with(path).and_return(normalized_path)
+    File.stub(:exists?).with(path).and_return(true)
+    File.stub(:exist?).with(path).and_return(true)
+    File.stub(:directory?).with(path).and_return(false)
+    File.stub(:writable?).with(path).and_return(true)
+    file_symlink_class.stub(:symlink?).with(path).and_return(true)
+  end
+  File.stub(:directory?).with(enclosing_directory).and_return(true)
 end
 
 def setup_unwritable_file
-  File.stub!(:exists?).with(resource_path).and_return(true)
-  File.stub!(:directory?).with(resource_path).and_return(false)
-  File.stub!(:directory?).with(enclosing_directory).and_return(true)
-  File.stub!(:writable?).with(resource_path).and_return(false)
-  file_symlink_class.stub!(:symlink?).with(resource_path).and_return(false)
+  [ resource_path, normalized_path, windows_path].each do |path|
+    File.stub(:file?).with(path).and_return(false)
+    File.stub(:realpath?).with(path).and_raise(Errno::ENOENT)
+    File.stub(:exists?).with(path).and_return(true)
+    File.stub(:exist?).with(path).and_return(true)
+    File.stub(:directory?).with(path).and_return(false)
+    File.stub(:writable?).with(path).and_return(false)
+    file_symlink_class.stub(:symlink?).with(path).and_return(false)
+  end
+  File.stub(:directory?).with(enclosing_directory).and_return(true)
 end
 
 def setup_missing_enclosing_directory
-  File.stub!(:exists?).with(resource_path).and_return(false)
-  File.stub!(:directory?).with(resource_path).and_return(false)
-  File.stub!(:directory?).with(enclosing_directory).and_return(false)
-  File.stub!(:writable?).with(resource_path).and_return(false)
-  file_symlink_class.stub!(:symlink?).with(resource_path).and_return(false)
+  [ resource_path, normalized_path, windows_path].each do |path|
+    File.stub(:file?).with(path).and_return(false)
+    File.stub(:realpath?).with(path).and_raise(Errno::ENOENT)
+    File.stub(:exists?).with(path).and_return(false)
+    File.stub(:exist?).with(path).and_return(false)
+    File.stub(:directory?).with(path).and_return(false)
+    File.stub(:writable?).with(path).and_return(false)
+    file_symlink_class.stub(:symlink?).with(path).and_return(false)
+  end
+  File.stub(:directory?).with(enclosing_directory).and_return(false)
 end
 
 shared_examples_for Chef::Provider::File do
@@ -93,63 +122,109 @@ shared_examples_for Chef::Provider::File do
 
   context "when loading the current resource" do
 
+    context "when running load_current_resource" do
+      #
+      # the content objects need the current_resource to be loaded (esp remote_file), so calling
+      # for content inside of load_current_resource is totally crossing the streams...
+      #
+      it "should not try to load the content when the file is present" do
+        setup_normal_file
+        provider.should_not_receive(:tempfile)
+        provider.should_not_receive(:content)
+        provider.load_current_resource
+      end
+
+      it "should not try to load the content when the file is missing" do
+        setup_missing_file
+        provider.should_not_receive(:tempfile)
+        provider.should_not_receive(:content)
+        provider.load_current_resource
+      end
+    end
+
     context "when running load_current_resource and the file exists" do
       before do
         setup_normal_file
-        provider.load_current_resource
       end
 
+      let(:tempfile_sha256) { "42971f0ddce0cb20cf7660a123ffa1a1543beb2f1e7cd9d65858764a27f3201d" }
+
       it "should load a current resource based on the one specified at construction" do
+        provider.load_current_resource
         provider.current_resource.should be_a_kind_of(Chef::Resource::File)
       end
 
       it "the loaded current_resource name should be the same as the resource name" do
+        provider.load_current_resource
         provider.current_resource.name.should eql(resource.name)
       end
 
       it "the loaded current_resource path should be the same as the resoure path" do
+        provider.load_current_resource
         provider.current_resource.path.should eql(resource.path)
       end
 
       it "the loaded current_resource content should be nil" do
+        provider.load_current_resource
         provider.current_resource.content.should eql(nil)
       end
+
+      it "it should call checksum if we are managing content" do
+        provider.should_receive(:managing_content?).at_least(:once).and_return(true)
+        provider.should_receive(:checksum).with(resource.path).and_return(tempfile_sha256)
+        provider.load_current_resource
+      end
+
+      it "it should not call checksum if we are not managing content" do
+        provider.should_receive(:managing_content?).at_least(:once).and_return(false)
+        provider.should_not_receive(:checksum)
+        provider.load_current_resource
+      end
     end
 
     context "when running load_current_resource and the file does not exist" do
       before do
         setup_missing_file
-        provider.load_current_resource
       end
 
       it "the current_resource should be a Chef::Resource::File" do
+        provider.load_current_resource
         provider.current_resource.should be_a_kind_of(Chef::Resource::File)
       end
 
       it "the current_resource name should be the same as the resource name" do
+        provider.load_current_resource
         provider.current_resource.name.should eql(resource.name)
       end
 
       it "the current_resource path should be the same as the resource path" do
+        provider.load_current_resource
         provider.current_resource.path.should eql(resource.path)
       end
 
       it "the loaded current_resource content should be nil" do
+        provider.load_current_resource
         provider.current_resource.content.should eql(nil)
       end
+
+      it "it should not call checksum if we are not managing content" do
+        provider.should_not_receive(:managing_content?)
+        provider.should_not_receive(:checksum)
+        provider.load_current_resource
+      end
     end
 
     context "examining file security metadata on Unix with a file that exists" do
       before do
         # fake that we're on unix even if we're on windows
-        Chef::Platform.stub!(:windows?).and_return(false)
+        Chef::Platform.stub(:windows?).and_return(false)
         # mock up the filesystem to behave like unix
         setup_normal_file
         stat_struct = mock("::File.stat", :mode => 0600, :uid => 0, :gid => 0, :mtime => 10000)
         resource_real_path = File.realpath(resource.path)
         File.should_receive(:stat).with(resource_real_path).at_least(:once).and_return(stat_struct)
-        Etc.stub!(:getgrgid).with(0).and_return(mock("Group Ent", :name => "wheel"))
-        Etc.stub!(:getpwuid).with(0).and_return(mock("User Ent", :name => "root"))
+        Etc.stub(:getgrgid).with(0).and_return(mock("Group Ent", :name => "wheel"))
+        Etc.stub(:getpwuid).with(0).and_return(mock("User Ent", :name => "root"))
       end
 
       context "when the new_resource does not specify any state" do
@@ -218,7 +293,7 @@ shared_examples_for Chef::Provider::File do
     context "examining file security metadata on Unix with a file that does not exist" do
       before do
         # fake that we're on unix even if we're on windows
-        Chef::Platform.stub!(:windows?).and_return(false)
+        Chef::Platform.stub(:windows?).and_return(false)
         setup_missing_file
       end
 
@@ -267,14 +342,14 @@ shared_examples_for Chef::Provider::File do
 
     before do
       # fake that we're on unix even if we're on windows
-      Chef::Platform.stub!(:windows?).and_return(false)
+      Chef::Platform.stub(:windows?).and_return(false)
       # mock up the filesystem to behave like unix
       setup_normal_file
       stat_struct = mock("::File.stat", :mode => 0600, :uid => 0, :gid => 0, :mtime => 10000)
       resource_real_path = File.realpath(resource.path)
-      File.stub!(:stat).with(resource_real_path).and_return(stat_struct)
-      Etc.stub!(:getgrgid).with(0).and_return(mock("Group Ent", :name => "wheel"))
-      Etc.stub!(:getpwuid).with(0).and_return(mock("User Ent", :name => "root"))
+      File.stub(:stat).with(resource_real_path).and_return(stat_struct)
+      Etc.stub(:getgrgid).with(0).and_return(mock("Group Ent", :name => "wheel"))
+      Etc.stub(:getpwuid).with(0).and_return(mock("User Ent", :name => "root"))
       provider.send(:load_resource_attributes_from_file, resource)
     end
 
@@ -368,7 +443,7 @@ shared_examples_for Chef::Provider::File do
           setup_normal_file
           provider.load_current_resource
           tempfile = double('Tempfile', :path => "/tmp/foo-bar-baz")
-          content.stub!(:tempfile).and_return(tempfile)
+          content.stub(:tempfile).and_return(tempfile)
           File.should_receive(:exists?).with("/tmp/foo-bar-baz").and_return(true)
           tempfile.should_receive(:unlink).once
         end
@@ -378,11 +453,12 @@ shared_examples_for Chef::Provider::File do
           let(:tempfile_sha256) { "42971f0ddce0cb20cf7660a123ffa1a1543beb2f1e7cd9d65858764a27f3201d" }
           let(:diff_for_reporting) { "+++\n---\n+foo\n-bar\n" }
           before do
-            provider.stub!(:contents_changed?).and_return(true)
+            provider.stub(:contents_changed?).and_return(true)
             diff = double('Diff', :for_output => ['+++','---','+foo','-bar'],
                                   :for_reporting => diff_for_reporting )
-            diff.stub!(:diff).with(resource_path, tempfile_path).and_return(true)
+            diff.stub(:diff).with(resource_path, tempfile_path).and_return(true)
             provider.should_receive(:diff).at_least(:once).and_return(diff)
+            provider.should_receive(:managing_content?).at_least(:once).and_return(true)
             provider.should_receive(:checksum).with(tempfile_path).and_return(tempfile_sha256)
             provider.should_receive(:checksum).with(resource_path).and_return(tempfile_sha256)
             provider.deployment_strategy.should_receive(:deploy).with(tempfile_path, normalized_path)
@@ -406,7 +482,7 @@ shared_examples_for Chef::Provider::File do
         end
 
         it "does nothing when the contents have not changed"  do
-          provider.stub!(:contents_changed?).and_return(false)
+          provider.stub(:contents_changed?).and_return(false)
           provider.should_not_receive(:diff)
           provider.send(:do_contents_changes)
         end
@@ -443,7 +519,7 @@ shared_examples_for Chef::Provider::File do
         before do
           setup_normal_file
           provider.load_current_resource
-          provider.stub!(:resource_updated?).and_return(true)
+          provider.stub(:resource_updated?).and_return(true)
         end
 
         it "should check for selinux_enabled? by default" do
@@ -508,7 +584,7 @@ shared_examples_for Chef::Provider::File do
 
       context "when resource is not updated" do
         before do
-          provider.stub!(:resource_updated?).and_return(false)
+          provider.stub(:resource_updated?).and_return(false)
         end
 
         it "should not check for selinux_enabled?" do
@@ -607,3 +683,65 @@ shared_examples_for Chef::Provider::File do
 
 end
 
+shared_examples_for "a file provider with content field" do
+  context "when testing managing_content?" do
+    it "should be false when creating a file without content" do
+      provider.action = :create
+      resource.stub(:content).and_return(nil)
+      resource.stub(:checksum).and_return(nil)
+      expect(provider.send(:managing_content?)).to be_false
+    end
+    it "should be true when creating a file with content" do
+      provider.action = :create
+      resource.stub(:content).and_return("flurbleblobbleblooble")
+      resource.stub(:checksum).and_return(nil)
+      expect(provider.send(:managing_content?)).to be_true
+    end
+    it "should be true when checksum is set on the content (no matter how crazy)" do
+      provider.action = :create_if_missing
+      resource.stub(:checksum).and_return("1234123234234234")
+      resource.stub(:content).and_return(nil)
+      expect(provider.send(:managing_content?)).to be_true
+    end
+    it "should be false when action is create_if_missing" do
+      provider.action = :create_if_missing
+      resource.stub(:content).and_return("flurbleblobbleblooble")
+      resource.stub(:checksum).and_return(nil)
+      expect(provider.send(:managing_content?)).to be_false
+    end
+  end
+end
+
+shared_examples_for "a file provider with source field" do
+  context "when testing managing_content?" do
+    it "should be false when creating a file without content" do
+      provider.action = :create
+      resource.stub(:content).and_return(nil)
+      resource.stub(:source).and_return(nil)
+      resource.stub(:checksum).and_return(nil)
+      expect(provider.send(:managing_content?)).to be_false
+    end
+    it "should be true when creating a file with content" do
+      provider.action = :create
+      resource.stub(:content).and_return(nil)
+      resource.stub(:source).and_return("http://somewhere.com/something.php")
+      resource.stub(:checksum).and_return(nil)
+      expect(provider.send(:managing_content?)).to be_true
+    end
+    it "should be true when checksum is set on the content (no matter how crazy)" do
+      provider.action = :create_if_missing
+      resource.stub(:content).and_return(nil)
+      resource.stub(:source).and_return(nil)
+      resource.stub(:checksum).and_return("1234123234234234")
+      expect(provider.send(:managing_content?)).to be_true
+    end
+    it "should be false when action is create_if_missing" do
+      provider.action = :create_if_missing
+      resource.stub(:content).and_return(nil)
+      resource.stub(:source).and_return("http://somewhere.com/something.php")
+      resource.stub(:checksum).and_return(nil)
+      expect(provider.send(:managing_content?)).to be_false
+    end
+  end
+end
+
diff --git a/spec/unit/provider/cookbook_file_spec.rb b/spec/unit/provider/cookbook_file_spec.rb
index 44569075de..05509fbae4 100644
--- a/spec/unit/provider/cookbook_file_spec.rb
+++ b/spec/unit/provider/cookbook_file_spec.rb
@@ -37,7 +37,7 @@ describe Chef::Provider::CookbookFile do
 
   let(:provider) do
     provider = described_class.new(resource, run_context)
-    provider.stub!(:content).and_return(content)
+    provider.stub(:content).and_return(content)
     provider
   end
 
@@ -54,4 +54,5 @@ describe Chef::Provider::CookbookFile do
 
   it_behaves_like Chef::Provider::File
 
+  it_behaves_like "a file provider with source field"
 end
diff --git a/spec/unit/provider/file_spec.rb b/spec/unit/provider/file_spec.rb
index 291f510067..6c401e3030 100644
--- a/spec/unit/provider/file_spec.rb
+++ b/spec/unit/provider/file_spec.rb
@@ -46,10 +46,12 @@ describe Chef::Provider::File do
 
   let(:provider) do
     provider = described_class.new(resource, run_context)
-    provider.stub!(:content).and_return(content)
+    provider.stub(:content).and_return(content)
     provider
   end
 
   it_behaves_like Chef::Provider::File
+
+  it_behaves_like "a file provider with content field"
 end
 
diff --git a/spec/unit/provider/remote_file_spec.rb b/spec/unit/provider/remote_file_spec.rb
index 3b01b45983..4562083e7e 100644
--- a/spec/unit/provider/remote_file_spec.rb
+++ b/spec/unit/provider/remote_file_spec.rb
@@ -47,16 +47,17 @@ describe Chef::Provider::RemoteFile do
 
   subject(:provider) do
     provider = described_class.new(resource, run_context)
-    provider.stub!(:content).and_return(content)
-    provider.stub!(:update_new_resource_checksum).and_return(nil) # Otherwise it doesn't behave like a File provider
+    provider.stub(:content).and_return(content)
+    provider.stub(:update_new_resource_checksum).and_return(nil) # Otherwise it doesn't behave like a File provider
     provider
   end
 
   before do
-    Chef::FileCache.stub!(:load).with("remote_file/#{resource.name}").and_raise(Chef::Exceptions::FileNotFound)
+    Chef::FileCache.stub(:load).with("remote_file/#{resource.name}").and_raise(Chef::Exceptions::FileNotFound)
   end
 
   it_behaves_like Chef::Provider::File
 
+  it_behaves_like "a file provider with source field"
 end
 
diff --git a/spec/unit/provider/template_spec.rb b/spec/unit/provider/template_spec.rb
index ca8f1db5e2..78d924aa41 100644
--- a/spec/unit/provider/template_spec.rb
+++ b/spec/unit/provider/template_spec.rb
@@ -39,7 +39,7 @@ describe Chef::Provider::Template do
 
   let(:provider) do
     provider = described_class.new(resource, run_context)
-    provider.stub!(:content).and_return(content)
+    provider.stub(:content).and_return(content)
     provider
   end
 
@@ -73,16 +73,18 @@ describe Chef::Provider::Template do
 
     let(:provider) do
       provider = described_class.new(resource, run_context)
-      provider.stub!(:content).and_return(content)
+      provider.stub(:content).and_return(content)
       provider
     end
 
     it "stops executing when the local template source can't be found" do
       setup_normal_file
-      content.stub!(:template_location).and_return("/baz/bar/foo")
+      content.stub(:template_location).and_return("/baz/bar/foo")
       File.stub(:exists?).with("/baz/bar/foo").and_return(false)
       lambda { provider.run_action(:create) }.should raise_error Chef::Mixin::WhyRun::ResourceRequirements::Assertion::AssertionFailure
     end
 
   end
+
+  it_behaves_like "a file provider with source field"
 end