dlss-capistrano 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7171cbf97175278c409ee689dfffe6e913aecffbcbafbfa2b1c4cb17a4ac1d6e
-  data.tar.gz: d8fdf63e606d14426b68111e8b24540faabf078fa12dee7dfaf728c5af1a2629
+  metadata.gz: 506c54e0736ba7c8d957d70eac27e0c87afac59efaf6661474d583633324af17
+  data.tar.gz: 467a54901a05725308adf64eacd926c6bee8788daa9c6c779ef053e178e51f8a
 SHA512:
-  metadata.gz: f5124eadc4d97921d2e77cc544e24c3f21e2d8ebc116bf8914ed8e7850d0fc836eed2d960c18bf57c9a1e8294a8af1a8841634fabc9f811e1cd8cd7c2419b630
-  data.tar.gz: b764c9e4e9946ed1a9cffe5628b470cfd4259248e715f60c6f46142a2f109990bd7df880b9051f2496ca7664d03a29a6d4bc7f4264b4a98db4ccea44ed406a0a
+  metadata.gz: 21c6a06bf65ea3a5df664de92e72c4030dce9bd281834863eda9205f4e2fa96b49753c2a5f8b36efec1f72fcfaef9ba559e3513f9efe09212e1584f7c25c7d57
+  data.tar.gz: 961902bb30a3e69e262ef12f140bf34fdee71d32c8f79eb9c3949ddcd32fa6f9c7160b52b349b7114f7535245b8420d61a7ec41e25afec98414f59000f55afe7

data/README.md

@@ -8,11 +8,9 @@ This gem provides Capistrano deployment tasks used by Stanford Libraries' Digita
 
 To start, we recommend an SSH configuration like the one described in the [DeveloperPlaybook](https://github.com/sul-dlss/DeveloperPlaybook/blob/main/best-practices/ssh_configuration.md), since it has sensible defaults for Kerberos authentication and multi-factor authentication (using `ProxyJump` and `ControlMaster`, etc.).
 
-To use controlmaster, you need to opt-in by setting the environment variable `USE_CAPISTRANO_CONTROLMASTER=true` (in e.g. your `~/.zshenv` file or similar for your particular shell).
+To get `dlss-capistrano` tasks running via an existing SSH control master socket, you need to opt-in by setting the environment variable `USE_CAPISTRANO_CONTROLMASTER=true` (in e.g. your `~/.zshenv` file or similar for your particular shell).
 
-If you use values other than the defaults for  `CONTROLMASTER_HOST` (`dlss-jump`) or `CONTROLMASTER_SOCKET` (`"~/.ssh/%r@%h:%p"`), you'll want to set these environment variables locally to the values you use (in e.g. your `~/.zshenv` file or similar for your particular shell).  Otherwise, the gem will fail to connect to the appropriate host and/or won't be able to properly check the status of the control master process.
-
-The control master host is the value of the `ProxyJump` directive in your SSH config, and the control master socket is the value of the `ControlPath` directive in your SSH config.
+If your SSH client configuration (`~/.ssh/config`) uses values other than the defaults for `CONTROLMASTER_HOST` (which maps to the `ProxyJump` directive, and defaults to `dlss-jump`) or `CONTROLMASTER_SOCKET` (which maps to the `ControlPath` directive, and defaults to `~/.ssh/%r@%h:%p`), you'll want to set these environment variables locally to the values you use (in e.g. your `~/.zshenv` file or similar for your particular shell). Otherwise, the gem will fail to connect to the appropriate jump host and/or won't be able to properly check the status of the control master process.
 
 ## Included Tasks
 

data/dlss-capistrano.gemspec

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

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

@@ -10,13 +10,6 @@ namespace :load do
   end
 end
 
-# Integrate hook into Capistrano
-namespace :deploy do
-  before :generate_otk, :setup_controlmaster do
-    invoke 'controlmaster:setup'
-  end
-end
-
 namespace :controlmaster do
   desc 'set up an SSH controlmaster process if missing'
   task :setup do

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

@@ -1,5 +1,5 @@
 desc 'display the deployed branch and commit'
-task deployed_branch: 'controlmaster:setup' do
+task :deployed_branch do
   # see https://github.com/mattbrictson/airbrussh/tree/v1.5.2?tab=readme-ov-file#capistrano-34x
   Airbrussh.configure do |config|
     config.truncate = false

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

@@ -10,7 +10,7 @@ namespace :load do
 end
 
 desc "execute command on all servers"
-task :remote_execute, [:command] => 'controlmaster:setup' do |_task, args|
+task :remote_execute, :command do |_task, args|
   raise ArgumentError, 'remote_execute task requires an argument' unless args[:command]
 
   # see https://github.com/mattbrictson/airbrussh/tree/v1.5.2?tab=readme-ov-file#capistrano-34x

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

@@ -0,0 +1,20 @@
+# Setup controlmaster SSH session before generating one-time-key
+before 'otk:generate', 'controlmaster:setup'
+
+DOES_NOT_REQUIRE_OTK_LIST = [
+  'bundler:map_bins',
+  'controlmaster:setup',
+  'controlmaster:start',
+  'default',
+  'deploy:generate_otk',
+  'install',
+  'load:defaults',
+  'otk:generate',
+  *Rake.application.stages
+].freeze
+
+Rake.application.tasks.each do |task|
+  next if DOES_NOT_REQUIRE_OTK_LIST.include?(task.name)
+
+  before task, 'deploy:generate_otk'
+end

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

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

data/lib/dlss/capistrano.rb

@@ -3,3 +3,4 @@ require 'capistrano/bundle_audit'
 require 'capistrano/shared_configs'
 
 Dir.glob("#{__dir__}/capistrano/tasks/*.rake").each { |r| import r }
+Dir.glob("#{__dir__}/capistrano/tasks/setup/*.rake").each { |r| import r }

data/lib/dlss.rb

@@ -1,3 +1,3 @@
 module DLSS
   require 'dlss/capistrano'
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dlss-capistrano
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Chris Beer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -119,6 +119,7 @@ files:
 - lib/dlss/capistrano/tasks/deployed_branch.rake
 - lib/dlss/capistrano/tasks/racecar_systemd.rake
 - lib/dlss/capistrano/tasks/remote_execute.rake
+- lib/dlss/capistrano/tasks/setup/setup.rake
 - lib/dlss/capistrano/tasks/sidekiq_systemd.rake
 - lib/dlss/capistrano/tasks/sneakers_systemd.rake
 - lib/dlss/capistrano/tasks/ssh.rake
@@ -144,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: Capistrano recipes for use in SUL/DLSS projects