capistrano 3.6.0 → 3.7.0

data/lib/capistrano/templates/stage.rb.erb

@@ -3,9 +3,9 @@
 # Defines a single server with a list of roles and multiple properties.
 # You can define all roles on a single server, or split them:
 
-# server 'example.com', user: 'deploy', roles: %w{app db web}, my_property: :my_value
-# server 'example.com', user: 'deploy', roles: %w{app web}, other_property: :other_value
-# server 'db.example.com', user: 'deploy', roles: %w{db}
+# server "example.com", user: "deploy", roles: %w{app db web}, my_property: :my_value
+# server "example.com", user: "deploy", roles: %w{app web}, other_property: :other_value
+# server "db.example.com", user: "deploy", roles: %w{db}
 
 
 
@@ -13,7 +13,7 @@
 # ==================
 
 # Defines a role with one or multiple servers. The primary server in each
-# group is considered to be the first unless any  hosts have the primary
+# group is considered to be the first unless any hosts have the primary
 # property set. Specify the username and a domain or IP for the server.
 # Don't use `:all`, it's a meta role.
 
@@ -49,13 +49,13 @@
 #
 # The server-based syntax can be used to override options:
 # ------------------------------------
-# server 'example.com',
-#   user: 'user_name',
+# server "example.com",
+#   user: "user_name",
 #   roles: %w{web app},
 #   ssh_options: {
-#     user: 'user_name', # overrides user setting above
+#     user: "user_name", # overrides user setting above
 #     keys: %w(/home/user_name/.ssh/id_rsa),
 #     forward_agent: false,
 #     auth_methods: %w(publickey password)
-#     # password: 'please use keys'
+#     # password: "please use keys"
 #   }

data/lib/capistrano/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  VERSION = "3.6.0".freeze
+  VERSION = "3.7.0".freeze
 end

data/lib/capistrano/version_validator.rb

@@ -5,11 +5,8 @@ module Capistrano
     end
 
     def verify
-      if match?
-        self
-      else
-        raise "Capfile locked at #{version}, but #{current_version} is loaded"
-      end
+      return self if match?
+      raise "Capfile locked at #{version}, but #{current_version} is loaded"
     end
 
     private

data/spec/lib/capistrano/configuration/host_filter_spec.rb

@@ -55,6 +55,11 @@ module Capistrano
           let(:values) { 'server\d{1,3}$' }
           it_behaves_like "it filters hosts correctly", %w{server1 server2 server3 server4 server5}
         end
+
+        context "without number" do
+          let(:values) { "server" }
+          it_behaves_like "it filters hosts correctly", %w{}
+        end
       end
     end
   end

data/spec/lib/capistrano/configuration/plugin_installer_spec.rb

@@ -0,0 +1,98 @@
+require "spec_helper"
+require "capistrano/plugin"
+require "capistrano/scm/plugin"
+
+module Capistrano
+  class Configuration
+    class ExamplePlugin < Capistrano::Plugin
+      def set_defaults
+        set_if_empty :example_variable, "foo"
+      end
+
+      def define_tasks
+        task :example
+        task :example_prerequisite
+      end
+
+      def register_hooks
+        before :example, :example_prerequisite
+      end
+    end
+
+    class ExampleSCMPlugin < Capistrano::SCM::Plugin
+    end
+
+    describe PluginInstaller do
+      include Capistrano::DSL
+
+      let(:installer) { PluginInstaller.new }
+      let(:options) { {} }
+      let(:plugin) { ExamplePlugin.new }
+
+      before do
+        installer.install(plugin, **options)
+      end
+
+      after do
+        Rake::Task.clear
+        Capistrano::Configuration.reset!
+      end
+
+      context "installing plugin" do
+        it "defines tasks" do
+          expect(Rake::Task[:example]).to_not be_nil
+          expect(Rake::Task[:example_prerequisite]).to_not be_nil
+        end
+
+        it "registers hooks" do
+          task = Rake::Task[:example]
+          expect(task.prerequisites).to eq([:example_prerequisite])
+        end
+
+        it "sets defaults when load:defaults is invoked" do
+          expect(fetch(:example_variable)).to be_nil
+          invoke "load:defaults"
+          expect(fetch(:example_variable)).to eq("foo")
+        end
+
+        it "doesn't say an SCM is installed" do
+          expect(installer.scm_installed?).to be_falsey
+        end
+      end
+
+      context "installing plugin class" do
+        let(:plugin) { ExamplePlugin }
+
+        it "defines tasks" do
+          expect(Rake::Task[:example]).to_not be_nil
+          expect(Rake::Task[:example_prerequisite]).to_not be_nil
+        end
+      end
+
+      context "installing plugin without hooks" do
+        let(:options) { { load_hooks: false } }
+
+        it "doesn't register hooks" do
+          task = Rake::Task[:example]
+          expect(task.prerequisites).to be_empty
+        end
+      end
+
+      context "installing plugin and loading immediately" do
+        let(:options) { { load_immediately: true } }
+
+        it "sets defaults immediately" do
+          expect(fetch(:example_variable)).to eq("foo")
+        end
+      end
+
+      context "installing an SCM plugin" do
+        let(:plugin) { ExampleSCMPlugin }
+
+        it "says an SCM is installed" do
+          expect(installer.scm_installed?).to be_truthy
+        end
+      end
+    end
+  end
+end

data/spec/lib/capistrano/configuration/role_filter_spec.rb

@@ -11,7 +11,8 @@ module Capistrano
           Server.new("server2").add_role(:web),
           Server.new("server3").add_role(:redis),
           Server.new("server4").add_role(:db),
-          Server.new("server5").add_role(:stageweb)
+          Server.new("server5").add_role(:stageweb),
+          Server.new("server6").add_role(:"db.new")
         ]
       end
 
@@ -58,6 +59,21 @@ module Capistrano
           let(:values) { "db,/red/" }
           it_behaves_like "it filters roles correctly", 3, %w{server1 server3 server4}
         end
+
+        context "with a dot wildcard" do
+          let(:values) { "db.*" }
+          it_behaves_like "it filters roles correctly", 0, %w{}
+        end
+
+        context "with a dot" do
+          let(:values) { "db.new" }
+          it_behaves_like "it filters roles correctly", 1, %w{server6}
+        end
+
+        context "with a dot wildcard regex" do
+          let(:values) { "/db.*/" }
+          it_behaves_like "it filters roles correctly", 3, %w{server1 server4 server6}
+        end
       end
     end
   end

data/spec/lib/capistrano/configuration_spec.rb

@@ -154,19 +154,29 @@ module Capistrano
           config.set(:key, "longer_value")
         end
 
-        it "validates proc without error" do
+        it "validates block without error" do
           config.set(:key) { "longer_value" }
           expect(config.fetch(:key)).to eq "longer_value"
         end
 
+        it "validates lambda without error" do
+          config.set :key, -> { "longer_value" }
+          expect(config.fetch(:key)).to eq "longer_value"
+        end
+
         it "raises an exception on invalid string" do
           expect { config.set(:key, "sho") }.to raise_error(Capistrano::ValidationError)
         end
 
-        it "raises an exception on invalid string provided by proc" do
+        it "raises an exception on invalid string provided by block" do
           config.set(:key) { "sho" }
           expect { config.fetch(:key) }.to raise_error(Capistrano::ValidationError)
         end
+
+        it "raises an exception on invalid string provided by lambda" do
+          config.set :key, -> { "sho" }
+          expect { config.fetch(:key) }.to raise_error(Capistrano::ValidationError)
+        end
       end
 
       context "appending" do
@@ -294,5 +304,54 @@ module Capistrano
         expect(config.dry_run?).to eq(true)
       end
     end
+
+    describe "custom filtering" do
+      it "accepts a custom filter object" do
+        filter = Object.new
+        def filter.filter(servers)
+          servers
+        end
+        config.add_filter(filter)
+      end
+
+      it "accepts a custom filter as a block" do
+        config.add_filter { |servers| servers }
+      end
+
+      it "raises an error if passed a block and an object" do
+        filter = Object.new
+        def filter.filter(servers)
+          servers
+        end
+
+        expect { config.add_filter(filter) { |servers| servers } }.to raise_error(ArgumentError)
+      end
+
+      it "raises an error if the filter lacks a filter method" do
+        filter = Object.new
+        expect { config.add_filter(filter) }.to raise_error(TypeError)
+      end
+
+      it "calls the filter method of a custom filter" do
+        ENV.delete "ROLES"
+        ENV.delete "HOSTS"
+
+        servers = Configuration::Servers.new
+
+        servers.add_host("test1")
+        servers.add_host("test2")
+        servers.add_host("test3")
+
+        filtered_servers = servers.take(2)
+
+        filter = mock("custom filter")
+        filter.expects(:filter)
+              .with { |subset| subset.is_a? Configuration::Servers }
+              .returns(filtered_servers)
+
+        config.add_filter(filter)
+        expect(config.filter(servers)).to eq(filtered_servers)
+      end
+    end
   end
 end

data/spec/lib/capistrano/doctor/variables_doctor_spec.rb

@@ -15,7 +15,6 @@ module Capistrano
         env.variables.untrusted! do
           set :application, "my_app"
           set :repo_url, ".git"
-          set :git_strategy, "Capistrano::Git::DefaultStrategy"
           set :copy_strategy, :scp
           set :custom_setting, "hello"
           set "string_setting", "hello"
@@ -57,12 +56,6 @@ module Capistrano
           .to_stdout
       end
 
-      it "does not print warning for the whitelisted git_strategy variable" do
-        expect { doc.call }.not_to \
-          output(/:git_strategy is not a recognized Capistrano setting/)\
-          .to_stdout
-      end
-
       describe "Rake" do
         before do
           load File.expand_path("../../../../../lib/capistrano/doctor.rb",

data/spec/lib/capistrano/dsl/task_enhancements_spec.rb

@@ -104,20 +104,5 @@ module Capistrano
         expect { Rake::Task["task"].invoke order }.to raise_error(ArgumentError, 'Task "non_existent_task" not found')
       end
     end
-
-    describe "remote_file" do
-      subject(:remote_file) { task_enhancements.remote_file("source" => "destination") }
-
-      it { expect(remote_file.name).to eq("source") }
-      it { is_expected.to be_a(Capistrano::UploadTask) }
-
-      describe "namespaced" do
-        let(:app) { Rake.application }
-        around { |ex| app.in_namespace("namespace", &ex) }
-
-        it { expect(remote_file.name).to eq("source") }
-        it { is_expected.to be_a(Capistrano::UploadTask) }
-      end
-    end
   end
 end

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

@@ -0,0 +1,131 @@
+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 "#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 --heads', "url").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
+    end
+
+    describe "#update_mirror" do
+      it "should run git update" do
+        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")
+        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
+  end
+end

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

@@ -0,0 +1,104 @@
+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")
+
+        backend.expects(:execute).with(:hg, "archive --type tgz -p . -I", "tree", "--rev", :branch, "| tar -x --strip-components 1 -f - -C", "path")
+
+        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,116 @@
+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(: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(: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
+    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