chef 11.4.4 → 11.6.0.hotfix.1

data/spec/unit/provider/remote_file/fetcher_spec.rb

@@ -0,0 +1,75 @@
+#
+# Author:: Lamont Granquist (<lamont@opscode.com>)
+# Copyright:: Copyright (c) 2013 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::Provider::RemoteFile::Fetcher do
+
+  let(:current_resource) { mock("current resource") }
+  let(:new_resource) { mock("new resource") }
+  let(:fetcher_instance) { mock("fetcher") }
+
+  describe "when passed an http url" do
+    let(:uri) { mock("uri", :scheme => "http" ) }
+    before do
+      Chef::Provider::RemoteFile::HTTP.should_receive(:new).and_return(fetcher_instance)
+    end
+    it "returns an http fetcher" do
+      described_class.for_resource(uri, new_resource, current_resource).should == fetcher_instance
+    end
+  end
+
+  describe "when passed an https url" do
+    let(:uri) { mock("uri", :scheme => "https" ) }
+    before do
+      Chef::Provider::RemoteFile::HTTP.should_receive(:new).and_return(fetcher_instance)
+    end
+    it "returns an http fetcher" do
+      described_class.for_resource(uri, new_resource, current_resource).should == fetcher_instance
+    end
+  end
+
+  describe "when passed an ftp url" do
+    let(:uri) { mock("uri", :scheme => "ftp" ) }
+    before do
+      Chef::Provider::RemoteFile::FTP.should_receive(:new).and_return(fetcher_instance)
+    end
+    it "returns an ftp fetcher" do
+      described_class.for_resource(uri, new_resource, current_resource).should == fetcher_instance
+    end
+  end
+
+  describe "when passed a file url" do
+    let(:uri) { mock("uri", :scheme => "file" ) }
+    before do
+      Chef::Provider::RemoteFile::LocalFile.should_receive(:new).and_return(fetcher_instance)
+    end
+    it "returns a localfile fetcher" do
+      described_class.for_resource(uri, new_resource, current_resource).should == fetcher_instance
+    end
+  end
+
+  describe "when passed a url we do not recognize" do
+    let(:uri) { mock("uri", :scheme => "xyzzy" ) }
+    it "throws an ArgumentError exception" do
+      lambda { described_class.for_resource(uri, new_resource, current_resource) }.should raise_error(ArgumentError)
+    end
+  end
+
+end
+

data/spec/unit/provider/remote_file/ftp_spec.rb

@@ -0,0 +1,224 @@
+#
+# Author:: Jesse Campbell (<hikeit@gmail.com>)
+# Copyright:: Copyright (c) 2013 Jesse Campbell
+# 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::Provider::RemoteFile::FTP do
+  let(:enclosing_directory) {
+    canonicalize_path(File.expand_path(File.join(CHEF_SPEC_DATA, "templates")))
+  }
+  let(:resource_path) {
+    canonicalize_path(File.expand_path(File.join(enclosing_directory, "seattle.txt")))
+  }
+
+  let(:new_resource) do
+    r = Chef::Resource::RemoteFile.new("remote file ftp backend test (new resource)")
+    r.ftp_active_mode(false)
+    r.path(resource_path)
+    r
+  end
+
+  let(:current_resource) do
+    Chef::Resource::RemoteFile.new("remote file ftp backend test (current resource)'")
+  end
+
+  let(:ftp) do
+    ftp = mock(Net::FTP, { })
+    ftp.stub!(:connect)
+    ftp.stub!(:login)
+    ftp.stub!(:voidcmd)
+    ftp.stub!(:mtime).and_return(Time.now)
+    ftp.stub!(:getbinaryfile)
+    ftp.stub!(:close)
+    ftp.stub!(:passive=)
+    ftp
+  end
+
+  let(:tempfile_path) { "/tmp/somedir/remote-file-ftp-backend-spec-test" }
+
+  let(:tempfile) do
+    t = StringIO.new
+    t.stub(:path).and_return(tempfile_path)
+    t
+  end
+
+  let(:uri) { URI.parse("ftp://opscode.com/seattle.txt") }
+
+  before(:each) do
+    Net::FTP.stub!(:new).with().and_return(ftp)
+    Tempfile.stub!(:new).and_return(tempfile)
+  end
+
+  describe "when first created" do
+
+    it "throws an argument exception when no path is given" do
+      uri.path = ""
+      lambda { Chef::Provider::RemoteFile::FTP.new(uri, new_resource, current_resource) }.should raise_error(ArgumentError)
+    end
+
+    it "throws an argument exception when only a / is given" do
+      uri.path = "/"
+      lambda { Chef::Provider::RemoteFile::FTP.new(uri, new_resource, current_resource) }.should raise_error(ArgumentError)
+    end
+
+    it "throws an argument exception when no filename is given" do
+      uri.path = "/the/whole/path/"
+      lambda { Chef::Provider::RemoteFile::FTP.new(uri, new_resource, current_resource) }.should raise_error(ArgumentError)
+    end
+
+    it "throws an argument exception when the typecode is invalid" do
+      uri.typecode = "d"
+      lambda { Chef::Provider::RemoteFile::FTP.new(uri, new_resource, current_resource) }.should raise_error(ArgumentError)
+    end
+
+    it "does not use passive mode when new_resource sets ftp_active_mode to true" do
+      new_resource.ftp_active_mode(true)
+      fetcher = Chef::Provider::RemoteFile::FTP.new(uri, new_resource, current_resource)
+      fetcher.use_passive_mode?.should be_false
+    end
+
+    it "uses passive mode when new_resource sets ftp_active_mode to false" do
+      new_resource.ftp_active_mode(false)
+      fetcher = Chef::Provider::RemoteFile::FTP.new(uri, new_resource, current_resource)
+      fetcher.use_passive_mode?.should be_true
+    end
+  end
+
+  describe "when fetching the object" do
+
+    let(:cache_control_data) { Chef::Provider::RemoteFile::CacheControlData.new(uri) }
+    let(:current_resource_checksum) { "e2a8938cc31754f6c067b35aab1d0d4864272e9bf8504536ef3e79ebf8432305" }
+
+    subject(:fetcher) { Chef::Provider::RemoteFile::FTP.new(uri, new_resource, current_resource) }
+
+    before do
+      current_resource.checksum(current_resource_checksum)
+      #Chef::Provider::RemoteFile::CacheControlData.should_receive(:load_and_validate).with(uri, current_resource_checksum).and_return(cache_control_data)
+    end
+
+    it "should connect to the host from the uri on the default port 21" do
+      ftp.should_receive(:connect).with("opscode.com", 21)
+      fetcher.fetch
+    end
+
+    it "should set passive true when ftp_active_mode is false" do
+      new_resource.ftp_active_mode(false)
+      ftp.should_receive(:passive=).with(true)
+      fetcher.fetch
+    end
+
+    it "should set passive false when ftp_active_mode is false" do
+      new_resource.ftp_active_mode(true)
+      ftp.should_receive(:passive=).with(false)
+      fetcher.fetch
+    end
+
+    it "should use anonymous ftp when no userinfo is provided" do
+      ftp.should_receive(:login).with("anonymous", nil)
+      fetcher.fetch
+    end
+
+    context "and the URI specifies an alternate port" do
+      let(:uri) { URI.parse("ftp://opscode.com:8021/seattle.txt") }
+
+      it "should connect on an alternate port when one is provided" do
+        uri = URI.parse("ftp://opscode.com:8021/seattle.txt")
+        ftp.should_receive(:connect).with("opscode.com", 8021)
+        fetcher.fetch
+      end
+
+    end
+
+    context "and the URI contains a username and password" do
+      let(:uri) { URI.parse("ftp://the_user:the_password@opscode.com/seattle.txt") }
+
+      it "should use authenticated ftp when userinfo is provided" do
+        ftp.should_receive(:login).with("the_user", "the_password")
+        fetcher.fetch
+      end
+    end
+
+    context "and the uri sets the typecode to ascii" do
+      let(:uri) { URI.parse("ftp://the_user:the_password@opscode.com/seattle.txt;type=a") }
+
+      it "fetches the file with ascii typecode set" do
+        ftp.should_receive(:voidcmd).with("TYPE A").once
+        fetcher.fetch
+      end
+
+    end
+
+    context "and the uri sets the typecode to image" do
+      let(:uri) { URI.parse("ftp://the_user:the_password@opscode.com/seattle.txt;type=i") }
+
+      it "should accept image for the typecode" do
+        ftp.should_receive(:voidcmd).with("TYPE I").once
+        fetcher.fetch
+      end
+
+    end
+
+    context "and the uri specifies a nested path" do
+      let(:uri) { URI.parse("ftp://opscode.com/the/whole/path/seattle.txt") }
+
+      it "should fetch the file from the correct path" do
+        ftp.should_receive(:voidcmd).with("CWD the").once
+        ftp.should_receive(:voidcmd).with("CWD whole").once
+        ftp.should_receive(:voidcmd).with("CWD path").once
+        ftp.should_receive(:getbinaryfile).with("seattle.txt", tempfile.path)
+        fetcher.fetch
+      end
+
+    end
+
+    context "when not using last modified based conditional fetching" do
+      before do
+        new_resource.use_last_modified(false)
+      end
+
+      it "should return a tempfile in the result" do
+        result = fetcher.fetch
+        result.should equal(tempfile)
+      end
+
+    end
+
+    context "and proxying is enabled" do
+      before do
+        @original_config = Chef::Config.hash_dup
+        Chef::Config[:ftp_proxy] = "socks5://socks.example.com:5000"
+        Chef::Config[:ftp_proxy_user] = "bill"
+        Chef::Config[:ftp_proxy_pass] = "ted"
+      end
+
+      after do
+        Chef::Config.configuration = @original_config
+      end
+
+      it "fetches the file via the proxy" do
+        current_socks_server = ENV["SOCKS_SERVER"]
+        ENV.should_receive(:[]=).with("SOCKS_SERVER", "socks5://bill:ted@socks.example.com:5000").ordered
+        ENV.should_receive(:[]=).with("SOCKS_SERVER", current_socks_server).ordered
+        result = fetcher.fetch
+        result.should equal(tempfile)
+      end
+
+    end
+
+  end
+end

data/spec/unit/provider/remote_file/http_spec.rb

@@ -0,0 +1,319 @@
+#
+# Author:: Lamont Granquist (<lamont@opscode.com>)
+# Copyright:: Copyright (c) 2013 Lamont Granquist
+# 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::Provider::RemoteFile::HTTP do
+
+  let(:uri) { URI.parse("http://opscode.com/seattle.txt") }
+
+  let(:existing_file_source) { nil }
+
+  let(:current_resource_checksum) { "41e78735319af11327e9d2ca8535ea1c191e5ac1f76bb08d88fe6c3f93a8c8e5" }
+
+  let(:current_resource) do
+    current_resource = Chef::Resource::RemoteFile.new("/tmp/foo.txt")
+    current_resource.source(existing_file_source) if existing_file_source
+    current_resource.checksum(current_resource_checksum)
+    current_resource
+  end
+
+  let(:new_resource) do
+    Chef::Resource::RemoteFile.new("/tmp/foo.txt")
+  end
+
+  subject(:fetcher) do
+    Chef::Provider::RemoteFile::HTTP.new(uri, new_resource, current_resource)
+  end
+
+  let(:cache_control_data) { Chef::Provider::RemoteFile::CacheControlData.new(uri) }
+
+  describe "generating cache control headers" do
+
+    context "and there is no valid cache control data for this URI on disk" do
+
+      before do
+        Chef::Provider::RemoteFile::CacheControlData.should_receive(:load_and_validate).with(uri, current_resource_checksum).and_return(cache_control_data)
+      end
+
+      it "does not add conditional GET headers" do
+        fetcher.conditional_get_headers.should == {}
+      end
+
+      context "and the resource specifies custom headers" do
+        before do
+          new_resource.headers("x-myapp-header" => "custom-header-value")
+        end
+
+        it "has the user-specified custom headers" do
+          fetcher.headers.should == {"x-myapp-header" => "custom-header-value"}
+        end
+      end
+
+    end
+
+    context "and the cache control data matches the existing file" do
+
+      # http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26
+      let(:etag) { "\"a-strong-unique-identifier\"" }
+
+      # http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.3
+      let(:mtime) { "Tue, 21 May 2013 19:19:23 GMT" }
+
+      before do
+        cache_control_data.etag = etag
+        cache_control_data.mtime = mtime
+
+        Chef::Provider::RemoteFile::CacheControlData.should_receive(:load_and_validate).with(uri, current_resource_checksum).and_return(cache_control_data)
+      end
+
+      context "and no conditional get features are enabled" do
+        before do
+          new_resource.use_conditional_get(false)
+        end
+
+        it "does not add headers to the request" do
+          fetcher.headers.should == {}
+        end
+      end
+
+      context "and conditional get is enabled" do
+        before do
+          new_resource.use_conditional_get(true)
+        end
+
+        it "adds If-None-Match and If-Modified-Since headers to the request" do
+          headers = fetcher.headers
+          headers["if-none-match"].should == etag
+          headers["if-modified-since"].should == mtime
+        end
+
+        context "and custom headers are provided" do
+          before do
+            new_resource.headers("x-myapp-header" => "app-specific-header",
+                                 "if-none-match" => "custom-etag",
+                                 "if-modified-since" => "custom-last-modified")
+          end
+
+          it "preserves non-conflicting headers" do
+            fetcher.headers["x-myapp-header"].should == "app-specific-header"
+          end
+
+          it "prefers user-supplied cache control headers" do
+            headers = fetcher.headers
+            headers["if-none-match"].should == "custom-etag"
+            headers["if-modified-since"].should == "custom-last-modified"
+          end
+        end
+
+      end
+
+      context "and etag support is enabled" do
+        before do
+          new_resource.use_conditional_get(false)
+          new_resource.use_etags(true)
+        end
+
+        it "only adds If-None-Match headers to the request" do
+          headers = fetcher.headers
+          headers["if-none-match"].should == etag
+          headers.should_not have_key("if-modified-since")
+        end
+      end
+
+      context "and mtime support is enabled" do
+        before do
+          new_resource.use_conditional_get(false)
+          new_resource.use_last_modified(true)
+        end
+
+        it "only adds If-Modified-Since headers to the request" do
+          headers = fetcher.headers
+          headers["if-modified-since"].should == mtime
+          headers.should_not have_key("if-none-match")
+        end
+      end
+    end
+
+  end
+
+  describe "when fetching the uri" do
+
+    let(:expected_http_opts) { {} }
+    let(:expected_http_args) { [uri, nil, nil, expected_http_opts] }
+
+    let(:tempfile_path) { "/tmp/chef-mock-tempfile-abc123" }
+
+    let(:tempfile) { mock(Tempfile, :path => tempfile_path) }
+
+    let(:last_response) { {} }
+
+    let(:rest) do
+      rest = mock(Chef::REST)
+      rest.stub!(:streaming_request).and_return(tempfile)
+      rest.stub!(:last_response).and_return(last_response)
+      rest
+    end
+
+    before do
+      new_resource.headers({})
+      new_resource.use_last_modified(false)
+      Chef::Provider::RemoteFile::CacheControlData.should_receive(:load_and_validate).with(uri, current_resource_checksum).and_return(cache_control_data)
+
+      Chef::REST.should_receive(:new).with(*expected_http_args).and_return(rest)
+    end
+
+
+    describe "and the request does not return new content" do
+
+      it "should propagate non-304 exceptions to the caller" do
+        r = Net::HTTPBadRequest.new("one", "two", "three")
+        e = Net::HTTPServerException.new("fake exception", r)
+        rest.stub!(:streaming_request).and_raise(e)
+        lambda { fetcher.fetch }.should raise_error(Net::HTTPServerException)
+      end
+
+      it "should return HTTPRetriableError when Chef::REST returns a 301" do
+        r = Net::HTTPMovedPermanently.new("one", "two", "three")
+        e = Net::HTTPRetriableError.new("301", r)
+        rest.stub!(:streaming_request).and_raise(e)
+        lambda { fetcher.fetch }.should raise_error(Net::HTTPRetriableError)
+      end
+
+      it "should return a nil tempfile for a 304 HTTPNotModifed" do
+        r = Net::HTTPNotModified.new("one", "two", "three")
+        e = Net::HTTPRetriableError.new("304", r)
+        rest.stub!(:streaming_request).and_raise(e)
+        result = fetcher.fetch
+        result.should be_nil
+      end
+
+    end
+
+    describe "and the request returns new content" do
+
+      let(:fetched_content_checksum) { "e2a8938cc31754f6c067b35aab1d0d4864272e9bf8504536ef3e79ebf8432305" }
+
+      before do
+        cache_control_data.should_receive(:save)
+        Chef::Digester.should_receive(:checksum_for_file).with(tempfile_path).and_return(fetched_content_checksum)
+      end
+
+      it "should return a tempfile" do
+        result = fetcher.fetch
+        result.should == tempfile
+        cache_control_data.etag.should be_nil
+        cache_control_data.mtime.should be_nil
+        cache_control_data.checksum.should == fetched_content_checksum
+      end
+
+      context "and the response does not contain an etag" do
+        let(:last_response) { {"etag" => nil} }
+        it "does not include an etag in the result" do
+          fetcher.fetch
+          cache_control_data.etag.should be_nil
+          cache_control_data.mtime.should be_nil
+          cache_control_data.checksum.should == fetched_content_checksum
+        end
+      end
+
+      context "and the response has an etag header" do
+        let(:last_response) { {"etag" => "abc123"} }
+
+        it "includes the etag value in the response" do
+          fetcher.fetch
+          cache_control_data.etag.should == "abc123"
+          cache_control_data.mtime.should be_nil
+          cache_control_data.checksum.should == fetched_content_checksum
+        end
+
+      end
+
+      context "and the response has no Date or Last-Modified header" do
+        let(:last_response) { {"date" => nil, "last_modified" => nil} }
+        it "does not set an mtime in the result" do
+          # RFC 2616 suggests that servers that do not set a Date header do not
+          # have a reliable clock, so no use in making them deal with dates.
+          fetcher.fetch
+          cache_control_data.etag.should be_nil
+          cache_control_data.mtime.should be_nil
+          cache_control_data.checksum.should == fetched_content_checksum
+        end
+      end
+
+      context "and the response has a Last-Modified header" do
+        let(:last_response) do
+          # Last-Modified should be preferred to Date if both are set
+          {"date" => "Fri, 17 May 2013 23:23:23 GMT", "last_modified" => "Fri, 17 May 2013 11:11:11 GMT"}
+        end
+
+        it "sets the mtime to the Last-Modified time in the response" do
+          fetcher.fetch
+          cache_control_data.etag.should be_nil
+          cache_control_data.mtime.should == last_response["last_modified"]
+        end
+      end
+
+      context "and the response has a Date header but no Last-Modified header" do
+        let(:last_response) do
+          {"date" => "Fri, 17 May 2013 23:23:23 GMT", "last_modified" => nil}
+        end
+
+        it "sets the mtime to the Date in the response" do
+          fetcher.fetch
+          cache_control_data.etag.should be_nil
+          cache_control_data.mtime.should == last_response["date"]
+          cache_control_data.checksum.should == fetched_content_checksum
+        end
+
+      end
+
+      context "and the target file is a tarball [CHEF-3140]" do
+
+        let(:uri) { URI.parse("http://opscode.com/tarball.tgz") }
+        let(:expected_http_opts) { {:disable_gzip => true} }
+
+        # CHEF-3140
+        # Some servers return tarballs as content type tar and encoding gzip, which
+        # is totally wrong. When this happens and gzip isn't disabled, Chef::REST
+        # will decompress the file for you, which is not at all what you expected
+        # to happen (you end up with an uncomressed tar archive instead of the
+        # gzipped tar archive you expected). To work around this behavior, we
+        # detect when users are fetching gzipped files and turn off gzip in
+        # Chef::REST.
+
+        it "should disable gzip compression in the client" do
+          # Before block in the parent context has set an expectation on
+          # Chef::REST.new() being called with expected arguments. Here we fufil
+          # that expectation, so that we can explicitly set it for this test.
+          # This is intended to provide insurance that refactoring of the parent
+          # context does not negate the value of this particular example.
+          Chef::REST.new(*expected_http_args)
+          Chef::REST.should_receive(:new).once.with(*expected_http_args).and_return(rest)
+          fetcher.fetch
+          cache_control_data.etag.should be_nil
+          cache_control_data.mtime.should be_nil
+          cache_control_data.checksum.should == fetched_content_checksum
+        end
+      end
+    end
+
+  end
+
+end
+