capistrano-opscomplete 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ab19048934d110250b8fafc444f686dba2467f8d3dec1a70cfebe206f2fb801
-  data.tar.gz: 49fd120dc3b325fe7356eb1eb7200030e16bb1077a223b6570b53d1f8a1d2b9b
+  metadata.gz: e0b8b15686f2822308863e7af85b079aa35e1473fbd23c3ed8a31251686d02b4
+  data.tar.gz: 2907023f2972eba8710484f9d2a995b028021e8db4a7b21677672c489f42454f
 SHA512:
-  metadata.gz: 1c287a757274a0961a0038b0f20cc1d145ae96645b063565b85cbe4742cb04c554adf2a4ea5ff5a663d7d4c16e9ee54f929af61f49db156942ab78e14d1ed94b
-  data.tar.gz: cc172a2a4c4c14f053096e1a94bd4c32b711fbeeb1ac6bcbf1ace135c0afe515b1251b712d47d66f71a3ccf1a8a5c5b94e2d737cafdab712e3497d8738bbe90a
+  metadata.gz: '0288303aa496066cc38cba7ee7136647c8da697841831efd16dcd2203794225260e7d2564e99d0b1c6a8b5c874e2f67b31bfd90fb9c95c59b65ea4472f37f824'
+  data.tar.gz: 35d0304e8b112ee6939bd0c20f93b73c1ec39dcaf753673aa0441f91dd3f46ffb244752c2a3c2098c3d035c7648575e24ec0c3292767aeb602534fae6cdb0f84

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-opscomplete (0.6.3)
+    capistrano-opscomplete (0.6.4)
       capistrano (>= 3.0, < 4.0.0)
       rake
 

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
@@ -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/lib/capistrano/dsl/opscomplete.rb

@@ -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

@@ -4,4 +4,6 @@ require 'capistrano/opscomplete/version'
 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/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 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

@@ -36,7 +36,7 @@ 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

data/lib/capistrano/opscomplete/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Opscomplete
-    VERSION = '0.6.3'.freeze
+    VERSION = '0.6.4'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-opscomplete
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Makandra Operations
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: makandra-rubocop
@@ -91,6 +91,8 @@ files:
 - capistrano-opscomplete.gemspec
 - lib/capistrano/dsl/opscomplete.rb
 - lib/capistrano/opscomplete.rb
+- 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