capistrano-asg-rolling 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb936e31e0f44787ba44293317b5716c0643d332998d1845156bc56a53c95bcf
-  data.tar.gz: 3a3ecb898eb6b1593e6273dc6f0168565a91bf5c213311ba0822181b812eb9c1
+  metadata.gz: cceded2d7adcb767bc8bb432781055a91af8268303514564a4c1de86ccb2ac2e
+  data.tar.gz: 8d08579c0a00000bb2457348e9808758d10d74751a08f7071e50fa794fb1ea72
 SHA512:
-  metadata.gz: 1c804035831e82a6b3f34afb2dfd2f87ed24ed9f00ae6714f6701ae32ca716c82d912b0063aee0b1b35b47a7d22ec9c3b87143c14db3654e896b61bb6a7ffd53
-  data.tar.gz: df5c16239d7820e755444ad1fd448d07e4cfa9122d4b5de8451f2c9673d30e6bdf1400948d8efb64767b289514a461a356cc6a70e778e21d7a0f3e7f0408d9ea
+  metadata.gz: 964743e3ab4ad9813100f3968e45b044d80fc46d6e9141a85b07686b0b4566f8c12bb79f3614fa5d473b358782d3c002d03532f72b60440b666423c4bc5e4947
+  data.tar.gz: 3366b9a2268485d777a101d1f29335aba073979122347c48e3191f318188ed3ce41eb2f3ec39861b286fa4a0148f9632af23b1d57f93f4e1d857f8f742e929b8

data/.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1', '3.2', '3.3']
+        ruby-version: ['3.1', '3.2', '3.3', '3.4', '4.0']
 
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -1,12 +1,11 @@
-require:
+plugins:
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
-  - rubocop-rspec_rails
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
   DisplayCopNames: true
   DisplayStyleGuide: true
 

data/Gemfile

@@ -11,4 +11,3 @@ gem 'rubocop', '~> 1.58'
 gem 'rubocop-performance', '~> 1.20'
 gem 'rubocop-rake', '~> 0.6'
 gem 'rubocop-rspec', '~> 3.0'
-gem 'rubocop-rspec_rails', '~> 2.30'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-asg-rolling (0.5.1)
+    capistrano-asg-rolling (0.7.0)
       aws-sdk-autoscaling (~> 1, >= 1.100.0)
       aws-sdk-ec2 (~> 1)
       capistrano (~> 3)
@@ -10,104 +10,115 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
-    airbrussh (1.5.3)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
+    airbrussh (1.6.0)
       sshkit (>= 1.6.1, != 1.7.0)
-    ast (2.4.2)
-    aws-eventstream (1.3.0)
-    aws-partitions (1.1001.0)
-    aws-sdk-autoscaling (1.124.0)
-      aws-sdk-core (~> 3, >= 3.210.0)
+    ast (2.4.3)
+    aws-eventstream (1.4.0)
+    aws-partitions (1.1198.0)
+    aws-sdk-autoscaling (1.149.0)
+      aws-sdk-core (~> 3, >= 3.239.1)
       aws-sigv4 (~> 1.5)
-    aws-sdk-core (3.211.0)
+    aws-sdk-core (3.240.0)
       aws-eventstream (~> 1, >= 1.3.0)
       aws-partitions (~> 1, >= 1.992.0)
       aws-sigv4 (~> 1.9)
+      base64
+      bigdecimal
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-ec2 (1.486.0)
-      aws-sdk-core (~> 3, >= 3.210.0)
+      logger
+    aws-sdk-ec2 (1.587.0)
+      aws-sdk-core (~> 3, >= 3.239.1)
       aws-sigv4 (~> 1.5)
-    aws-sigv4 (1.10.1)
+    aws-sigv4 (1.12.1)
       aws-eventstream (~> 1, >= 1.0.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.8)
-    capistrano (3.19.1)
+    base64 (0.3.0)
+    bigdecimal (4.0.1)
+    capistrano (3.20.0)
       airbrussh (>= 1.0.0)
       i18n
       rake (>= 10.0.0)
       sshkit (>= 1.9.0)
-    concurrent-ruby (1.3.4)
-    crack (1.0.0)
+    concurrent-ruby (1.3.6)
+    crack (1.0.1)
       bigdecimal
       rexml
-    diff-lcs (1.5.1)
-    hashdiff (1.1.1)
-    i18n (1.14.6)
+    diff-lcs (1.6.2)
+    hashdiff (1.2.1)
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
     jmespath (1.6.2)
-    json (2.7.5)
-    language_server-protocol (3.17.0.3)
-    net-scp (4.0.0)
+    json (2.18.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    net-scp (4.1.0)
       net-ssh (>= 2.6.5, < 8.0.0)
     net-sftp (4.0.0)
       net-ssh (>= 5.0.0, < 8.0.0)
     net-ssh (7.3.0)
-    ostruct (0.6.0)
-    parallel (1.26.3)
-    parser (3.3.5.1)
+    ostruct (0.6.3)
+    parallel (1.27.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
-    public_suffix (5.1.1)
+    prism (1.7.0)
+    public_suffix (6.0.2)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
-    regexp_parser (2.9.2)
-    rexml (3.3.9)
-    rspec (3.13.0)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rexml (3.4.4)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.68.0)
+    rspec-support (3.13.6)
+    rubocop (1.82.0)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rubocop-ast (>= 1.32.2, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.33.1)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.22.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    rubocop-rspec (3.2.0)
-      rubocop (~> 1.61)
-    rubocop-rspec_rails (2.30.0)
-      rubocop (~> 1.61)
-      rubocop-rspec (~> 3, >= 3.0.1)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.48.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.8.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
     ruby-progressbar (1.13.0)
-    sshkit (1.23.2)
+    sshkit (1.25.0)
       base64
+      logger
       net-scp (>= 1.1.2)
       net-sftp (>= 2.1.2)
       net-ssh (>= 2.8.0)
       ostruct
-    unicode-display_width (2.6.0)
-    webmock (3.24.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    webmock (3.26.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -124,8 +135,7 @@ DEPENDENCIES
   rubocop-performance (~> 1.20)
   rubocop-rake (~> 0.6)
   rubocop-rspec (~> 3.0)
-  rubocop-rspec_rails (~> 2.30)
   webmock (~> 3.11)
 
 BUNDLED WITH
-   2.3.7
+   2.6.7

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/capistrano-asg-rolling.svg)](https://badge.fury.io/rb/capistrano-asg-rolling)
 [![Build Status](https://github.com/KentaaNL/capistrano-asg-rolling/actions/workflows/test.yml/badge.svg)](https://github.com/KentaaNL/capistrano-asg-rolling/actions)
-[![Code Climate](https://codeclimate.com/github/KentaaNL/capistrano-asg-rolling/badges/gpa.svg)](https://codeclimate.com/github/KentaaNL/capistrano-asg-rolling)
+[![CodeQL](https://github.com/KentaaNL/capistrano-asg-rolling/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/KentaaNL/capistrano-asg-rolling/actions/workflows/github-code-scanning/codeql)
 
 Capistrano plugin for performing rolling updates to AWS Auto Scaling Groups using the [instance refresh feature](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html).
 
@@ -106,6 +106,13 @@ set :asg_wait_for_instance_refresh, true
 set :asg_instance_refresh_polling_interval, 30 # default
 ```
 
+Enable or disable auto-rollback on instance refreshes (default: false):
+
+```ruby
+# config/deploy.rb
+set :asg_instance_refresh_auto_rollback, true
+```
+
 ## Usage
 
 Specify the Auto Scaling Groups with the keyword `autoscale` instead of using the `server` keyword in Capistrano's stage configuration. Provide the name of the Auto Scaling Group and any properties you want to pass to the server:
@@ -174,6 +181,26 @@ autoscale 'web-autoscale-group', rolling: true, user: 'deployer'
 
 With these two stages, you can run any tasks with `cap production <task name>` and rolling deployments with `cap production_rolling deploy`.
 
+### Tags
+
+During deployment, the following tags will be added to the AMI and snapshot containing information about the current application, stage and deployment:
+- `capistrano-asg-rolling:application`
+- `capistrano-asg-rolling:stage`
+- `capistrano-asg-rolling:deployment-branch`
+- `capistrano-asg-rolling:deployment-release`
+- `capistrano-asg-rolling:deployment-revision`
+- `capistrano-asg-rolling:deployment-user`
+
+In addition to that, the tag `capistrano-asg-rolling:gem-version` will be added with the value of the current gem version.
+This tag is also used to determine if the AMI was created by this gem, and can be deleted automatically.
+
+You can add custom tag(s) to the AMI and snapshot by setting the property `asg_rolling_ami_tags`, for example:
+
+```ruby
+# config/deploy/<stage>.rb
+set :asg_rolling_ami_tags, { 'Application' => 'My Application', 'Environment' => 'Production' }
+```
+
 ## Useful commands
 
 ### Test deployment

data/capistrano-asg-rolling.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.1.0'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 13.0'

data/lib/capistrano/asg/rolling/autoscale_group.rb

@@ -55,6 +55,10 @@ module Capistrano
           properties.fetch(:min_healthy_percentage, nil)
         end
 
+        def auto_rollback
+          properties.fetch(:asg_instance_refresh_auto_rollback, nil)
+        end
+
         def max_healthy_percentage
           properties.fetch(:max_healthy_percentage, nil)
         end
@@ -73,7 +77,8 @@ module Capistrano
               instance_warmup: instance_warmup_time,
               skip_matching: true,
               min_healthy_percentage: min_healthy_percentage,
-              max_healthy_percentage: max_healthy_percentage
+              max_healthy_percentage: max_healthy_percentage,
+              auto_rollback: auto_rollback
             }.compact
           ).instance_refresh_id
         rescue Aws::AutoScaling::Errors::InstanceRefreshInProgress => e

data/lib/capistrano/asg/rolling/autoscale_groups.rb

@@ -15,8 +15,8 @@ module Capistrano
           @groups << group
         end
 
-        def each(&block)
-          @groups.reject { |group| filtered?(group) }.each(&block)
+        def each(&)
+          @groups.reject { |group| filtered?(group) }.each(&)
         end
 
         def launch_templates

data/lib/capistrano/asg/rolling/exception.rb

@@ -39,6 +39,13 @@ module Capistrano
           super('No instances have been launched. Are you using a configuration with rolling deployments?')
         end
       end
+
+      # Exception when waiting for SSH availability timed out.
+      class SSHAvailabilityTimeoutError < Capistrano::ASG::Rolling::Exception
+        def initialize(timeout)
+          super("Timed out waiting for SSH to become available after #{timeout} seconds")
+        end
+      end
     end
   end
 end

data/lib/capistrano/asg/rolling/instance.rb

@@ -65,18 +65,6 @@ module Capistrano
           new(instance.instance_id, instance.private_ip_address, instance.public_ip_address, instance.image_id, autoscaling_group)
         end
 
-        def wait_for_ssh
-          started_at = Time.now
-
-          loop do
-            result = SSH.test?(ip_address, autoscale_group.properties[:user], Configuration.ssh_options)
-
-            break if result || Time.now - started_at > 300
-
-            sleep 1
-          end
-        end
-
         def ip_address
           Configuration.use_private_ip_address? ? private_ip_address : public_ip_address
         end

data/lib/capistrano/asg/rolling/instances.rb

@@ -15,8 +15,8 @@ module Capistrano
           @instances << instance
         end
 
-        def each(&block)
-          instances.each(&block)
+        def each(&)
+          instances.each(&)
         end
 
         def empty?
@@ -31,10 +31,6 @@ module Capistrano
           self.class.new(select { |instance| instance.image_id == image_id })
         end
 
-        def wait_for_ssh
-          Parallel.run(instances, &:wait_for_ssh)
-        end
-
         def stop
           Parallel.run(instances, &:stop)
         end

data/lib/capistrano/asg/rolling/launch_templates.rb

@@ -21,8 +21,8 @@ module Capistrano
           @templates.merge(templates)
         end
 
-        def each(&block)
-          @templates.each(&block)
+        def each(&)
+          @templates.each(&)
         end
 
         def empty?

data/lib/capistrano/asg/rolling/plugin.rb

@@ -29,6 +29,7 @@ module Capistrano
           after 'rolling:update', 'rolling:cleanup'
           after 'rolling:create_ami', 'rolling:cleanup'
           after 'rolling:update', 'rolling:instance_refresh_status'
+          after 'rolling:trigger_instance_refresh', 'rolling:instance_refresh_status'
 
           # Register an exit hook to do some cleanup when Capistrano
           # terminates without calling our after cleanup hook.
@@ -47,6 +48,16 @@ module Capistrano
           Capistrano::ASG::Rolling::Configuration
         end
 
+        # Add an instance to the Capistrano server list, with the given properties.
+        def add_instance(instance, properties)
+          server_properties = properties.merge(instance_id: instance.id)
+
+          logger.verbose "Adding server: **#{instance.ip_address}**"
+
+          server(instance.ip_address, server_properties)
+        end
+
+        # Make sure any instances that were launched for rolling updates are terminated.
         def cleanup
           instances = config.instances.auto_terminate
           return if instances.empty?

data/lib/capistrano/asg/rolling/ssh.rb

@@ -1,22 +1,41 @@
 # frozen_string_literal: true
 
+require 'time'
+
 module Capistrano
   module ASG
     module Rolling
-      # SSH availability test.
+      # Test the SSHKit backend for availability.
       module SSH
         module_function
 
-        def test?(ip_address, user, ssh_options)
-          options = ssh_options || {}
-          options[:timeout] = 10
+        WAIT_TIMEOUT = 300
+
+        def wait_for_availability(backend)
+          timeout = WAIT_TIMEOUT
+          expires_at = Time.now + timeout
+
+          loop do
+            break if available?(backend)
+
+            raise SSHAvailabilityTimeoutError, timeout if Time.now > expires_at
 
-          ::Net::SSH.start(ip_address, user, options) do |ssh|
-            ssh.exec!('echo hello')
+            sleep 1
           end
+        end
+
+        def available?(backend)
+          backend.test('echo hello')
 
           true
-        rescue ::Net::SSH::ConnectionTimeout, ::Net::SSH::Proxy::ConnectError, Errno::ECONNREFUSED, Errno::ETIMEDOUT
+        rescue ::Net::SSH::AuthenticationFailed, ::Net::SSH::Authentication::DisallowedMethod
+          # SSH server is reachable and responding.
+          true
+        rescue ::Net::SSH::ConnectionTimeout, ::Net::SSH::Proxy::ConnectError, Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::ETIMEDOUT, Errno::ECONNRESET
+          # SSH server not reachable or port closed.
+          false
+        rescue ::Net::SSH::Disconnect # rubocop:disable Lint/DuplicateBranch
+          # SSH server is reachable, but the connection dropped unexpectedly.
           false
         end
       end

data/lib/capistrano/asg/rolling/tags.rb

@@ -9,7 +9,7 @@ module Capistrano
 
         # The tags to add to an AMI.
         def ami_tags
-          application_tags.merge(deployment_tags).merge(gem_tags)
+          application_tags.merge(deployment_tags).merge(gem_tags).merge(custom_tags)
         end
 
         # Tags related to the current application / stage.
@@ -36,6 +36,11 @@ module Capistrano
             'capistrano-asg-rolling:gem-version' => Capistrano::ASG::Rolling::VERSION
           }
         end
+
+        # Custom added tags.
+        def custom_tags
+          fetch(:asg_rolling_ami_tags) || {}
+        end
       end
     end
   end

data/lib/capistrano/asg/rolling/version.rb

@@ -3,7 +3,7 @@
 module Capistrano
   module ASG
     module Rolling
-      VERSION = '0.5.1'
+      VERSION = '0.7.0'
     end
   end
 end

data/lib/capistrano/asg/tasks/rolling.rake

@@ -14,10 +14,7 @@ namespace :rolling do
         logger.info "Launched Instance: **#{instance.id}**"
         config.instances << instance
 
-        logger.verbose "Adding server: **#{instance.ip_address}**"
-
-        # Add server to the Capistrano server list.
-        server(instance.ip_address, group.properties)
+        add_instance(instance, group.properties)
       else
         logger.info "Auto Scaling Group: **#{group.name}**, standard deployment strategy."
 
@@ -29,17 +26,17 @@ namespace :rolling do
             server_properties = group.properties
           end
 
-          logger.verbose "Adding server: **#{instance.ip_address}**"
-
-          # Add server to the Capistrano server list.
-          server(instance.ip_address, server_properties)
+          add_instance(instance, server_properties)
         end
       end
     end
 
     unless config.instances.empty?
       logger.info 'Waiting for SSH to be available...'
-      config.instances.wait_for_ssh
+
+      on roles(:all) do
+        Capistrano::ASG::Rolling::SSH.wait_for_availability(self)
+      end
     end
   end
 
@@ -71,6 +68,17 @@ namespace :rolling do
     end
   end
 
+  desc 'Trigger instance refresh of deployed autoscaling groups'
+  task :trigger_instance_refresh do
+    logger.info 'Triggering Instance Refresh on Auto Scaling Group(s)...'
+    config.autoscale_groups.each do |group|
+      group.start_instance_refresh(group.launch_template)
+      logger.info "Successfully started Instance Refresh on Auto Scaling Group **#{group.name}**."
+    rescue Capistrano::ASG::Rolling::StartInstanceRefreshError => e
+      logger.info "Failed to start Instance Refresh on Auto Scaling Group **#{group.name}**: #{e.message}"
+    end
+  end
+
   desc 'Clean up old Launch Template versions and AMIs and terminate instances'
   task :cleanup do
     unless config.launch_templates.empty?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-asg-rolling
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Kentaa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-04 00:00:00.000000000 Z
+date: 2025-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -181,14 +181,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Capistrano plugin for performing rolling updates to AWS Auto Scaling Groups