dlss-capistrano 3.11.1 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de77b7bc3796b78fdbbc7b4900fb773bc31f98bf86713751311d62fa1a686c55
-  data.tar.gz: 8688c207edc6e7aa97008b7a9e209cfa19f391e463eac79cedd9a4d4ea352c09
+  metadata.gz: 7c83f228efbada9563b37dee41ba9d92c9c0739be6ae0852e9141fd8bdfa27d8
+  data.tar.gz: b32eb019a8ff21b5e492a91c8a59ff133aed7f07b0143e6c49953c794c5b3ed6
 SHA512:
-  metadata.gz: c8e66b1a045e9656bcf2f6c046a87cb1fad008cb0dd0f6044928738da5d1c780c256a238533fd0f05478caa948ef4fdfdf509ee11572f008b28f5a3db1dde8c2
-  data.tar.gz: 03de4eecdf5adca8277f84d4167e1f587ab758f38a75f8d11f5feac662d851fa9637ea812948c276347c00557f7c3a02c536fff34e5e51eca8fa2aeaebb5defc
+  metadata.gz: b09739793af365242f7e7295fded043596973d12ae22096fd526411a7843ed495d93d43ea77a2b8211c0bf7d4529ad3005162e222302b0d7f17ede5a48f857a8
+  data.tar.gz: 39394b595c334c1ba591bdd8bcab7053a951281261e312703feb00efbf4a9e327a1c935f376bf9eaeeb35e8d98a305a0e97713dc39aa3ee1ab89143e671ff049

data/README.md

@@ -6,20 +6,21 @@ This gem provides Capistrano deployment tasks used by Stanford Libraries' Digita
 
 ## Included Tasks
 
-### Bundle 2-style Configuration
+### Remote Execution
 
-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`:
+Sometimes you want to execute a command on all boxes in a given environment, and dlss-capistrano's got your back:
 
-```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
+```shell
+$ cap qa remote_execute["ps -ef | grep rolling | grep -v grep"]
+00:00 remote_execute
+      ps -ef | grep rolling | grep -v grep
+      ps -ef | grep rolling | grep -v grep
+      dor-indexing-app-qa-a.stanford.edu:
+dor_ind+  9159     1 20 Feb18 ?        14:15:03 rolling index
+      dor-indexing-app-qa-b.stanford.edu:
+dor_ind+ 29689     1 20 Feb18 ?        14:24:53 rolling index
 ```
 
-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:
@@ -31,6 +32,19 @@ 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).
 
+### Status checking
+
+**NOTE**: Requires that `curl` is installed on each server host the check is run on.
+
+Use `cap ENV check_status` to hit the (*e.g.*, [okcomputer](https://github.com/sportngin/okcomputer)-based) status endpoint of your application. This is especially valuable with hosts that cannot be directly checked due to firewall rules.
+
+By default, these checks run against all nodes with the `:web` role and hit the `/status/all` endpoint. These can be configured in `config/deploy.rb` (or `config/deploy/{ENV}.rb` if you need environment-specific variation):
+
+```ruby
+set :check_status_roles, [:my_status_check_web_role]
+set :check_status_path, '/my/status/check/endpoint'
+```
+
 ### SSH
 
 `cap ENV ssh` establishes an SSH connection to the host running in `ENV` environment, and changes into the current deployment directory

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.11.1'
+  s.version     = '4.1.1'
 
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Chris Beer", 'Mike Giarlo']

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

@@ -21,7 +21,7 @@ namespace :bundled_sidekiq do
 
   # NOTE: no `desc` here to avoid publishing this task in the `cap -T` list
   task :symlink do
-    on roles fetch(:bundled_sidekiq_roles) 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")

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

@@ -0,0 +1,23 @@
+# Capistrano plugin hook to set default values
+namespace :load do
+  task :defaults do
+    set :check_status_roles, fetch(:check_status_roles, [:web])
+    set :check_status_path, fetch(:check_status_path, '/status/all')
+  end
+end
+
+desc 'Run status checks'
+task :check_status do
+  on roles(fetch(:check_status_roles)), in: :sequence do |host|
+    status_url = "https://#{host}#{fetch(:check_status_path)}"
+
+    info "Checking status at #{status_url}"
+    status_body = capture("curl #{status_url}")
+
+    if status_body.match?(/FAILED/)
+      error status_body.lines.grep(/FAILED/).join
+    else
+      info SSHKit::Color.new($stdout).colorize('All checks passed!', :green)
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+desc "execute command on all servers"
+task :remote_execute, :command do |_task, args|
+  raise ArgumentError, 'remote_execute task requires an argument' unless args[:command]
+
+  on roles(:all) do |host|
+    info args[:command] if fetch(:log_level) == :debug
+    info "#{host}:\n#{capture(args[:command])}"
+  end
+end

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

@@ -24,28 +24,28 @@ namespace :sidekiq_systemd do
 
   desc 'Stop workers from picking up new jobs'
   task :quiet do
-    on roles fetch(:sidekiq_systemd_role) 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
+    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
+    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
+    on roles(fetch(:sidekiq_systemd_role)) do
       sudo :systemctl, 'restart', 'sidekiq-*', raise_on_non_zero_exit: false
     end
   end

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

@@ -23,21 +23,21 @@ namespace :sneakers_systemd do
 
   desc 'Stop running workers gracefully'
   task :stop do
-    on roles fetch(:sneakers_systemd_role) do
+    on roles(fetch(:sneakers_systemd_role)) do
       sudo :systemctl, 'stop', 'sneakers'
     end
   end
 
   desc 'Start workers'
   task :start do
-    on roles fetch(:sneakers_systemd_role) do
+    on roles(fetch(:sneakers_systemd_role)) do
       sudo :systemctl, 'start', 'sneakers'
     end
   end
 
   desc 'Restart workers'
   task :restart do
-    on roles fetch(:sneakers_systemd_role) do
+    on roles(fetch(:sneakers_systemd_role)) do
       sudo :systemctl, 'restart', 'sneakers', raise_on_non_zero_exit: false
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dlss-capistrano
 version: !ruby/object:Gem::Version
-  version: 3.11.1
+  version: 4.1.1
 platform: ruby
 authors:
 - Chris Beer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -87,9 +87,10 @@ files:
 - 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/check_status.rake
 - lib/dlss/capistrano/tasks/deployed_branch.rake
+- lib/dlss/capistrano/tasks/remote_execute.rake
 - lib/dlss/capistrano/tasks/sidekiq_systemd.rake
 - lib/dlss/capistrano/tasks/sneakers_systemd.rake
 - lib/dlss/capistrano/tasks/ssh.rake
@@ -114,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Capistrano recipes for use in SUL/DLSS projects

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

@@ -1,53 +0,0 @@
-# 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