capistrano 3.16.0 → 3.19.1

data/features/support/docker_gateway.rb

@@ -0,0 +1,53 @@
+# Ensure Docker container is completely stopped when Ruby exits.
+at_exit do
+  DockerGateway.new.stop
+end
+
+# Manages the Docker-based SSH server that is declared in docker-compose.yml.
+class DockerGateway
+  def initialize(log_proc=$stderr.method(:puts))
+    @log_proc = log_proc
+  end
+
+  def start
+    run_compose_command("up -d")
+  end
+
+  def stop
+    run_compose_command("down")
+  end
+
+  def run_shell_command(command)
+    run_compose_command("exec ssh_server /bin/bash -c #{command.shellescape}")
+  end
+
+  private
+
+  def run_compose_command(command)
+    log "[docker compose] #{command}"
+    stdout, stderr, status = Open3.popen3("docker compose #{command}") do |stdin, stdout, stderr, wait_threads|
+      stdin << ""
+      stdin.close
+      out = Thread.new { read_lines(stdout, &$stdout.method(:puts)) }
+      err = Thread.new { stderr.read }
+      [out.value, err.value.to_s, wait_threads.value]
+    end
+
+    (stdout + stderr).each_line { |line| log "[docker compose] #{line}" }
+
+    [stdout, stderr, status]
+  end
+
+  def read_lines(io)
+    buffer = + ""
+    while (line = io.gets)
+      buffer << line
+      yield line
+    end
+    buffer
+  end
+
+  def log(message)
+    @log_proc.call(message)
+  end
+end

data/features/support/env.rb

@@ -1,11 +1 @@
-PROJECT_ROOT = File.expand_path("../../../", __FILE__)
-VAGRANT_ROOT = File.join(PROJECT_ROOT, "spec/support")
-VAGRANT_BIN = ENV["VAGRANT_BIN"] || "vagrant"
-
-at_exit do
-  if ENV["KEEP_RUNNING"]
-    VagrantHelpers.run_vagrant_command("rm -rf /home/vagrant/var")
-  end
-end
-
 require_relative "../../spec/support/test_app"

data/features/support/remote_command_helpers.rb

@@ -12,7 +12,7 @@ module RemoteCommandHelpers
   end
 
   def exists?(type, path)
-    %Q{[ -#{type} "#{path}" ]}
+    %Q{[[ -#{type} "#{path}" ]]}
   end
 
   def symlinked?(symlink_path, target_path)
@@ -20,9 +20,9 @@ module RemoteCommandHelpers
   end
 
   def safely_remove_file(_path)
-    run_vagrant_command("rm #{test_file}")
+    run_remote_ssh_command("rm #{test_file}")
   rescue
-    VagrantHelpers::VagrantSSHCommandError
+    RemoteSSHHelpers::RemoteSSHCommandError
   end
 end
 

data/features/support/remote_ssh_helpers.rb

@@ -0,0 +1,33 @@
+require "open3"
+require "socket"
+require_relative "docker_gateway"
+
+module RemoteSSHHelpers
+  extend self
+
+  class RemoteSSHCommandError < RuntimeError; end
+
+  def start_ssh_server
+    docker_gateway.start
+  end
+
+  def wait_for_ssh_server(retries=3)
+    Socket.tcp("localhost", 2022, connect_timeout: 1).close
+  rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT
+    retries -= 1
+    sleep(2) && retry if retries.positive?
+    raise
+  end
+
+  def run_remote_ssh_command(command)
+    stdout, stderr, status = docker_gateway.run_shell_command(command)
+    return [stdout, stderr] if status.success?
+    raise RemoteSSHCommandError, status
+  end
+
+  def docker_gateway
+    @docker_gateway ||= DockerGateway.new(method(:log))
+  end
+end
+
+World(RemoteSSHHelpers)

data/lib/capistrano/configuration/validated_variables.rb

@@ -68,7 +68,7 @@ module Capistrano
       # works as expected.
       #
       def assert_valid_later(key, callable)
-        validation_callback = lambda do
+        validation_callback = proc do
           value = callable.call
           assert_valid_now(key, value)
           value

data/lib/capistrano/doctor/variables_doctor.rb

@@ -10,6 +10,8 @@ module Capistrano
       WHITELIST = %i(
         application
         current_directory
+        linked_dirs
+        linked_files
         releases_directory
         repo_url
         repo_tree

data/lib/capistrano/scm/git.rb

@@ -26,6 +26,7 @@ class Capistrano::SCM::Git < Capistrano::SCM::Plugin
     after "deploy:new_release_path", "git:create_release"
     before "deploy:check", "git:check"
     before "deploy:set_current_revision", "git:set_current_revision"
+    before "deploy:set_current_revision_time", "git:set_current_revision_time"
   end
 
   def define_tasks
@@ -78,6 +79,10 @@ class Capistrano::SCM::Git < Capistrano::SCM::Plugin
     backend.capture(:git, "rev-list --max-count=1 #{fetch(:branch)}")
   end
 
+  def fetch_revision_time
+    backend.capture(:git, "--no-pager log -1 --pretty=format:\"%ct\" #{fetch(:branch)}")
+  end
+
   def git(*args)
     args.unshift :git
     backend.execute(*args)

data/lib/capistrano/scm/tasks/git.rake

@@ -70,4 +70,15 @@ namespace :git do
       end
     end
   end
+
+  desc "Determine the unix timestamp that the revision that will be deployed was created"
+  task :set_current_revision_time do
+    on release_roles(:all), in: :groups, limit: fetch(:git_max_concurrent_connections), wait: fetch(:git_wait_interval) do
+      within repo_path do
+        with fetch(:git_environmental_variables) do
+          set :current_revision_time, git_plugin.fetch_revision_time
+        end
+      end
+    end
+  end
 end

data/lib/capistrano/tasks/deploy.rake

@@ -3,6 +3,7 @@ namespace :deploy 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
@@ -27,6 +28,7 @@ namespace :deploy do
 
   task updating: :new_release_path do
     invoke "deploy:set_current_revision"
+    invoke "deploy:set_current_revision_time"
     invoke "deploy:symlink:shared"
   end
 
@@ -236,7 +238,7 @@ namespace :deploy do
   end
 
   desc "Place a REVISION file with the current revision SHA in the current release path"
-  task :set_current_revision  do
+  task :set_current_revision do
     on release_roles(:all) do
       within release_path do
         execute :echo, "\"#{fetch(:current_revision)}\" > REVISION"
@@ -253,6 +255,26 @@ namespace :deploy do
     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/templates/deploy.rb.erb

@@ -21,10 +21,10 @@ set :repo_url, "git@example.com:me/my_repo.git"
 # set :pty, true
 
 # Default value for :linked_files is []
-# append :linked_files, "config/database.yml"
+# 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"
+# 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" }

data/lib/capistrano/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  VERSION = "3.16.0".freeze
+  VERSION = "3.19.1".freeze
 end

data/spec/integration/dsl_spec.rb

@@ -247,7 +247,7 @@ describe Capistrano::DSL do
           end
         end
 
-        context "when the attribute `primary` is explicity set" do
+        context "when the attribute `primary` is explicitly set" do
           subject { dsl.primary(:app) }
           it "returns the servers" do
             expect(subject.hostname).to eq "example4.com"
@@ -592,8 +592,8 @@ describe Capistrano::DSL do
 
     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)
+      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
@@ -601,8 +601,8 @@ describe Capistrano::DSL do
 
     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("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)
@@ -611,10 +611,10 @@ describe Capistrano::DSL do
 
     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)
+      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
@@ -622,8 +622,8 @@ describe Capistrano::DSL do
 
     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)
+      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

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

@@ -12,6 +12,7 @@ module Capistrano
         Rake::Task.define_task("deploy:check")
         Rake::Task.define_task("deploy:new_release_path")
         Rake::Task.define_task("deploy:set_current_revision")
+        Rake::Task.define_task("deploy:set_current_revision_time")
         set :scm, SCMResolver::DEFAULT_GIT
       end
 

data/spec/lib/capistrano/dsl_spec.rb

@@ -72,7 +72,7 @@ module Capistrano
 
     describe "#invoke" do
       context "reinvoking" do
-        it "will not reenable invoking task", capture_io: true do
+        it "will not re-enable invoking task", capture_io: true do
           counter = 0
 
           Rake::Task.define_task("A") do
@@ -98,7 +98,7 @@ module Capistrano
 
     describe "#invoke!" do
       context "reinvoking" do
-        it "will reenable invoking task", capture_io: true do
+        it "will re-enable invoking task", capture_io: true do
           counter = 0
 
           Rake::Task.define_task("C") do

data/spec/lib/capistrano/scm/git_spec.rb

@@ -19,6 +19,7 @@ module Capistrano
       Rake::Task.define_task("deploy:new_release_path")
       Rake::Task.define_task("deploy:check")
       Rake::Task.define_task("deploy:set_current_revision")
+      Rake::Task.define_task("deploy:set_current_revision_time")
     end
 
     # Clean up any tasks or variables that the plugin defined.
@@ -170,6 +171,15 @@ module Capistrano
       end
     end
 
+    describe "#fetch_revision_time" do
+      it "should capture git log without a pager" do
+        env.set(:branch, "branch")
+        backend.expects(:capture).with(:git, "--no-pager log -1 --pretty=format:\"%ct\" branch").returns("1715828406")
+        revision_time = subject.fetch_revision_time
+        expect(revision_time).to eq("1715828406")
+      end
+    end
+
     describe "#verify_commit" do
       it "should run git verify-commit" do
         env.set(:branch, "branch")

data/spec/support/test_app.rb

@@ -1,6 +1,7 @@
 require "English"
 require "fileutils"
 require "pathname"
+require "open3"
 
 module TestApp
   extend self
@@ -12,10 +13,10 @@ module TestApp
   def default_config
     <<-CONFIG
       set :deploy_to, '#{deploy_to}'
-      set :repo_url, 'git://github.com/capistrano/capistrano.git'
+      set :repo_url, 'https://github.com/capistrano/capistrano.git'
       set :branch, 'master'
-      set :ssh_options, { keys: "\#{ENV['HOME']}/.vagrant.d/insecure_private_key", auth_methods: ['publickey'] }
-      server 'vagrant@localhost:2220', roles: %w{web app}
+      set :ssh_options, { keys: '#{File.expand_path('../../.docker/ssh_key_rsa', __dir__)}', auth_methods: ['publickey'] }
+      server 'deployer@localhost:2022', roles: %w{web app}
       set :linked_files, #{linked_files}
       set :linked_dirs, #{linked_dirs}
       set :format_options, log_file: nil
@@ -39,9 +40,13 @@ module TestApp
     FileUtils.rm_rf(test_app_path)
     FileUtils.mkdir(test_app_path)
 
-    File.open(gemfile, "w+") do |file|
-      file.write "gem 'capistrano', path: '#{path_to_cap}'"
-    end
+    File.write(gemfile, <<-GEMFILE.gsub(/^\s+/, ""))
+      source "https://rubygems.org"
+
+      gem "capistrano", path: #{path_to_cap.to_s.inspect}
+      gem "ed25519", ">= 1.2", "< 2.0"
+      gem "bcrypt_pbkdf", ">= 1.0", "< 2.0"
+    GEMFILE
 
     Dir.chdir(test_app_path) do
       run "bundle"
@@ -95,13 +100,12 @@ module TestApp
   end
 
   def run(command, subdirectory=nil)
-    output = nil
     command = "bundle exec #{command}" unless command =~ /^bundle\b/
     dir = subdirectory ? test_app_path.join(subdirectory) : test_app_path
-    Dir.chdir(dir) do
-      output = with_clean_bundler_env { `#{command}` }
+    output, status = Dir.chdir(dir) do
+      with_clean_bundler_env { Open3.capture2e(command) }
     end
-    [$CHILD_STATUS.success?, output]
+    [status.success?, output]
   end
 
   def stage
@@ -117,7 +121,7 @@ module TestApp
   end
 
   def deploy_to
-    Pathname.new("/home/vagrant/var/www/deploy")
+    Pathname.new("/home/deployer/var/www/deploy")
   end
 
   def shared_path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano
 version: !ruby/object:Gem::Version
-  version: 3.16.0
+  version: 3.19.1
 platform: ruby
 authors:
 - Tom Clements
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-28 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrussh
@@ -67,48 +67,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.0
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.48.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.48.1
 description: Capistrano is a utility and framework for executing commands in parallel
   on multiple remote machines, via SSH.
 email:
@@ -120,17 +78,20 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".docker/Dockerfile"
+- ".docker/ssh_key_rsa"
+- ".docker/ssh_key_rsa.pub"
+- ".docker/ubuntu_setup.sh"
 - ".github/issue_template.md"
 - ".github/pull_request_template.md"
 - ".github/release-drafter.yml"
-- ".github/workflows/push.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/release-drafter.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - DEVELOPMENT.md
-- Dangerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -140,6 +101,7 @@ files:
 - bin/cap
 - bin/capify
 - capistrano.gemspec
+- docker-compose.yml
 - features/configuration.feature
 - features/deploy.feature
 - features/deploy_failure.feature
@@ -151,9 +113,10 @@ files:
 - features/step_definitions/cap_commands.rb
 - features/step_definitions/setup.rb
 - features/subdirectory.feature
+- features/support/docker_gateway.rb
 - features/support/env.rb
 - features/support/remote_command_helpers.rb
-- features/support/vagrant_helpers.rb
+- features/support/remote_ssh_helpers.rb
 - lib/Capfile
 - lib/capistrano.rb
 - lib/capistrano/all.rb
@@ -244,8 +207,6 @@ files:
 - spec/lib/capistrano/version_validator_spec.rb
 - spec/lib/capistrano_spec.rb
 - spec/spec_helper.rb
-- spec/support/.gitignore
-- spec/support/Vagrantfile
 - spec/support/matchers.rb
 - spec/support/tasks/database.rake
 - spec/support/tasks/fail.rake
@@ -277,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.5.8
 signing_key:
 specification_version: 4
 summary: Capistrano - Welcome to easy deployment with Ruby over SSH
@@ -293,9 +254,10 @@ test_files:
 - features/step_definitions/cap_commands.rb
 - features/step_definitions/setup.rb
 - features/subdirectory.feature
+- features/support/docker_gateway.rb
 - features/support/env.rb
 - features/support/remote_command_helpers.rb
-- features/support/vagrant_helpers.rb
+- features/support/remote_ssh_helpers.rb
 - spec/integration/dsl_spec.rb
 - spec/integration_spec_helper.rb
 - spec/lib/capistrano/application_spec.rb
@@ -328,8 +290,6 @@ test_files:
 - spec/lib/capistrano/version_validator_spec.rb
 - spec/lib/capistrano_spec.rb
 - spec/spec_helper.rb
-- spec/support/.gitignore
-- spec/support/Vagrantfile
 - spec/support/matchers.rb
 - spec/support/tasks/database.rake
 - spec/support/tasks/fail.rake

data/.github/workflows/push.yml

@@ -1,12 +0,0 @@
-on: push
-name: Push
-jobs:
-  draftRelease:
-    name: Draft Release
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@master
-      - name: Draft Release
-        uses: toolmantim/release-drafter@v5.2.0
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.travis.yml

@@ -1,30 +0,0 @@
-language: ruby
-rvm:
-  - 3.0
-  - 2.7
-  - 2.6
-  - 2.5
-  - 2.4
-  - 2.3
-  - 2.2
-  - 2.1
-  - 2.0
-matrix:
-  # Rubinius periodically fails in general, and it always segfaults for RuboCop
-  # in particular. Until we figure out how to make it work consistently, allow
-  # it to fail without breaking the build.
-  allow_failures:
-    - rvm: rbx-2
-  include:
-    - rvm: rbx-2
-      script: bundle exec rake spec
-    # Run Danger only once, on 2.5
-    - rvm: 2.5
-      before_script: bundle exec danger
-
-script: bundle exec rake spec rubocop
-install: bundle install --jobs=1
-cache: bundler
-branches:
-  only:
-    - master

data/Dangerfile

@@ -1 +0,0 @@
-danger.import_dangerfile(github: "capistrano/danger", branch: "no-changelog")

data/features/support/vagrant_helpers.rb

@@ -1,41 +0,0 @@
-require "open3"
-
-module VagrantHelpers
-  extend self
-
-  class VagrantSSHCommandError < RuntimeError; end
-
-  at_exit do
-    if ENV["KEEP_RUNNING"]
-      puts "Vagrant vm will be left up because KEEP_RUNNING is set."
-      puts "Rerun without KEEP_RUNNING set to cleanup the vm."
-    else
-      vagrant_cli_command("destroy -f")
-    end
-  end
-
-  def vagrant_cli_command(command)
-    puts "[vagrant] #{command}"
-    stdout, stderr, status = Dir.chdir(VAGRANT_ROOT) do
-      Open3.capture3("#{VAGRANT_BIN} #{command}")
-    end
-
-    (stdout + stderr).each_line { |line| puts "[vagrant] #{line}" }
-
-    [stdout, stderr, status]
-  end
-
-  def run_vagrant_command(command)
-    stdout, stderr, status = vagrant_cli_command("ssh -c #{command.inspect}")
-    return [stdout, stderr] if status.success?
-    raise VagrantSSHCommandError, status
-  end
-
-  def puts(message)
-    # Attach log messages to the current cucumber feature (`log`),
-    # or simply puts to the console (`super`) if we are outside of cucumber.
-    respond_to?(:log) ? log(message) : super(message)
-  end
-end
-
-World(VagrantHelpers)

data/spec/support/.gitignore

@@ -1 +0,0 @@
-.vagrant