capistrano-opscomplete 0.6.0 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c5c6ec21950e64171120fc314ea2b909ceb7262fd1175732a93f5897b9a6933
-  data.tar.gz: daa695ea2c44e828cd82ee95c37cecc8ab6257421d1c8e7b05b5876cf5912a46
+  metadata.gz: 4338dafea7ab6110c0e31e90aedce65d26ae913cb34e637336e367fcf847ad65
+  data.tar.gz: 98a5dbee6e6b063e0354473e37eba77c0a29ed6c3234f7dc26e39a6862597614
 SHA512:
-  metadata.gz: 93c67f0e7960afb7b4c691cdd170b43215cc119b236beebe9b4bfb492dca3ca9d55d7e819d56bd034415c833669b0196291a6ff904c9df16c2dcb251d8e04243
-  data.tar.gz: 558e16c5063b40ff09ca57c0c4312454622cb3ca91a1b4817a1465ef8a424a65513162378792c97a5bf433b9ac130c411e7ac0ce8c367b75e34d5e859387408e
+  metadata.gz: 4d8ab6821a98cb0de4f94fde3e91925cf8e02d4427add9f7055c8b4cf08eb825d0f074b0cc4c80abec33a10c8f031e12d8b1e583355fad26e1d73cb9bfe8f920
+  data.tar.gz: ba7615f7868f66f31ee84050ffc2de14a450c91265b38d74774f3849c17cd737332889fb32dff1e9742656ab3c6a80858265ca81895b923b4e80b44974a478f8

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/CHANGELOG.md

@@ -1,4 +1,36 @@
-## Unreleased
+## [0.6.5] - 2020-11-20
+
+### Fixed
+- Correct warning message for `opscomplete:ruby:broken_gems_warning`
+
+## [0.6.4] - 2020-11-19
+
+### Added
+- You can now manage the Node.js version which needs to be installed
+- Add two new capistrano tasks (`opscomplete:ruby:broken_gems_warning`, `opscomplete:ruby:reset`) which help to mitigate problems when a deployment fails (described in: [#19](https://github.com/makandra/capistrano-opscomplete/issues/19))
+
+### Fixed
+- Added missing namespace for code example
+
+## [0.6.3] - 2020-07-23
+
+### Fixed
+- regression after ([#18](https://github.com/makandra/capistrano-opscomplete/issues/18)) was merged
+
+## [0.6.2] - 2020-07-23
+
+### Fixed
+- rbenv-build changed behaviour of `--list` ([#20](https://github.com/makandra/capistrano-opscomplete/issues/20))
+
+### Changed
+- Bumped rack dependency from 2.1.1 to 2.2.3
+
+## [0.6.1] - 2020-04-16
+### Added
+- Use Ruby 2.6 for development
+
+### Changed
+- Add rake as a runtime dependency
 
 ## [0.6.0] - 2020-01-13
 ### Added

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    capistrano-opscomplete (0.6.0)
+    capistrano-opscomplete (0.6.5)
       capistrano (>= 3.0, < 4.0.0)
+      rake
 
 GEM
   remote: https://rubygems.org/
@@ -15,8 +16,8 @@ GEM
       i18n
       rake (>= 10.0.0)
       sshkit (>= 1.9.0)
-    concurrent-ruby (1.1.5)
-    i18n (1.8.2)
+    concurrent-ruby (1.1.6)
+    i18n (1.8.4)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
     makandra-rubocop (4.2.0)
@@ -28,9 +29,9 @@ GEM
     parallel (1.19.1)
     parser (2.7.0.2)
       ast (~> 2.4.0)
-    rack (2.1.1)
+    rack (2.2.3)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rubocop (0.76.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -54,7 +55,6 @@ DEPENDENCIES
   bundler (~> 2)
   capistrano-opscomplete!
   makandra-rubocop (~> 4)
-  rake (~> 10.0)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -36,7 +36,13 @@ An example configuration could look like this:
 after 'deploy:updating', 'opscomplete:ruby:ensure'
 ```
 
-and in case you enabled [`Procfile support`](https://makandracards.com/opscomplete/67829-procfile-support) you can use the following tasks:
+If you want to handle the ruby version for rollbacks too, you should add:
+
+```ruby
+after 'deploy:reverting', 'opscomplete:ruby:ensure'
+```
+
+And in case you enabled [`Procfile support`](https://makandracards.com/opscomplete/67829-procfile-support) you can use the following tasks:
 
     opscomplete:supervisor:gen_config
     opscomplete:supervisor:restart_procs
@@ -59,7 +65,7 @@ To change the role where these tasks will get executed, set `:procfile_role` in
 set :procfile_role, :sidekiq
 ```
 
-If you want to run different Procfiles on differen servers, you can set the `:procfile` property in your `config/deploy/${env}.rb`:
+If you want to run different Procfiles on different servers, you can set the `:procfile` property in your `config/deploy/${env}.rb`:
 
 ```
 # In this example, `Procfile` will get used for supervisor on srv2.example.com and `Procfile.sidekiq` for supervisor on srv1.example.com.
@@ -151,6 +157,24 @@ There are many hooks available in the [default deploy flow](https://capistranorb
 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.
+
+Include the gem in your applications Gemfile:
+
+```ruby
+gem 'capistrano-opscomplete'
+```
+
+Now, add some [hooks](#using-capistrano-hooks) in your capistrano configuration (e.g. `deploy.rb`).
+An example configuration could look like this:
+
+```ruby
+# After unpacking your release, before bundling, compiling assets, ...
+after 'deploy:updating', 'opscomplete:nodejs:ensure'
+```
+
 ## 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/capistrano-opscomplete.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'makandra-rubocop', '~> 4'
   spec.add_development_dependency 'bundler', '~> 2'
-  spec.add_development_dependency 'rake', '~> 10.0'
 
+  spec.add_dependency 'rake'
   spec.add_dependency 'capistrano', '>=3.0', '<4.0.0'
 end

data/lib/capistrano/dsl/opscomplete.rb

@@ -24,17 +24,17 @@ module Capistrano
         # 1) Get version from capistrano configuration (highest precedence, 'override')
         if fetch(:opscomplete_ruby_version)
           debug("Using version from :opscomplete_ruby_version setting: #{fetch(:opscomplete_ruby_version)}.")
-          return fetch(:opscomplete_ruby_version)
+          fetch(:opscomplete_ruby_version)
 
         # 2) Get version from .ruby-version in release dir (after deploy:updating, before deploy:updated)
         elsif test("[ -f #{release_ruby_version_file_path} ]")
           debug("Using version from server's release_dir/.ruby-version file: #{capture(:cat, release_ruby_version_file_path)}")
-          return capture(:cat, release_ruby_version_file_path)
+          capture(:cat, release_ruby_version_file_path)
 
         # 3) Get version from local checkout/cwd
         elsif File.readable?('.ruby-version')
           debug("Using version from local (cwd) .ruby-version file: #{File.read('.ruby-version').strip}")
-          return File.read('.ruby-version').strip
+          File.read('.ruby-version').strip
 
         # FAIL: We have no idea which version to use
         else
@@ -65,7 +65,7 @@ module Capistrano
       end
 
       def rbenv_installable_rubies
-        rbenv_installable_rubies = capture(:rbenv, :install, '--list').split("\n")
+        rbenv_installable_rubies = capture(:rbenv, :install, '--list-all').split("\n")
         rbenv_installable_rubies.map!(&:strip)
         rbenv_installable_rubies.delete('Available version:')
         rbenv_installable_rubies
@@ -108,6 +108,38 @@ module Capistrano
       def rubygems_install(version)
         rbenv_exec("gem update --no-document --system '#{version}'")
       end
+
+      def managed_nodejs?
+        test("[ -f ${HOME}/.nodejs_managed_by_makandra ]")
+      end
+
+      def app_nodejs_version
+
+        # 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)
+
+        # 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)
+
+        else
+          raise Capistrano::ValidationError, 'Could not find application\'s Node.js version. Consider setting opscomplete_ruby_version.'
+        end
+      end
+
+      def nodejs_installable_versions
+        nodejs_installable_versions = capture(:nodejs_installable_versions).split("\n")
+        nodejs_installable_versions.map!(&:strip)
+        nodejs_installable_versions
+      end
+
+      def nodejs_installed_versions
+        nodejs_installed_versions = capture(:nodejs_installed_versions).split("\n")
+        nodejs_installed_versions.map!(&:strip)
+      end
     end
   end
 end

data/lib/capistrano/opscomplete.rb

@@ -1,5 +1,9 @@
 require 'capistrano/opscomplete/version'
 
+# Need to require rake before we can use the Rake DSL (task do ..., namespace do, ...)
+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/deploy.rake', __dir__)
+load File.expand_path('../opscomplete/hooks.rb', __FILE__)

data/lib/capistrano/opscomplete/hooks.rb

@@ -0,0 +1 @@
+after 'deploy:failed', 'opscomplete:ruby:broken_gems_warning'

data/lib/capistrano/opscomplete/nodejs.rake

@@ -0,0 +1,53 @@
+# vim: filetype=ruby
+require 'capistrano/dsl/opscomplete'
+
+namespace :opscomplete do
+  include Capistrano::DSL::Opscomplete
+  # desc 'Validate opscomplete specific configuration'
+  task :validate do
+    invoke('opscomplete:nodejs:check')
+  end
+
+  namespace :nodejs do
+    desc 'Check if nodejs version is set according to application\'s .node-version or .nvmrc (in this order).'
+    task :check do
+      on roles fetch(:nodejs_roles, :all) do |host|
+        warn("#{host}: Managed Node.js environment! Won't do any changes to nodejs version.") if managed_nodejs?
+        unless capture(:nodejs_current_version) == app_nodejs_version
+          raise Capistrano::ValidationError,
+                "#{host}: Node.js version is not set according to application\'s .node-version or .nvmrc file. Use cap opscomplete:nodejs:ensure."
+        end
+        info("#{host}: Node.js #{app_nodejs_version} is installed.")
+      end
+    end
+
+    desc 'Update Node.js version management tool'
+    task :update_nodejs_build do
+      on roles fetch(:nodejs_roles, :all) do
+        execute :nodejs_update_management_tool
+      end
+    end
+
+    desc 'Install and configure NodeJS according to applications .nvmrc, .node-version or .tool-versions.'
+    task :ensure do
+      invoke('opscomplete:nodejs:update_nodejs_build')
+      on roles fetch(:nodejs_roles, :all) do |host|
+        if managed_nodejs?
+          raise Capistrano::ValidationError, "#{host}: Managed Node.js environment! Won't do any changes to Node.js version."
+        end
+        if nodejs_installed_versions.include?(app_nodejs_version)
+          info("#{host}: Node.js #{app_nodejs_version} is installed.")
+        elsif nodejs_installable_versions.include?(app_nodejs_version)
+          info("#{host}: Configured Node.js version is not installed, but available for installation.")
+          with tmpdir: fetch(:tmp_dir) do
+            execute(:nodejs_install_version, "'#{app_nodejs_version}'")
+          end
+        else
+          raise Capistrano::ValidationError,
+                "#{host}: Configured Node.js version is neither installed nor installable."
+        end
+        execute(:nodejs_set_version, "'#{app_nodejs_version}'")
+      end
+    end
+  end
+end

data/lib/capistrano/opscomplete/ruby.rake

@@ -106,12 +106,52 @@ namespace :opscomplete do
           raise Capistrano::ValidationError,
                 "#{host}: Configured Ruby version is neither installed nor installable using ruby-install."
         end
-        execute(:rbenv, :global, "'#{app_ruby_version}'") unless capture(:rbenv, :global) == app_ruby_version
+        unless capture(:rbenv, :global) == app_ruby_version
+          set :ruby_modified, true
+          execute(:rbenv, :global, "'#{app_ruby_version}'")
+        end
       end
       invoke('opscomplete:ruby:install_rubygems')
       invoke('opscomplete:ruby:install_bundler')
       invoke('opscomplete:ruby:install_geordi')
       invoke('opscomplete:ruby:rehash') if fetch(:rbenv_needs_rehash, false)
     end
+
+    desc 'resets the global ruby version and gems to Gemfile and .ruby-version in current_path.'
+    task :reset do
+      on roles fetch(:rbenv_roles, :all) do |host|
+        within current_path do
+          current_ruby_version_file_path = current_path.join('.ruby-version').to_s
+          if test("[ -f #{current_ruby_version_file_path} ]")
+            execute(:rbenv, :global, capture(:cat, current_ruby_version_file_path))
+          else
+            raise Capistrano::ValidationError,
+                  "#{host}: Missing .ruby-version in #{current_path}. Won't set a new global version."
+          end
+          if test("[ -f '#{current_path}/.bundle/config' ]")
+            debug("#{host}: Found #{current_path}/.bundle/config, running bundle pristine.")
+            set :bundle_gemfile, -> { current_path.join('Gemfile') }
+            execute(:bundle, :pristine)
+          else
+            raise Capistrano::ValidationError,
+              "Unable to find #{current_path}/.bundle/config, won't run bundle pristine."
+          end
+        end
+      end
+    end
+
+    desc 'Set the old ruby version before the change and invoke bundle pristine.'
+    task :broken_gems_warning do
+      on roles fetch(:rbenv_roles, :all) do |host|
+        if fetch(:ruby_modified, false)
+          warn("Deploy failed and the ruby version has been modified in this deploy.")
+          warn("If this was a minor ruby version upgrade your running application may run into issues with native gem extensions.")
+          warn("If your deploy failed before deploy:symlink:release you may run bundle exec `cap #{fetch(:stage)} opscomplete:ruby:reset`.")
+          warn("Please refer https://makandracards.com/makandra/477884-bundler-in-deploy-mode-shares-gems-between-patch-level-ruby-versions")
+        else
+          debug("#{host}: Ruby not modified in current deploy.")
+        end
+      end
+    end
   end
 end

data/lib/capistrano/opscomplete/supervisor.rake

@@ -27,7 +27,7 @@ namespace :opscomplete do
         end
       end
     end
-    
+
     # Can be used for example to quiet sidekiq with a task like this:
     #
     #     namespace :sidekiq do
@@ -36,12 +36,12 @@ namespace :opscomplete do
     #         on roles :cron do
     #           # The TSTP signal tells sidekiq to quiet all workers.
     #           # see: https://github.com/mperham/sidekiq/wiki/Signals#tstp
-    #           invoke('supervisor:signal_procs', 'TSTP', 'sidekiq')
+    #           invoke('opscomplete:supervisor:signal_procs', 'TSTP', 'sidekiq')
     #         end
     #       end
     #     end
     desc 'Sends the signal (e.g. USR1 or TSTP) to all programs or if specified to program_name.'
-    task :signal_procs, :signal, :program_name do |task_name, args|
+    task :signal_procs, :signal, :program_name do |_task_name, args|
       signal = args.fetch(:signal)
       program_name = args.fetch(:program_name, nil)
 

data/lib/capistrano/opscomplete/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Opscomplete
-    VERSION = '0.6.0'.freeze
+    VERSION = '0.6.5'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-opscomplete
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.5
 platform: ruby
 authors:
 - Makandra Operations
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-13 00:00:00.000000000 Z
+date: 2020-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: makandra-rubocop
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +79,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -90,7 +91,8 @@ files:
 - capistrano-opscomplete.gemspec
 - lib/capistrano/dsl/opscomplete.rb
 - lib/capistrano/opscomplete.rb
-- lib/capistrano/opscomplete/deploy.rake
+- lib/capistrano/opscomplete/hooks.rb
+- lib/capistrano/opscomplete/nodejs.rake
 - lib/capistrano/opscomplete/ruby.rake
 - lib/capistrano/opscomplete/supervisor.rake
 - lib/capistrano/opscomplete/version.rb

data/lib/capistrano/opscomplete/deploy.rake

@@ -1,10 +0,0 @@
-namespace :deploy do
-  desc 'Show deployed revision'
-  task :revision do
-    on roles :app do
-      within current_path do
-        info "Revision: #{capture(:cat, 'REVISION')}"
-      end
-    end
-  end
-end