cfn-status 0.4.2 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cfa3f286eb58e4b6178a1e5b91ae3ad1377c938e431afec5c62604ade1ae690
-  data.tar.gz: 8726add33467c6fa4f27297579f59e1daa392ea39ebdeed2141bd457c3ea990b
+  metadata.gz: d783959f733a3175c56612fc8b1f9be8124f4c21fc591d87df3fc2457b57040f
+  data.tar.gz: c78bffbbfd322f25fa4b6c00ed8b0c98e386dac24042bfec825d409e2e4ea357
 SHA512:
-  metadata.gz: 9e320d27a72fb9c8b644443ae7774ea3c8d0c8862905a2ac75b405fc02e82c2d02c801c78b5602ce311bb8706ffc436f34a98fcdc7f445dc31c57edfc8649134
-  data.tar.gz: 25feec8075d4575ddec75f57531790a634b57e1bfce690e61cb24882505d390051a53f4304b19a0d7eb0096a975284c29aefa17bae41d62632e569de30ec9e5b
+  metadata.gz: a2a89727d0321574dda3f212dbdfeff7ffae32ae3621de889191f6632d8b1aae8c98dd5f8b16c32c80789864fe0d63665fca304831c07e2bc015c5db310e6c34
+  data.tar.gz: e691c6788d1a5400d80e4e2ff01157dd80985f0464c58118cf78e04364bf055f24784cc662d93f72237d415f497c0d0eb1ec0b7a3c24872f903fec4eff5c6e43

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.6] - 2022-02-21
+- show took time for deletion also
+
+## [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.
 

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.2"
+  VERSION = "0.4.6"
 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
 
@@ -37,8 +39,6 @@ class CfnStatus
   end
 
   def in_progress?
-    resp = cfn.describe_stacks(stack_name: @stack_name)
-    stack = resp.stacks.first
     in_progress = stack.stack_status =~ /_IN_PROGRESS$/
     !!in_progress
   end
@@ -66,6 +66,7 @@ class CfnStatus
 
     if @stack_deletion_completed
       puts "Stack #{@stack_name} deleted."
+      show_took(start_time)
       return
     end
 
@@ -82,11 +83,15 @@ class CfnStatus
     end
 
     return if @hide_time_took # set in run
-    took = Time.now - start_time
-    puts "Time took for stack deployment: #{pretty_time(took).color(:green)}."
+    show_took(start_time)
     success?
   end
 
+  def show_took(start_time)
+    took = Time.now - start_time
+    puts "Time took: #{pretty_time(took).color(:green)}"
+  end
+
   def completed
     last_event_status =~ /(_COMPLETE|_FAILED)$/ &&
     @events[0]["logical_resource_id"] == @stack_name &&

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-status
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.6
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2022-02-21 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