capistrano-opscomplete 0.4.0 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0743d3bbb02bac9362a1729bf5821a4d4a0bd59e
-  data.tar.gz: b045d4e90dd46e866c4b4647ebefff9a74e69d35
+SHA256:
+  metadata.gz: 8ab19048934d110250b8fafc444f686dba2467f8d3dec1a70cfebe206f2fb801
+  data.tar.gz: 49fd120dc3b325fe7356eb1eb7200030e16bb1077a223b6570b53d1f8a1d2b9b
 SHA512:
-  metadata.gz: 287c4b000c0de702f2055bd29cf94a37d4578ea730cf2676c8f2f42b12dd77be6edcee232b33b0a0fc2f5716c36e3b4393199d444ea49898f2b526db91e7f93b
-  data.tar.gz: 823a06e3d2f3f533e3a9d70f1ee84eea7719d10a8eb90dcd89fa86156776dee71d265809ae50ac15ab8b97645d6c281966c8b2dc03373cd0155e0465eca5ea70
+  metadata.gz: 1c287a757274a0961a0038b0f20cc1d145ae96645b063565b85cbe4742cb04c554adf2a4ea5ff5a663d7d4c16e9ee54f929af61f49db156942ab78e14d1ed94b
+  data.tar.gz: cc172a2a4c4c14f053096e1a94bd4c32b711fbeeb1ac6bcbf1ace135c0afe515b1251b712d47d66f71a3ccf1a8a5c5b94e2d737cafdab712e3497d8738bbe90a

data/.ruby-version

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

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## [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
+
+- Support for Procfiles/supervisord. See [this makandra card](https://makandracards.com/opscomplete/67829-procfile-support) for more information.
+
+## [0.5.0] - 2019-12-09
+### Changed
+- Install the bundler version that was used to create the `Gemfile.lock` (`BUNDLED WITH`) if it is present. Can be overwritten by `set :bundler_version`.
+- Reword some info output
+
 ## [0.4.0] - 2019-09-23
 ### Added
 - ruby-build now honors the :tmp_dir setting
@@ -6,7 +36,6 @@
 - Allow using --force when installing a gem e.g. overwrite binaries
 - Quote some shell arguments
 
-
 ## [0.3.0] - 2019-04-05
 ### Added
 - You can now specify the rubygems and bundler version to be installed. (#4)
@@ -35,6 +64,8 @@
 ### Added
 - Initial release.
 
+[0.6.0]: https://github.com/makandra/capistrano-opscomplete/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/makandra/capistrano-opscomplete/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/makandra/capistrano-opscomplete/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/makandra/capistrano-opscomplete/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/makandra/capistrano-opscomplete/compare/v0.1.0...v0.2.0

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    capistrano-opscomplete (0.6.3)
+      capistrano (>= 3.0, < 4.0.0)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.4.0)
+      sshkit (>= 1.6.1, != 1.7.0)
+    ast (2.4.0)
+    capistrano (3.11.2)
+      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.0)
+    jaro_winkler (1.5.4)
+    makandra-rubocop (4.2.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)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rails (2.3.2)
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    ruby-progressbar (1.10.1)
+    sshkit (1.20.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2)
+  capistrano-opscomplete!
+  makandra-rubocop (~> 4)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -28,13 +28,45 @@ Verify the gem was installed and tasks are available:
 
     $ bundle exec cap -T opscomplete
 
-Now, add some [hooks](#using-capistrano-hooks) in your capistrano configuration. An example configuration could look like this:
+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: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
+    opscomplete:supervisor:stop_procs
+    opscomplete:supervisor:signal_procs
+
+e.g. like this:
+
+```ruby
+# Update and Restart supervisor config
+after 'deploy:updating', 'opscomplete:supervisor:gen_config'
+after 'deploy:published', 'opscomplete:supervisor:restart_procs'
+```
+
+Using the default configuration, these tasks will run on all Servers where role is `:app` using the Procfile called `Procfile`.
+To change the role where these tasks will get executed, set `:procfile_role` in e.g. your `config/deploy.rb` like:
+
+```ruby
+# Use supervisor tasks only for sidekiq role
+set :procfile_role, :sidekiq
+```
+
+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.
+server "srv1.example.com", user: "deploy-example_s", roles: %w{app web}, procfile: "Procfile.sidekiq"
+server "srv2.example.com", user: "deploy-example_s", roles: %w{app web}
+```
+
 ## Usage
 
 If you encounter any errors, please make sure you have the newest version of the capistrano-opscomplete gem installed. Don't hesitate to contact the OpsComplete for Ruby team for further support.
@@ -75,7 +107,8 @@ More specifically this task will:
       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.
-    - Install the `bundler` and `geordi` gem 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.
 
 **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`:
@@ -92,12 +125,18 @@ set :rbenv_roles, :web
 set :rbenv_roles, [:web, :worker]
 ```
 
-**Optional:** If you want a specific bundler version available for your release, set it in your `deploy.rb`, e.g '~>2' if you need bundler version 2.x:
+**Optional:** If you want a specific bundler version other than the one that is set in `Gemfile.lock` available for your release, set it in your `deploy.rb`:
 
 ```ruby
 set :bundler_version, '<VERSION>'
 ```
 
+e.g. if you need bundler version 2.x:
+
+```ruby
+set :bundler_version, '~>2'
+```
+
 **Optional:** By default, the rubygems version defined by the ruby-build manifest will be installed. If you want a specific rubygems version available for your release, set it in your `deploy.rb`:
 
 ```ruby

data/capistrano-opscomplete.gemspec

@@ -8,13 +8,18 @@ Gem::Specification.new do |spec|
   spec.authors  = ['Makandra Operations']
   spec.email    = ['ops@makandra.de']
 
-  spec.summary  = %q(Capistrano tasks for easy deployment to a makandra opscomplete environment.)
+  spec.summary  = 'Capistrano tasks for easy deployment to a makandra opscomplete environment.'
   spec.homepage = 'https://opscomplete.com/ruby'
 
   spec.license  = 'MIT'
 
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata = {
+      'allowed_push_host' => 'https://rubygems.org',
+      'bug_tracker_uri' => 'https://github.com/makandra/capistrano-opscomplete/issues',
+      'changelog_uri' => 'https://github.com/makandra/capistrano-opscomplete/blob/master/CHANGELOG.md',
+      'source_code_uri' => 'https://github.com/makandra/capistrano-opscomplete',
+    }
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'
@@ -31,9 +36,9 @@ Gem::Specification.new do |spec|
 
   spec.required_rubygems_version = '>=2.0.1'
 
-  spec.add_development_dependency 'makandra-rubocop', '~> 0'
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'makandra-rubocop', '~> 4'
+  spec.add_development_dependency 'bundler', '~> 2'
 
+  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
@@ -42,8 +42,30 @@ module Capistrano
         end
       end
 
+      def app_gemfile_bundled_with_version
+        release_gemfile_lock_file_path = release_path.join('Gemfile.lock').to_s
+
+        if test("[ -f #{release_gemfile_lock_file_path} ]")
+          debug('found release_dir/Gemfile.lock')
+
+          grep_command = [:grep, '-A', '1', '"BUNDLED WITH"', release_gemfile_lock_file_path]
+
+          if test(*grep_command)
+            bundled_with_lines = capture(*grep_command)
+            version = bundled_with_lines.split.last
+            debug("Using version #{version.inspect} from server's release_dir/Gemfile.lock file.")
+            version
+          else
+            # old bundler versions did not write "BUNDLED WITH"
+            debug('Gemfile.lock was found but did not contain "BUNDLED WITH"-section')
+          end
+        else
+          debug('There was no Gemfile.lock to parse the bundler version')
+        end
+      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

data/lib/capistrano/opscomplete.rb

@@ -1,4 +1,7 @@
 require 'capistrano/opscomplete/version'
 
-load File.expand_path('opscomplete/tasks.rake', __dir__)
-load File.expand_path('opscomplete/deploy.rake', __dir__)
+# 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/supervisor.rake', __dir__)

data/lib/capistrano/opscomplete/{tasks.rake → ruby.rake}

@@ -16,15 +16,15 @@ namespace :opscomplete do
       end
     end
 
-    desc 'Check if rbenv global ruby is set according to application\'s .ruby-version.'
+    desc 'Check if rbenv global 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?
+        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."
         end
-        info("#{host}: Required ruby version '#{app_ruby_version}' is installed.")
+        info("#{host}: Ruby #{app_ruby_version} is installed.")
       end
     end
 
@@ -52,9 +52,12 @@ namespace :opscomplete do
     # desc 'Install bundler gem'
     task :install_bundler do
       on roles fetch(:rbenv_roles, :all) do
-        if fetch(:bundler_version, false)
+        # 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', fetch(:bundler_version), true) unless gem_installed?('bundler', fetch(:bundler_version))
+          gem_install('bundler', specific_bundler_version, true) unless gem_installed?('bundler', specific_bundler_version)
         else
           gem_install('bundler') unless gem_installed?('bundler')
         end
@@ -89,19 +92,19 @@ 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."
+          raise Capistrano::ValidationError, "#{host}: Managed Ruby environment! Won't do any changes to Ruby version."
         end
         if rbenv_installed_rubies.include?(app_ruby_version)
-          info("#{host}: Required ruby version '#{app_ruby_version}' is installed.")
+          info("#{host}: Ruby #{app_ruby_version} is installed.")
         elsif rbenv_installable_rubies.include?(app_ruby_version)
-          info("#{host}: Required ruby version is not installed, but available for installation.")
+          info("#{host}: Configured Ruby version is not installed, but available for installation.")
           with tmpdir: fetch(:tmp_dir) do
             execute(:rbenv, :install, "'#{app_ruby_version}'")
           end
           set :rbenv_needs_rehash, true
         else
           raise Capistrano::ValidationError,
-                "#{host}: Ruby version required by application is neither installed nor installable using ruby-install."
+                "#{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
       end

data/lib/capistrano/opscomplete/supervisor.rake

@@ -0,0 +1,59 @@
+# vim: filetype=ruby
+namespace :opscomplete do
+  namespace :supervisor do
+    desc '(Re-)Generate the supervisor configuration (e.g. for supervisord).'
+    task :gen_config do
+      on roles fetch(:procfile_role, :app) do |host|
+        within release_path do
+          execute :supervisor_gen_config, host.properties.procfile
+        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
+        within release_path do
+          execute :supervisor_restart_procs
+        end
+      end
+    end
+
+    desc 'Stop all Procfile processes in case you want to them to be stopped while your deployment runs'
+    task :stop_procs do
+      on roles fetch(:procfile_role, :app) do
+        within release_path do
+          execute :supervisor_stop_procs
+        end
+      end
+    end
+
+    # Can be used for example to quiet sidekiq with a task like this:
+    #
+    #     namespace :sidekiq do
+    #       desc 'quiet all sidekiq processes so they stop accepting new jobs.'
+    #       task :quiet 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')
+    #         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|
+      signal = args.fetch(:signal)
+      program_name = args.fetch(:program_name, nil)
+
+      on roles fetch(:procfile_role, :app) do
+        within release_path do
+          if program_name
+            execute :supervisor_signal_procs, signal, program_name
+          else
+            execute :supervisor_signal_procs, signal
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/opscomplete/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-opscomplete
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.3
 platform: ruby
 authors:
 - Makandra Operations
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-23 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: makandra-rubocop
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2'
 - !ruby/object:Gem::Dependency
   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,8 +79,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -89,14 +91,17 @@ files:
 - capistrano-opscomplete.gemspec
 - lib/capistrano/dsl/opscomplete.rb
 - lib/capistrano/opscomplete.rb
-- lib/capistrano/opscomplete/deploy.rake
-- lib/capistrano/opscomplete/tasks.rake
+- lib/capistrano/opscomplete/ruby.rake
+- lib/capistrano/opscomplete/supervisor.rake
 - lib/capistrano/opscomplete/version.rb
 homepage: https://opscomplete.com/ruby
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/makandra/capistrano-opscomplete/issues
+  changelog_uri: https://github.com/makandra/capistrano-opscomplete/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/makandra/capistrano-opscomplete
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -112,8 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Capistrano tasks for easy deployment to a makandra opscomplete environment.

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