capistrano-opscomplete 1.0.2 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39158f12f3935cff8bc3d2c39b6d252c7ac594de47bad9c35fa83463d8dbec03
-  data.tar.gz: aefdd1684fa67a31f19a1e9520edc82139ded5f5569b324cafaa5afa9c8a1e9e
+  metadata.gz: a20eef8ec0a80982b18b4ce9f01d0b1596b56ae46f49ef1c8fcaf90d0172e7f0
+  data.tar.gz: b01fc372be74a269ff2d31e8e5f004624b45f1e42b247a8b1435c7c2ab17ec18
 SHA512:
-  metadata.gz: 9639dc1c7d2a77fee4088ac466e428c5e60691ae82e802a7c32dc990008d6b7ef568daac73e0bfec16e489bc2038e91431f0bdd1600919ec3d30e57e8b6d354d
-  data.tar.gz: df97a9b57171097b35ce78222d0d073ecfcab37c42f3d362c52e96d5ae68cae23a610b33cfc80017828723ab479567881f0dd23c8183424211681387432a9f6f
+  metadata.gz: 23d4853424d027318d5054fde4e024a849b2575b75a07ee754177a7eb43a14262bee6bcb8cb956236bccf9ea7d625d4bb42b23ec20b895499346f8c2b50b8bb7
+  data.tar.gz: 07ef3b9da3ec41136d4a2698e649b3413ebe035d294cb59546411a0111f571a45b9c2b64b8e542c299b7db1c033a47d1681dfcee9326db89b70389d773aa7e8b

data/.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Tests
+
+on:
+  push:
+    branches: [master, workflow]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.6.6', '3.1.2']
+    # steps:
+    # - name: Rubocop checks
+    #   uses: gimenete/rubocop-action@1.0
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [1.3.0] - 2025-02-18
+### Added
+- Add new capistrano task (`opscomplete:supervisor:disable`) which disables supervisor on non-procfile servers
+
+## [1.2.0] - 2024-08-23
+### Changed
+- Added a feature to restart Puma
+
+## [1.1.0] - 2024-08-23
+### Changed
+- Added a feature to reload the puma systemd user service.
+
 ## [1.0.2] - 2022-07-29
 ### Changed
 - Improve error message for missing Node.js version

data/Gemfile.lock

@@ -1,35 +1,38 @@
 PATH
   remote: .
   specs:
-    capistrano-opscomplete (1.0.2)
+    capistrano-opscomplete (1.3.1)
       capistrano (>= 3.0, < 4.0.0)
       rake
 
 GEM
   remote: https://rubygems.org/
   specs:
-    airbrussh (1.4.1)
+    airbrussh (1.5.2)
       sshkit (>= 1.6.1, != 1.7.0)
     ast (2.4.2)
-    capistrano (3.17.0)
+    base64 (0.2.0)
+    capistrano (3.19.1)
       airbrussh (>= 1.0.0)
       i18n
       rake (>= 10.0.0)
       sshkit (>= 1.9.0)
-    concurrent-ruby (1.1.10)
-    i18n (1.12.0)
+    concurrent-ruby (1.3.4)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
     makandra-rubocop (4.4.0)
       rubocop (~> 0.76.0)
       rubocop-rails (~> 2.3.2)
-    net-scp (1.2.1)
-      net-ssh (>= 2.6.5)
-    net-ssh (7.0.1)
+    net-scp (4.0.0)
+      net-ssh (>= 2.6.5, < 8.0.0)
+    net-sftp (4.0.0)
+      net-ssh (>= 5.0.0, < 8.0.0)
+    net-ssh (7.2.3)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
-    rack (2.2.3)
+    rack (3.0.12)
     rainbow (3.0.0)
     rake (13.0.6)
     rubocop (0.76.0)
@@ -43,8 +46,10 @@ GEM
       rack (>= 1.1)
       rubocop (>= 0.72.0)
     ruby-progressbar (1.11.0)
-    sshkit (1.21.2)
+    sshkit (1.23.0)
+      base64
       net-scp (>= 1.1.2)
+      net-sftp (>= 2.1.2)
       net-ssh (>= 2.8.0)
     unicode-display_width (1.6.1)
 
@@ -55,6 +60,7 @@ DEPENDENCIES
   bundler (~> 2)
   capistrano-opscomplete!
   makandra-rubocop (~> 4)
+  rake (~> 13)
 
 BUNDLED WITH
-   2.3.10
+   2.4.22

data/README.md

@@ -7,7 +7,7 @@ This gem provides capistrano tasks for convenient deployment to a makandra [OpsC
 Include the gem in your applications Gemfile:
 
 ```ruby
-gem 'capistrano-opscomplete'
+gem 'capistrano-opscomplete', require: false
 ```
 
 And then execute:
@@ -52,8 +52,11 @@ And in case you enabled [`Procfile support`](https://makandracards.com/opscomple
 e.g. like this:
 
 ```ruby
-# Update and Restart supervisor config
+# Update supervisor config
 after 'deploy:updating', 'opscomplete:supervisor:gen_config'
+# Stop processes and remove config on non :procfile_role servers
+after 'deploy:published', 'opscomplete:supervisor:disable'
+# Restart supervisor processes
 after 'deploy:published', 'opscomplete:supervisor:restart_procs'
 ```
 
@@ -159,7 +162,7 @@ after 'deploy:updating', 'opscomplete:ruby:ensure'
 
 ## Managing your nodejs version with `capistrano-opscomplete`
 
-You can manage NodeJS also with `capistrano-opscomplete`. It will check the `.nvmrc`, `.node-version` and `.tool-versions` in the release direcotry (in this order) or you can configure it with `:opscomplete_nodejs_version` in your capistrano configuration.
+You can manage NodeJS also with `capistrano-opscomplete`. It will check the `.nvmrc`, `.node-version` and `.tool-versions` in the release directory (in this order) or you can configure it with `:opscomplete_nodejs_version` in your capistrano configuration.
 
 Include the gem in your applications Gemfile:
 
@@ -173,8 +176,12 @@ An example configuration could look like this:
 ```ruby
 # After unpacking your release, before bundling, compiling assets, ...
 after 'deploy:updating', 'opscomplete:nodejs:ensure'
+# reload puma
+after 'deploy:published', 'opscomplete:puma:reload'
 ```
 
+The version for the NodeJS installation has to be a specific version and not a floating version like, e.g. lts/gallium.
+
 ## Contributing
 
 Bug reports and pull requests are welcome. Don't hesitate to [open a new issue](https://github.com/makandra/capistrano-opscomplete/issues/new).

data/Rakefile

@@ -1,2 +1,10 @@
+require 'rubocop/rake_task'
 require 'bundler/gem_tasks'
-task default: :spec
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  # task.requires << 'rubocop-rake'
+  task.patterns = ['lib/**/*.rb']
+  # task.formatters = ['files']
+end
+
+task default: [:rubocop]

data/capistrano-opscomplete.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
 
   spec.required_rubygems_version = '>=2.0.1'
 
+  spec.add_development_dependency 'rake', '~> 13'
   spec.add_development_dependency 'makandra-rubocop', '~> 4'
   spec.add_development_dependency 'bundler', '~> 2'
 

data/lib/capistrano/dsl/opscomplete.rb

@@ -89,32 +89,48 @@ module Capistrano
         # 1) Get version from capistrano configuration (highest precedence, 'override')
         if fetch(:opscomplete_nodejs_version)
           debug("Using version from :opscomplete_nodejs_version setting: #{fetch(:opscomplete_nodejs_version)}.")
-          fetch(:opscomplete_nodejs_version)
+          app_version = fetch(:opscomplete_nodejs_version)
 
         # 2) Get version from version file in release dir (after deploy:updating, before deploy:updated)
         elsif capture(:nodejs_get_version, release_path)
           debug("Using version from server's release_dir/.nvmrc, .node-version or .tool-versions file: #{capture(:nodejs_get_version, release_path)}")
-          capture(:nodejs_get_version, release_path)
+          app_version = capture(:nodejs_get_version, release_path)
 
         else
           raise Capistrano::ValidationError, 'Could not find application\'s Node.js version. Consider setting opscomplete_ruby_version.'
         end
+
+        normalize_nodejs_version(app_version)
       end
 
       def nodejs_installable_versions
         nodejs_installable_versions = capture(:nodejs_installable_versions).split("\n")
-        nodejs_installable_versions.map!(&:strip)
-        nodejs_installable_versions
+        nodejs_installable_versions.map { |version| normalize_nodejs_version(version) }
       end
 
       def nodejs_installed_versions
         nodejs_installed_versions = capture(:nodejs_installed_versions).split("\n")
-        nodejs_installed_versions.map!(&:strip)
+        nodejs_installed_versions.map { |version| normalize_nodejs_version(version) }
       end
 
       def validation_error!(message)
         raise Capistrano::ValidationError, message unless dry_run?
       end
+
+      private
+
+      def normalize_nodejs_version(version)
+        version = version.strip
+        # Make sure the versions returned by our Node version manager have the same format
+        # as the one in our .nvmrc or .tools-versions:
+        #
+        # - In .nvmrc, we often document node versions as "1.2.3". But some people use "v1.2.3".
+        # - When asking NVM for Node versions, it gives us "v1.2.3".
+        # - When asking asdf for Node versions, it gives us "1.2.3" (without the leading "v").
+        version = version.sub(/\A[vV]/, '') # remove leading "v" or "V"
+        version
+      end
+
     end
   end
 end

data/lib/capistrano/opscomplete/puma.rake

@@ -0,0 +1,20 @@
+# vim: filetype=ruby
+namespace :opscomplete do
+  namespace :puma do
+
+    desc 'Reload puma'
+    task :reload do
+      on roles fetch(:puma_roles, :all) do # by default only the puma role, but if not available on all systems
+        execute :puma_reload
+      end
+    end
+
+    desc 'Restart puma'
+    task :restart do
+      on roles fetch(:puma_roles, :all) do # by default only the puma role, but if not available on all systems
+        execute :puma_restart
+      end
+    end
+
+  end
+end

data/lib/capistrano/opscomplete/supervisor.rake

@@ -10,6 +10,15 @@ namespace :opscomplete do
       end
     end
 
+    desc 'Remove supervisor configuration and stop all Procfile processes on non :procfile_role servers.'
+    task :disable do
+      on roles(:all) - roles(fetch(:procfile_role, :app)) do
+        within release_path do
+          execute :supervisor_disable
+        end
+      end
+    end
+
     desc 'Reread the supervisor configuration and (re)start all Procfile processes'
     task :restart_procs do
       on roles fetch(:procfile_role, :app) do

data/lib/capistrano/opscomplete/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Opscomplete
-    VERSION = '1.0.2'.freeze
+    VERSION = '1.3.1'.freeze
   end
 end

data/lib/capistrano/opscomplete.rb

@@ -6,4 +6,5 @@ require 'rake'
 load File.expand_path('opscomplete/ruby.rake', __dir__)
 load File.expand_path('opscomplete/nodejs.rake', __dir__)
 load File.expand_path('opscomplete/supervisor.rake', __dir__)
+load File.expand_path('opscomplete/puma.rake', __dir__)
 load File.expand_path('opscomplete/hooks.rb', __dir__)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-opscomplete
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.3.1
 platform: ruby
 authors:
 - Makandra Operations
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 2025-03-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: makandra-rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +93,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
@@ -95,6 +110,7 @@ files:
 - lib/capistrano/opscomplete.rb
 - lib/capistrano/opscomplete/hooks.rb
 - lib/capistrano/opscomplete/nodejs.rake
+- lib/capistrano/opscomplete/puma.rake
 - lib/capistrano/opscomplete/ruby.rake
 - lib/capistrano/opscomplete/supervisor.rake
 - lib/capistrano/opscomplete/version.rb
@@ -121,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Capistrano tasks for easy deployment to a makandra opscomplete environment.