capistrano-opscomplete 0.6.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ab19048934d110250b8fafc444f686dba2467f8d3dec1a70cfebe206f2fb801
-  data.tar.gz: 49fd120dc3b325fe7356eb1eb7200030e16bb1077a223b6570b53d1f8a1d2b9b
+  metadata.gz: c7bda13c0f33ab7e11818d801b18587bb9cd5754f114b757627296d4cb1fc338
+  data.tar.gz: 7587402cf62a88b9b7980ec1567f60552fa6fa8d8f1eb10d811c123175323bb0
 SHA512:
-  metadata.gz: 1c287a757274a0961a0038b0f20cc1d145ae96645b063565b85cbe4742cb04c554adf2a4ea5ff5a663d7d4c16e9ee54f929af61f49db156942ab78e14d1ed94b
-  data.tar.gz: cc172a2a4c4c14f053096e1a94bd4c32b711fbeeb1ac6bcbf1ace135c0afe515b1251b712d47d66f71a3ccf1a8a5c5b94e2d737cafdab712e3497d8738bbe90a
+  metadata.gz: 76e8a0d39c56bbc84fa91d4fc52fb1c22106c6afe19f47e0dff2a27fbd81ce0c2cf76cc7d0b2d90b6aa270d71fa9d5de02a076291883bc7bbc2c1c59a1e864cb
+  data.tar.gz: a481d59f2a8e9cf719ec0e6120eebf9672c0a765bfe69ef253c262879c0d0d0f5874ad0a3508b7c7e3b93173ec8ae054090b55384f640e82773d86fb5779e2fa

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+## [1.0.0] - 2021-03-16
+
+### Changed
+- Version bump to 1.0 and switch to semantic versioning: There were no breaking changes
+- Remove rbenv dependency for our opscomplete infrastructure
+
+## [0.6.7] - 2021-02-05
+
+### Fixed
+- Fix missing command in opscomplete:nodejs:check
+
+### Changed
+- Improve error message for wrong Node.js version
+
+## [0.6.6] - 2020-12-08
+
+### Fixed
+- Fix the error `undefined method 'after' for main:Object (NoMethodError)` when starting the rails application with capistrano-opscomplete required
+
+## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-opscomplete (0.6.3)
+    capistrano-opscomplete (1.0.0)
       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
@@ -105,11 +111,11 @@ More specifically this task will:
       1) The value of `:opscomplete_ruby_version` from your capistrano config. Leave this empty unless you want to override the desired version.
       2) A file in the `release_path` on the server (e.g. `/var/www/staging.myapp.biz/releases/20180523234205/.ruby-version`)
       3) A file in the current working directory of your local checkout (e.g. `/home/user/code/myapp/.ruby-version`)
-    - If the desired version is not installed, it checks if it can be installed using `ruby-build` and installs it.
-    - Check if `rbenv global` version is set according to application's `.ruby-version` file. Change it if required.
+    - If the desired version is not installed, it checks if it can be installed and installs it.
+    - Check if the global version is set according to application's `.ruby-version` file. Change it if required.
     - Install `bundler`. It is tried to determine the version that was used to create the `Gemfile.lock` (`BUNDLED WITH`) if it is present.
     - Install `geordi` gem if required.
-    - Run `rbenv rehash` if required.
+    - Rehash the shims if required.
 
 **Note:** If, for any reason, no `.ruby-version` file can be found in your release or current working directory, you may set the following option in `deploy.rb`:
 
@@ -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

@@ -3,19 +3,7 @@ module Capistrano
     # A whole capistrano/rake namespace, for grouping our helpers and tasks
     module Opscomplete
       def managed_ruby?
-        test("[ -f #{rbenv_root_path}/.ruby_managed_by_makandra ]")
-      end
-
-      def rbenv_ruby_build_path
-        "#{rbenv_root_path}/plugins/ruby-build"
-      end
-
-      def rbenv_repo_url
-        'https://github.com/rbenv/rbenv.git'
-      end
-
-      def ruby_build_repo_url
-        'https://github.com/rbenv/ruby-build.git'
+        test(:ruby_update_management_tool, 'managed')
       end
 
       def app_ruby_version
@@ -64,49 +52,65 @@ module Capistrano
         end
       end
 
-      def rbenv_installable_rubies
-        rbenv_installable_rubies = capture(:rbenv, :install, '--list-all').split("\n")
-        rbenv_installable_rubies.map!(&:strip)
-        rbenv_installable_rubies.delete('Available version:')
-        rbenv_installable_rubies
+      def ruby_installable_versions
+        ruby_installable_versions = capture(:ruby_installable_versions).split("\n")
+        ruby_installable_versions.map!(&:strip)
+        ruby_installable_versions
       end
 
-      def rbenv_root_path
-        capture(:rbenv, :root)
+      def ruby_installed_versions
+        ruby_installed_versions = capture(:ruby_installed_versions).split("\n")
+        ruby_installed_versions.map!(&:strip)
+        warn('Could not look up installed versions. This is probably the first ruby install.') if ruby_installed_versions.empty?
+        ruby_installed_versions
       end
 
-      def rbenv_installed_rubies
-        if test("[ -d #{rbenv_root_path}/versions ]")
-          rbenv_installed_rubies = capture(:ls, '-1', "#{rbenv_root_path}/versions").split("\n")
-          rbenv_installed_rubies.map!(&:strip)
+      def gem_installed?(name, version = nil)
+        if version
+          test(:ruby_installed_gem, name, '--version', "'#{version}'")
         else
-          warn("Could not look up installed versions from missing '.rbenv/versions' directory. This is probably the first ruby install for this rbenv.")
-          []
+          test(:ruby_installed_gem, name)
         end
       end
 
-      def rbenv_exec(*args)
-        execute(:rbenv, :exec, *args)
-      end
-
-      def gem_installed?(name, version = nil)
+      def gem_install(name, version = nil, force = false)
         if version
-          test(:rbenv, :exec, "gem query --quiet --installed --version '#{version}' --name-matches '^#{name}$'")
+          execute(:ruby_install_gem, name, '--version', "'#{version}'", force ? '--force' : '')
         else
-          test(:rbenv, :exec, :gem, :query, "--quiet --installed --name-matches ^#{name}$")
+          execute(:ruby_install_gem, name)
         end
       end
 
-      def gem_install(name, version = nil, force = false)
-        if version
-          rbenv_exec('gem install', name, '--no-document', '--version', "'#{version}'", force ? '--force' : '')
+      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
-          rbenv_exec('gem install', name, '--no-document')
+          raise Capistrano::ValidationError, 'Could not find application\'s Node.js version. Consider setting opscomplete_ruby_version.'
         end
       end
 
-      def rubygems_install(version)
-        rbenv_exec("gem update --no-document --system '#{version}'")
+      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

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,55 @@
+# 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_get_version, release_path) == 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
+          info("#{host}: Check if the configured Node.js version is part of the installable versions")
+          execute :nodejs_installable_versions
+          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

@@ -9,18 +9,11 @@ namespace :opscomplete do
   end
 
   namespace :ruby do
-    # desc 'Rehash rbenv shims (run this after installing executables).'
-    task :rehash do
-      on roles fetch(:rbenv_roles, :all) do
-        execute(:rbenv, :rehash)
-      end
-    end
-
-    desc 'Check if rbenv global Ruby version is set according to application\'s .ruby-version.'
+    desc 'Check if Ruby version is set according to application\'s .ruby-version.'
     task :check do
       on roles fetch(:rbenv_roles, :all) do |host|
         warn("#{host}: Managed Ruby environment! Won't do any changes to ruby version.") if managed_ruby?
-        unless capture(:rbenv, :global) == app_ruby_version
+        unless capture(:ruby_get_current_version) == app_ruby_version
           raise Capistrano::ValidationError,
                 "#{host}: Ruby version is not set according to application\'s .ruby-version file. Use cap opscomplete:ruby:ensure."
         end
@@ -28,61 +21,58 @@ namespace :opscomplete do
       end
     end
 
-    # desc 'Install rbenv plugin ruby-build'
+    desc 'Install Ruby version management tool dependencies'
     task :install_ruby_build do
       on roles fetch(:rbenv_roles, :all) do
-        next if test "[ -d #{rbenv_ruby_build_path} ]"
-        execute :git, :clone, ruby_build_repo_url, rbenv_ruby_build_path
+        execute(:ruby_update_management_tool, :install_build)
       end
     end
 
-    # desc 'Update rbenv plugin ruby-build'
+    desc 'Update Ruby version management tool'
     task :update_ruby_build do
       on roles fetch(:rbenv_roles, :all) do
-        if test "[ -d #{rbenv_ruby_build_path} ]"
-          within rbenv_ruby_build_path do
-            execute :git, :pull, '-q'
-          end
-        else
-          warn('Could not find ruby-build.')
-        end
+        execute(:ruby_update_management_tool, :update_build)
       end
     end
 
-    # desc 'Install bundler gem'
+    desc 'Rehash shims (run this after installing executables).'
+    task :rehash do
+      on roles fetch(:rbenv_roles, :all) do
+        execute(:ruby_update_management_tool, :rehash)
+      end
+    end
+
+    desc 'Install bundler gem'
     task :install_bundler do
       on roles fetch(:rbenv_roles, :all) do
         # manually specified version will take precedence
         specific_bundler_version = fetch(:bundler_version, app_gemfile_bundled_with_version)
-
         if specific_bundler_version
           # We have to set force = true to overwrite the binary
           gem_install('bundler', specific_bundler_version, true) unless gem_installed?('bundler', specific_bundler_version)
         else
           gem_install('bundler') unless gem_installed?('bundler')
         end
-        set :rbenv_needs_rehash, true
       end
     end
 
-    # desc 'Install geordi gem'
+    desc 'Install geordi gem'
     task :install_geordi do
       on roles fetch(:rbenv_roles, :all) do
         gem_install('geordi') unless gem_installed?('geordi')
-        set :rbenv_needs_rehash, true
       end
     end
 
+    desc 'Install RubyGems'
     task :install_rubygems do
       on roles fetch(:rbenv_roles, :all) do
-        # if no rubygems_version was set, we use and don't check the rubygems version installed by rbenv
+        # if no rubygems_version was set, we use and don't check the installed rubygems version
         if fetch(:rubygems_version, false)
-          current_rubygems_version = capture(:rbenv, :exec, :gem, '--version').chomp
+          current_rubygems_version = capture(:ruby_get_current_version, :rubygems).chomp
           info("Ensuring requested RubyGems version #{fetch(:rubygems_version)}")
           next if current_rubygems_version == fetch(:rubygems_version)
           info("Previously installed RubyGems version was #{current_rubygems_version}")
-          rbenv_exec(:gem, :update, '--no-document', '--system', "'#{fetch(:rubygems_version)}'")
-          set :rbenv_needs_rehash, true
+          execute(:ruby_install_version, :rubygems, "'#{fetch(:rubygems_version)}'")
         end
       end
     end
@@ -94,24 +84,63 @@ namespace :opscomplete do
         if managed_ruby?
           raise Capistrano::ValidationError, "#{host}: Managed Ruby environment! Won't do any changes to Ruby version."
         end
-        if rbenv_installed_rubies.include?(app_ruby_version)
+        if ruby_installed_versions.include?(app_ruby_version)
           info("#{host}: Ruby #{app_ruby_version} is installed.")
-        elsif rbenv_installable_rubies.include?(app_ruby_version)
+        elsif ruby_installable_versions.include?(app_ruby_version)
           info("#{host}: Configured Ruby version is not installed, but available for installation.")
           with tmpdir: fetch(:tmp_dir) do
-            execute(:rbenv, :install, "'#{app_ruby_version}'")
+            execute(:ruby_install_version, "'#{app_ruby_version}'")
           end
-          set :rbenv_needs_rehash, true
         else
           raise Capistrano::ValidationError,
-                "#{host}: Configured Ruby version is neither installed nor installable using ruby-install."
+                "#{host}: Configured Ruby version is neither installed nor installable."
+        end
+        unless capture(:ruby_get_current_version) == app_ruby_version
+          set :ruby_modified, true
+          execute(:ruby_set_version, "'#{app_ruby_version}'")
         end
-        execute(:rbenv, :global, "'#{app_ruby_version}'") unless capture(:rbenv, :global) == app_ruby_version
       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)
+      invoke('opscomplete:ruby:rehash')
+    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

@@ -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 = '1.0.0'.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: 1.0.0
 platform: ruby
 authors:
 - Makandra Operations
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: makandra-rubocop
@@ -89,8 +89,11 @@ files:
 - bin/console
 - bin/setup
 - capistrano-opscomplete.gemspec
+- lib/capistrano-opscomplete.rb
 - 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