capistrano 3.0.0.pre2 → 3.0.0.pre3

data/lib/capistrano/dsl.rb

@@ -34,5 +34,7 @@ module Capistrano
     def local_user
       `whoami`
     end
+
   end
 end
+self.extend Capistrano::DSL

data/lib/capistrano/dsl/env.rb

@@ -12,7 +12,7 @@ module Capistrano
 
       def any?(key)
         value = fetch(key)
-        if value.respond_to?(:any)
+        if value && value.respond_to?(:any?)
           value.any?
         else
           !fetch(key).nil?
@@ -27,8 +27,12 @@ module Capistrano
         env.ask(key, value)
       end
 
-      def role(name, servers)
-        env.role(name, servers)
+      def role(name, servers, options={})
+        env.role(name, servers, options)
+      end
+
+      def server(name, properties={})
+        env.server(name, properties)
       end
 
       def roles(*names)
@@ -54,4 +58,3 @@ module Capistrano
     end
   end
 end
-

data/lib/capistrano/i18n.rb

@@ -13,11 +13,12 @@ en = {
   stage_not_set:               'Stage not set, please call something such as `cap production deploy`, where production is a stage you have defined.',
   written_file:                'create %{file}',
   question:                    'Please enter %{key}: |%{default_value}|',
-  keeping_releases:            'Keeping %{keep_releases} of %{releases} deployed releases',
+  keeping_releases:            'Keeping %{keep_releases} of %{releases} deployed releases on %{host}',
   linked_file_does_not_exist:  'linked file %{file} does not exist on %{host}',
   mirror_exists:               "The repository mirror is at %{at}",
   revision_log_message:        'Branch %{branch} deployed as release %{release} by %{user}',
   rollback_log_message:        '%{user} rolled back to release %{release}',
+  filter_removes_all_servers:  'Your filter `:%{filter}` would remove all matching servers',
   console: {
     welcome:  'capistrano console - enter command to execute on %{stage}',
     bye:      'bye'

data/lib/capistrano/tasks/deploy.rake

@@ -112,13 +112,10 @@ namespace :deploy do
 
   desc 'Clean up old releases'
   task :cleanup do
-    releases = on primary :app do
-      capture(:ls, '-xt', releases_path).split.reverse
-    end
-
-    on roles :all do
+    on roles :all do |host|
+      releases = capture(:ls, '-xt', releases_path).split.reverse
       if releases.count >= fetch(:keep_releases)
-        info t(:keeping_releases, keep_releases: fetch(:keep_releases), releases: releases.count)
+        info t(:keeping_releases, host: host.to_s, keep_releases: fetch(:keep_releases), releases: releases.count)
         directories = (releases - releases.last(fetch(:keep_releases))).map { |release|
           releases_path.join(release) }.join(" ")
         execute :rm, '-rf', directories

data/lib/capistrano/templates/Capfile

@@ -8,10 +8,14 @@ require 'capistrano/deploy'
 #
 # For documentation on these, see for example:
 #
+#   https://github.com/capistrano/rvm
+#   https://github.com/capistrano/rbenv
 #   https://github.com/capistrano/bundler
 #   https://github.com/capistrano/rails/tree/master/assets
 #   https://github.com/capistrano/rails/tree/master/migrations
 #
+# require 'capistrano/rvm'
+# require 'capistrano/rbenv'
 # require 'capistrano/bundler'
 # require 'capistrano/rails/assets'
 # require 'capistrano/rails/migrations'

data/lib/capistrano/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  VERSION = "3.0.0.pre2"
+  VERSION = "3.0.0.pre3"
 end

data/spec/integration/deploy_finalize_spec.rb

@@ -0,0 +1,34 @@
+require 'integration_spec_helper'
+
+describe 'cap deploy:finished', slow: true do
+  before do
+    install_test_app_with(config)
+  end
+
+  describe 'deploy' do
+    let(:config) {
+      %{
+        set :stage, :#{stage}
+        set :deploy_to, '#{deploy_to}'
+        set :repo, 'git://github.com/capistrano/capistrano.git'
+        set :branch, 'v3'
+        server 'localhost', roles: %w{web app}, user: '#{current_user}'
+        set :linked_files, %w{config/database.yml}
+        set :linked_dirs, %w{bin log public/system vendor/bundle}
+        }
+    }
+
+    describe 'log_revision' do
+      before do
+        cap 'deploy:started'
+        cap 'deploy:update'
+        cap 'deploy:finalize'
+        cap 'deploy:finished'
+      end
+
+      it 'writes the log file' do
+        expect(deploy_to.join('revisions.log')).to be_a_file
+      end
+    end
+  end
+end

data/spec/integration/deploy_finished_spec.rb

@@ -0,0 +1,36 @@
+require 'integration_spec_helper'
+
+describe 'cap deploy:finished', slow: true do
+  before do
+    install_test_app_with(config)
+  end
+
+  describe 'deploy' do
+    let(:config) {
+      %{
+        set :stage, :#{stage}
+        set :deploy_to, '#{deploy_to}'
+        set :repo, 'git://github.com/capistrano/capistrano.git'
+        set :branch, 'v3'
+        server 'localhost', roles: %w{web app}, user: '#{current_user}'
+        set :linked_files, %w{config/database.yml}
+        set :linked_dirs, %w{bin log public/system vendor/bundle}
+        }
+    }
+
+    describe 'symlink' do
+      before do
+        cap 'deploy:started'
+        cap 'deploy:update'
+        cap 'deploy:finalize'
+      end
+
+      describe 'release' do
+        it 'symlinks the release to `current`' do
+          expect(File.symlink?(current_path)).to be_true
+          expect(File.readlink(current_path)).to match /\/tmp\/test_app\/deploy_to\/releases\/\d{14}/
+        end
+      end
+    end
+  end
+end

data/spec/integration/deploy_started_spec.rb

@@ -0,0 +1,74 @@
+require 'integration_spec_helper'
+
+describe 'cap deploy:started', slow: true do
+  before do
+    install_test_app_with(config)
+  end
+
+  describe 'deploy:check' do
+    let(:config) {
+      %{
+        set :stage, :#{stage}
+        set :deploy_to, '#{deploy_to}'
+        set :repo, 'git://github.com/capistrano/capistrano.git'
+        set :branch, 'v3'
+        server 'localhost', roles: %w{web app}, user: '#{current_user}'
+        set :linked_files, %w{config/database.yml}
+        set :linked_dirs, %w{bin log public/system vendor/bundle}
+      }
+    }
+
+    describe 'directories' do
+      before do
+        cap 'deploy:check:directories'
+      end
+
+      it 'ensures the directory structure' do
+        expect(shared_path).to be_a_directory
+        expect(releases_path).to be_a_directory
+      end
+    end
+
+    describe 'linked_dirs' do
+      before do
+        cap 'deploy:check:linked_dirs'
+      end
+
+      it 'ensure directories to be linked in `shared`' do
+        [
+          shared_path.join('bin'),
+          shared_path.join('log'),
+          shared_path.join('public/system'),
+          shared_path.join('vendor/bundle'),
+        ].each do |dir|
+          expect(dir).to be_a_directory
+        end
+      end
+    end
+
+    describe 'linked_files' do
+
+      subject { cap 'deploy:check:linked_files' }
+
+      context 'file does not exist' do
+        it 'fails' do
+          expect(subject).to match 'config/database.yml does not exist'
+        end
+      end
+
+      context 'file exists' do
+        before do
+          create_shared_directory('config')
+          create_shared_file('config/database.yml')
+        end
+
+        it 'suceeds' do
+          expect(subject).not_to match 'config/database.yml does not exist'
+          expect(subject).to match 'successful'
+        end
+
+      end
+    end
+  end
+end
+

data/spec/integration/deploy_update_spec.rb

@@ -0,0 +1,45 @@
+require 'integration_spec_helper'
+
+describe 'cap deploy:update', slow: true do
+  before do
+    install_test_app_with(config)
+  end
+
+  describe 'deploy' do
+    let(:config) {
+      %{
+        set :stage, :#{stage}
+        set :deploy_to, '#{deploy_to}'
+        set :repo, 'git://github.com/capistrano/capistrano.git'
+        set :branch, 'v3'
+        server 'localhost', roles: %w{web app}, user: '#{current_user}'
+        set :linked_files, %w{config/database.yml}
+        set :linked_dirs, %w{bin log public/system vendor/bundle}
+        }
+    }
+
+    describe 'symlink' do
+      before do
+        cap 'deploy:started'
+        create_shared_directory('config')
+        create_shared_file('config/database.yml')
+        cap 'deploy:symlink:shared'
+      end
+
+      describe 'linked_dirs' do
+        it 'symlinks the directories in shared to `current`' do
+          %w{bin log public/system vendor/bundle}.each do |dir|
+            expect(release_path.join(dir)).to be_a_symlink_to shared_path.join(dir)
+          end
+        end
+      end
+
+      describe 'linked_files' do
+        it 'symlinks the files in shared to `current`' do
+          file = 'config/database.yml'
+          expect(release_path.join(file)).to be_a_symlink_to shared_path.join(file)
+        end
+      end
+    end
+  end
+end

data/spec/integration/dsl_spec.rb

@@ -0,0 +1,254 @@
+require 'spec_helper'
+
+describe Capistrano::DSL do
+
+  let(:dsl) { Class.new.extend Capistrano::DSL }
+
+  describe 'setting and fetching hosts' do
+    describe 'when defining a host using the `server` syntax' do
+      before do
+        dsl.server 'example1.com', roles: %w{web}, active: true
+        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
+      end
+
+      describe 'fetching all servers' do
+        subject { dsl.roles(:all) }
+
+        it 'returns all servers' do
+          expect(subject.map(&:hostname)).to eq %w{example1.com example2.com example3.com example4.com}
+        end
+      end
+
+      describe 'fetching servers by role' do
+        subject { dsl.roles(:app) }
+
+        it 'returns the servers' do
+          expect(subject.map(&:hostname)).to eq %w{example3.com example4.com}
+        end
+      end
+
+      describe 'fetching filtered servers by role' do
+        subject { dsl.roles(:app, filter: :active) }
+
+        it 'returns the servers' do
+          expect(subject.map(&:hostname)).to eq %w{example3.com}
+        end
+      end
+
+      describe 'fetching selected servers by role' do
+        subject { dsl.roles(:app, select: :active) }
+
+        it 'returns the servers' do
+          expect(subject.map(&:hostname)).to eq %w{example3.com}
+        end
+      end
+
+      describe 'fetching the primary server by role' do
+        context 'when inferring primary status based on order' do
+          subject { dsl.primary(:web) }
+          it 'returns the servers' do
+            expect(subject.hostname).to eq 'example1.com'
+          end
+        end
+
+        context 'when the attribute `primary` is explicity set' do
+          subject { dsl.primary(:app) }
+          it 'returns the servers' do
+            expect(subject.hostname).to eq 'example4.com'
+          end
+        end
+      end
+
+    end
+
+    describe 'when defining hosts using the `role` syntax' do
+      before do
+        dsl.role :web, %w{example1.com example2.com example3.com}
+        dsl.role :web, %w{example1.com}, active: true
+        dsl.role :app, %w{example3.com example4.com}
+        dsl.role :app, %w{example3.com}, active: true
+        dsl.role :app, %w{example4.com}, primary: true
+      end
+
+      describe 'fetching all servers' do
+        subject { dsl.roles(:all) }
+
+        it 'returns all servers' do
+          expect(subject.map(&:hostname)).to eq %w{example1.com example2.com example3.com example4.com}
+        end
+      end
+
+      describe 'fetching servers by role' do
+        subject { dsl.roles(:app) }
+
+        it 'returns the servers' do
+          expect(subject.map(&:hostname)).to eq %w{example3.com example4.com}
+        end
+      end
+
+      describe 'fetching filtered servers by role' do
+        subject { dsl.roles(:app, filter: :active) }
+
+        it 'returns the servers' do
+          expect(subject.map(&:hostname)).to eq %w{example3.com}
+        end
+      end
+
+      describe 'fetching selected servers by role' do
+        subject { dsl.roles(:app, select: :active) }
+
+        it 'returns the servers' do
+          expect(subject.map(&:hostname)).to eq %w{example3.com}
+        end
+      end
+
+      describe 'fetching the primary server by role' do
+        context 'when inferring primary status based on order' do
+          subject { dsl.primary(:web) }
+          it 'returns the servers' do
+            expect(subject.hostname).to eq 'example1.com'
+          end
+        end
+
+        context 'when the attribute `primary` is explicity set' do
+          subject { dsl.primary(:app) }
+          it 'returns the servers' do
+            expect(subject.hostname).to eq 'example4.com'
+          end
+        end
+      end
+
+    end
+
+  end
+
+  describe 'setting and fetching variables' do
+
+    before do
+      dsl.set :scm, :git
+    end
+
+    context 'without a default' do
+      context 'when the variables is defined' do
+        it 'returns the variable' do
+          expect(dsl.fetch(:scm)).to eq :git
+        end
+      end
+
+      context 'when the variables is undefined' do
+        it 'returns nil' do
+          expect(dsl.fetch(:source_control)).to be_nil
+        end
+      end
+    end
+
+    context 'with a default' do
+      context 'when the variables is defined' do
+        it 'returns the variable' do
+          expect(dsl.fetch(:scm, :svn)).to eq :git
+        end
+      end
+
+      context 'when the variables is undefined' do
+        it 'returns the default' do
+          expect(dsl.fetch(:source_control, :svn)).to eq :svn
+        end
+      end
+    end
+
+  end
+
+  describe 'asking for a variable' do
+    before do
+      dsl.ask(:scm, :svn)
+      $stdout.stubs(:puts)
+    end
+
+    context 'variable is provided' do
+      before do
+        $stdin.expects(:gets).returns('git')
+      end
+
+      it 'sets the input as the variable' do
+        expect(dsl.fetch(:scm)).to eq 'git'
+      end
+    end
+
+    context 'variable is not provided' do
+      before do
+        $stdin.expects(:gets).returns('')
+      end
+
+      it 'sets the variable as the default' do
+        expect(dsl.fetch(:scm)).to eq :svn
+      end
+    end
+  end
+
+  describe 'checking for presence' do
+    subject { dsl.any? :linked_files }
+
+    before do
+      dsl.set(:linked_files, linked_files)
+    end
+
+    context 'variable is an non-empty array' do
+      let(:linked_files) { %w{1} }
+
+      it { should be_true }
+    end
+
+    context 'variable is an empty array' do
+      let(:linked_files) { [] }
+      it { should be_false }
+    end
+
+    context 'variable exists, is not an array' do
+      let(:linked_files) { stub }
+      it { should be_true }
+    end
+
+    context 'variable is nil' do
+      let(:linked_files) { nil }
+      it { should be_false }
+    end
+  end
+
+  describe 'configuration SSHKit' do
+    let(:config) { SSHKit.config }
+    let(:backend) { SSHKit.config.backend.config }
+    let(:default_env) { { rails_env: :production } }
+
+    before do
+      dsl.set(:format, :dot)
+      dsl.set(:log_level, :debug)
+      dsl.set(:default_env, default_env)
+      dsl.set(:pty, true)
+      dsl.set(:connection_timeout, 10)
+      dsl.configure_backend
+    end
+
+    it 'sets the output' do
+      expect(config.output).to be_a SSHKit::Formatter::Dot
+    end
+
+    it 'sets the output verbosity' do
+      expect(config.output_verbosity).to eq 0
+    end
+
+    it 'sets the default env' do
+      expect(config.default_env).to eq default_env
+    end
+
+    it 'sets the backend pty' do
+      expect(backend.pty).to be_true
+    end
+
+    it 'sets the backend connection timeout' do
+      expect(backend.connection_timeout).to eq 10
+    end
+  end
+
+end