# # Author:: Daniel DeLeo () # 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::Provider::Deploy do before do @release_time = Time.utc( 2004, 8, 15, 16, 23, 42) Time.stub!(:now).and_return(@release_time) @expected_release_dir = "/my/deploy/dir/releases/20040815162342" @resource = Chef::Resource::Deploy.new("/my/deploy/dir") @node = Chef::Node.new @events = Chef::EventDispatch::Dispatcher.new @run_context = Chef::RunContext.new(@node, {}, @events) @provider = Chef::Provider::Deploy.new(@resource, @run_context) @provider.stub!(:release_slug) @provider.stub!(:release_path).and_return(@expected_release_dir) end it "loads scm resource" do @provider.scm_provider.should_receive(:load_current_resource) @provider.load_current_resource end it "supports :deploy and :rollback actions" do @provider.should respond_to(:action_deploy) @provider.should respond_to(:action_rollback) end it "creates deploy_to dir if it does not exist yet" do FileUtils.should_receive(:mkdir_p).with(@resource.deploy_to) FileUtils.should_receive(:mkdir_p).with(@resource.shared_path) ::File.stub!(:directory?).and_return(false) @provider.stub(:copy_cached_repo) @provider.stub(:update_cached_repo) @provider.stub(:symlink) @provider.stub(:migrate) @provider.deploy @provider.converge end it "does not create deploy_to dir if it exists" do ::File.stub!(:directory?).and_return(true) FileUtils.should_not_receive(:mkdir_p).with(@resource.deploy_to) FileUtils.should_not_receive(:mkdir_p).with(@resource.shared_path) @provider.stub(:copy_cached_repo) @provider.stub(:update_cached_repo) @provider.stub(:symlink) @provider.stub(:migrate) @provider.deploy @provider.converge end it "updates and copies the repo, then does a migrate, symlink, restart, restart, cleanup on deploy" do FileUtils.stub(:mkdir_p).with("/my/deploy/dir") FileUtils.stub(:mkdir_p).with("/my/deploy/dir/shared") @provider.should_receive(:enforce_ownership).twice @provider.should_receive(:update_cached_repo) @provider.should_receive(:copy_cached_repo) @provider.should_receive(:install_gems) @provider.should_receive(:callback).with(:before_migrate, nil) @provider.should_receive(:migrate) @provider.should_receive(:callback).with(:before_symlink, nil) @provider.should_receive(:symlink) @provider.should_receive(:callback).with(:before_restart, nil) @provider.should_receive(:restart) @provider.should_receive(:callback).with(:after_restart, nil) @provider.should_receive(:cleanup!) @provider.deploy @provider.converge end it "should not deploy if there is already a deploy at release_path, and it is the current release" do @provider.stub!(:all_releases).and_return([@expected_release_dir]) @provider.stub!(:current_release?).with(@expected_release_dir).and_return(true) @provider.should_not_receive(:deploy) @provider.run_action(:deploy) end it "should call action_rollback if there is already a deploy of this revision at release_path, and it is not the current release" do @provider.stub!(:all_releases).and_return([@expected_release_dir, "102021"]) @provider.stub!(:current_release?).with(@expected_release_dir).and_return(false) @provider.should_receive(:rollback_to).with(@expected_release_dir) @provider.should_receive(:current_release?) @provider.run_action(:deploy) end it "calls deploy when deploying a new release" do @provider.stub!(:all_releases).and_return([]) @provider.should_receive(:deploy) @provider.run_action(:deploy) end it "runs action svn_force_export when new_resource.svn_force_export is true" do @resource.svn_force_export true @provider.scm_provider.should_receive(:run_action).with(:force_export) @provider.update_cached_repo @provider.converge end it "Removes the old release before deploying when force deploying over it" do @provider.stub!(:all_releases).and_return([@expected_release_dir]) FileUtils.should_receive(:rm_rf).with(@expected_release_dir) @provider.should_receive(:deploy) @provider.run_action(:force_deploy) end it "deploys as normal when force deploying and there's no prior release at the same path" do @provider.stub!(:all_releases).and_return([]) @provider.should_receive(:deploy) @provider.run_action(:force_deploy) end it "dont care by default if error happens on deploy" do @provider.stub!(:all_releases).and_return(['previous_release']) @provider.stub!(:deploy).and_return{ raise "Unexpected error" } @provider.stub!(:previous_release_path).and_return('previous_release') @provider.should_not_receive(:rollback) lambda { @provider.run_action(:deploy) }.should raise_exception(RuntimeError, "Unexpected error") end it "rollbacks to previous release if error happens on deploy" do @resource.rollback_on_error true @provider.stub!(:all_releases).and_return(['previous_release']) @provider.stub!(:deploy).and_return{ raise "Unexpected error" } @provider.stub!(:previous_release_path).and_return('previous_release') @provider.should_receive(:rollback) lambda { @provider.run_action(:deploy) }.should raise_exception(RuntimeError, "Unexpected error") end describe "on systems without broken Dir.glob results" do it "sets the release path to the penultimate release when one is not specified, symlinks, and rm's the last release on rollback" do @provider.stub!(:release_path).and_return("/my/deploy/dir/releases/3") all_releases = ["/my/deploy/dir/releases/1", "/my/deploy/dir/releases/2", "/my/deploy/dir/releases/3", "/my/deploy/dir/releases/4", "/my/deploy/dir/releases/5"] Dir.stub!(:glob).with("/my/deploy/dir/releases/*").and_return(all_releases) @provider.should_receive(:symlink) FileUtils.should_receive(:rm_rf).with("/my/deploy/dir/releases/4") FileUtils.should_receive(:rm_rf).with("/my/deploy/dir/releases/5") @provider.run_action(:rollback) @provider.release_path.should eql("/my/deploy/dir/releases/3") end it "sets the release path to the specified release, symlinks, and rm's any newer releases on rollback" do @provider.unstub!(:release_path) all_releases = ["/my/deploy/dir/releases/20040815162342", "/my/deploy/dir/releases/20040700000000", "/my/deploy/dir/releases/20040600000000", "/my/deploy/dir/releases/20040500000000"].sort! Dir.stub!(:glob).with("/my/deploy/dir/releases/*").and_return(all_releases) @provider.should_receive(:symlink) FileUtils.should_receive(:rm_rf).with("/my/deploy/dir/releases/20040815162342") @provider.run_action(:rollback) @provider.release_path.should eql("/my/deploy/dir/releases/20040700000000") end it "sets the release path to the penultimate release, symlinks, and rm's the last release on rollback" do @provider.unstub!(:release_path) all_releases = [ "/my/deploy/dir/releases/20040815162342", "/my/deploy/dir/releases/20040700000000", "/my/deploy/dir/releases/20040600000000", "/my/deploy/dir/releases/20040500000000"] Dir.stub!(:glob).with("/my/deploy/dir/releases/*").and_return(all_releases) @provider.should_receive(:symlink) FileUtils.should_receive(:rm_rf).with("/my/deploy/dir/releases/20040815162342") @provider.run_action(:rollback) @provider.release_path.should eql("/my/deploy/dir/releases/20040700000000") end describe "if there are no releases to fallback to" do it "an exception is raised when there is only 1 release" do #@provider.unstub!(:release_path) -- unstub the release path on top to feed our own release path all_releases = [ "/my/deploy/dir/releases/20040815162342"] Dir.stub!(:glob).with("/my/deploy/dir/releases/*").and_return(all_releases) #@provider.should_receive(:symlink) #FileUtils.should_receive(:rm_rf).with("/my/deploy/dir/releases/20040815162342") #@provider.run_action(:rollback) #@provider.release_path.should eql(NIL) -- no check needed since assertions will fail lambda { @provider.run_action(:rollback) }.should raise_exception(RuntimeError, "There is no release to rollback to!") end it "an exception is raised when there are no releases" do all_releases = [] Dir.stub!(:glob).with("/my/deploy/dir/releases/*").and_return(all_releases) lambda { @provider.run_action(:rollback) }.should raise_exception(RuntimeError, "There is no release to rollback to!") end end end describe "CHEF-628: on systems with broken Dir.glob results" do it "sets the release path to the penultimate release, symlinks, and rm's the last release on rollback" do @provider.unstub!(:release_path) all_releases = [ "/my/deploy/dir/releases/20040500000000", "/my/deploy/dir/releases/20040600000000", "/my/deploy/dir/releases/20040700000000", "/my/deploy/dir/releases/20040815162342" ] Dir.stub!(:glob).with("/my/deploy/dir/releases/*").and_return(all_releases) @provider.should_receive(:symlink) FileUtils.should_receive(:rm_rf).with("/my/deploy/dir/releases/20040815162342") @provider.run_action(:rollback) @provider.release_path.should eql("/my/deploy/dir/releases/20040700000000") end end it "raises a runtime error when there's no release to rollback to" do all_releases = [] Dir.stub!(:glob).with("/my/deploy/dir/releases/*").and_return(all_releases) lambda {@provider.run_action(:rollback)}.should raise_error(RuntimeError) end it "runs the new resource collection in the runner during a callback" do @runner = mock("Runner") Chef::Runner.stub!(:new).and_return(@runner) @runner.should_receive(:converge) callback_code = Proc.new { :noop } @provider.callback(:whatevs, callback_code) @provider.converge end it "loads callback files from the release/ dir if the file exists" do foo_callback = @expected_release_dir + "/deploy/foo.rb" ::File.should_receive(:exist?).with(foo_callback).once.and_return(true) ::Dir.should_receive(:chdir).with(@expected_release_dir).and_yield @provider.should_receive(:from_file).with(foo_callback) @provider.callback(:foo, "deploy/foo.rb") @provider.converge end it "raises a runtime error if a callback file is explicitly specified but does not exist" do baz_callback = "/deploy/baz.rb" ::File.should_receive(:exist?).with("#{@expected_release_dir}/#{baz_callback}").and_return(false) @resource.before_migrate baz_callback @provider.define_resource_requirements @provider.action = :deploy lambda {@provider.process_resource_requirements}.should raise_error(RuntimeError) end it "runs a default callback if the callback code is nil" do bar_callback = @expected_release_dir + "/deploy/bar.rb" ::File.should_receive(:exist?).with(bar_callback).and_return(true) ::Dir.should_receive(:chdir).with(@expected_release_dir).and_yield @provider.should_receive(:from_file).with(bar_callback) @provider.callback(:bar, nil) @provider.converge end it "skips an eval callback if the file doesn't exist" do barbaz_callback = @expected_release_dir + "/deploy/barbaz.rb" ::File.should_receive(:exist?).with(barbaz_callback).and_return(false) @provider.should_not_receive(:from_file) @provider.callback(:barbaz, nil) @provider.converge end it "gets a SCM provider as specified by its resource" do @provider.scm_provider.should be_an_instance_of(Chef::Provider::Git) @provider.scm_provider.new_resource.destination.should eql("/my/deploy/dir/shared/cached-copy") end it "syncs the cached copy of the repo" do @provider.scm_provider.should_receive(:run_action).with(:sync) @provider.update_cached_repo @provider.converge end it "makes a copy of the cached repo in releases dir" do FileUtils.should_receive(:mkdir_p).with("/my/deploy/dir/releases") @provider.should_receive(:run_command).with({:command => "cp -RPp /my/deploy/dir/shared/cached-copy/. #{@expected_release_dir}"}) @provider.copy_cached_repo @provider.converge end it "calls the internal callback :release_created when copying the cached repo" do FileUtils.stub!(:mkdir_p) @provider.stub!(:run_command).and_return(true) @provider.should_receive(:release_created) @provider.copy_cached_repo @provider.converge end it "chowns the whole release dir to user and group specified in the resource" do @resource.user "foo" @resource.group "bar" FileUtils.should_receive(:chown_R).with("foo", "bar", "/my/deploy/dir") @provider.enforce_ownership @provider.converge end it "skips the migration when resource.migrate => false but runs symlinks before migration" do @resource.migrate false @provider.should_not_receive :run_command @provider.should_receive :run_symlinks_before_migrate @provider.migrate @provider.converge end it "links the database.yml and runs resource.migration_command when resource.migrate #=> true" do @resource.migrate true @resource.migration_command "migration_foo" @resource.user "deployNinja" @resource.group "deployNinjas" @resource.environment "RAILS_ENV" => "production" FileUtils.should_receive(:ln_sf).with("/my/deploy/dir/shared/config/database.yml", @expected_release_dir + "/config/database.yml") @provider.should_receive(:enforce_ownership) STDOUT.stub!(:tty?).and_return(true) Chef::Log.stub!(:info?).and_return(true) @provider.should_receive(:run_command).with(:command => "migration_foo", :cwd => @expected_release_dir, :user => "deployNinja", :group => "deployNinjas", :log_level => :info, :live_stream => STDOUT, :log_tag => "deploy[/my/deploy/dir]", :environment => {"RAILS_ENV"=>"production"}) @provider.migrate @provider.converge end it "purges the current release's /log /tmp/pids/ and /public/system directories" do FileUtils.should_receive(:rm_rf).with(@expected_release_dir + "/log") FileUtils.should_receive(:rm_rf).with(@expected_release_dir + "/tmp/pids") FileUtils.should_receive(:rm_rf).with(@expected_release_dir + "/public/system") @provider.purge_tempfiles_from_current_release @provider.converge end it "symlinks temporary files and logs from the shared dir into the current release" do FileUtils.stub(:mkdir_p).with(@resource.shared_path + "/system") FileUtils.stub(:mkdir_p).with(@resource.shared_path + "/pids") FileUtils.stub(:mkdir_p).with(@resource.shared_path + "/log") FileUtils.should_receive(:mkdir_p).with(@expected_release_dir + "/tmp") FileUtils.should_receive(:mkdir_p).with(@expected_release_dir + "/public") FileUtils.should_receive(:mkdir_p).with(@expected_release_dir + "/config") FileUtils.should_receive(:ln_sf).with("/my/deploy/dir/shared/system", @expected_release_dir + "/public/system") FileUtils.should_receive(:ln_sf).with("/my/deploy/dir/shared/pids", @expected_release_dir + "/tmp/pids") FileUtils.should_receive(:ln_sf).with("/my/deploy/dir/shared/log", @expected_release_dir + "/log") FileUtils.should_receive(:ln_sf).with("/my/deploy/dir/shared/config/database.yml", @expected_release_dir + "/config/database.yml") @provider.should_receive(:enforce_ownership) @provider.link_tempfiles_to_current_release @provider.converge end it "symlinks the current release dir into production" do FileUtils.should_receive(:rm_f).with("/my/deploy/dir/current") FileUtils.should_receive(:ln_sf).with(@expected_release_dir, "/my/deploy/dir/current") @provider.should_receive(:enforce_ownership) @provider.link_current_release_to_production @provider.converge end context "with a customized app layout" do before do @resource.purge_before_symlink(%w{foo bar}) @resource.create_dirs_before_symlink(%w{baz qux}) @resource.symlinks "foo/bar" => "foo/bar", "baz" => "qux/baz" @resource.symlink_before_migrate "radiohead/in_rainbows.yml" => "awesome" @provider.converge end it "purges the purge_before_symlink directories" do FileUtils.should_receive(:rm_rf).with(@expected_release_dir + "/foo") FileUtils.should_receive(:rm_rf).with(@expected_release_dir + "/bar") @provider.purge_tempfiles_from_current_release @provider.converge end it "symlinks files from the shared directory to the current release directory" do FileUtils.should_receive(:mkdir_p).with(@expected_release_dir + "/baz") FileUtils.should_receive(:mkdir_p).with(@expected_release_dir + "/qux") FileUtils.stub(:mkdir_p).with(@resource.shared_path + "/foo/bar") FileUtils.stub(:mkdir_p).with(@resource.shared_path + "/baz") FileUtils.should_receive(:ln_sf).with("/my/deploy/dir/shared/foo/bar", @expected_release_dir + "/foo/bar") FileUtils.should_receive(:ln_sf).with("/my/deploy/dir/shared/baz", @expected_release_dir + "/qux/baz") FileUtils.should_receive(:ln_sf).with("/my/deploy/dir/shared/radiohead/in_rainbows.yml", @expected_release_dir + "/awesome") @provider.should_receive(:enforce_ownership) @provider.link_tempfiles_to_current_release @provider.converge end end it "does nothing for restart if restart_command is empty" do @provider.should_not_receive(:run_command) @provider.restart @provider.converge end it "runs the restart command in the current application dir when the resource has a restart_command" do @resource.restart_command "restartcmd" @provider.should_receive(:run_command).with(:command => "restartcmd", :cwd => "/my/deploy/dir/current", :log_tag => "deploy[/my/deploy/dir]", :log_level => :debug) @provider.restart @provider.converge end it "lists all available releases" do all_releases = ["/my/deploy/dir/20040815162342", "/my/deploy/dir/20040700000000", "/my/deploy/dir/20040600000000", "/my/deploy/dir/20040500000000"].sort! Dir.should_receive(:glob).with("/my/deploy/dir/releases/*").and_return(all_releases) @provider.all_releases.should eql(all_releases) end it "removes all but the 5 newest releases" do all_releases = ["/my/deploy/dir/20040815162342", "/my/deploy/dir/20040700000000", "/my/deploy/dir/20040600000000", "/my/deploy/dir/20040500000000", "/my/deploy/dir/20040400000000", "/my/deploy/dir/20040300000000", "/my/deploy/dir/20040200000000", "/my/deploy/dir/20040100000000"].sort! @provider.stub!(:all_releases).and_return(all_releases) FileUtils.should_receive(:rm_rf).with("/my/deploy/dir/20040100000000") FileUtils.should_receive(:rm_rf).with("/my/deploy/dir/20040200000000") FileUtils.should_receive(:rm_rf).with("/my/deploy/dir/20040300000000") @provider.cleanup! @provider.converge end it "removes all but a certain number of releases when the resource has a keep_releases" do @resource.keep_releases 7 all_releases = ["/my/deploy/dir/20040815162342", "/my/deploy/dir/20040700000000", "/my/deploy/dir/20040600000000", "/my/deploy/dir/20040500000000", "/my/deploy/dir/20040400000000", "/my/deploy/dir/20040300000000", "/my/deploy/dir/20040200000000", "/my/deploy/dir/20040100000000"].sort! @provider.stub!(:all_releases).and_return(all_releases) FileUtils.should_receive(:rm_rf).with("/my/deploy/dir/20040100000000") @provider.cleanup! @provider.converge end it "fires a callback for :release_deleted when deleting an old release" do all_releases = ["/my/deploy/dir/20040815162342", "/my/deploy/dir/20040700000000", "/my/deploy/dir/20040600000000", "/my/deploy/dir/20040500000000", "/my/deploy/dir/20040400000000", "/my/deploy/dir/20040300000000"].sort! @provider.stub!(:all_releases).and_return(all_releases) FileUtils.stub!(:rm_rf) @provider.should_receive(:release_deleted).with("/my/deploy/dir/20040300000000") @provider.cleanup! @provider.converge end it "puts resource.to_hash in @configuration for backwards compat with capistano-esque deploy hooks" do @provider.instance_variable_get(:@configuration).should == @resource.to_hash end it "sets @configuration[:environment] to the value of RAILS_ENV for backwards compat reasons" do resource = Chef::Resource::Deploy.new("/my/deploy/dir") resource.environment "production" provider = Chef::Provider::Deploy.new(resource, @run_context) provider.instance_variable_get(:@configuration)[:environment].should eql("production") @provider.converge end it "shouldn't give a no method error on migrate if the environment is nil" do @provider.stub!(:enforce_ownership) @provider.stub!(:run_symlinks_before_migrate) @provider.stub!(:run_command) @provider.migrate @provider.converge end context "using inline recipes for callbacks" do it "runs an inline recipe with the provided block for :callback_name == {:recipe => &block} " do snitch = nil recipe_code = Proc.new {snitch = 42} #@provider.should_receive(:instance_eval).with(&recipe_code) @provider.callback(:whateverz, recipe_code) @provider.converge snitch.should == 42 end it "loads a recipe file from the specified path and from_file evals it" do ::File.should_receive(:exist?).with(@expected_release_dir + "/chefz/foobar_callback.rb").once.and_return(true) ::Dir.should_receive(:chdir).with(@expected_release_dir).and_yield @provider.should_receive(:from_file).with(@expected_release_dir + "/chefz/foobar_callback.rb") @provider.callback(:whateverz, "chefz/foobar_callback.rb") @provider.converge end it "instance_evals a block/proc for restart command" do snitch = nil restart_cmd = Proc.new {snitch = 42} @resource.restart(&restart_cmd) @provider.restart @provider.converge snitch.should == 42 end end describe "API bridge to capistrano" do it "defines sudo as a forwarder to execute" do @provider.should_receive(:execute).with("the moon, fool") @provider.sudo("the moon, fool") @provider.converge end it "defines run as a forwarder to execute, setting the user, group, cwd and environment to new_resource.user" do mock_execution = mock("Resource::Execute") @provider.should_receive(:execute).with("iGoToHell4this").and_return(mock_execution) @resource.user("notCoolMan") @resource.group("Ggroup") @resource.environment("APP_ENV" => 'staging') @resource.deploy_to("/my/app") mock_execution.should_receive(:user).with("notCoolMan") mock_execution.should_receive(:group).with("Ggroup") mock_execution.should_receive(:cwd){|*args| if args.empty? nil else args.size.should == 1 args.first.should == @provider.release_path end }.twice mock_execution.should_receive(:environment){ |*args| if args.empty? nil else args.size.should == 1 args.first.should == {"APP_ENV" => "staging"} end }.twice @provider.run("iGoToHell4this") @provider.converge end it "defines run as a forwarder to execute, setting cwd and environment but not override" do mock_execution = mock("Resource::Execute") @provider.should_receive(:execute).with("iGoToHell4this").and_return(mock_execution) @resource.user("notCoolMan") mock_execution.should_receive(:user).with("notCoolMan") mock_execution.should_receive(:cwd).with(no_args()).and_return("/some/value") mock_execution.should_receive(:environment).with(no_args()).and_return({}) @provider.run("iGoToHell4this") @provider.converge end it "converts sudo and run to exec resources in hooks" do runner = mock("tehRunner") Chef::Runner.stub!(:new).and_return(runner) snitch = nil @resource.user("tehCat") callback_code = Proc.new do snitch = 42 temp_collection = self.resource_collection run("tehMice") snitch = temp_collection.lookup("execute[tehMice]") end runner.should_receive(:converge) # @provider.callback(:phony, callback_code) @provider.converge snitch.should be_an_instance_of(Chef::Resource::Execute) snitch.user.should == "tehCat" end end describe "installing gems from a gems.yml" do before do ::File.stub!(:exist?).with("#{@expected_release_dir}/gems.yml").and_return(true) @gem_list = [{:name=>"eventmachine", :version=>"0.12.9"}] end it "reads a gems.yml file, creating gem providers for each with action :upgrade" do IO.should_receive(:read).with("#{@expected_release_dir}/gems.yml").and_return("cookie") YAML.should_receive(:load).with("cookie").and_return(@gem_list) gems = @provider.send(:gem_packages) gems.map { |g| g.action }.should == [[:install]] gems.map { |g| g.name }.should == %w{eventmachine} gems.map { |g| g.version }.should == %w{0.12.9} end it "takes a list of gem providers converges them" do IO.stub!(:read) YAML.stub!(:load).and_return(@gem_list) expected_gem_resources = @provider.send(:gem_packages).map { |r| [r.name, r.version] } gem_runner = @provider.send(:gem_resource_collection_runner) # no one has heard of defining == to be meaningful so I have use this monstrosity actual = gem_runner.run_context.resource_collection.all_resources.map { |r| [r.name, r.version] } actual.should == expected_gem_resources end end end