capistrano 3.4.0 → 3.17.1

data/spec/lib/capistrano/immutable_task_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+require "rake"
+require "capistrano/immutable_task"
+
+module Capistrano
+  describe ImmutableTask do
+    after do
+      # Ensure that any tasks we create in these tests don't pollute other tests
+      Rake::Task.clear
+    end
+
+    it "prints warning and raises when task is enhanced" do
+      extend(Rake::DSL)
+
+      load_defaults = Rake::Task.define_task("load:defaults")
+      load_defaults.extend(Capistrano::ImmutableTask)
+
+      $stderr.expects(:puts).with do |message|
+        message =~ /^ERROR: load:defaults has already been invoked/
+      end
+
+      expect do
+        namespace :load do
+          task :defaults do
+            # Never reached since load_defaults is frozen and can't be enhanced
+          end
+        end
+      end.to raise_error(/frozen/i)
+    end
+  end
+end

data/spec/lib/capistrano/plugin_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+require "capistrano/plugin"
+
+module Capistrano
+  describe Plugin do
+    include Rake::DSL
+    include Capistrano::DSL
+
+    class DummyPlugin < Capistrano::Plugin
+      def define_tasks
+        task :hello do
+        end
+      end
+
+      def register_hooks
+        before "deploy:published", "hello"
+      end
+    end
+
+    class ExternalTasksPlugin < Capistrano::Plugin
+      def define_tasks
+        eval_rakefile(
+          File.expand_path("../../../support/tasks/plugin.rake", __FILE__)
+        )
+      end
+
+      # Called from plugin.rake to demonstrate that helper methods work
+      def hello
+        set :plugin_result, "hello"
+      end
+    end
+
+    before do
+      # Define an example task to allow testing hooks
+      task "deploy:published"
+    end
+
+    after do
+      # Clean up any tasks or variables we created during the tests
+      Rake::Task.clear
+      Capistrano::Configuration.reset!
+    end
+
+    it "defines tasks when constructed" do
+      install_plugin(DummyPlugin)
+      expect(Rake::Task["hello"]).not_to be_nil
+    end
+
+    it "registers hooks when constructed" do
+      install_plugin(DummyPlugin)
+      expect(Rake::Task["deploy:published"].prerequisites).to include("hello")
+    end
+
+    it "skips registering hooks if load_hooks: false" do
+      install_plugin(DummyPlugin, load_hooks: false)
+      expect(Rake::Task["deploy:published"].prerequisites).to be_empty
+    end
+
+    it "doesn't call set_defaults immediately" do
+      dummy = DummyPlugin.new
+      install_plugin(dummy)
+      dummy.expects(:set_defaults).never
+    end
+
+    it "calls set_defaults during load:defaults", capture_io: true do
+      dummy = DummyPlugin.new
+      dummy.expects(:set_defaults).once
+      install_plugin(dummy)
+      Rake::Task["load:defaults"].invoke
+    end
+
+    it "is able to load tasks from a .rake file", capture_io: true do
+      install_plugin(ExternalTasksPlugin)
+      Rake::Task["plugin_test"].invoke
+      expect(fetch(:plugin_result)).to eq("hello")
+    end
+
+    it "exposes the SSHKit backend to subclasses" do
+      SSHKit::Backend.expects(:current).returns(:backend)
+      plugin = DummyPlugin.new
+      expect(plugin.send(:backend)).to eq(:backend)
+    end
+  end
+end

data/spec/lib/capistrano/scm/git_spec.rb

@@ -0,0 +1,184 @@
+require "spec_helper"
+
+require "capistrano/scm/git"
+
+module Capistrano
+  describe SCM::Git do
+    subject { Capistrano::SCM::Git.new }
+
+    # This allows us to easily use `set`, `fetch`, etc. in the examples.
+    let(:env) { Capistrano::Configuration.env }
+
+    # Stub the SSHKit backend so we can set up expectations without the plugin
+    # actually executing any commands.
+    let(:backend) { stub }
+    before { SSHKit::Backend.stubs(:current).returns(backend) }
+
+    # Mimic the deploy flow tasks so that the plugin can register its hooks.
+    before do
+      Rake::Task.define_task("deploy:new_release_path")
+      Rake::Task.define_task("deploy:check")
+      Rake::Task.define_task("deploy:set_current_revision")
+    end
+
+    # Clean up any tasks or variables that the plugin defined.
+    after do
+      Rake::Task.clear
+      Capistrano::Configuration.reset!
+    end
+
+    describe "#set_defaults" do
+      it "makes git_wrapper_path using a random hex value" do
+        env.set(:tmp_dir, "/tmp")
+        subject.set_defaults
+        expect(env.fetch(:git_wrapper_path)).to match(%r{/tmp/git-ssh-\h{20}\.sh})
+      end
+
+      it "makes git_max_concurrent_connections" do
+        subject.set_defaults
+        expect(env.fetch(:git_max_concurrent_connections)).to eq(10)
+        env.set(:git_max_concurrent_connections, 7)
+        expect(env.fetch(:git_max_concurrent_connections)).to eq(7)
+      end
+
+      it "makes git_wait_interval" do
+        subject.set_defaults
+        expect(env.fetch(:git_wait_interval)).to eq(0)
+        env.set(:git_wait_interval, 5)
+        expect(env.fetch(:git_wait_interval)).to eq(5)
+      end
+    end
+
+    describe "#git" do
+      it "should call execute git in the context, with arguments" do
+        backend.expects(:execute).with(:git, :init)
+        subject.git(:init)
+      end
+    end
+
+    describe "#repo_mirror_exists?" do
+      it "should call test for repo HEAD" do
+        env.set(:repo_path, "/path/to/repo")
+        backend.expects(:test).with " [ -f /path/to/repo/HEAD ] "
+
+        subject.repo_mirror_exists?
+      end
+    end
+
+    describe "#check_repo_is_reachable" do
+      it "should test the repo url" do
+        env.set(:repo_url, "url")
+        backend.expects(:execute).with(:git, :'ls-remote', "url", "HEAD").returns(true)
+
+        subject.check_repo_is_reachable
+      end
+    end
+
+    describe "#clone_repo" do
+      it "should run git clone" do
+        env.set(:repo_url, "url")
+        env.set(:repo_path, "path")
+        backend.expects(:execute).with(:git, :clone, "--mirror", "url", "path")
+
+        subject.clone_repo
+      end
+
+      it "should run git clone in shallow mode" do
+        env.set(:git_shallow_clone, "1")
+        env.set(:repo_url, "url")
+        env.set(:repo_path, "path")
+
+        backend.expects(:execute).with(:git, :clone, "--mirror", "--depth", "1", "--no-single-branch", "url", "path")
+
+        subject.clone_repo
+      end
+
+      context "with username and password specified" do
+        before do
+          env.set(:git_http_username, "hello")
+          env.set(:git_http_password, "topsecret")
+          env.set(:repo_url, "https://example.com/repo.git")
+          env.set(:repo_path, "path")
+        end
+
+        it "should include the credentials in the url" do
+          backend.expects(:execute).with(:git, :clone, "--mirror", "https://hello:topsecret@example.com/repo.git", "path")
+          subject.clone_repo
+        end
+      end
+    end
+
+    describe "#update_mirror" do
+      it "should run git update" do
+        env.set(:repo_url, "url")
+
+        backend.expects(:execute).with(:git, :remote, "set-url", "origin", "url")
+        backend.expects(:execute).with(:git, :remote, :update, "--prune")
+
+        subject.update_mirror
+      end
+
+      it "should run git update in shallow mode" do
+        env.set(:git_shallow_clone, "1")
+        env.set(:branch, "branch")
+        env.set(:repo_url, "url")
+
+        backend.expects(:execute).with(:git, :remote, "set-url", "origin", "url")
+        backend.expects(:execute).with(:git, :fetch, "--depth", "1", "origin", "branch")
+
+        subject.update_mirror
+      end
+    end
+
+    describe "#archive_to_release_path" do
+      it "should run git archive without a subtree" do
+        env.set(:branch, "branch")
+        env.set(:release_path, "path")
+
+        backend.expects(:execute).with(:git, :archive, "branch", "| /usr/bin/env tar -x -f - -C", "path")
+
+        subject.archive_to_release_path
+      end
+
+      it "should run git archive with a subtree" do
+        env.set(:repo_tree, "tree")
+        env.set(:branch, "branch")
+        env.set(:release_path, "path")
+
+        backend.expects(:execute).with(:git, :archive, "branch", "tree", "| /usr/bin/env tar -x --strip-components 1 -f - -C", "path")
+
+        subject.archive_to_release_path
+      end
+
+      it "should run tar with an overridden name" do
+        env.set(:branch, "branch")
+        env.set(:release_path, "path")
+        SSHKit.config.command_map.expects(:[]).with(:tar).returns("/usr/bin/env gtar")
+
+        backend.expects(:execute).with(:git, :archive, "branch", "| /usr/bin/env gtar -x -f - -C", "path")
+
+        subject.archive_to_release_path
+      end
+    end
+
+    describe "#fetch_revision" do
+      it "should capture git rev-list" do
+        env.set(:branch, "branch")
+        backend.expects(:capture).with(:git, "rev-list --max-count=1 branch").returns("81cec13b777ff46348693d327fc8e7832f79bf43")
+        revision = subject.fetch_revision
+        expect(revision).to eq("81cec13b777ff46348693d327fc8e7832f79bf43")
+      end
+    end
+
+    describe "#verify_commit" do
+      it "should run git verify-commit" do
+        env.set(:branch, "branch")
+
+        backend.expects(:capture).with(:git, "rev-list --max-count=1 branch").returns("81cec13b777ff46348693d327fc8e7832f79bf43")
+        backend.expects(:execute).with(:git, :"verify-commit", "81cec13b777ff46348693d327fc8e7832f79bf43")
+
+        subject.verify_commit
+      end
+    end
+  end
+end

data/spec/lib/capistrano/scm/hg_spec.rb

@@ -0,0 +1,109 @@
+require "spec_helper"
+
+require "capistrano/scm/hg"
+
+module Capistrano
+  describe SCM::Hg do
+    subject { Capistrano::SCM::Hg.new }
+
+    # This allows us to easily use `set`, `fetch`, etc. in the examples.
+    let(:env) { Capistrano::Configuration.env }
+
+    # Stub the SSHKit backend so we can set up expectations without the plugin
+    # actually executing any commands.
+    let(:backend) { stub }
+    before { SSHKit::Backend.stubs(:current).returns(backend) }
+
+    # Mimic the deploy flow tasks so that the plugin can register its hooks.
+    before do
+      Rake::Task.define_task("deploy:new_release_path")
+      Rake::Task.define_task("deploy:check")
+      Rake::Task.define_task("deploy:set_current_revision")
+    end
+
+    # Clean up any tasks or variables that the plugin defined.
+    after do
+      Rake::Task.clear
+      Capistrano::Configuration.reset!
+    end
+
+    describe "#hg" do
+      it "should call execute hg in the context, with arguments" do
+        backend.expects(:execute).with(:hg, :init)
+        subject.hg(:init)
+      end
+    end
+
+    describe "#repo_mirror_exists?" do
+      it "should call test for repo HEAD" do
+        env.set(:repo_path, "/path/to/repo")
+        backend.expects(:test).with " [ -d /path/to/repo/.hg ] "
+
+        subject.repo_mirror_exists?
+      end
+    end
+
+    describe "#check_repo_is_reachable" do
+      it "should test the repo url" do
+        env.set(:repo_url, :url)
+        backend.expects(:execute).with(:hg, "id", :url)
+
+        subject.check_repo_is_reachable
+      end
+    end
+
+    describe "#clone_repo" do
+      it "should run hg clone" do
+        env.set(:repo_url, :url)
+        env.set(:repo_path, "path")
+
+        backend.expects(:execute).with(:hg, "clone", "--noupdate", :url, "path")
+
+        subject.clone_repo
+      end
+    end
+
+    describe "#update_mirror" do
+      it "should run hg update" do
+        backend.expects(:execute).with(:hg, "pull")
+
+        subject.update_mirror
+      end
+    end
+
+    describe "#archive_to_release_path" do
+      it "should run hg archive without a subtree" do
+        env.set(:branch, :branch)
+        env.set(:release_path, "path")
+
+        backend.expects(:execute).with(:hg, "archive", "path", "--rev", :branch)
+
+        subject.archive_to_release_path
+      end
+
+      it "should run hg archive with a subtree" do
+        env.set(:repo_tree, "tree")
+        env.set(:branch, :branch)
+        env.set(:release_path, "path")
+        env.set(:tmp_dir, "/tmp")
+
+        SecureRandom.stubs(:hex).with(10).returns("random")
+        backend.expects(:execute).with(:hg, "archive -p . -I", "tree", "--rev", :branch, "/tmp/random.tar")
+        backend.expects(:execute).with(:mkdir, "-p", "path")
+        backend.expects(:execute).with(:tar, "-x --strip-components 1 -f", "/tmp/random.tar", "-C", "path")
+        backend.expects(:execute).with(:rm, "/tmp/random.tar")
+
+        subject.archive_to_release_path
+      end
+    end
+
+    describe "#fetch_revision" do
+      it "should capture hg log" do
+        env.set(:branch, :branch)
+        backend.expects(:capture).with(:hg, "log --rev branch --template \"{node}\n\"").returns("01abcde")
+        revision = subject.fetch_revision
+        expect(revision).to eq("01abcde")
+      end
+    end
+  end
+end

data/spec/lib/capistrano/scm/svn_spec.rb

@@ -0,0 +1,137 @@
+require "spec_helper"
+
+require "capistrano/scm/svn"
+
+module Capistrano
+  describe SCM::Svn do
+    subject { Capistrano::SCM::Svn.new }
+
+    # This allows us to easily use `set`, `fetch`, etc. in the examples.
+    let(:env) { Capistrano::Configuration.env }
+
+    # Stub the SSHKit backend so we can set up expectations without the plugin
+    # actually executing any commands.
+    let(:backend) { stub }
+    before { SSHKit::Backend.stubs(:current).returns(backend) }
+
+    # Mimic the deploy flow tasks so that the plugin can register its hooks.
+    before do
+      Rake::Task.define_task("deploy:new_release_path")
+      Rake::Task.define_task("deploy:check")
+      Rake::Task.define_task("deploy:set_current_revision")
+    end
+
+    # Clean up any tasks or variables that the plugin defined.
+    after do
+      Rake::Task.clear
+      Capistrano::Configuration.reset!
+    end
+
+    describe "#svn" do
+      it "should call execute svn in the context, with arguments" do
+        env.set(:svn_username, "someuser")
+        env.set(:svn_password, "somepassword")
+        backend.expects(:execute).with(:svn, :init, "--username someuser", "--password somepassword")
+        subject.svn(:init)
+      end
+    end
+
+    describe "#repo_mirror_exists?" do
+      it "should call test for repo HEAD" do
+        env.set(:repo_path, "/path/to/repo")
+        backend.expects(:test).with " [ -d /path/to/repo/.svn ] "
+
+        subject.repo_mirror_exists?
+      end
+    end
+
+    describe "#check_repo_is_reachable" do
+      it "should test the repo url" do
+        env.set(:repo_url, :url)
+        env.set(:svn_username, "someuser")
+        env.set(:svn_password, "somepassword")
+        backend.expects(:test).with(:svn, :info, :url, "--username someuser", "--password somepassword").returns(true)
+
+        subject.check_repo_is_reachable
+      end
+    end
+
+    describe "#clone_repo" do
+      it "should run svn checkout" do
+        env.set(:repo_url, :url)
+        env.set(:repo_path, "path")
+        env.set(:svn_username, "someuser")
+        env.set(:svn_password, "somepassword")
+
+        backend.expects(:execute).with(:svn, :checkout, :url, "path", "--username someuser", "--password somepassword")
+
+        subject.clone_repo
+      end
+    end
+
+    describe "#update_mirror" do
+      it "should run svn update" do
+        env.set(:repo_url, "url")
+        env.set(:repo_path, "path")
+        backend.expects(:capture).with(:svn, :info, "path").returns("URL: url\n")
+
+        env.set(:svn_username, "someuser")
+        env.set(:svn_password, "somepassword")
+        backend.expects(:execute).with(:svn, :update, "--username someuser", "--password somepassword")
+
+        subject.update_mirror
+      end
+
+      context "for specific revision" do
+        it "should run svn update" do
+          env.set(:repo_url, "url")
+          env.set(:repo_path, "path")
+          backend.expects(:capture).with(:svn, :info, "path").returns("URL: url\n")
+
+          env.set(:svn_username, "someuser")
+          env.set(:svn_password, "somepassword")
+          env.set(:svn_revision, "12345")
+          backend.expects(:execute).with(:svn, :update, "--username someuser", "--password somepassword", "--revision 12345")
+
+          subject.update_mirror
+        end
+      end
+
+      it "should run svn switch if repo_url is changed" do
+        env.set(:repo_url, "url")
+        env.set(:repo_path, "path")
+        backend.expects(:capture).with(:svn, :info, "path").returns("URL: old_url\n")
+
+        env.set(:svn_username, "someuser")
+        env.set(:svn_password, "somepassword")
+        backend.expects(:execute).with(:svn, :switch, "url", "--username someuser", "--password somepassword")
+        backend.expects(:execute).with(:svn, :update, "--username someuser", "--password somepassword")
+
+        subject.update_mirror
+      end
+    end
+
+    describe "#archive_to_release_path" do
+      it "should run svn export" do
+        env.set(:release_path, "path")
+        env.set(:svn_username, "someuser")
+        env.set(:svn_password, "somepassword")
+
+        backend.expects(:execute).with(:svn, :export, "--force", ".", "path", "--username someuser", "--password somepassword")
+
+        subject.archive_to_release_path
+      end
+    end
+
+    describe "#fetch_revision" do
+      it "should capture svn version" do
+        env.set(:repo_path, "path")
+
+        backend.expects(:capture).with(:svnversion, "path").returns("12345")
+
+        revision = subject.fetch_revision
+        expect(revision).to eq("12345")
+      end
+    end
+  end
+end

data/spec/lib/capistrano/scm_spec.rb

@@ -1,13 +1,13 @@
-require 'spec_helper'
+require "spec_helper"
 
-require 'capistrano/scm'
+require "capistrano/scm"
 
 module RaiseNotImplementedMacro
   def raise_not_implemented_on(method)
     it "should raise NotImplemented on #{method}" do
-      expect {
+      expect do
         subject.send(method)
-      }.to raise_error(NotImplementedError)
+      end.to raise_error(NotImplementedError)
     end
   end
 end
@@ -26,7 +26,7 @@ module BlindStrategy; end
 
 module Capistrano
   describe SCM do
-    let(:context) { Class.new.new }
+    let(:context) { mock }
 
     describe "#initialize" do
       subject { Capistrano::SCM.new(context, DummyStrategy) }
@@ -63,8 +63,8 @@ module Capistrano
 
       describe "#release_path" do
         it "should return the release path according to the context" do
-          context.expects(:release_path).returns('/path/to/nowhere')
-          expect(subject.release_path).to eq('/path/to/nowhere')
+          context.expects(:release_path).returns("/path/to/nowhere")
+          expect(subject.release_path).to eq("/path/to/nowhere")
         end
       end
 
@@ -101,4 +101,3 @@ module Capistrano
     end
   end
 end
-

data/spec/lib/capistrano/upload_task_spec.rb

@@ -1,19 +1,19 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Capistrano::UploadTask do
   let(:app) { Rake.application = Rake::Application.new }
 
-  subject(:upload_task) { described_class.define_task('path/file.yml') }
+  subject(:upload_task) { described_class.define_task("path/file.yml") }
 
   it { is_expected.to be_a(Rake::FileCreationTask) }
   it { is_expected.to be_needed }
 
-  context 'inside namespace' do
-    let(:normal_task) { Rake::Task.define_task('path/other_file.yml') }
+  context "inside namespace" do
+    let(:normal_task) { Rake::Task.define_task("path/other_file.yml") }
 
-    around { |ex| app.in_namespace('namespace', &ex) }
+    around { |ex| app.in_namespace("namespace", &ex) }
 
-    it { expect(upload_task.name).to eq('path/file.yml') }
-    it { expect(upload_task.scope.path).to eq('namespace') }
+    it { expect(upload_task.name).to eq("path/file.yml") }
+    it { expect(upload_task.scope.path).to eq("namespace") }
   end
 end