capistrano 3.6.1 → 3.7.0.beta1

data/lib/capistrano/setup.rb

@@ -27,7 +27,7 @@ stages.each do |stage|
       load deploy_config_path
       load stage_config_path.join("#{stage}.rb")
     end
-    load "capistrano/#{fetch(:scm)}.rb"
+    configure_scm
     I18n.locale = fetch(:locale, :en)
     configure_backend
   end

data/lib/capistrano/tasks/deploy.rake

@@ -26,7 +26,6 @@ namespace :deploy do
   end
 
   task updating: :new_release_path do
-    invoke "#{scm}:create_release"
     invoke "deploy:set_current_revision"
     invoke "deploy:symlink:shared"
   end
@@ -53,7 +52,6 @@ namespace :deploy do
 
   desc "Check required files and directories exist"
   task :check do
-    invoke "#{scm}:check"
     invoke "deploy:check:directories"
     invoke "deploy:check:linked_dirs"
     invoke "deploy:check:make_linked_dirs"
@@ -225,7 +223,6 @@ namespace :deploy do
 
   desc "Place a REVISION file with the current revision SHA in the current release path"
   task :set_current_revision  do
-    invoke "#{scm}:set_current_revision"
     on release_roles(:all) do
       within release_path do
         execute :echo, "\"#{fetch(:current_revision)}\" >> REVISION"

data/lib/capistrano/templates/Capfile

@@ -4,6 +4,17 @@ require "capistrano/setup"
 # Include default deployment tasks
 require "capistrano/deploy"
 
+# Load the SCM plugin appropriate to your project:
+#
+# require "capistrano/scm/hg"
+# install_plugin Capistrano::SCM::Hg
+# or
+# require "capistrano/scm/svn"
+# install_plugin Capistrano::SCM::Svn
+# or
+require "capistrano/scm/git"
+install_plugin Capistrano::SCM::Git
+
 # Include tasks from other gems included in your Gemfile
 #
 # For documentation on these, see for example:
@@ -15,13 +26,13 @@ require "capistrano/deploy"
 #   https://github.com/capistrano/rails
 #   https://github.com/capistrano/passenger
 #
-# require 'capistrano/rvm'
-# require 'capistrano/rbenv'
-# require 'capistrano/chruby'
-# require 'capistrano/bundler'
-# require 'capistrano/rails/assets'
-# require 'capistrano/rails/migrations'
-# require 'capistrano/passenger'
+# require "capistrano/rvm"
+# require "capistrano/rbenv"
+# require "capistrano/chruby"
+# require "capistrano/bundler"
+# require "capistrano/rails/assets"
+# require "capistrano/rails/migrations"
+# require "capistrano/passenger"
 
 # Load custom tasks from `lib/capistrano/tasks` if you have any defined
 Dir.glob("lib/capistrano/tasks/*.rake").each { |r| import r }

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

@@ -1,33 +1,30 @@
 # config valid only for current version of Capistrano
-lock '<%= Capistrano::VERSION %>'
+lock "<%= Capistrano::VERSION %>"
 
-set :application, 'my_app_name'
-set :repo_url, 'git@example.com:me/my_repo.git'
+set :application, "my_app_name"
+set :repo_url, "git@example.com:me/my_repo.git"
 
 # Default branch is :master
 # ask :branch, `git rev-parse --abbrev-ref HEAD`.chomp
 
 # Default deploy_to directory is /var/www/my_app_name
-# set :deploy_to, '/var/www/my_app_name'
-
-# Default value for :scm is :git
-# set :scm, :git
+# set :deploy_to, "/var/www/my_app_name"
 
 # Default value for :format is :airbrussh.
 # set :format, :airbrussh
 
 # You can configure the Airbrussh format using :format_options.
 # These are the defaults.
-# set :format_options, command_output: true, log_file: 'log/capistrano.log', color: :auto, truncate: :auto
+# set :format_options, command_output: true, log_file: "log/capistrano.log", color: :auto, truncate: :auto
 
 # Default value for :pty is false
 # set :pty, true
 
 # Default value for :linked_files is []
-# append :linked_files, 'config/database.yml', 'config/secrets.yml'
+# append :linked_files, "config/database.yml", "config/secrets.yml"
 
 # Default value for linked_dirs is []
-# append :linked_dirs, 'log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'public/system'
+# append :linked_dirs, "log", "tmp/pids", "tmp/cache", "tmp/sockets", "public/system"
 
 # Default value for default_env is {}
 # set :default_env, { path: "/opt/ruby/bin:$PATH" }

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}
 
 
 
@@ -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.1".freeze
+  VERSION = "3.7.0.beta1".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/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