cfn-status 0.4.1 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b5779a34350074951fd6e52df7e72dbd1d78a291bcd394ab04ef4e85101d4c2
-  data.tar.gz: 104e5f8f7665e2f42c26c8f60d65ac2027022c883f622134abb815b59195c955
+  metadata.gz: 7b8d3f2b5eaaab5d41d434b53fdb4ed16337bac065772db5efd0da6869f03d7c
+  data.tar.gz: 7412b786f0ab988f2c20100222026a13fa8cd1385742efc2cc074d6bfb319925
 SHA512:
-  metadata.gz: 76c29de282df67688889e29cec71240ae37fdbbd19cc581067761b0c8d73757f76929db1bc5900eee52cd844b72e5b44a1b4566d1584a2a802ed98bd9ca81151
-  data.tar.gz: 65e8894d61f52ae4fd19ee1801301fbc8934f6cab0cd7c875b586693dda423a33b3f2447fa9813675fbc17511f544f78c73166f0655293b90a259056521e5f7a
+  metadata.gz: 1b32d13db397770b601204ec8c9dcc33d28c0f7671863d84a8e3e225adfd2feb5674eba8ff06e808cb8399f5452e3fb9b3d9f267cc4b90288da0e02c16ea5604
+  data.tar.gz: 97dfb7f30531b3269c255af4d892e4c67084cc6c21670adc43efa48c5927088317983fdfe00888ee29a5a3395fbfb3c162c632aba34470aa67b7b1056875b6aa

data/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 This project *loosely* adheres to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.4.5] - 2022-02-20
+- [#5](https://github.com/tongueroo/cfn-status/pull/5) cfn-status retry options
+
+## [0.4.4] - 2022-02-14
+- more generic time took message
+
+## [0.4.3] - 2021-05-27
+- [#4](https://github.com/tongueroo/cfn-status/pull/4) fix current status message
+
+## [0.4.2]
+- #3 improve messaging when wait called directly. dont show old events.
+
 ## [0.4.1]
 - fix require cfn_status/rollback_stack
 

data/lib/cfn_status/aws_service.rb

@@ -3,7 +3,7 @@ require "aws-sdk-cloudformation"
 class CfnStatus
   module AwsService
     def cfn
-      @cfn ||= Aws::CloudFormation::Client.new
+      @cfn ||= Aws::CloudFormation::Client.new(aws_options)
     end
 
     def stack_exists?(stack_name)
@@ -47,5 +47,36 @@ class CfnStatus
     def rollback_complete?(stack)
       stack&.stack_status == 'ROLLBACK_COMPLETE'
     end
+
+    # Override the AWS retry settings.
+    #
+    # The aws-sdk-core has exponential backup with this formula:
+    #
+    #   2 ** c.retries * c.config.retry_base_delay
+    #
+    # Source:
+    #   https://github.com/aws/aws-sdk-ruby/blob/version-3/gems/aws-sdk-core/lib/aws-sdk-core/plugins/retry_errors.rb
+    #
+    # So the max delay will be 2 ** 7 * 0.6 = 76.8s
+    #
+    # Only scoping this to deploy because dont want to affect people's application that use the aws sdk.
+    #
+    # There is also additional rate backoff logic elsewhere, since this is only scoped to deploys.
+    #
+    # Useful links:
+    #   https://github.com/aws/aws-sdk-ruby/blob/master/gems/aws-sdk-core/lib/aws-sdk-core/plugins/retry_errors.rb
+    #   https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.html
+    #
+    def aws_options
+      options = {
+        retry_limit: 7, # default: 3
+        retry_base_delay: 0.6, # default: 0.3
+      }
+      options.merge!(
+        log_level: :debug,
+        logger: Logger.new($stdout),
+      ) if ENV['CFN_STATUS_DEBUG_AWS_SDK']
+      options
+    end
   end
 end

data/lib/cfn_status/version.rb

@@ -1,3 +1,3 @@
 class CfnStatus
-  VERSION = "0.4.1"
+  VERSION = "0.4.5"
 end

data/lib/cfn_status.rb

@@ -7,11 +7,13 @@ class CfnStatus
   autoload :AwsService, "cfn_status/aws_service"
   include AwsService
 
-  attr_reader :events
+  attr_reader :events, :stack
   def initialize(stack_name, options={})
     @stack_name = stack_name
     @options = options
     @cfn = options[:cfn] # allow use of different cfn client. can be useful multiple cfn clients and with different regions
+    resp = cfn.describe_stacks(stack_name: @stack_name)
+    @stack = resp.stacks.first
     reset
   end
 
@@ -21,11 +23,8 @@ class CfnStatus
       return true
     end
 
-    resp = cfn.describe_stacks(stack_name: @stack_name)
-    stack = resp.stacks.first
-
     puts "The current status for the stack #{@stack_name.color(:green)} is #{stack.stack_status.color(:green)}"
-    if stack.stack_status =~ /_IN_PROGRESS$/
+    if in_progress?
       puts "Stack events (tailing):"
       # tail all events until done
       @hide_time_took = true
@@ -39,6 +38,11 @@ class CfnStatus
     success?
   end
 
+  def in_progress?
+    in_progress = stack.stack_status =~ /_IN_PROGRESS$/
+    !!in_progress
+  end
+
   def reset
     @events = [] # constantly replaced with recent events
     @last_shown_event_id = nil
@@ -47,6 +51,10 @@ class CfnStatus
 
   # check for /(_COMPLETE|_FAILED)$/ status
   def wait
+    # Check for in progress again in case .wait is called from other libraries like s3-antivirus
+    # Showing the event messages when will show old messages which can be confusing.
+    return unless in_progress?
+
     puts "Waiting for stack to complete"
     start_time = Time.now
 
@@ -75,7 +83,7 @@ class CfnStatus
 
     return if @hide_time_took # set in run
     took = Time.now - start_time
-    puts "Time took for stack deployment: #{pretty_time(took).color(:green)}."
+    puts "Time took: #{pretty_time(took).color(:green)}."
     success?
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-status
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.5
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2022-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: CloudFormation status library