@@ -6,9 +6,9 @@ # 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. @@ -26,14 +26,14 @@ require 'net/https' class Chef class Provider class RemoteFile < Chef::Provider::File - + include Chef::Mixin::FindPreferredFile - - def action_create + + def action_create Chef::Log.debug("Checking #{@new_resource} for changes") do_remote_file(@new_resource.source, @current_resource.path) end - + def action_create_if_missing if ::File.exists?(@new_resource.path) Chef::Log.debug("File #{@new_resource.path} exists, taking no action.") @@ -41,56 +41,28 @@ class Chef action_create end end - + def do_remote_file(source, path) - # The remote filehandle - raw_file = nil - # The current files checksum - current_checksum = nil current_checksum = self.checksum(path) if ::File.exists?(path) - - # If we are solo, try and find the file in a local cookbook - # assuming we find it, we open it up and set it to raw_file. - if Chef::Config[:solo] - filename = find_preferred_file( - @new_resource.cookbook_name.to_s, - :remote_file, - source, - @node[:fqdn], - @node[:platform], - @node[:platform_version] - ) - Chef::Log.debug("Using local file for remote_file:#{filename}") - raw_file = ::File.open(filename) - else - # Otherwise, we need to go get it from the chef server - # This results in a tmpfile as raw_file - r = Chef::REST.new(Chef::Config[:remotefile_url]) - - url = generate_url( - source, - "files", - { - :checksum => current_checksum - } - ) - - begin - raw_file = r.get_rest(url, true) - rescue Net::HTTPRetriableError => e - if e.response.kind_of?(Net::HTTPNotModified) - Chef::Log.debug("File #{path} is unchanged") - return false - else - raise e - end + + begin + # The remote filehandle + raw_file = get_from_uri(source) || + get_from_server(source, current_checksum) || + get_from_local_cookbook(source) + rescue Net::HTTPRetriableError => e + if e.response.kind_of?(Net::HTTPNotModified) + Chef::Log.debug("File #{path} is unchanged") + return false + else + raise e end end - + # If the file exists if ::File.exists?(@new_resource.path) - # And it matches the checsum of the raw file + # And it matches the checksum of the raw file @new_resource.checksum(self.checksum(raw_file.path)) if @new_resource.checksum != @current_resource.checksum # Updating target file, let's perform a backup! @@ -102,17 +74,48 @@ class Chef # We're creating a new file Chef::Log.info("Creating #{@new_resource} at #{@new_resource.path}") end - + FileUtils.cp(raw_file.path, @new_resource.path) @new_resource.updated = true - set_owner if @new_resource.owner != nil - set_group if @new_resource.group != nil - set_mode if @new_resource.mode != nil + set_owner if @new_resource.owner + set_group if @new_resource.group + set_mode if @new_resource.mode - return true + true end - + + def get_from_uri(source) + uri = URI.parse(source) + if uri.absolute + r = Chef::REST.new(source) + r.get_rest(source, true) + end + rescue URI::InvalidURIError + nil + end + + def get_from_server(source, current_checksum) + unless Chef::Config[:solo] + r = Chef::REST.new(Chef::Config[:remotefile_url]) + url = generate_url(source, "files", :checksum => current_checksum) + r.get_rest(url, true) + end + end + + def get_from_local_cookbook(source) + filename = find_preferred_file( + @new_resource.cookbook_name.to_s, + :remote_file, + source, + @node[:fqdn], + @node[:platform], + @node[:platform_version] + ) + Chef::Log.debug("Using local file for remote_file:#{filename}") + ::File.open(filename) + end + end end end chef/lib/chef/provider/remote_file.rb @@ -61,7 +61,41 @@ describe Chef::Provider::RemoteFile, "do_remote_file" do Chef::REST.stub!(:new).and_return(@rest) @provider.do_remote_file(@resource.source, @resource.path) end + + describe "when given a URI source" do + it "should download the file from the remote URL" do + @resource.source("http://opscode.com/seattle.txt") + @rest.should_receive(:get_rest).with("http://opscode.com/seattle.txt", true).and_return(@tempfile) + do_remote_file + end + end + describe "when given a non-URI source" do + describe "and using chef-solo" do + it "should load the file from the local cookbook" do + Chef::Config[:solo] = true + File.stub!(:open).and_return(@tempfile) + @provider.should_receive(:find_preferred_file).with("monkey", :remote_file, @resource.source, "latte.local", nil, nil).and_return(@tempfile.path) + do_remote_file + end + end + + it "should call generate_url with the current checksum as an extra attribute" do + @provider.should_receive(:generate_url).with(@resource.source, "files", { :checksum => "0fd012fdc96e96f8f7cf2046522a54aed0ce470224513e45da6bc1a17a4924aa"}) + do_remote_file + end + + it "should call get_rest with a correctly composed url" do + url = "cookbooks/#{@resource.cookbook_name}/files?id=#{@resource.source}" + url += "&platform=mac_os_x" + url += "&version=10.5.1" + url += "&fqdn=latte.local" + url += "&checksum=0fd012fdc96e96f8f7cf2046522a54aed0ce470224513e45da6bc1a17a4924aa" + @rest.should_receive(:get_rest).with(url, true).and_return(@tempfile) + do_remote_file + end + end + it "should set the checksum if the file exists" do @provider.should_receive(:checksum).with(@resource.path) do_remote_file @@ -72,22 +106,7 @@ describe Chef::Provider::RemoteFile, "do_remote_file" do @provider.should_not_receive(:checksum).with(@resource.path) do_remote_file end - - it "should call generate_url with the current checksum as an extra attribute" do - @provider.should_receive(:generate_url).with(@resource.source, "files", { :checksum => "0fd012fdc96e96f8f7cf2046522a54aed0ce470224513e45da6bc1a17a4924aa"}) - do_remote_file - end - - it "should call get_rest with a correctly composed url" do - url = "cookbooks/#{@resource.cookbook_name}/files?id=#{@resource.source}" - url += "&platform=mac_os_x" - url += "&version=10.5.1" - url += "&fqdn=latte.local" - url += "&checksum=0fd012fdc96e96f8f7cf2046522a54aed0ce470224513e45da6bc1a17a4924aa" - @rest.should_receive(:get_rest).with(url, true).and_return(@tempfile) - do_remote_file - end - + it "should not transfer the file if it has not been changed" do r = Net::HTTPNotModified.new("one", "two", "three") e = Net::HTTPRetriableError.new("304", r) @@ -117,6 +136,7 @@ describe Chef::Provider::RemoteFile, "do_remote_file" do describe "when the target file already exists" do before do ::File.stub!(:exists?).and_return(true) + @provider.stub!(:get_from_server).and_return(@tempfile) end it "should backup the original file if it is different" do chef/spec/unit/provider/remote_file_spec.rb bbc71e1463c42f7d4ef7bca680c5d333f07029ff Sean Cribbs seancribbs@gmail.com http://github.com/opscode/chef/commit/a831499a6f402ca95b8e1152bc913d324eea3199 a831499a6f402ca95b8e1152bc913d324eea3199 2009-02-06T06:55:51-08:00 2009-02-05T06:39:57-08:00 CHEF-89: Refactor Chef::Provider::RemoteFile to support downloads from any URI. 959f39a281c8fdfae75f5548dcda721d93810866 Sean Cribbs seancribbs@gmail.com