capistrano-opscomplete 0.6.7 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 342b22962198a630ea6f41463f0cd69cbb5e6edfdd0d66df3b2fe24c5ff81397
-  data.tar.gz: 9ded78666b373b6322e0981dc1fad8ad5c6012549bfab62b7740120f54f4972d
+  metadata.gz: 39158f12f3935cff8bc3d2c39b6d252c7ac594de47bad9c35fa83463d8dbec03
+  data.tar.gz: aefdd1684fa67a31f19a1e9520edc82139ded5f5569b324cafaa5afa9c8a1e9e
 SHA512:
-  metadata.gz: 99e89af95cf85d01a9a2deb3d43e914c72f3725f1070b099c0b502d0417ba64663d5ec3c5cb740ea801ba7bc05ac96b1d02d2c3728985c370cd4c2698fdc35bf
-  data.tar.gz: 354a993896fb9b019b5be292dec3a3dbe9b76fbbba780e5a982b72474a9585829eab2f8feab03c3387a9dd74e84e74bb7466f9bc628677bd4ad9c6bb2a02496b
+  metadata.gz: 9639dc1c7d2a77fee4088ac466e428c5e60691ae82e802a7c32dc990008d6b7ef568daac73e0bfec16e489bc2038e91431f0bdd1600919ec3d30e57e8b6d354d
+  data.tar.gz: df97a9b57171097b35ce78222d0d073ecfcab37c42f3d362c52e96d5ae68cae23a610b33cfc80017828723ab479567881f0dd23c8183424211681387432a9f6f

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [1.0.2] - 2022-07-29
+### Changed
+- Improve error message for missing Node.js version
+
+## [1.0.1] - 2021-03-16
+
+### Fixed
+- Made it possible to use `--dry-run` ([#27](https://github.com/makandra/capistrano-opscomplete/issues/27)
+
+## [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

data/Gemfile.lock

@@ -1,37 +1,37 @@
 PATH
   remote: .
   specs:
-    capistrano-opscomplete (0.6.7)
+    capistrano-opscomplete (1.0.2)
       capistrano (>= 3.0, < 4.0.0)
       rake
 
 GEM
   remote: https://rubygems.org/
   specs:
-    airbrussh (1.4.0)
+    airbrussh (1.4.1)
       sshkit (>= 1.6.1, != 1.7.0)
-    ast (2.4.0)
-    capistrano (3.11.2)
+    ast (2.4.2)
+    capistrano (3.17.0)
       airbrussh (>= 1.0.0)
       i18n
       rake (>= 10.0.0)
       sshkit (>= 1.9.0)
-    concurrent-ruby (1.1.6)
-    i18n (1.8.4)
+    concurrent-ruby (1.1.10)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    makandra-rubocop (4.2.0)
+    makandra-rubocop (4.4.0)
       rubocop (~> 0.76.0)
       rubocop-rails (~> 2.3.2)
-    net-scp (2.0.0)
-      net-ssh (>= 2.6.5, < 6.0.0)
-    net-ssh (5.2.0)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (7.0.1)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
     rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.6)
     rubocop (0.76.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -42,11 +42,11 @@ GEM
     rubocop-rails (2.3.2)
       rack (>= 1.1)
       rubocop (>= 0.72.0)
-    ruby-progressbar (1.10.1)
-    sshkit (1.20.0)
+    ruby-progressbar (1.11.0)
+    sshkit (1.21.2)
       net-scp (>= 1.1.2)
       net-ssh (>= 2.8.0)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.6.1)
 
 PLATFORMS
   ruby
@@ -57,4 +57,4 @@ DEPENDENCIES
   makandra-rubocop (~> 4)
 
 BUNDLED WITH
-   2.1.4
+   2.3.10

data/README.md

@@ -111,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`:
 

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,57 +52,40 @@ 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)
-      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)
-        else
-          warn("Could not look up installed versions from missing '.rbenv/versions' directory. This is probably the first ruby install for this rbenv.")
-          []
-        end
-      end
-
-      def rbenv_exec(*args)
-        execute(:rbenv, :exec, *args)
+      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 gem_installed?(name, version = nil)
         if version
-          test(:rbenv, :exec, "gem query --quiet --installed --version '#{version}' --name-matches '^#{name}$'")
+          test(:ruby_installed_gem, name, '--version', "'#{version}'")
         else
-          test(:rbenv, :exec, :gem, :query, "--quiet --installed --name-matches ^#{name}$")
+          test(:ruby_installed_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' : '')
+          execute(:ruby_install_gem, name, '--version', "'#{version}'", force ? '--force' : '')
         else
-          rbenv_exec('gem install', name, '--no-document')
+          execute(:ruby_install_gem, name)
         end
       end
 
-      def rubygems_install(version)
-        rbenv_exec("gem update --no-document --system '#{version}'")
-      end
-
       def managed_nodejs?
-        test("[ -f ${HOME}/.nodejs_managed_by_makandra ]")
+        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)}.")
@@ -140,6 +111,10 @@ module Capistrano
         nodejs_installed_versions = capture(:nodejs_installed_versions).split("\n")
         nodejs_installed_versions.map!(&:strip)
       end
+
+      def validation_error!(message)
+        raise Capistrano::ValidationError, message unless dry_run?
+      end
     end
   end
 end

data/lib/capistrano/opscomplete/nodejs.rake

@@ -14,8 +14,7 @@ namespace :opscomplete 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."
+          validation_error!("#{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
@@ -33,7 +32,7 @@ namespace :opscomplete 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."
+          validation_error!("#{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.")
@@ -43,10 +42,11 @@ namespace :opscomplete 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."
+          error("#{host}: Check if the configured Node.js version: #{app_nodejs_version} is not an installable version")
+          info("These are the ten latest versions:")
+          info(nodejs_installable_versions.slice(-10,10).join(', '))
+
+          validation_error!("#{host}: Configured Node.js version: #{app_nodejs_version} is not installable.")
         end
         execute(:nodejs_set_version, "'#{app_nodejs_version}'")
       end

data/lib/capistrano/opscomplete/ruby.rake

@@ -9,80 +9,69 @@ 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
-          raise Capistrano::ValidationError,
-                "#{host}: Ruby version is not set according to application\'s .ruby-version file. Use cap opscomplete:ruby:ensure."
+        unless capture(:ruby_get_current_version) == app_ruby_version
+          validation_error!("#{host}: Ruby version is not set according to application\'s .ruby-version file. Use cap opscomplete:ruby:ensure.")
         end
         info("#{host}: Ruby #{app_ruby_version} is installed.")
       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
@@ -92,29 +81,27 @@ namespace :opscomplete do
       invoke('opscomplete:ruby:update_ruby_build')
       on roles fetch(:rbenv_roles, :all) do |host|
         if managed_ruby?
-          raise Capistrano::ValidationError, "#{host}: Managed Ruby environment! Won't do any changes to Ruby version."
+          validation_error!("#{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."
+          validation_error!("#{host}: Configured Ruby version is neither installed nor installable.")
         end
-        unless capture(:rbenv, :global) == app_ruby_version
+        unless capture(:ruby_get_current_version) == app_ruby_version
           set :ruby_modified, true
-          execute(:rbenv, :global, "'#{app_ruby_version}'")
+          execute(:ruby_set_version, "'#{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)
+      invoke('opscomplete:ruby:rehash')
     end
 
     desc 'resets the global ruby version and gems to Gemfile and .ruby-version in current_path.'
@@ -125,16 +112,14 @@ namespace :opscomplete do
           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."
+            validation_error!("#{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."
+            validation_error!("Unable to find #{current_path}/.bundle/config, won't run bundle pristine.")
           end
         end
       end
@@ -144,10 +129,10 @@ namespace :opscomplete do
     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")
+          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

data/lib/capistrano/opscomplete/version.rb

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

data/lib/capistrano/opscomplete.rb

@@ -6,4 +6,4 @@ 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__)
+load File.expand_path('opscomplete/hooks.rb', __dir__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-opscomplete
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 1.0.2
 platform: ruby
 authors:
 - Makandra Operations
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2022-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: makandra-rubocop
@@ -89,6 +89,7 @@ files:
 - bin/console
 - bin/setup
 - capistrano-opscomplete.gemspec
+- gem_graph.png
 - lib/capistrano-opscomplete.rb
 - lib/capistrano/dsl/opscomplete.rb
 - lib/capistrano/opscomplete.rb