capistrano-asg-rolling 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8df47c0498d2086c65ea0b92eb4ac4fbcce15f253e6752ad1cbe1fedcf58abe5
-  data.tar.gz: 1ec79f6ab87ce44a220e003ec47dd9cc35843f824dc389756c69c4e0c4418265
+  metadata.gz: 517d95aa2350605f6a9fb472c3c5b293916946747936f2850219f65f6eb4b439
+  data.tar.gz: 159c94f7e0c371d0e7d1877fbc73ad40e923fc6e8c24e22ab586b7c603c98999
 SHA512:
-  metadata.gz: 70325e34622519ef8b91cc6d324ca0e22ebd61f7c69ce0011c1f0b958845ecacd8a0fbeba0985ca192c83b323e8a307dfb067271b2db0ade59332e7205062126
-  data.tar.gz: 9fa3da49333f7721986593de03f764d4bb75809ce2401b654de45548610d5b73c65357ccb88205d7516c55cf91d7191bef03c8dc1def11f091762cbd9e4cc33d
+  metadata.gz: 628c4200fb0e4e81370829d700bc0206a81390ad4392d97459c20f8c358a72a1882bcacd829cb69dcb816f9c2f5ed39ef5f8c05c35e7abc7231defa41fce98c0
+  data.tar.gz: 688a2886933cb90fd2781946e09fd54bd8d72fbbe450256fdd8c16302465007652c34194047a9a49e87226a7a0f823aeba6f5ddc9f210102edf1e6622afa495c

data/.rubocop.yml

@@ -21,6 +21,9 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/ClassLength:
+  Enabled: false
+
 Metrics/MethodLength:
   Enabled: false
 

data/Gemfile

@@ -7,7 +7,7 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in capistrano-asg-rolling.gemspec
 gemspec
 
-gem 'rubocop', '~> 1.52.0'
-gem 'rubocop-performance', '~> 1.18.0'
+gem 'rubocop', '~> 1.56.3'
+gem 'rubocop-performance', '~> 1.19.0'
 gem 'rubocop-rake', '~> 0.6.0'
-gem 'rubocop-rspec', '~> 2.22.0'
+gem 'rubocop-rspec', '~> 2.24.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-asg-rolling (0.3.0)
+    capistrano-asg-rolling (0.4.0)
       aws-sdk-autoscaling (~> 1, >= 1.67.0)
       aws-sdk-ec2 (~> 1)
       capistrano (~> 3)
@@ -10,26 +10,27 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.4)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
-    airbrussh (1.4.1)
+    airbrussh (1.5.0)
       sshkit (>= 1.6.1, != 1.7.0)
     ast (2.4.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.774.0)
-    aws-sdk-autoscaling (1.90.0)
-      aws-sdk-core (~> 3, >= 3.174.0)
+    aws-partitions (1.830.0)
+    aws-sdk-autoscaling (1.98.0)
+      aws-sdk-core (~> 3, >= 3.184.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.174.0)
+    aws-sdk-core (3.184.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.651.0)
       aws-sigv4 (~> 1.5)
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-ec2 (1.381.0)
-      aws-sdk-core (~> 3, >= 3.174.0)
+    aws-sdk-ec2 (1.410.0)
+      aws-sdk-core (~> 3, >= 3.184.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.5.2)
+    aws-sigv4 (1.6.0)
       aws-eventstream (~> 1, >= 1.0.2)
+    base64 (0.1.1)
     capistrano (3.17.3)
       airbrussh (>= 1.0.0)
       i18n
@@ -44,17 +45,20 @@ GEM
       concurrent-ruby (~> 1.0)
     jmespath (1.6.2)
     json (2.6.3)
+    language_server-protocol (3.17.0.3)
     net-scp (4.0.0)
       net-ssh (>= 2.6.5, < 8.0.0)
-    net-ssh (7.1.0)
+    net-ssh (7.2.0)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    public_suffix (5.0.1)
+      racc
+    public_suffix (5.0.3)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -64,41 +68,43 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.52.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.4)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.18.0)
+    rubocop-capybara (2.19.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.23.1)
+    rubocop-factory_bot (2.24.0)
       rubocop (~> 1.33)
-    rubocop-performance (1.18.0)
+    rubocop-performance (1.19.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.22.0)
+    rubocop-rspec (2.24.1)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
-    sshkit (1.21.4)
+    sshkit (1.21.5)
       net-scp (>= 1.1.2)
       net-ssh (>= 2.8.0)
     unicode-display_width (2.4.2)
-    webmock (3.18.1)
+    webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -111,10 +117,10 @@ DEPENDENCIES
   capistrano-asg-rolling!
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 1.52.0)
-  rubocop-performance (~> 1.18.0)
+  rubocop (~> 1.56.3)
+  rubocop-performance (~> 1.19.0)
   rubocop-rake (~> 0.6.0)
-  rubocop-rspec (~> 2.22.0)
+  rubocop-rspec (~> 2.24.0)
   webmock (~> 3.11)
 
 BUNDLED WITH

data/README.md

@@ -101,6 +101,14 @@ When launching an Instance, you can override any settings defined in the Launch
 set :asg_rolling_instance_overrides, { instance_type: 'c5.large' }
 ```
 
+You can make Capistrano wait until the instances in the autoscaling group have completed refreshing with:
+
+```ruby
+# config/deploy.rb
+set :asg_wait_for_instance_refresh, true
+set :asg_instance_refresh_polling_interval, 30 # default
+```
+
 ## 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:
@@ -141,7 +149,7 @@ autoscale 'web-autoscale-group', user: 'deployer', healthy_percentage: 75   # ov
 
 The rolling configuration of the stage has a side-effect: any Capistrano tasks you run, will also launch instances per Auto Scaling Group.
 
-For example the command: `cap production rails:console`, will launch a new instance and run `rails:console` and that instance. While that can be useful, you often just want to run the task on the primary server. A solution is to create two stages with different rolling configurations, for example:
+For example the command: `cap production rails:console`, will launch a new instance and run `rails:console` on that instance. While that can be useful, you often just want to run the task on the primary server. A solution is to create two stages with different rolling configurations, for example:
 
 ```ruby
 # config/deploy/production.rb

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

@@ -12,7 +12,9 @@ module Capistrano
         LIFECYCLE_STATE_IN_SERVICE = 'InService'
         LIFECYCLE_STATE_STANDBY = 'Standby'
 
-        attr_reader :name, :properties
+        COMPLETED_REFRESH_STATUSES = %w[Successful Failed Cancelled RollbackSuccessful RollbackFailed].freeze
+
+        attr_reader :name, :properties, :refresh_id
 
         def initialize(name, properties = {})
           @name = name
@@ -45,7 +47,7 @@ module Capistrano
         end
 
         def start_instance_refresh(launch_template)
-          aws_autoscaling_client.start_instance_refresh(
+          @refresh_id = aws_autoscaling_client.start_instance_refresh(
             auto_scaling_group_name: name,
             strategy: 'Rolling',
             desired_configuration: {
@@ -59,11 +61,26 @@ module Capistrano
               min_healthy_percentage: healthy_percentage,
               skip_matching: true
             }
-          )
+          ).instance_refresh_id
         rescue Aws::AutoScaling::Errors::InstanceRefreshInProgress => e
           raise Capistrano::ASG::Rolling::InstanceRefreshFailed, e
         end
 
+        InstanceRefreshStatus = Struct.new(:status, :percentage_complete) do
+          def completed?
+            COMPLETED_REFRESH_STATUSES.include?(status)
+          end
+        end
+
+        def latest_instance_refresh
+          instance_refresh = most_recent_instance_refresh
+          status = instance_refresh&.dig(:status)
+          percentage_complete = instance_refresh&.dig(:percentage_complete)
+          return nil if status.nil?
+
+          InstanceRefreshStatus.new(status, percentage_complete)
+        end
+
         # Returns instances with lifecycle state "InService" for this Auto Scaling Group.
         def instances
           instance_ids = aws_autoscaling_group.instances.select { |i| i.lifecycle_state == LIFECYCLE_STATE_IN_SERVICE }.map(&:instance_id)
@@ -106,6 +123,16 @@ module Capistrano
 
         private
 
+        def most_recent_instance_refresh
+          parameters = {
+            auto_scaling_group_name: name,
+            max_records: 1
+          }
+          parameters[:instance_refresh_ids] = [@refresh_id] if @refresh_id
+          refresh = aws_autoscaling_client.describe_instance_refreshes(parameters).to_h
+          refresh[:instance_refreshes].first
+        end
+
         def aws_autoscaling_group
           @aws_autoscaling_group ||= ::Aws::AutoScaling::AutoScalingGroup.new(name: name, client: aws_autoscaling_client)
         end

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

@@ -71,6 +71,14 @@ module Capistrano
         def rolling_update?
           fetch(:asg_rolling_update)
         end
+
+        def wait_for_instance_refresh?
+          fetch(:asg_wait_for_instance_refresh, false)
+        end
+
+        def instance_refresh_polling_interval
+          fetch(:asg_instance_refresh_polling_interval, 30)
+        end
       end
     end
   end

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

@@ -15,6 +15,16 @@ module Capistrano
 
       class InstanceRefreshFailed < Capistrano::ASG::Rolling::Exception
       end
+
+      # Exception when instance terminate fails.
+      class InstanceTerminateFailed < Capistrano::ASG::Rolling::Exception
+        attr_reader :instance
+
+        def initialize(instance, exception)
+          @instance = instance
+          super(exception)
+        end
+      end
     end
   end
 end

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

@@ -91,6 +91,8 @@ module Capistrano
           aws_ec2_client.wait_until(:instance_terminated, instance_ids: [id]) if wait
 
           @terminated = true
+        rescue Aws::EC2::Errors::ServiceError => e
+          raise Capistrano::ASG::Rolling::InstanceTerminateFailed.new(self, e)
         end
 
         def create_ami(name: nil, description: nil, tags: nil)

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

@@ -13,6 +13,10 @@ module Capistrano
           $stdout.puts format_text(text)
         end
 
+        def warning(text)
+          $stdout.puts format_text("WARNING: #{text}")
+        end
+
         def error(text)
           $stderr.puts format_text(text, color: :red) # rubocop:disable Style/StderrPuts
         end

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

@@ -28,6 +28,7 @@ module Capistrano
 
           after 'rolling:update', 'rolling:cleanup'
           after 'rolling:create_ami', 'rolling:cleanup'
+          after 'rolling:update', 'rolling:instance_refresh_status'
 
           # Register an exit hook to do some cleanup when Capistrano
           # terminates without calling our after cleanup hook.
@@ -52,6 +53,8 @@ module Capistrano
 
           logger.info 'Terminating instance(s)...'
           instances.terminate
+        rescue Capistrano::ASG::Rolling::InstanceTerminateFailed => e
+          logger.warning "Failed to terminate Instance **#{e.instance.id}**: #{e.message}"
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module Capistrano
   module ASG
     module Rolling
-      VERSION = '0.3.0'
+      VERSION = '0.4.0'
     end
   end
 end

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

@@ -21,7 +21,7 @@ namespace :rolling do
       else
         logger.info "Auto Scaling Group: **#{group.name}**, standard deployment strategy."
 
-        group.instances.each_with_index do |instance, index| # rubocop:disable Lint/ShadowingOuterLocalVariable
+        group.instances.each_with_index do |instance, index|
           if index.zero? && group.properties.key?(:primary_roles)
             server_properties = group.properties.dup
             server_properties[:roles] = server_properties.delete(:primary_roles)
@@ -86,7 +86,7 @@ namespace :rolling do
           deleted = deleted_amis.include?(ami)
 
           if !exists && !deleted
-            logger.info("WARNING: AMI **#{ami.id}** does not exist for Launch Template **#{version.name}** version **#{version.version}**.")
+            logger.warning("AMI **#{ami.id}** does not exist for Launch Template **#{version.name}** version **#{version.version}**.")
             next
           end
 
@@ -109,7 +109,11 @@ namespace :rolling do
     instances = config.instances.auto_terminate
     if instances.any?
       logger.info 'Terminating instance(s)...'
-      instances.terminate
+      begin
+        instances.terminate
+      rescue Capistrano::ASG::Rolling::InstanceTerminateFailed => e
+        logger.warning "Failed to terminate Instance **#{e.instance.id}**: #{e.message}"
+      end
     end
   end
 
@@ -168,4 +172,30 @@ namespace :rolling do
       end
     end
   end
+
+  desc 'Get status of instance refresh'
+  task :instance_refresh_status do
+    return unless config.wait_for_instance_refresh?
+
+    groups = config.autoscale_groups.to_h { |group| [group.name, group] }
+
+    while groups.any?
+      groups.each do |name, group|
+        refresh = group.latest_instance_refresh
+        if refresh.nil? || refresh.completed?
+          logger.info "Auto Scaling Group: **#{name}**, completed with status '#{refresh.status}'." if refresh.completed?
+          groups.delete(name)
+        elsif !refresh.percentage_complete.nil?
+          logger.info "Auto Scaling Group: **#{name}**, #{refresh.percentage_complete}% completed, status '#{refresh.status}'."
+        else
+          logger.info "Auto Scaling Group: **#{name}**, status '#{refresh.status}'."
+        end
+      end
+      next if groups.empty?
+
+      wait_for = config.instance_refresh_polling_interval
+      logger.info "Instance refresh(es) not completed, waiting #{wait_for} seconds..."
+      sleep wait_for
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-asg-rolling
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kentaa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-05 00:00:00.000000000 Z
+date: 2023-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler