capistrano 3.14.0 → 3.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05d4d15902188667bafc9bbaa729506f5648ffb2adcd1f5705739977dd971db1
-  data.tar.gz: f75c361ed0aa048cce3d18870e089e7d73861b2f43caf05aa4282d009e06e199
+  metadata.gz: 99671d269dca096fd99e25e1990a89ebb3241875e1f5bad7c09b6d31ee89181f
+  data.tar.gz: ce19a13c14d57456bdcc00077a68d908e8433e7995fe24b7eeaa96f4a32463b8
 SHA512:
-  metadata.gz: 287936297e0003a7deb6e56e822355a65d1d2b12dfa141a957de6cf4aeaf818220d7ab3f1fe55c3e9c381c58ef72f1837ba49b8f0637637af62373d0fa3f3e72
-  data.tar.gz: '08dadc7a9ae58638b5618203a6577de5f9cdab92c8f062977ea5758a915dcbd53d050a779373fde0d66a9173be58140f05ea03bda6ff20dc9c42c49ccab9e95d'
+  metadata.gz: 6fa979409c1e6e5e9ff293b97a4341ded24c4ab5e1a788f0b782ce6be010572851266aabb7ada7b8c955cb5a5d044fb1a28f4e97cfc2f7acfa742ccb1141cfc5
+  data.tar.gz: 57b9f530d593e32f64085e4b90e17ae5d23371382c91bbaa73e96268597d9d1ddf9bbd509806e955f3771d2a4cedd2a1fde300ea33ba470c0a4b46d9a5150247

data/.circleci/config.yml

@@ -0,0 +1,113 @@
+version: 2.1
+
+executors:
+  ruby:
+    parameters:
+      version:
+        description: "Ruby version number"
+        default: "3.1"
+        type: string
+    docker:
+      - image: ruby:<< parameters.version >>
+
+commands:
+  bundle_install:
+    description: Install Ruby dependencies with Bundler
+    parameters:
+      version:
+        description: "Ruby version number"
+        default: "3.1"
+        type: string
+    steps:
+      - restore_cache:
+          keys:
+            - bundle-v1-{{ arch }}-<< parameters.version >>
+      - run:
+          name: Install Ruby Dependencies
+          command: |
+            gem install bundler --conservative --no-document || gem install bundler -v '< 2' --no-document
+            bundle config --local path vendor/bundle
+            bundle check || (bundle install --jobs=4 --retry=3 && bundle clean)
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: bundle-v1-{{ arch }}-<< parameters.version >>-{{ checksum "Gemfile.lock" }}
+
+jobs:
+  danger:
+    executor: ruby
+    steps:
+      - checkout
+      - bundle_install
+      - run: bundle exec danger
+
+  rubocop:
+    executor: ruby
+    steps:
+      - checkout
+      - bundle_install
+      - run: bundle exec rubocop
+
+  spec:
+    parameters:
+      version:
+        description: "Ruby version number"
+        default: "3.1"
+        type: string
+    executor:
+      name: ruby
+      version: << parameters.version >>
+    steps:
+      - checkout
+      - bundle_install:
+          version: << parameters.version >>
+      - run: bundle exec rake spec
+
+workflows:
+  version: 2
+  commit-workflow:
+    jobs:
+      - danger
+      - rubocop
+      - spec:
+          matrix:
+            parameters:
+              version:
+                [
+                  "2.0",
+                  "2.1",
+                  "2.2",
+                  "2.3",
+                  "2.4",
+                  "2.5",
+                  "2.6",
+                  "2.7",
+                  "3.0",
+                  "3.1",
+                ]
+  cron-workflow:
+    jobs:
+      - rubocop
+      - spec:
+          matrix:
+            parameters:
+              version:
+                [
+                  "2.0",
+                  "2.1",
+                  "2.2",
+                  "2.3",
+                  "2.4",
+                  "2.5",
+                  "2.6",
+                  "2.7",
+                  "3.0",
+                  "3.1",
+                ]
+    triggers:
+      - schedule:
+          cron: "0 13 * * 6"
+          filters:
+            branches:
+              only:
+                - master

data/DEVELOPMENT.md

@@ -53,7 +53,7 @@ $ bundle exec rake features KEEP_RUNNING=1
 
 ### Report failing Cucumber features!
 
-Currently, the Capistrano Travis build does *not* run the Cucumber suite. This means it is possible for a failing Cucumber feature to sneak in without being noticed by our continuous integration checks.
+Currently, the Capistrano CI build does *not* run the Cucumber suite. This means it is possible for a failing Cucumber feature to sneak in without being noticed by our continuous integration checks.
 
 **If you come across a failing Cucumber feature, this is a bug.** Please report it by opening a GitHub issue. Or even better: do your best to fix the feature and submit a pull request!
 
@@ -63,7 +63,7 @@ This project uses [RuboCop](https://github.com/bbatsov/rubocop) to enforce stand
 
 * Test that your contributions pass with `rake rubocop`
 * Rubocop is also run as part of the full test suite with `rake`
-* Note the Travis build will fail and your PR cannot be merged if Rubocop finds errors
+* Note the CI build will fail and your PR cannot be merged if Rubocop finds errors
 
 ## Submitting a pull request
 

data/Gemfile

@@ -3,6 +3,10 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in capistrano.gemspec
 gemspec
 
+gem "mocha"
+gem "rspec"
+gem "rspec-core", "~> 3.4.4"
+
 group :cucumber do
   # Latest versions of cucumber don't support Ruby < 2.1
   # rubocop:disable Bundler/DuplicatedGem
@@ -12,8 +16,6 @@ group :cucumber do
     gem "cucumber"
   end
   # rubocop:enable Bundler/DuplicatedGem
-  gem "rspec"
-  gem "rspec-core", "~> 3.4.4"
 end
 
 # Latest versions of net-ssh don't support Ruby < 2.2.6
@@ -36,7 +38,9 @@ if Gem::Requirement.new("< 2.2").satisfied_by?(Gem::Version.new(RUBY_VERSION))
   gem "rake", "< 13.0.0"
 end
 
-# We only run danger once on a new-ish ruby; no need to install it otherwise
+# We only run danger and rubocop on a new-ish ruby; no need to install them otherwise
 if Gem::Requirement.new("> 2.4").satisfied_by?(Gem::Version.new(RUBY_VERSION))
   gem "danger"
+  gem "psych", "< 4" # Ensures rubocop works on Ruby 3.1
+  gem "rubocop", "0.48.1"
 end

data/README.md

@@ -1,7 +1,7 @@
 
 # Capistrano: A deployment automation tool built on Ruby, Rake, and SSH.
 
-[![Gem Version](https://badge.fury.io/rb/capistrano.svg)](http://badge.fury.io/rb/capistrano) [![Build Status](https://travis-ci.org/capistrano/capistrano.svg?branch=master)](https://travis-ci.org/capistrano/capistrano) [![Code Climate](https://codeclimate.com/github/capistrano/capistrano/badges/gpa.svg)](https://codeclimate.com/github/capistrano/capistrano) [![CodersClan](https://img.shields.io/badge/get-support-blue.svg)](http://codersclan.net/?repo_id=325&source=small)
+[![Gem Version](https://badge.fury.io/rb/capistrano.svg)](http://badge.fury.io/rb/capistrano) [![Build Status](https://circleci.com/gh/capistrano/capistrano/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/capistrano/capistrano?branch=master) [![Code Climate](https://codeclimate.com/github/capistrano/capistrano/badges/gpa.svg)](https://codeclimate.com/github/capistrano/capistrano) [![CodersClan](https://img.shields.io/badge/get-support-blue.svg)](http://codersclan.net/?repo_id=325&source=small)
 
 Capistrano is a framework for building automated deployment scripts. Although Capistrano itself is written in Ruby, it can easily be used to deploy projects of any language or framework, be it Rails, Java, or PHP.
 
@@ -107,7 +107,7 @@ Add Capistrano to your project's Gemfile using `require: false`:
 
 ``` ruby
 group :development do
-  gem "capistrano", "~> 3.14", require: false
+  gem "capistrano", "~> 3.17", require: false
 end
 ```
 

data/Rakefile

@@ -1,16 +1,19 @@
 require "bundler/gem_tasks"
 require "cucumber/rake/task"
 require "rspec/core/rake_task"
-require "rubocop/rake_task"
 
-task default: %i(spec rubocop)
-RSpec::Core::RakeTask.new
+begin
+  require "rubocop/rake_task"
+  desc "Run RuboCop checks"
+  RuboCop::RakeTask.new
+  task default: %i(spec rubocop)
+rescue LoadError
+  task default: :spec
+end
 
+RSpec::Core::RakeTask.new
 Cucumber::Rake::Task.new(:features)
 
-desc "Run RuboCop checks"
-RuboCop::RakeTask.new
-
 Rake::Task["release"].enhance do
   puts "Don't forget to publish the release on GitHub!"
   system "open https://github.com/capistrano/capistrano/releases"

data/capistrano.gemspec

@@ -31,8 +31,4 @@ Gem::Specification.new do |gem|
   gem.add_dependency "i18n"
   gem.add_dependency "rake", ">= 10.0.0"
   gem.add_dependency "sshkit", ">= 1.9.0"
-
-  gem.add_development_dependency "mocha"
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "rubocop", "0.48.1"
 end

data/features/step_definitions/assertions.rb

@@ -5,7 +5,7 @@ Then(/^references in the remote repo are listed$/) do
 end
 
 Then(/^git wrapper permissions are 0700$/) do
-  permissions_test = %Q([ $(stat -c "%a" #{TestApp.git_wrapper_path.shellescape}) == "700" ])
+  permissions_test = %Q([ $(stat -c "%a" #{TestApp.git_wrapper_path_glob}) == "700" ])
   _stdout, _stderr, status = vagrant_cli_command("ssh -c #{permissions_test.shellescape}")
 
   expect(status).to be_success

data/features/support/vagrant_helpers.rb

@@ -30,6 +30,12 @@ module VagrantHelpers
     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/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/dsl.rb

@@ -33,7 +33,7 @@ module Capistrano
     end
 
     def t(key, options={})
-      I18n.t(key, options.merge(scope: :capistrano))
+      I18n.t(key, **options.merge(scope: :capistrano))
     end
 
     def scm

data/lib/capistrano/scm/git.rb

@@ -1,5 +1,6 @@
 require "capistrano/scm/plugin"
 require "cgi"
+require "securerandom"
 require "shellwords"
 require "uri"
 
@@ -7,10 +8,9 @@ class Capistrano::SCM::Git < Capistrano::SCM::Plugin
   def set_defaults
     set_if_empty :git_shallow_clone, false
     set_if_empty :git_wrapper_path, lambda {
-      # Try to avoid permissions issues when multiple users deploy the same app
-      # by using different file names in the same dir for each deployer and stage.
-      suffix = %i(application stage local_user).map { |key| fetch(key).to_s }.join("-")
-      "#{fetch(:tmp_dir)}/git-ssh-#{suffix}.sh"
+      # Use a unique name that won't collide with other deployments, and
+      # that cannot be guessed by other processes that have access to /tmp.
+      "#{fetch(:tmp_dir)}/git-ssh-#{SecureRandom.hex(10)}.sh"
     }
     set_if_empty :git_environmental_variables, lambda {
       {
@@ -60,6 +60,10 @@ class Capistrano::SCM::Git < Capistrano::SCM::Plugin
     end
   end
 
+  def verify_commit
+    git :"verify-commit", fetch_revision
+  end
+
   def archive_to_release_path
     if (tree = fetch(:repo_tree))
       tree = tree.slice %r#^/?(.*?)/?$#, 1

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

@@ -42,6 +42,7 @@ namespace :git do
       within repo_path do
         with fetch(:git_environmental_variables) do
           git_plugin.update_mirror
+          git_plugin.verify_commit if fetch(:git_verify_commit)
         end
       end
     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", "tmp/webpacker", "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.14.0".freeze
+  VERSION = "3.17.0".freeze
 end

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

@@ -28,13 +28,10 @@ module Capistrano
     end
 
     describe "#set_defaults" do
-      it "makes git_wrapper_path using application, stage, and local_user" do
+      it "makes git_wrapper_path using a random hex value" do
         env.set(:tmp_dir, "/tmp")
-        env.set(:application, "my_app")
-        env.set(:stage, "staging")
-        env.set(:local_user, "(Git Web User) via ShipIt")
         subject.set_defaults
-        expect(env.fetch(:git_wrapper_path)).to eq("/tmp/git-ssh-my_app-staging-(Git Web User) via ShipIt.sh")
+        expect(env.fetch(:git_wrapper_path)).to match(%r{/tmp/git-ssh-\h{20}\.sh})
       end
 
       it "makes git_max_concurrent_connections" do
@@ -172,5 +169,16 @@ module Capistrano
         expect(revision).to eq("81cec13b777ff46348693d327fc8e7832f79bf43")
       end
     end
+
+    describe "#verify_commit" do
+      it "should run git verify-commit" do
+        env.set(:branch, "branch")
+
+        backend.expects(:capture).with(:git, "rev-list --max-count=1 branch").returns("81cec13b777ff46348693d327fc8e7832f79bf43")
+        backend.expects(:execute).with(:git, :"verify-commit", "81cec13b777ff46348693d327fc8e7832f79bf43")
+
+        subject.verify_commit
+      end
+    end
   end
 end

data/spec/support/Vagrantfile

@@ -6,7 +6,7 @@ Vagrant.configure("2") do |config|
   [:app].each_with_index do |role, i|
     config.vm.define(role, primary: true) do |primary|
       primary.vm.define role
-      primary.vm.box = "hashicorp/precise64"
+      primary.vm.box = "hashicorp/bionic64"
       primary.vm.network "forwarded_port", guest: 22, host: "222#{i}".to_i
       primary.vm.provision :shell, inline: "sudo apt-get -y install git-core"
 

data/spec/support/test_app.rb

@@ -40,6 +40,7 @@ module TestApp
     FileUtils.mkdir(test_app_path)
 
     File.open(gemfile, "w+") do |file|
+      file.write "source 'https://rubygems.org'\n"
       file.write "gem 'capistrano', path: '#{path_to_cap}'"
     end
 
@@ -185,12 +186,17 @@ module TestApp
     FileUtils.mv(config_path, location)
   end
 
-  def git_wrapper_path
-    "/tmp/git-ssh-my_app_name-#{stage}-#{current_user}.sh"
+  def git_wrapper_path_glob
+    "/tmp/git-ssh-*.sh"
   end
 
   def with_clean_bundler_env(&block)
     return yield unless defined?(Bundler)
-    Bundler.with_clean_env(&block)
+
+    if Bundler.respond_to?(:with_unbundled_env)
+      Bundler.with_unbundled_env(&block)
+    else
+      Bundler.with_clean_env(&block)
+    end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: capistrano
 version: !ruby/object:Gem::Version
-  version: 3.14.0
+  version: 3.17.0
 platform: ruby
 authors:
 - Tom Clements
 - Lee Hambley
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2022-03-12 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,13 +78,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".github/issue_template.md"
 - ".github/pull_request_template.md"
 - ".github/release-drafter.yml"
 - ".github/workflows/push.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - DEVELOPMENT.md
@@ -262,7 +220,7 @@ metadata:
   source_code_uri: https://github.com/capistrano/capistrano
   homepage_uri: https://capistranorb.com/
   documentation_uri: https://capistranorb.com/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -277,8 +235,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.8
+signing_key:
 specification_version: 4
 summary: Capistrano - Welcome to easy deployment with Ruby over SSH
 test_files:

data/.travis.yml

@@ -1,28 +0,0 @@
-language: ruby
-rvm:
-  - 2.6.3
-  - 2.5.5
-  - 2.4.6
-  - 2.3.8
-  - 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.3
-    - rvm: 2.5.5
-      before_script: bundle exec danger
-
-script: bundle exec rake spec rubocop
-install: bundle install --jobs=1
-cache: bundler
-branches:
-  only:
-    - master