capistrano 2.8.0 → 3.19.0

data/lib/capistrano/tasks/console.rake

@@ -0,0 +1,25 @@
+desc "Execute remote commands"
+task :console do
+  stage = fetch(:stage)
+  puts I18n.t("console.welcome", scope: :capistrano, stage: stage)
+  loop do
+    print "#{stage}> "
+
+    command = (input = $stdin.gets) ? input.chomp : "exit"
+
+    next if command.empty?
+
+    if %w{quit exit q}.include? command
+      puts t("console.bye")
+      break
+    else
+      begin
+        on roles :all do
+          execute command
+        end
+      rescue => e
+        puts e
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/deploy.rake

@@ -0,0 +1,280 @@
+namespace :deploy do
+  task :starting do
+    invoke "deploy:print_config_variables" if fetch(:print_config_variables, false)
+    invoke "deploy:check"
+    invoke "deploy:set_previous_revision"
+    invoke "deploy:set_previous_revision_time"
+  end
+
+  task :print_config_variables do
+    puts
+    puts "------- Printing current config variables -------"
+    env.keys.each do |config_variable_key|
+      if is_question?(config_variable_key)
+        puts "#{config_variable_key.inspect} => Question (awaits user input on next fetch(#{config_variable_key.inspect}))"
+      else
+        puts "#{config_variable_key.inspect} => #{fetch(config_variable_key).inspect}"
+      end
+    end
+
+    puts
+    puts "------- Printing current config variables of SSHKit mechanism -------"
+    puts env.backend.config.inspect
+    # puts env.backend.config.backend.config.ssh_options.inspect
+    # puts env.backend.config.command_map.defaults.inspect
+
+    puts
+  end
+
+  task updating: :new_release_path do
+    invoke "deploy:set_current_revision"
+    invoke "deploy:set_current_revision_time"
+    invoke "deploy:symlink:shared"
+  end
+
+  task :reverting do
+    invoke "deploy:revert_release"
+  end
+
+  task :publishing do
+    invoke "deploy:symlink:release"
+  end
+
+  task :finishing do
+    invoke "deploy:cleanup"
+  end
+
+  task :finishing_rollback do
+    invoke "deploy:cleanup_rollback"
+  end
+
+  task :finished do
+    invoke "deploy:log_revision"
+  end
+
+  desc "Check required files and directories exist"
+  task :check do
+    invoke "deploy:check:directories"
+    invoke "deploy:check:linked_dirs"
+    invoke "deploy:check:make_linked_dirs"
+    invoke "deploy:check:linked_files"
+  end
+
+  namespace :check do
+    desc "Check shared and release directories exist"
+    task :directories do
+      on release_roles :all do
+        execute :mkdir, "-p", 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 release_roles :all do
+        execute :mkdir, "-p", linked_dirs(shared_path)
+      end
+    end
+
+    desc "Check directories of files to be linked exist in shared"
+    task :make_linked_dirs do
+      next unless any? :linked_files
+      on release_roles :all do |_host|
+        execute :mkdir, "-p", linked_file_dirs(shared_path)
+      end
+    end
+
+    desc "Check files to be linked exist in shared"
+    task :linked_files do
+      next unless any? :linked_files
+      on release_roles :all do |host|
+        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 release_roles :all do
+        tmp_current_path = release_path.parent.join(current_path.basename)
+        execute :ln, "-s", release_path, tmp_current_path
+        execute :mv, tmp_current_path, current_path.parent
+      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 release_roles :all do
+        execute :mkdir, "-p", linked_dir_parents(release_path)
+
+        fetch(:linked_dirs).each do |dir|
+          target = release_path.join(dir)
+          source = shared_path.join(dir)
+          next if test "[ -L #{target} ]"
+          execute :rm, "-rf", target if test "[ -d #{target} ]"
+          execute :ln, "-s", source, target
+        end
+      end
+    end
+
+    desc "Symlink linked files"
+    task :linked_files do
+      next unless any? :linked_files
+      on release_roles :all do
+        execute :mkdir, "-p", linked_file_dirs(release_path)
+
+        fetch(:linked_files).each do |file|
+          target = release_path.join(file)
+          source = shared_path.join(file)
+          next if test "[ -L #{target} ]"
+          execute :rm, target if test "[ -f #{target} ]"
+          execute :ln, "-s", source, target
+        end
+      end
+    end
+  end
+
+  desc "Clean up old releases"
+  task :cleanup do
+    on release_roles :all do |host|
+      releases = capture(:ls, "-x", releases_path).split
+      valid, invalid = releases.partition { |e| /^\d{14}$/ =~ e }
+
+      warn t(:skip_cleanup, host: host.to_s) if invalid.any?
+
+      if valid.count >= fetch(:keep_releases)
+        info t(:keeping_releases, host: host.to_s, keep_releases: fetch(:keep_releases), releases: valid.count)
+        directories = (valid - valid.last(fetch(:keep_releases))).map do |release|
+          releases_path.join(release).to_s
+        end
+        if test("[ -d #{current_path} ]")
+          current_release = capture(:readlink, current_path).to_s
+          if directories.include?(current_release)
+            warn t(:wont_delete_current_release, host: host.to_s)
+            directories.delete(current_release)
+          end
+        else
+          debug t(:no_current_release, host: host.to_s)
+        end
+        if directories.any?
+          directories.each_slice(100) do |directories_batch|
+            execute :rm, "-rf", *directories_batch
+          end
+        else
+          info t(:no_old_releases, host: host.to_s, keep_releases: fetch(:keep_releases))
+        end
+      end
+    end
+  end
+
+  desc "Remove and archive rolled-back release."
+  task :cleanup_rollback do
+    on release_roles(:all) do
+      last_release = capture(:ls, "-xt", releases_path).split.first
+      last_release_path = releases_path.join(last_release)
+      if test "[ `readlink #{current_path}` != #{last_release_path} ]"
+        execute :tar, "-czf",
+                deploy_path.join("rolled-back-release-#{last_release}.tar.gz"),
+                last_release_path
+        execute :rm, "-rf", last_release_path
+      else
+        debug "Last release is the current release, skip cleanup_rollback."
+      end
+    end
+  end
+
+  desc "Log details of the deploy"
+  task :log_revision do
+    on release_roles(:all) do
+      within releases_path do
+        execute :echo, %Q{"#{revision_log_message}" >> #{revision_log}}
+      end
+    end
+  end
+
+  desc "Revert to previous release timestamp"
+  task revert_release: :rollback_release_path do
+    on release_roles(:all) do
+      set(:revision_log_message, rollback_log_message)
+    end
+  end
+
+  task :new_release_path do
+    set_release_path
+  end
+
+  task :rollback_release_path do
+    on release_roles(:all) do
+      releases = capture(:ls, "-xt", releases_path).split
+      if releases.count < 2
+        error t(:cannot_rollback)
+        exit 1
+      end
+
+      rollback_release = ENV["ROLLBACK_RELEASE"]
+      index = rollback_release.nil? ? 1 : releases.index(rollback_release)
+      if index.nil?
+        error t(:cannot_found_rollback_release, release: rollback_release)
+        exit 1
+      end
+
+      last_release = releases[index]
+      set_release_path(last_release)
+      set(:rollback_timestamp, last_release)
+    end
+  end
+
+  desc "Place a REVISION file with the current revision SHA in the current release path"
+  task :set_current_revision do
+    on release_roles(:all) do
+      within release_path do
+        execute :echo, "\"#{fetch(:current_revision)}\" > REVISION"
+      end
+    end
+  end
+
+  task :set_previous_revision do
+    on release_roles(:all) do
+      target = release_path.join("REVISION")
+      if test "[ -f #{target} ]"
+        set(:previous_revision, capture(:cat, target, "2>/dev/null"))
+      end
+    end
+  end
+
+  desc "Place a REVISION_TIME file with the current revision commit time in the current release path"
+  task :set_current_revision_time do
+    on release_roles(:all) do
+      within release_path do
+        if fetch(:current_revision_time)
+          execute :echo, "\"#{fetch(:current_revision_time)}\" > REVISION_TIME"
+        end
+      end
+    end
+  end
+
+  task :set_previous_revision_time do
+    on release_roles(:all) do
+      target = release_path.join("REVISION_TIME")
+      if test "[ -f #{target} ]"
+        set(:previous_revision_time, capture(:cat, target, "2>/dev/null"))
+      end
+    end
+  end
+
+  task :restart
+  task :failed
+end

data/lib/capistrano/tasks/doctor.rake

@@ -0,0 +1,24 @@
+desc "Display a Capistrano troubleshooting report (all doctor: tasks)"
+task doctor: ["doctor:environment", "doctor:gems", "doctor:variables", "doctor:servers"]
+
+namespace :doctor do
+  desc "Display Ruby environment details"
+  task :environment do
+    Capistrano::Doctor::EnvironmentDoctor.new.call
+  end
+
+  desc "Display Capistrano gem versions"
+  task :gems do
+    Capistrano::Doctor::GemsDoctor.new.call
+  end
+
+  desc "Display the values of all Capistrano variables"
+  task :variables do
+    Capistrano::Doctor::VariablesDoctor.new.call
+  end
+
+  desc "Display the effective servers configuration"
+  task :servers do
+    Capistrano::Doctor::ServersDoctor.new.call
+  end
+end

data/lib/capistrano/tasks/framework.rake

@@ -0,0 +1,67 @@
+namespace :deploy do
+  desc "Start a deployment, make sure server(s) ready."
+  task :starting do
+  end
+
+  desc "Started"
+  task :started do
+  end
+
+  desc "Update server(s) by setting up a new release."
+  task :updating do
+  end
+
+  desc "Updated"
+  task :updated do
+  end
+
+  desc "Revert server(s) to previous release."
+  task :reverting do
+  end
+
+  desc "Reverted"
+  task :reverted do
+  end
+
+  desc "Publish the release."
+  task :publishing do
+  end
+
+  desc "Published"
+  task :published do
+  end
+
+  desc "Finish the deployment, clean up server(s)."
+  task :finishing do
+  end
+
+  desc "Finish the rollback, clean up server(s)."
+  task :finishing_rollback do
+  end
+
+  desc "Finished"
+  task :finished do
+  end
+
+  desc "Rollback to previous release."
+  task :rollback do
+    %w{ starting started
+        reverting reverted
+        publishing published
+        finishing_rollback finished }.each do |task|
+      invoke "deploy:#{task}"
+    end
+  end
+end
+
+desc "Deploy a new release."
+task :deploy do
+  set(:deploying, true)
+  %w{ starting started
+      updating updated
+      publishing published
+      finishing finished }.each do |task|
+    invoke "deploy:#{task}"
+  end
+end
+task default: :deploy

data/lib/capistrano/tasks/install.rake

@@ -0,0 +1,41 @@
+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
+
+  entries = [{ template: deploy_rb, file: config_dir.join("deploy.rb") }]
+  entries += envs.split(",").map { |stage| { template: stage_rb, file: deploy_dir.join("#{stage}.rb") } }
+
+  entries.each do |entry|
+    if File.exist?(entry[:file])
+      warn "[skip] #{entry[:file]} already exists"
+    else
+      File.open(entry[:file], "w+") do |f|
+        f.write(ERB.new(File.read(entry[:template])).result(binding))
+        puts I18n.t(:written_file, scope: :capistrano, file: entry[:file])
+      end
+    end
+  end
+
+  mkdir_p tasks_dir
+
+  if File.exist?("Capfile")
+    warn "[skip] Capfile already exists"
+  else
+    FileUtils.cp(capfile, "Capfile")
+    puts I18n.t(:written_file, scope: :capistrano, file: "Capfile")
+  end
+
+  puts I18n.t :capified, scope: :capistrano
+end

data/lib/capistrano/templates/Capfile

@@ -0,0 +1,38 @@
+# Load DSL and set up stages
+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:
+#
+#   https://github.com/capistrano/rvm
+#   https://github.com/capistrano/rbenv
+#   https://github.com/capistrano/chruby
+#   https://github.com/capistrano/bundler
+#   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"
+
+# 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

@@ -0,0 +1,39 @@
+# config valid for current version and patch releases of Capistrano
+lock "~> <%= Capistrano::VERSION %>"
+
+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 :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
+
+# Default value for :pty is false
+# set :pty, true
+
+# Default value for :linked_files is []
+# append :linked_files, "config/database.yml", 'config/master.key'
+
+# Default value for linked_dirs is []
+# append :linked_dirs, "log", "tmp/pids", "tmp/cache", "tmp/sockets", "public/system", "vendor", "storage"
+
+# Default value for default_env is {}
+# set :default_env, { path: "/opt/ruby/bin:$PATH" }
+
+# Default value for local_user is ENV['USER']
+# set :local_user, -> { `git config user.name`.chomp }
+
+# Default value for keep_releases is 5
+# set :keep_releases, 5
+
+# Uncomment the following to require manually verifying the host key before first deploy.
+# set :ssh_options, verify_host_key: :secure

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

@@ -0,0 +1,61 @@
+# 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
+# ==================
+
+# 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}
+
+
+
+# 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 the Net::SSH documentation.
+# http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start
+#
+# Global options
+# --------------
+#  set :ssh_options, {
+#    keys: %w(/home/user_name/.ssh/id_rsa),
+#    forward_agent: false,
+#    auth_methods: %w(password)
+#  }
+#
+# The server-based syntax can be used to override options:
+# ------------------------------------
+# server "example.com",
+#   user: "user_name",
+#   roles: %w{web app},
+#   ssh_options: {
+#     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"
+#   }

data/lib/capistrano/upload_task.rb

@@ -0,0 +1,9 @@
+require "rake/file_creation_task"
+
+module Capistrano
+  class UploadTask < Rake::FileCreationTask
+    def needed?
+      true # always needed because we can't check remote hosts
+    end
+  end
+end

data/lib/capistrano/version.rb

@@ -1,16 +1,3 @@
-require 'scanf'
 module Capistrano
-
-  class Version
-
-    MAJOR = 2
-    MINOR = 8
-    PATCH = 0
-
-    def self.to_s
-      "#{MAJOR}.#{MINOR}.#{PATCH}"
-    end
-
-  end
-
+  VERSION = "3.19.0".freeze
 end

data/lib/capistrano/version_validator.rb

@@ -0,0 +1,32 @@
+module Capistrano
+  class VersionValidator
+    def initialize(version)
+      @version = version
+    end
+
+    def verify
+      return self if match?
+      raise "Capfile locked at #{version}, but #{current_version} is loaded"
+    end
+
+    private
+
+    attr_reader :version
+
+    def match?
+      available =~ requested
+    end
+
+    def current_version
+      VERSION
+    end
+
+    def available
+      Gem::Dependency.new("cap", version)
+    end
+
+    def requested
+      Gem::Dependency.new("cap", current_version)
+    end
+  end
+end

data/lib/capistrano.rb

@@ -1,3 +0,0 @@
-require 'capistrano/configuration'
-require 'capistrano/extensions'
-require 'capistrano/ext/string'