dlss-capistrano 3.5.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cccccc5b5eaf3803ab7126c36e158c7261e39e6008a5b0d41779c9b1899efdc
-  data.tar.gz: 0d047c34a9dd98823e0d4febf90324f4f0bd677885c28a2532cbe4bfdc2d4c9a
+  metadata.gz: e70dce4334fb19dd733691feeb6767a15ad60ec0b23cdd798db3b95eac0cbb3c
+  data.tar.gz: 2ec578117cf92d26845b752285b7f4f469978873584d8f2abfbc18dd66c49aaf
 SHA512:
-  metadata.gz: 4ef5f0bb20fad9adfa66175b7cbbbedf9113b346f2e321ef8514659fe868f3c77aa304c9f4c1cbd73ce686d5c7dde0ca7c0908681c3246df77c5022bfc2b71e6
-  data.tar.gz: 909936827f0f18dd5d864b16ca865db074ce16cc1b264abdb2e4495195f32c19ee0b2cc04dd6511db26d2e95743f92caf537e65c5dd0ab39e147b7f6562b383a
+  metadata.gz: 5aaf6ce12fd37b5586d8302116e2db5d94fb83076c8860ca203573ae93b414fc304892e45a4e5b2368bf68be260dc5c01b61d02319b63c7127c313cdb07821e6
+  data.tar.gz: c5f48c6365a083f290814c3063d3c65cd7ae49a48d3b303c4615758cd7df69dd7a6acc858ba6e47922f7a3caf8d81d046e2a6be7ecd09dfcff97b2eb97fa44a2

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

@@ -1,20 +1,106 @@
 # dlss-capistrano
 
-This gem contains classes that deal with the Capistrano deployment of SUL DLSS Ruby projects.
+[![Gem Version](https://badge.fury.io/rb/dlss-capistrano.svg)](https://badge.fury.io/rb/dlss-capistrano)
 
-## Capfile assumptions
+This gem provides Capistrano deployment tasks used by Stanford Libraries' Digital Library Systems and Services group.
 
-This gem makes the following assumptions about your Ruby project
+## Included Tasks
+
+### Bundle 2-style Configuration
+
+To override the capistrano-bundler gem and use Bundler 2-style configuration without using deprecated arguments, you can set the following settings in `config/deploy.rb`:
+
+```ruby
+set :bundler2_config_use_hook, true # this is how to opt-in to bundler 2-style config. it's false by default
+set :bundler2_config_roles, [:app] # feel free to add roles to this array if you need them
+set :bundler2_config_deployment, true # this is true by default
+set :bundler2_config_without, 'production' # exclude development, and test bundle groups by default
+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'
+```
+
+### Sidekiq via systemd
+
+`cap ENV sidekiq_systemd:{quiet,stop,start,restart}`: quiets, stops, starts, restarts Sidekiq via systemd.
+
+These tasks are intended to replace those provided by `capistrano-sidekiq` gem, which has assumptions about systemd that do not apply to our deployed environments.
+
+#### Capistrano role
+
+The sidekiq_systemd tasks assume a Capistrano role of `:app`. If your application uses a different Capistrano role for hosts that run Sidekiq workers, you can configure this in `config/deploy.rb`, *e.g.*:
+
+```ruby
+set :sidekiq_systemd_role, :worker
+```
+
+#### Deployment hooks
+
+The sidekiq_systemd tasks assume you want to hook them into Capistrano deployment on your own. If you want to use the hooks provided by `dlss-capistrano`, you can opt in via `config/deploy.rb`:
+
+```ruby
+set :sidekiq_systemd_use_hooks, true
+```
+
+These are the hooks provided if you opt in:
+
+```ruby
+after 'deploy:failed', 'sidekiq_systemd:restart'
+after 'deploy:published', 'sidekiq_systemd:start'
+after 'deploy:starting', 'sidekiq_systemd:quiet'
+after 'deploy:updated', 'sidekiq_systemd:stop'
+```
+
+## Assumptions
+
+dlss-capistrano makes the following assumptions about your Ruby project
 
 - You are using Capistrano 3+
 - You use git for source control
-- The server you deploy to uses rvm, it is installed systemwide, and is the default system ruby
+- The server you deploy to uses rvm, it is installed system-wide, and is the default system ruby
 - You do not have an .rvmrc checked into git (should be in your .gitignore)
 - You will not use rvm gemsets on the server you deploy to
 - Bundler will install specified gems into {your_project_home}/shared/bundle directory
 - Will deploy from the master branch, unless you set :branch to another branch or tag
 
+## Copyright
 
-== Copyright
-
-Copyright (c) 2015 Stanford University Library. See LICENSE for details.
+Copyright (c) 2020 Stanford University. See LICENSE for details.

data/dlss-capistrano.gemspec

@@ -4,13 +4,13 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "dlss-capistrano"
-  s.version     = "3.5.0"
+  s.version     = "3.10.0"
 
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Chris Beer","Willy Mene"]
-  s.email       = ["cabeer@stanford.edu"]
-  s.summary     = "Capistrano recipies for use in SUL/DLSS projects"
-  s.description = "Capistrano recipies  to assist with the development, testing, and release of SUL/DLSS Ruby project"
+  s.authors     = ["Chris Beer", 'Mike Giarlo']
+  s.email       = ["cabeer@stanford.edu", 'mjgiarlo@stanford.edu']
+  s.summary     = "Capistrano recipes for use in SUL/DLSS projects"
+  s.description = "Capistrano recipes to assist with development, testing, & deployment of SUL/DLSS Ruby projects"
   s.license     = "Apache-2.0"
 
   s.required_rubygems_version = ">= 1.3.6"
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   # All dependencies are runtime dependencies, since this gem's "runtime" is
   # the dependent gem's development-time.
   s.add_dependency "capistrano", "~> 3.0"
-  s.add_dependency "capistrano-bundle_audit", ">= 0.1.0"
+  s.add_dependency "capistrano-bundle_audit", ">= 0.3.0"
   s.add_dependency "capistrano-one_time_key"
   s.add_dependency "capistrano-shared_configs"
 

data/lib/dlss/capistrano.rb

@@ -2,4 +2,4 @@ require 'capistrano/one_time_key'
 require 'capistrano/bundle_audit'
 require 'capistrano/shared_configs'
 
-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:restart', '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/bundle_config.rake

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# These tasks exist because capistrano-bundler does not yet have a built-in
+# mechanism for configuring bundler 2 without deprecation warnings. We can dump
+# this if/when https://github.com/capistrano/bundler/issues/115 is resolved.
+
+def default_bundle_path
+  Pathname.new("#{shared_path}/bundle")
+end
+
+namespace :load do
+  task :defaults do
+    # This provides opt-in behavior. Do nothing if not requested.
+    set :bundler2_config_use_hook, fetch(:bundler2_config_use_hook, false)
+    set :bundler2_config_roles, fetch(:bundler2_config_roles, [:app])
+    set :bundler2_config_deployment, fetch(:bundler2_config_deployment, true)
+    set :bundler2_config_without, fetch(:bundler2_config_without, 'development:test')
+    # NOTE: `shared_path` is not defined at this point, so we can't set the default value to `default_bundle_path`
+    set :bundler2_config_path, fetch(:bundler2_config_path, nil)
+  end
+end
+
+# Integrate bundle config hook into Capistrano
+namespace :deploy do
+  before :starting, :add_bundler2_config_hook do
+    invoke 'bundler2:add_hook' if fetch(:bundler2_config_use_hook)
+  end
+end
+
+namespace :bundler2 do
+  # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
+  task :add_hook do
+    # Override capistrano-bundler settings
+    # HT: https://github.com/capistrano/bundler/issues/115#issuecomment-616570236
+    set :bundle_flags, '--quiet' # this unsets --deployment, see details in config_bundler task details
+    set :bundle_path, nil
+    set :bundle_without, nil
+
+    before 'bundler:install', 'bundler2:config'
+  end
+
+  # NOTE: This task lacks a `desc` to avoid publishing it, since we do not
+  #       foresee needing to run this task manually. It should run via hook.
+  #
+  # Configure bundler 2 without using deprecated arguments (overrides capistrano-bundler
+  task :config do
+    on roles fetch(:bundler2_config_roles) do
+      execute "bundle config --local deployment #{fetch(:bundler2_config_deployment)}"
+      execute "bundle config --local without '#{fetch(:bundler2_config_without)}'"
+      execute "bundle config --local path #{fetch(:bundler2_config_path) || default_bundle_path}"
+    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/sidekiq_systemd.rake

@@ -0,0 +1,52 @@
+# Capistrano plugin hook to set default values
+namespace :load do
+  task :defaults do
+    set :sidekiq_systemd_role, fetch(:sidekiq_systemd_role, :app)
+    set :sidekiq_systemd_use_hooks, fetch(:sidekiq_systemd_use_hooks, false)
+  end
+end
+
+# Integrate sidekiq hooks into Capistrano
+namespace :deploy do
+  before :starting, :add_sidekiq_systemd_hooks do
+    invoke 'sidekiq_systemd:add_hooks' if fetch(:sidekiq_systemd_use_hooks)
+  end
+end
+
+namespace :sidekiq_systemd do
+  # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
+  task :add_hooks do
+    after 'deploy:failed', 'sidekiq_systemd:restart'
+    after 'deploy:published', 'sidekiq_systemd:start'
+    after 'deploy:starting', 'sidekiq_systemd:quiet'
+    after 'deploy:updated', 'sidekiq_systemd:stop'
+  end
+
+  desc 'Stop workers from picking up new jobs'
+  task :quiet do
+    on roles fetch(:sidekiq_systemd_role) do
+      sudo :systemctl, 'reload', 'sidekiq-*', raise_on_non_zero_exit: false
+    end
+  end
+
+  desc 'Stop running workers gracefully'
+  task :stop do
+    on roles fetch(:sidekiq_systemd_role) do
+      sudo :systemctl, 'stop', 'sidekiq-*'
+    end
+  end
+
+  desc 'Start workers'
+  task :start do
+    on roles fetch(:sidekiq_systemd_role) do
+      sudo :systemctl, 'start', 'sidekiq-*', '--all'
+    end
+  end
+
+  desc 'Restart workers'
+  task :restart do
+    on roles fetch(:sidekiq_systemd_role) do
+      sudo :systemctl, 'restart', 'sidekiq-*', raise_on_non_zero_exit: false
+    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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dlss-capistrano
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.10.0
 platform: ruby
 authors:
 - Chris Beer
-- Willy Mene
+- Mike Giarlo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-01 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: capistrano-one_time_key
   requirement: !ruby/object:Gem::Requirement
@@ -67,14 +67,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Capistrano recipies  to assist with the development, testing, and release
-  of SUL/DLSS Ruby project
+description: Capistrano recipes to assist with development, testing, & deployment
+  of SUL/DLSS Ruby projects
 email:
 - cabeer@stanford.edu
+- mjgiarlo@stanford.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/pull_request_template.md"
 - ".gitignore"
 - Gemfile
 - LICENSE
@@ -83,7 +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:
@@ -104,9 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Capistrano recipies for use in SUL/DLSS projects
+summary: Capistrano recipes for use in SUL/DLSS projects
 test_files: []