capistrano 2.15.11 → 3.0.0.pre

data/lib/capistrano/tasks/deploy.rake

@@ -0,0 +1,153 @@
+namespace :deploy do
+
+  task :started do
+    invoke 'deploy:check'
+  end
+
+  task :update do
+    invoke "#{scm}:create_release"
+    invoke 'deploy:symlink:shared'
+  end
+
+  task :finalize do
+    invoke 'deploy:symlink:release'
+  end
+
+  task :finished do
+    invoke 'deploy:log_revision'
+  end
+
+  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:linked_files'
+  end
+
+  namespace :check do
+    desc 'Check shared and release directories exist'
+    task :directories do
+      on roles :all do
+        execute :mkdir, '-pv', shared_path, releases_path
+      end
+    end
+
+    desc 'Check directories to be linked exist in shared'
+    task :linked_dirs do
+      next unless any? :linked_dirs
+      on roles :app do
+        execute :mkdir, '-pv', linked_dirs(shared_path)
+      end
+    end
+
+    desc 'Check files to be linked exist in shared'
+    task :linked_files do
+      next unless any? :linked_files
+      on roles :app do |host|
+        execute :mkdir, '-pv', linked_file_dirs(shared_path)
+        linked_files(shared_path).each do |file|
+          unless test "[ -f #{file} ]"
+            error t(:linked_file_does_not_exist, file: file, host: host)
+            exit 1
+          end
+        end
+      end
+    end
+  end
+
+  namespace :symlink do
+    desc 'Symlink release to current'
+    task :release do
+      on roles :web, :app do
+        execute :rm, '-rf', current_path
+        execute :ln, '-s', release_path, current_path
+      end
+    end
+
+    desc 'Symlink files and directories from shared to release'
+    task :shared do
+      invoke 'deploy:symlink:linked_files'
+      invoke 'deploy:symlink:linked_dirs'
+    end
+
+    desc 'Symlink linked directories'
+    task :linked_dirs do
+      next unless any? :linked_dirs
+      on roles :app do
+        execute :mkdir, '-pv', linked_dir_parents(release_path)
+
+        fetch(:linked_dirs).each do |dir|
+          target = release_path.join(dir)
+          source = shared_path.join(dir)
+          unless test "[ -L #{target} ]"
+            if test "[ -f #{target} ]"
+              execute :rm, '-rf', target
+            end
+            execute :ln, '-s', source, target
+          end
+        end
+      end
+    end
+
+    desc 'Symlink linked files'
+    task :linked_files do
+      next unless any? :linked_files
+      on roles :app do
+        execute :mkdir, '-pv', linked_file_dirs(release_path)
+
+        fetch(:linked_files).each do |file|
+          target = release_path.join(file)
+          source = shared_path.join(file)
+          unless test "[ -L #{target} ]"
+            if test "[ -f #{target} ]"
+              execute :rm, target
+            end
+            execute :ln, '-s', source, target
+          end
+        end
+      end
+    end
+  end
+
+  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
+      if releases.count >= fetch(:keep_releases)
+        info t(:keeping_releases, 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
+      end
+    end
+  end
+
+  desc 'Log details of the deploy'
+  task :log_revision do
+    on primary :app do
+      within releases_path do
+        execute %{echo "#{revision_log_message}" >> #{revision_log}}
+      end
+    end
+  end
+
+  desc 'Rollback to the last release'
+  task :rollback do
+    on primary :app do
+      last_release = capture(:ls, '-xt', releases_path).split[1]
+      set(:rollback_release_timestamp, last_release)
+      set(:branch, last_release)
+      set(:revision_log_message, rollback_log_message)
+    end
+
+    on roles :app do
+      %w{check finalize restart finishing finished}.each do |task|
+        invoke "deploy:#{task}"
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/framework.rake

@@ -0,0 +1,45 @@
+namespace :deploy do
+
+  desc 'Starting'
+  task :starting do
+  end
+
+  desc 'Started'
+  task :started do
+  end
+
+  desc 'Update'
+  task :update do
+  end
+
+  desc 'Finalize'
+  task :finalize do
+  end
+
+  desc 'Restart'
+  task :restart do
+  end
+
+  desc 'Finishing'
+  task :finishing do
+  end
+
+  desc 'Finished'
+  task :finished do
+  end
+
+  before :starting, :ensure_stage do
+    unless stage_set?
+      puts t(:stage_not_set)
+      exit 1
+    end
+  end
+end
+
+desc 'Deploy'
+task :deploy do
+  %w{starting started update finalize restart finishing finished}.each do |task|
+    invoke "deploy:#{task}"
+  end
+end
+task default: :deploy

data/lib/capistrano/tasks/git.rake

@@ -0,0 +1,65 @@
+namespace :git do
+
+  git_environmental_variables = {
+    git_askpass: '/bin/echo',
+    git_ssh:     '/tmp/git-ssh.sh'
+  }
+
+  desc 'Upload the git wrapper script, this script guarantees that we can script git without getting an interactive prompt'
+  task :wrapper do
+    on roles :all do
+      upload! StringIO.new("#!/bin/sh -e\nexec /usr/bin/ssh -o PasswordAuthentication=no -o StrictHostKeyChecking=no \"$@\"\n"), '/tmp/git-ssh.sh'
+      execute :chmod, "+x", '/tmp/git-ssh.sh'
+    end
+  end
+
+  desc 'Check that the repository is reachable'
+  task check: :'git:wrapper' do
+    fetch(:branch)
+    on roles :all do
+      with git_environmental_variables do
+        execute :git, :'ls-remote', fetch(:repo)
+      end
+    end
+  end
+
+  desc 'Clone the repo to the cache'
+  task clone: :'git:wrapper' do
+    on roles :all do
+      if test " [ -f #{repo_path}/HEAD ] "
+        info t(:mirror_exists, at: repo_path)
+      else
+        within deploy_path do
+          with git_environmental_variables do
+            execute :git, :clone, '--mirror', fetch(:repo), repo_path
+          end
+        end
+      end
+    end
+  end
+
+  desc 'Update the repo mirror to reflect the origin state'
+  task update: :'git:clone' do
+    on roles :all do
+      within repo_path do
+        execute :git, :remote, :update
+      end
+    end
+  end
+
+  desc 'Copy repo to releases'
+  task create_release: :'git:update' do
+    on roles :all do
+      with git_environmental_variables do
+        within repo_path do
+          execute :git, :clone, '--branch', fetch(:branch),               \
+            '--depth 1',                                                  \
+            '--recursive',                                                \
+            '--no-hardlinks',                                             \
+            repo_path, release_path
+        end
+      end
+    end
+  end
+end
+

data/lib/capistrano/tasks/install.rake

@@ -0,0 +1,39 @@
+require 'erb'
+require 'pathname'
+desc 'Install Capistrano, cap install STAGES=staging,production'
+task :install do
+  envs = ENV['STAGES'] || 'staging,production'
+
+  tasks_dir = Pathname.new('lib/capistrano/tasks')
+  config_dir = Pathname.new('config')
+  deploy_dir = config_dir.join('deploy')
+
+  deploy_rb = File.expand_path("../../templates/deploy.rb.erb", __FILE__)
+  stage_rb = File.expand_path("../../templates/stage.rb.erb", __FILE__)
+  capfile = File.expand_path("../../templates/Capfile", __FILE__)
+
+  mkdir_p deploy_dir
+
+  template = File.read(deploy_rb)
+  file = config_dir.join('deploy.rb')
+  File.open(file, 'w+') do |f|
+    f.write(ERB.new(template).result(binding))
+    puts I18n.t(:written_file, scope: :capistrano, file: file)
+  end
+
+  template = File.read(stage_rb)
+  envs.split(',').each do |stage|
+    file = deploy_dir.join("#{stage}.rb")
+    File.open(file, 'w+') do |f|
+      f.write(ERB.new(template).result(binding))
+      puts I18n.t(:written_file, scope: :capistrano, file: file)
+    end
+  end
+
+  mkdir_p tasks_dir
+
+  FileUtils.cp(capfile, 'Capfile')
+
+
+  puts I18n.t :capified, scope: :capistrano
+end

data/lib/capistrano/templates/Capfile

@@ -0,0 +1,43 @@
+#!/usr/bin/env cap
+# loads dsl, sets up stages
+require 'capistrano/setup'
+
+# provides remote execution of arbitrary commands
+require 'capistrano/console'
+
+# includes default deployment tasks
+# remove to start completely from scratch
+require 'capistrano/deploy'
+
+# Includes tasks from other gems included in your Gemfile
+#
+# For documentation on these, see for example:
+#
+#   https://github.com/capistrano/bundler
+#   https://github.com/capistrano/rails/tree/master/assets
+#   https://github.com/capistrano/rails/tree/master/migrations
+#
+# require 'capistrano/bundler'
+# require 'capistrano/rails/assets'
+# require 'capistrano/rails/migrations'
+# require 'capistrano/heroku'
+
+# Loads custom tasks from lib/capistrano/tasks if you have any defined.
+# Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }
+
+namespace :deploy do
+  desc 'Restart application'
+  task :restart do
+    on roles(:app), in: :sequence, wait: 5 do
+      #
+    end
+  end
+
+  after :restart, :clear_cache do
+    on roles(:web), in: :groups, limit: 3, wait: 10 do
+      #
+    end
+  end
+
+  after :finishing, 'deploy:cleanup'
+end

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

@@ -0,0 +1,17 @@
+set :application, 'my app name'
+set :repo, 'git@example.com:me/my_repo.git'
+
+ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }
+
+# set :deploy_to, '/var/www/my_app'
+# set :scm, :git
+
+# set :format, :pretty
+# set :log_level, :debug
+# set :pty, true
+
+# set :linked_files, %w{config/database.yml}
+# set :linked_dirs, %w{bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system}
+
+# set :default_environment, { path: "/opt/ruby/bin:$PATH" }
+# set :keep_releases, 5

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

@@ -0,0 +1,20 @@
+set :stage, :<%= stage %>
+
+# Simple Role 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.
+role :app, %w{example.com}
+role :web, %w{example.com}
+role :db,  %w{example.com}
+
+# Extended Server Syntax
+# ======================
+# This can be used to drop a more detailed server
+# definition into the server list. The second argument
+# something that quacks like a has can be used to set
+# extended properties on the server.
+server 'example.com', roles: %w{web app}, my_property: :my_value
+
+# set :rails_env, :<%= stage %>

data/lib/capistrano/version.rb

@@ -1,13 +1,3 @@
 module Capistrano
-  class Version
-    MAJOR = 2
-    MINOR = 15
-    PATCH = 11
-
-    def self.to_s
-      "#{MAJOR}.#{MINOR}.#{PATCH}"
-    end
-  end
-
-  VERSION = Version.to_s
+  VERSION = "3.0.0.pre"
 end

data/lib/capistrano.rb

@@ -1,5 +1,11 @@
-require 'capistrano/fix_rake_deprecated_dsl'
+require 'rake'
+require 'sshkit'
 
+require 'capistrano/version'
+require 'capistrano/i18n'
+require 'capistrano/dsl'
+require 'capistrano/application'
 require 'capistrano/configuration'
-require 'capistrano/extensions'
-require 'capistrano/ext/string'
+
+module Capistrano
+end

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

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module Capistrano
+  class Configuration
+
+    describe Question do
+
+      let(:question) { Question.new(env, key, default) }
+      let(:default) { :default }
+      let(:key) { :branch }
+      let(:env) { stub }
+
+      describe '.new' do
+        it 'takes a key, default' do
+          question
+        end
+      end
+
+      describe '#call' do
+        subject { question.call }
+
+        context 'value is entered' do
+          let(:branch) { 'branch' }
+
+          before do
+            $stdout.expects(:puts).with('Please enter branch: |default|')
+            $stdin.expects(:gets).returns(branch)
+          end
+
+          it 'sets the value' do
+            env.expects(:set).with(key, branch)
+            question.call
+          end
+        end
+
+        context 'value is not entered' do
+          let(:branch) { default }
+
+          before do
+            $stdout.expects(:puts).with('Please enter branch: |default|')
+            $stdin.expects(:gets).returns('')
+          end
+
+          it 'sets the default as the value' do
+            env.expects(:set).with(key, branch)
+            question.call
+          end
+
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+module Capistrano
+  class Configuration
+    describe Server do
+      let(:server) { Server.new('hostname') }
+
+      describe 'adding a role' do
+        subject { server.add_role(:test) }
+        it 'adds the role' do
+          expect{subject}.to change{server.roles.size}.from(0).to(1)
+        end
+      end
+
+      describe 'checking roles' do
+        subject { server.has_role?(:test) }
+
+        before do
+          server.add_role(:test)
+        end
+
+        it 'adds the role' do
+          expect{subject}.to be_true
+        end
+      end
+
+      describe 'comparing identity' do
+        subject { server.matches? hostname }
+
+        context 'with the same hostname' do
+          let(:hostname) { 'hostname' }
+          it { should be_true }
+        end
+
+        context 'with the same hostname and a user' do
+          let(:hostname) { 'user@hostname' }
+          it { should be_true }
+        end
+
+        context 'with a different hostname' do
+          let(:hostname) { 'otherserver' }
+          it { should be_false }
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+module Capistrano
+  class Configuration
+    describe Servers do
+      let(:servers) { Servers.new }
+
+      describe 'adding a role' do
+        subject { servers.add_role(:app, %w{1 2}) }
+
+        it 'adds two new server instances' do
+          expect{subject}.to change{servers.count}.from(0).to(2)
+        end
+      end
+
+      describe 'adding a role to an existing server' do
+        before do
+          servers.add_role(:web, %w{1 2})
+          servers.add_role(:app, %w{1 2})
+        end
+
+        it 'adds new roles to existing servers' do
+          expect(servers.count).to eq 2
+        end
+      end
+
+      describe 'collecting server roles' do
+        let(:app) { Set.new([:app]) }
+        let(:web_app) { Set.new([:web, :app]) }
+        let(:web) { Set.new([:web]) }
+
+        before do
+          servers.add_role(:app, %w{1 2 3})
+          servers.add_role(:web, %w{2 3 4})
+        end
+
+        it 'returns an array of the roles' do
+          expect(servers.fetch_roles([:app]).collect(&:roles)).to eq [app, web_app, web_app]
+          expect(servers.fetch_roles([:web]).collect(&:roles)).to eq [web_app, web_app, web]
+        end
+      end
+
+      describe 'finding the primary server' do
+        it 'takes the first server for if none have the primary property' do
+          servers.add_role(:app, %w{1 2})
+          servers.fetch_primary(:app).hostname.should == "1"
+        end
+        it 'takes the first server with the primary have the primary flag' do
+          servers.add_role(:app, %w{1 2})
+          servers.add_host('2', primary: true)
+          servers.fetch_primary(:app).hostname.should == "2"
+        end
+      end
+
+      describe 'fetching servers' do
+        before do
+          servers.add_role(:app, %w{1 2})
+          servers.add_role(:web, %w{2 3})
+        end
+
+        it 'returns the correct app servers' do
+          expect(servers.fetch_roles([:app]).map(&:hostname)).to eq %w{1 2}
+        end
+
+        it 'returns the correct web servers' do
+          expect(servers.fetch_roles([:web]).map(&:hostname)).to eq %w{2 3}
+        end
+
+        it 'returns the correct app and web servers' do
+          expect(servers.fetch_roles([:app, :web]).map(&:hostname)).to eq %w{1 2 3}
+        end
+
+        it 'returns all servers' do
+          expect(servers.fetch_roles([:all]).map(&:hostname)).to eq %w{1 2 3}
+        end
+      end
+    end
+  end
+end

data/spec/lib/capistrano/configuration_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+module Capistrano
+  describe Configuration do
+    let(:config) { Configuration.new }
+    let(:servers) { stub }
+
+    describe '.env' do
+      it 'is a global accessor to a single instance' do
+        Configuration.env.set(:test, true)
+        expect(Configuration.env.fetch(:test)).to be_true
+      end
+    end
+
+    describe 'roles' do
+      context 'adding a role' do
+        subject { config.role(:app, %w{server1 server2}) }
+
+        before do
+          Configuration::Servers.expects(:new).returns(servers)
+          servers.expects(:add_role).with(:app, %w{server1 server2})
+        end
+
+        it 'adds the role' do
+          expect(subject)
+        end
+      end
+    end
+
+    describe 'setting and fetching' do
+      subject { config.fetch(:key, :default) }
+
+      context 'value is set' do
+        before do
+          config.set(:key, :value)
+        end
+
+        it 'returns the set value' do
+          expect(subject).to eq :value
+        end
+      end
+
+      context 'value is not set' do
+        it 'returns the default value' do
+          expect(subject).to eq :default
+        end
+      end
+
+      context 'value is a proc' do
+        subject { config.fetch(:key, Proc.new { :proc } ) }
+        it 'calls the proc' do
+          expect(subject).to eq :proc
+        end
+      end
+
+      context 'block is passed to fetch' do
+        subject { config.fetch(:key, :default) { fail 'we need this!' } }
+
+        it 'returns the block value' do
+          expect { subject }.to raise_error
+        end
+      end
+    end
+
+    describe 'asking' do
+      let(:question) { stub }
+
+      before do
+        Configuration::Question.expects(:new).with(config, :branch, :default).
+          returns(question)
+      end
+
+      it 'prompts for the value when fetching' do
+        config.ask(:branch, :default)
+        expect(config.fetch(:branch)).to eq question
+      end
+    end
+  end
+
+end