capistrano 3.3.5 → 3.4.0

data/features/step_definitions/assertions.rb

@@ -106,10 +106,14 @@ When(/^an error is raised$/) do
   run_vagrant_command(test_file_exists(error))
 end
 
-Then(/contains "(.*?)" in the output/) do |expected|
+Then(/contains "([^"]*)" in the output/) do |expected|
   expect(@output).to include(expected)
 end
 
-Then(/doesn't contain "(.*?)" in the output/) do |expected|
+Then(/the output matches "([^"]*)" followed by "([^"]*)"/) do |expected, followedby|
+  expect(@output).to match(/#{expected}.*#{followedby}/m)
+end
+
+Then(/doesn't contain "([^"]*)" in the output/) do |expected|
   expect(@output).not_to include(expected)
 end

data/features/step_definitions/setup.rb

@@ -27,6 +27,10 @@ Given(/^a custom task to generate a file$/) do
   TestApp.copy_task_to_test_app('spec/support/tasks/database.rake')
 end
 
+Given(/^a task which executes as root$/) do
+  TestApp.copy_task_to_test_app('spec/support/tasks/root.rake')
+end
+
 Given(/config stage file has line "(.*?)"/) do |line|
   TestApp.append_to_deploy_file(line)
 end

data/lib/capistrano/configuration.rb

@@ -63,6 +63,10 @@ module Capistrano
       servers.roles_for(names)
     end
 
+    def role_properties_for(names, &block)
+      servers.role_properties_for(names, &block)
+    end
+
     def primary(role)
       servers.fetch_primary(role)
     end
@@ -82,7 +86,7 @@ module Capistrano
         sshkit.backend.configure do |backend|
           backend.pty                = fetch(:pty)
           backend.connection_timeout = fetch(:connection_timeout)
-          backend.ssh_options        = fetch(:ssh_options) if fetch(:ssh_options)
+          backend.ssh_options        = (backend.ssh_options || {}).merge(fetch(:ssh_options,{}))
         end
       end
     end

data/lib/capistrano/configuration/filter.rb

@@ -5,7 +5,7 @@ module Capistrano
     class Filter
       def initialize type, values = nil
         raise "Invalid filter type #{type}" unless [:host,:role].include? type
-        av = Array(values)
+        av = Array(values).dup
         @mode = case
                 when av.size == 0 then :none
                 when av.include?(:all) then :all
@@ -32,7 +32,7 @@ module Capistrano
               when Regexp then v
               else
                 vs = v.to_s
-                vs =~ %r{^/(.+)/$} ? Regexp.new($1) : vs
+                vs =~ %r{^/(.+)/$} ? Regexp.new($1) : %r{^#{vs}$}
               end
             end
             Regexp.union av

data/lib/capistrano/configuration/server.rb

@@ -25,8 +25,19 @@ module Capistrano
       end
 
       def select?(options)
-        selector = Selector.for(options)
-        selector.call(self)
+        options.each do |k,v|
+          callable = v.respond_to?(:call) ? v: ->(server){server.fetch(v)}
+          result = case k
+          when :filter, :select
+            callable.call(self)
+          when :exclude
+            !callable.call(self)
+          else
+            self.fetch(k) == v
+          end
+          return false unless result
+        end
+        return true
       end
 
       def primary
@@ -51,7 +62,7 @@ module Capistrano
       end
 
       def matches?(other)
-        user == other.user && hostname == other.hostname && port == other.port
+        hostname == other.hostname
       end
 
       private
@@ -87,7 +98,7 @@ module Capistrano
           @properties[key]
         end
 
-        def respond_to?(method)
+        def respond_to?(method, include_all=false)
           @properties.has_key?(method)
         end
 
@@ -115,55 +126,6 @@ module Capistrano
 
       end
 
-      class Selector
-        def initialize(options)
-          @options = options
-        end
-
-        def self.for(options)
-          if options.has_key?(:exclude)
-            Exclusive
-          else
-            self
-          end.new(options)
-        end
-
-        def callable
-          if key.respond_to?(:call)
-            key
-          else
-            ->(server) { server.fetch(key) }
-          end
-        end
-
-        def call(server)
-          callable.call(server)
-        end
-
-        private
-        attr_reader :options
-
-        def key
-          options[:filter] || options[:select] || all
-        end
-
-        def all
-          ->(server) { :all }
-        end
-
-        class Exclusive < Selector
-
-          def key
-            options[:exclude]
-          end
-
-          def call(server)
-            !callable.call(server)
-          end
-        end
-
-      end
-
     end
   end
 end

data/lib/capistrano/configuration/servers.rb

@@ -8,7 +8,14 @@ module Capistrano
       include Enumerable
 
       def add_host(host, properties={})
-        servers.add server(host).with(properties)
+        new_host = Server[host]
+        if server = servers.find { |s| s.matches? new_host }
+          server.user = new_host.user if new_host.user
+          server.port = new_host.port if new_host.port
+          server.with(properties)
+        else
+          servers << new_host.with(properties)
+        end
       end
 
       def add_role(role, hosts, options={})
@@ -22,6 +29,23 @@ module Capistrano
         s.select { |server| server.select?(options) }
       end
 
+      def role_properties_for(rolenames)
+        roles = rolenames.to_set
+        rps = Set.new unless block_given?
+        roles_for(rolenames).each do |host|
+          host.roles.intersection(roles).each do |role|
+            [host.properties.fetch(role)].flatten(1).each do |props|
+              if block_given?
+                yield host, role, props
+              else
+                rps << (props || {}).merge( role: role, hostname: host.hostname )
+              end
+            end
+          end
+        end
+        block_given? ? nil: rps
+      end
+
       def fetch_primary(role)
         hosts = roles_for([role])
         hosts.find(&:primary) || hosts.first
@@ -33,13 +57,8 @@ module Capistrano
 
       private
 
-      def server(host)
-        new_host = Server[host]
-        servers.find { |server| server.matches? new_host } || new_host
-      end
-
       def servers
-        @servers ||= Set.new
+        @servers ||= []
       end
 
       def extract_options(array)

data/lib/capistrano/deploy.rb

@@ -1,4 +1,3 @@
 require 'capistrano/framework'
-require 'capistrano-stats'
 
 load File.expand_path("../tasks/deploy.rake", __FILE__)

data/lib/capistrano/dsl.rb

@@ -51,8 +51,8 @@ module Capistrano
     end
 
     def on(hosts, options={}, &block)
-      subset = Configuration.env.filter hosts
-      SSHKit::Coordinator.new(subset).each(options, &block)
+      subset_copy = Marshal.dump(Configuration.env.filter(hosts))
+      SSHKit::Coordinator.new(Marshal.load(subset_copy)).each(options, &block)
     end
 
     def run_locally(&block)

data/lib/capistrano/dsl/env.rb

@@ -47,8 +47,16 @@ module Capistrano
         env.roles_for(names.flatten)
       end
 
+      def role_properties(*names, &block)
+        env.role_properties_for(names, &block)
+      end
+
       def release_roles(*names)
-        names << { exclude: :no_release } unless names.last.is_a? Hash
+        if names.last.is_a? Hash
+          names.last.merge!({ :exclude => :no_release })
+        else
+          names << { exclude: :no_release }
+        end
         roles(*names)
       end
 

data/lib/capistrano/dsl/paths.rb

@@ -54,7 +54,7 @@ module Capistrano
       end
 
       def repo_path
-        deploy_path.join('repo')
+        Pathname.new(fetch(:repo_path, ->(){deploy_path.join('repo')}))
       end
 
       def shared_path

data/lib/capistrano/git.rb

@@ -40,7 +40,7 @@ class Capistrano::Git < Capistrano::SCM
     end
 
     def fetch_revision
-      context.capture(:git, "rev-parse --short #{fetch(:branch)}")
+      context.capture(:git, "rev-list --max-count=1 --abbrev-commit #{fetch(:branch)}")
     end
   end
 end

data/lib/capistrano/tasks/deploy.rake

@@ -1,7 +1,6 @@
 namespace :deploy do
 
   task :starting do
-    invoke 'metrics:collect'
     invoke 'deploy:check'
     invoke 'deploy:set_previous_revision'
   end

data/lib/capistrano/templates/Capfile

@@ -23,5 +23,5 @@ require 'capistrano/deploy'
 # require 'capistrano/rails/migrations'
 # require 'capistrano/passenger'
 
-# Load custom tasks from `lib/capistrano/tasks' if you have any defined
+# 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

@@ -5,7 +5,7 @@ set :application, 'my_app_name'
 set :repo_url, 'git@example.com:me/my_repo.git'
 
 # Default branch is :master
-# ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }.call
+# 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'
@@ -23,10 +23,10 @@ set :repo_url, 'git@example.com:me/my_repo.git'
 # set :pty, true
 
 # Default value for :linked_files is []
-# set :linked_files, fetch(:linked_files, []).push('config/database.yml')
+# set :linked_files, fetch(:linked_files, []).push('config/database.yml', 'config/secrets.yml')
 
 # Default value for linked_dirs is []
-# set :linked_dirs, fetch(:linked_dirs, []).push('bin', 'log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'vendor/bundle', 'public/system')
+# set :linked_dirs, fetch(:linked_dirs, []).push('log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'vendor/bundle', 'public/system')
 
 # Default value for default_env is {}
 # set :default_env, { path: "/opt/ruby/bin:$PATH" }

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

@@ -1,27 +1,43 @@
-# Simple Role Syntax
+# server-based syntax
+# ======================
+# 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}
+
+
+
+# role-based syntax
 # ==================
-# Supports bulk-adding hosts to roles, the primary server in each group
-# is considered to be the first unless any hosts have the primary
-# property set.  Don't declare `role :all`, it's a meta role.
 
-role :app, %w{deploy@example.com}
-role :web, %w{deploy@example.com}
-role :db,  %w{deploy@example.com}
+# 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
+# property set. Specify the username and a domain or IP for the server.
+# Don't use `:all`, it's a meta role.
 
+# role :app, %w{deploy@example.com}, my_property: :my_value
+# role :web, %w{user1@primary.com user2@additional.com}, other_property: :other_value
+# role :db,  %w{deploy@example.com}
 
-# Extended Server Syntax
-# ======================
-# This can be used to drop a more detailed server definition into the
-# server list. The second argument is a, or duck-types, Hash and is
-# used to set extended properties on the server.
 
-server 'example.com', user: 'deploy', roles: %w{web app}, my_property: :my_value
+
+# Configuration
+# =============
+# You can set any configuration variable like in config/deploy.rb
+# These variables are then only loaded and set in this stage.
+# For available Capistrano configuration variables see the documentation page.
+# http://capistranorb.com/documentation/getting-started/configuration/
+# Feel free to add new variables to customise your setup.
+
 
 
 # Custom SSH Options
 # ==================
 # You may pass any option but keep in mind that net/ssh understands a
-# limited set of options, consult[net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start).
+# limited set of options, consult the Net::SSH documentation.
+# http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start
 #
 # Global options
 # --------------
@@ -31,7 +47,7 @@ server 'example.com', user: 'deploy', roles: %w{web app}, my_property: :my_value
 #    auth_methods: %w(password)
 #  }
 #
-# And/or per server (overrides global)
+# The server-based syntax can be used to override options:
 # ------------------------------------
 # server 'example.com',
 #   user: 'user_name',

data/lib/capistrano/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  VERSION = "3.3.5"
+  VERSION = "3.4.0"
 end

data/spec/integration/dsl_spec.rb

@@ -15,7 +15,7 @@ describe Capistrano::DSL do
         dsl.server 'example2.com', roles: %w{web}
         dsl.server 'example3.com', roles: %w{app web}, active: true
         dsl.server 'example4.com', roles: %w{app}, primary: true
-        dsl.server 'example5.com', roles: %w{db}, no_release: true
+        dsl.server 'example5.com', roles: %w{db}, no_release: true, active:true
       end
 
       describe 'fetching all servers' do
@@ -241,23 +241,43 @@ describe Capistrano::DSL do
       end
 
       describe 'fetching all servers' do
-        subject { dsl.roles(:all).map { |server| "#{server.user}@#{server.hostname}:#{server.port}" } }
-
-        it 'creates a server instance for each unique user@host:port combination' do
-          expect(subject).to eq %w{db@example1.com:1234 root@example1.com:1234 @example1.com:5678 deployer@example1.com:1234}
+        it 'creates one server per hostname, ignoring user and port combinations' do
+          expect(dsl.roles(:all).size).to eq(1)
         end
       end
 
       describe 'fetching servers for a role' do
         it 'roles defined using the `server` syntax are included' do
-          expect(dsl.roles(:web).size).to eq(2)
+          as = dsl.roles(:web).map { |server| "#{server.user}@#{server.hostname}:#{server.port}" }
+          expect(as.size).to eq(1)
+          expect(as[0]).to eq("deployer@example1.com:5678")
         end
 
         it 'roles defined using the `role` syntax are included' do
-          expect(dsl.roles(:app).size).to eq(2)
+          as = dsl.roles(:app).map { |server| "#{server.user}@#{server.hostname}:#{server.port}" }
+          expect(as.size).to eq(1)
+          expect(as[0]).to eq("deployer@example1.com:5678")
+        end
+      end
+
+    end
+
+    describe 'when setting user and port' do
+      subject { dsl.roles(:all).map { |server| "#{server.user}@#{server.hostname}:#{server.port}" }.first }
+
+      describe "using the :user property" do
+        it "takes precedence over in the host string" do
+          dsl.server 'db@example1.com:1234', roles: %w{db}, active: true, user: 'brian'
+          expect(subject).to eq("brian@example1.com:1234")
         end
       end
 
+      describe "using the :port property" do
+        it "takes precedence over in the host string" do
+          dsl.server 'db@example1.com:9090', roles: %w{db}, active: true, port: 1234
+          expect(subject).to eq("db@example1.com:1234")
+        end
+      end
     end
 
   end
@@ -415,112 +435,6 @@ describe Capistrano::DSL do
 
   end
 
-  describe 'release path' do
-
-    before do
-      dsl.set(:deploy_to, '/var/www')
-    end
-
-    describe 'fetching release path' do
-      subject { dsl.release_path }
-
-      context 'where no release path has been set' do
-        before do
-          dsl.delete(:release_path)
-        end
-
-        it 'returns the `current_path` value' do
-          expect(subject.to_s).to eq '/var/www/current'
-        end
-      end
-
-      context 'where the release path has been set' do
-        before do
-          dsl.set(:release_path, '/var/www/release_path')
-        end
-
-        it 'returns the set `release_path` value' do
-          expect(subject.to_s).to eq '/var/www/release_path'
-        end
-      end
-    end
-
-    describe 'setting release path' do
-      let(:now) { Time.parse("Oct 21 16:29:00 2015") }
-      subject { dsl.release_path }
-
-      context 'without a timestamp' do
-        before do
-          dsl.env.expects(:timestamp).returns(now)
-          dsl.set_release_path
-        end
-
-        it 'returns the release path with the current env timestamp' do
-          expect(subject.to_s).to eq '/var/www/releases/20151021162900'
-        end
-      end
-
-      context 'with a timestamp' do
-        before do
-          dsl.set_release_path('timestamp')
-        end
-
-        it 'returns the release path with the timestamp' do
-          expect(subject.to_s).to eq '/var/www/releases/timestamp'
-        end
-      end
-    end
-
-    describe 'setting deploy configuration path' do
-      subject { dsl.deploy_config_path.to_s }
-
-      context 'where no config path is set' do
-        before do
-          dsl.delete(:deploy_config_path)
-        end
-
-        it 'returns "config/deploy.rb"' do
-          expect(subject).to eq 'config/deploy.rb'
-        end
-      end
-
-      context 'where a custom path is set' do
-        before do
-          dsl.set(:deploy_config_path, 'my/custom/path.rb')
-        end
-
-        it 'returns the custom path' do
-          expect(subject).to eq 'my/custom/path.rb'
-        end
-      end
-    end
-
-    describe 'setting stage configuration path' do
-      subject { dsl.stage_config_path.to_s }
-
-      context 'where no config path is set' do
-
-        before do
-          dsl.delete(:stage_config_path)
-        end
-
-        it 'returns "config/deploy"' do
-          expect(subject).to eq 'config/deploy'
-        end
-      end
-
-      context 'where a custom path is set' do
-        before do
-          dsl.set(:stage_config_path, 'my/custom/path')
-        end
-
-        it 'returns the custom path' do
-          expect(subject).to eq 'my/custom/path'
-        end
-      end
-    end
-  end
-
   describe 'local_user' do
     before do
       dsl.set :local_user, -> { Etc.getlogin }
@@ -607,4 +521,63 @@ describe Capistrano::DSL do
 
   end
 
+  describe 'role_properties()' do
+
+    before do
+      dsl.role :redis, %w[example1.com example2.com], redis: { port: 6379, type: :slave }
+      dsl.server 'example1.com', roles: %w{web}, active: true, web: { port: 80 }
+      dsl.server 'example2.com', roles: %w{web redis}, web: { port: 81 }, redis: { type: :master }
+      dsl.server 'example3.com', roles: %w{app}, primary: true
+    end
+
+    it 'retrieves properties for a single role as a set' do
+      rps = dsl.role_properties(:app)
+      expect(rps).to eq(Set[{ hostname: 'example3.com', role: :app}])
+    end
+
+    it 'retrieves properties for multiple roles as a set' do
+      rps = dsl.role_properties(:app, :web)
+      expect(rps).to eq(Set[{ hostname: 'example3.com', role: :app},{ hostname: 'example1.com', role: :web, port: 80},{ hostname: 'example2.com', role: :web, port: 81}])
+    end
+
+    it 'yields the properties for a single role' do
+      recipient = mock('recipient')
+      recipient.expects(:doit).with('example1.com', :redis, { port: 6379, type: :slave})
+      recipient.expects(:doit).with('example2.com', :redis, { port: 6379, type: :master})
+      dsl.role_properties(:redis) do |host, role, props|
+        recipient.doit(host, role, props)
+      end
+    end
+
+    it 'yields the properties for multiple roles' do
+      recipient = mock('recipient')
+      recipient.expects(:doit).with('example1.com', :redis, { port: 6379, type: :slave})
+      recipient.expects(:doit).with('example2.com', :redis, { port: 6379, type: :master})
+      recipient.expects(:doit).with('example3.com', :app, nil)
+      dsl.role_properties(:redis, :app) do |host, role, props|
+        recipient.doit(host, role, props)
+      end
+    end
+
+    it 'yields the merged properties for multiple roles' do
+      recipient = mock('recipient')
+      recipient.expects(:doit).with('example1.com', :redis, { port: 6379, type: :slave})
+      recipient.expects(:doit).with('example2.com', :redis, { port: 6379, type: :master})
+      recipient.expects(:doit).with('example1.com', :web, { port: 80 })
+      recipient.expects(:doit).with('example2.com', :web, { port: 81 })
+      dsl.role_properties(:redis, :web) do |host, role, props|
+        recipient.doit(host, role, props)
+      end
+    end
+
+    it 'honours a property filter before yielding' do
+      recipient = mock('recipient')
+      recipient.expects(:doit).with('example1.com', :redis, { port: 6379, type: :slave})
+      recipient.expects(:doit).with('example1.com', :web, { port: 80 })
+      dsl.role_properties(:redis, :web, select: :active) do |host, role, props|
+        recipient.doit(host, role, props)
+      end
+    end
+  end
+
 end