dlss-capistrano 3.6.0 → 3.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c8f550ec45bd1d6633ac6868fc417aefc33b64ba8ef8134b14cb40f61c01c48
-  data.tar.gz: 2d1d900f77b688e06e7ccfaa314494307947b0a43ac19bdda7b0c163263f19f8
+  metadata.gz: 59f3e0a3a28fd4c039e6e2a861b16603911fe806ad71ca1aee18ffedb6e17ef9
+  data.tar.gz: c272545718a09a47b2cc2cd523edc55a6cd43c6b71453d390a14da1464d756d5
 SHA512:
-  metadata.gz: d3e1f76b839e71f7aaf1103d865ab0a30051161d3dd8360d525ee0486c554409a0ddcf8758f4b5081e36815710caa4d484790cab04f675e378a0f4fdcae97394
-  data.tar.gz: a266d77daf559af7cf561587f4ed5e47e27d79dad8afe835d3f38884cbb23cdd64f81dd5ecad3acdb6adc998540d57c3115ed071b971d5392abb248de5dadcea
+  metadata.gz: 5cbb9b707d0ff42c95c15e97f08a70bfd02a19cdc7fda35ca112571c907e911e43a1451a8ca3cccebe902db757fa5f4a6f31fc86fd63ef5976cf8047a525021e
+  data.tar.gz: a9b908df522ad9696ca5b99b9235c77016fc3eaf9c7665fba277c5b3f48bb4ccf964c9c7c696339cbd204b99245587713e75fc8af24913a5c72d9732de14408e

data/.github/pull_request_template.md

@@ -0,0 +1,12 @@
+## Why was this change made?
+
+
+
+## How was this change tested?
+
+
+
+## Which documentation and/or configurations were updated?
+
+
+

data/README.md

@@ -20,10 +20,50 @@ set :bundler2_config_path, '/tmp' # set to '#{shared_path}/bundle' by default
 
 Note that only `bundler2_config_use_hook` **must** be set in order to use this functionality.
 
+### Sidekiq symlink
+
+Every time the version of Sidekiq or Ruby changes, a corresponding Puppet PR must be made in order to update the XSendFilePath that allows Apache to access the bundled Sidekiq gem's assets. dlss-capistrano provides a hook to create a symlink to the bundled Sidekiq to avoid having to do this:
+
+```ruby
+set :bundled_sidekiq_symlink, true # false is the default value
+set :bundled_sidekiq_roles, [:app] # this is the default value
+```
+
+Set this in `config/deploy.rb` to automate the symlink creation, and then use `XSendFilePath /path/to/my/app/shared/bundled_sidekiq/web/assets` in Apache configuration (in Puppet).
+
 ### SSH
 
 `cap ENV ssh` establishes an SSH connection to the host running in `ENV` environment, and changes into the current deployment directory
 
+### SSH Connection Checking
+
+`cap ENV ssh_check` establishes an SSH connection to all app servers running in `ENV` environment and prints environment information to confirm the connection was made. This is used by [sdr-deploy](https://github.com/sul-dlss-labs/sdr-deploy/) to check SSH connections can be made in bulk before proceeding with a mass deploy.
+
+### Display Revision (and branches)
+
+`cap ENV deployed_branch` displays the currently deployed revision (commit ID) and any branches containing the revision for each server in `ENV`.
+
+### Resque-Pool hot swap (OPTIONAL)
+
+The `dlss-capistrano` gem provides a set of tasks for managing `resque-pool` workers when deployed in `hot_swap` mode. (If you are using `resque-pool` without `hot_swap`, we recommend continuing to use the `capistrano-resque-pool` gem instead of what `dlss-capistrano` provides.) The tasks are:
+
+```shell
+$ cap ENV resque:pool:hot_swap # this gracefully replaces the current pool with a new pool
+$ cap ENV resque:pool:stop     # this gracefully stops the current pool
+```
+
+By default, these tasks are not provided; instead, they must be explicitly enabled via adding a new `require` statement to the application's `Capfile`:
+
+```ruby
+require 'dlss/capistrano/resque_pool'
+```
+
+This is the hook provided if you opt in:
+
+```ruby
+after 'deploy:publishing', 'resque:pool:hot_swap'
+```
+
 ### Sidekiq via systemd
 
 `cap ENV sidekiq_systemd:{quiet,stop,start,restart}`: quiets, stops, starts, restarts Sidekiq via systemd.

data/dlss-capistrano.gemspec

@@ -4,7 +4,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "dlss-capistrano"
-  s.version     = "3.6.0"
+  s.version     = "3.10.1"
 
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Chris Beer", 'Mike Giarlo']

data/lib/dlss/capistrano.rb

@@ -2,6 +2,4 @@ require 'capistrano/one_time_key'
 require 'capistrano/bundle_audit'
 require 'capistrano/shared_configs'
 
-load File.expand_path('../capistrano/tasks/bundle_config.rake', __FILE__)
-load File.expand_path('../capistrano/tasks/sidekiq_systemd.rake', __FILE__)
-load File.expand_path('../capistrano/tasks/ssh.rake', __FILE__)
+Dir.glob("#{__dir__}/capistrano/tasks/*.rake").each { |r| import r }

data/lib/dlss/capistrano/resque_pool.rb

@@ -0,0 +1 @@
+import "#{__dir__}/resque_pool/tasks/resque_pool.rake"

data/lib/dlss/capistrano/resque_pool/tasks/resque_pool.rake

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# These tasks are a drop-in replacement for capistrano-resque-pool when using
+# hot-swappable pools. We replace these tasks because the upstream ones assume a
+# pidfile is present, which is not the case with hot-swappable pools.
+
+namespace :load do
+  task :defaults do
+    # Same capistrano variable used by capistrano-resque-pool for compatibility
+    set :resque_server_roles, fetch(:resque_server_roles, [:app])
+  end
+end
+
+# Integrate hook into Capistrano
+namespace :deploy do
+  before :starting, :add_resque_pool_hotswap_hook do
+    invoke 'resque:pool:add_hook'
+  end
+end
+
+namespace :resque do
+  namespace :pool do
+    # Lifted from capistrano-resque-pool
+    def rails_env
+      fetch(:resque_rails_env) ||
+        fetch(:rails_env) ||       # capistrano-rails doesn't automatically set this (yet),
+        fetch(:stage)              # so we need to fall back to the stage.
+    end
+
+    # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
+    task :add_hook do
+      after 'deploy:publishing', 'resque:pool:hot_swap'
+    end
+
+    desc 'Swap in a new pool, then shut down the old pool'
+    task :hot_swap do
+      on roles(fetch(:resque_server_roles)) do
+        within current_path do
+          execute :bundle, :exec, 'resque-pool', "--daemon --hot-swap --environment #{rails_env}"
+        end
+      end
+    end
+
+    desc 'Gracefully shut down current pool'
+    task :stop do
+      on roles(fetch(:resque_server_roles)) do
+        # This will usually return a single pid, but if you do multiple quick
+        # deployments, you may pick up multiple pids here, in which case we only
+        # kill the oldest one
+        pid = capture(:pgrep, '-f resque-pool-master').split.first
+
+        if test "kill -0 #{pid} > /dev/null 2>&1"
+          execute :kill, "-s QUIT #{pid}"
+        else
+          warn "Process #{pid} is not running"
+        end
+      end
+    end
+  end
+end

data/lib/dlss/capistrano/tasks/bundled_sidekiq.rake

@@ -0,0 +1,31 @@
+# Capistrano plugin hook to set default values
+namespace :load do
+  task :defaults do
+    set :bundled_sidekiq_symlink, fetch(:bundled_sidekiq_symlink, false)
+    set :bundled_sidekiq_roles, fetch(:bundled_sidekiq_roles, [:app])
+  end
+end
+
+# Integrate sidekiq-bundle hook into Capistrano
+namespace :deploy do
+  before :starting, :add_bundled_sidekiq_hook do
+    invoke 'bundled_sidekiq:add_hook' if fetch(:bundled_sidekiq_symlink)
+  end
+end
+
+namespace :bundled_sidekiq do
+  # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
+  task :add_hook do
+    after 'bundler:install', 'bundled_sidekiq:symlink'
+  end
+
+  # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
+  task :symlink do
+    on roles fetch(:bundled_sidekiq_roles) do
+      within release_path do
+        bundled_sidekiq_path = capture(:bundle, :info, '--path', :sidekiq)
+        execute(:ln, '-sf', bundled_sidekiq_path, "#{shared_path}/bundled_sidekiq")
+      end
+    end
+  end
+end

data/lib/dlss/capistrano/tasks/deployed_branch.rake

@@ -0,0 +1,10 @@
+desc 'display the deployed branch and commit'
+task :deployed_branch do
+  on roles(:app) do |host|
+    within current_path do
+      revision = capture :cat, 'REVISION'
+      branches = `git branch -r --contains #{revision}`.strip
+      info "#{host}: #{revision} (#{branches})"
+    end
+  end
+end

data/lib/dlss/capistrano/tasks/ssh_check.rake

@@ -0,0 +1,6 @@
+desc "check ssh connections to all app servers"
+task :ssh_check do
+  on roles(:app), in: :sequence do
+    execute
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dlss-capistrano
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.10.1
 platform: ruby
 authors:
 - Chris Beer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-21 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -76,6 +76,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/pull_request_template.md"
 - ".gitignore"
 - Gemfile
 - LICENSE
@@ -84,9 +85,14 @@ files:
 - dlss-capistrano.gemspec
 - lib/dlss.rb
 - lib/dlss/capistrano.rb
+- lib/dlss/capistrano/resque_pool.rb
+- lib/dlss/capistrano/resque_pool/tasks/resque_pool.rake
 - lib/dlss/capistrano/tasks/bundle_config.rake
+- lib/dlss/capistrano/tasks/bundled_sidekiq.rake
+- lib/dlss/capistrano/tasks/deployed_branch.rake
 - lib/dlss/capistrano/tasks/sidekiq_systemd.rake
 - lib/dlss/capistrano/tasks/ssh.rake
+- lib/dlss/capistrano/tasks/ssh_check.rake
 - lib/lyberteam-capistrano-devel.rb
 homepage: 
 licenses:
@@ -107,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Capistrano recipes for use in SUL/DLSS projects