cfn-status 0.4.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d783959f733a3175c56612fc8b1f9be8124f4c21fc591d87df3fc2457b57040f
-  data.tar.gz: c78bffbbfd322f25fa4b6c00ed8b0c98e386dac24042bfec825d409e2e4ea357
+  metadata.gz: 83ea64eefe541a908445abdcb961258dc4da1214975c4a0e757c8a54e689e554
+  data.tar.gz: f8d9d83fdf7d77b71f93ca9049f46c6d9a054adc4c7c64d8afe9b620e9f7df09
 SHA512:
-  metadata.gz: a2a89727d0321574dda3f212dbdfeff7ffae32ae3621de889191f6632d8b1aae8c98dd5f8b16c32c80789864fe0d63665fca304831c07e2bc015c5db310e6c34
-  data.tar.gz: e691c6788d1a5400d80e4e2ff01157dd80985f0464c58118cf78e04364bf055f24784cc662d93f72237d415f497c0d0eb1ec0b7a3c24872f903fec4eff5c6e43
+  metadata.gz: b8944265098682315726a329935fea5ab71e6ccef3b02ef786714802d6eae13ab484957d9de132b433e1a8978a18f2deedf79126a7aab6a5e1c1fe704ff234b9
+  data.tar.gz: 2ae96f538b6af56ddcbf48fcc630e3270ae4ad40d61668578e3c69f87e08924d338649e8d5be3e783978306cdecd3ff698793f58eb72d2c5b7c48acd675edc82

data/CHANGELOG.md

@@ -3,6 +3,20 @@
 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.6.0] - 2024-04-15
+- [#8](https://github.com/tongueroo/cfn-status/pull/8) Fix success return
+- fix success after delete
+- fix success return after wait
+- remove bin scripts
+- @hide_time_took fix
+- show took false by default
+
+## [0.5.0] - 2023-12-17
+- [#6](https://github.com/tongueroo/cfn-status/pull/6) Use events.dig instead of brackets
+- [#7](https://github.com/tongueroo/cfn-status/pull/7) Add start_index_before_delete option
+- add add_development_dependency nokogiri
+- improve dev dependency version pins
+
 ## [0.4.6] - 2022-02-21
 - show took time for deletion also
 

data/cfn-status.gemspec

@@ -24,7 +24,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "aws-sdk-cloudformation"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "nokogiri"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", ">= 3.0"
 end

data/lib/cfn_status/version.rb

@@ -1,3 +1,3 @@
 class CfnStatus
-  VERSION = "0.4.6"
+  VERSION = "0.6.0"
 end

data/lib/cfn_status.rb

@@ -8,7 +8,7 @@ class CfnStatus
   include AwsService
 
   attr_reader :events, :stack
-  def initialize(stack_name, options={})
+  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
@@ -23,7 +23,7 @@ class CfnStatus
       return true
     end
 
-    puts "The current status for the stack #{@stack_name.color(:green)} is #{stack.stack_status.color(:green)}"
+    puts "Stack #{@stack_name.color(:green)} Status: #{stack.stack_status.color(:green)}"
     if in_progress?
       puts "Stack events (tailing):"
       # tail all events until done
@@ -53,13 +53,13 @@ class CfnStatus
   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?
+    return success? unless in_progress?
 
     puts "Waiting for stack to complete"
     start_time = Time.now
 
     refresh_events
-    until completed || @stack_deletion_completed
+    until completed? || @stack_deletion_completed
       show_events(final: false)
     end
     show_events(final: true) # show the final event
@@ -67,35 +67,39 @@ class CfnStatus
     if @stack_deletion_completed
       puts "Stack #{@stack_name} deleted."
       show_took(start_time)
-      return
+      # Cant use success? because the stack is deleted and the describe stack errors
+      # For deletion, always return true once describe_stack fails to return the stack
+      return true
     end
 
     # Never gets beyond here when deleting a stack because the describe stack returns nothing
     # once the stack is deleted. Gets here for stack create and update though.
 
-    if last_event_status =~ /_FAILED/
+    if /_FAILED/.match?(last_event_status)
       puts "Stack failed: #{last_event_status}".color(:red)
-      puts "Stack reason #{@events[0]["resource_status_reason"]}".color(:red)
-    elsif last_event_status =~ /_ROLLBACK_/
+      puts "Stack reason #{@events.dig(0, "resource_status_reason")}".color(:red)
+    elsif /_ROLLBACK_/.match?(last_event_status)
       puts "Stack rolled back: #{last_event_status}".color(:red)
     else # success
       puts "Stack success status: #{last_event_status}".color(:green)
     end
 
-    return if @hide_time_took # set in run
     show_took(start_time)
     success?
   end
 
   def show_took(start_time)
+    # @hide_time_took set in run
+    return if @hide_time_took
+    return unless @options[:show_took]
     took = Time.now - start_time
     puts "Time took: #{pretty_time(took).color(:green)}"
   end
 
-  def completed
+  def completed?
     last_event_status =~ /(_COMPLETE|_FAILED)$/ &&
-    @events[0]["logical_resource_id"] == @stack_name &&
-    @events[0]["resource_type"] == "AWS::CloudFormation::Stack"
+      @events.dig(0, "logical_resource_id") == @stack_name &&
+      @events.dig(0, "resource_type") == "AWS::CloudFormation::Stack"
   end
 
   def last_event_status
@@ -110,20 +114,20 @@ class CfnStatus
     else
       i = last_shown_index
       # puts "last_shown index #{i}"
-      print_events(i-1) unless i == 0
+      print_events(i - 1) unless i == 0
     end
 
     return if final
-    sleep 5 unless ENV['TEST']
+    sleep 5 unless ENV["TEST"]
     refresh_events
   end
 
   def print_events(i)
-    @events[0..i].reverse.each do |e|
+    @events[0..i].reverse_each do |e|
       print_event(e)
     end
 
-    @last_shown_event_id = @events[0]["event_id"]
+    @last_shown_event_id = @events.dig(0, "event_id")
     # puts "@last_shown_event_id #{@last_shown_event_id.inspect}"
   end
 
@@ -135,7 +139,7 @@ class CfnStatus
       e["logical_resource_id"],
       e["resource_status_reason"]
     ].join(" ")
-    message = message.color(:red) if e["resource_status"] =~ /_FAILED/
+    message = message.color(:red) if /_FAILED/.match?(e["resource_status"])
     puts message
   end
 
@@ -160,9 +164,8 @@ class CfnStatus
     else
       add_events_pages(resp, :start_index)
     end
-
   rescue Aws::CloudFormation::Errors::ValidationError => e
-    if e.message =~ /Stack .* does not exis/
+    if /Stack .* does not exis/.match?(e.message)
       @stack_deletion_completed = true
     else
       raise
@@ -191,9 +194,14 @@ class CfnStatus
 
   # Should always find a "User Initiated" stack event when @last_shown_index is not set
   def start_index
+    start_index_before_delete = @options[:start_index_before_delete]
+
     @events.find_index do |event|
+      skip = start_index_before_delete && event["resource_status"] == "DELETE_IN_PROGRESS"
+
       event["resource_type"] == "AWS::CloudFormation::Stack" &&
-      event["resource_status_reason"] == "User Initiated"
+        event["resource_status_reason"] == "User Initiated" &&
+        !skip
     end
   end
 
@@ -204,18 +212,26 @@ class CfnStatus
   end
 
   def success?
-    resource_status = @events[0]["resource_status"]
-    %w[CREATE_COMPLETE UPDATE_COMPLETE].include?(resource_status)
+    resource_status = @events.dig(0, "resource_status")
+    if resource_status.nil? # not called as a part of wait
+      resp = cfn.describe_stacks(stack_name: @stack_name)
+      status = resp.stacks.first.stack_status
+    else
+      status = resource_status
+    end
+
+    successes = %w[CREATE_COMPLETE UPDATE_COMPLETE]
+    successes.include?(status)
   end
 
   def update_rollback?
-    @events[0]["resource_status"] == "UPDATE_ROLLBACK_COMPLETE"
+    @events.dig(0, "resource_status") == "UPDATE_ROLLBACK_COMPLETE"
   end
 
   def find_update_failed_event
     i = @events.find_index do |event|
       event["resource_type"] == "AWS::CloudFormation::Stack" &&
-      event["resource_status_reason"] == "User Initiated"
+        event["resource_status_reason"] == "User Initiated"
     end
 
     @events[0..i].reverse.find do |e|
@@ -231,7 +247,7 @@ class CfnStatus
 
     reason = event["resource_status_reason"]
     messages_map.each do |pattern, message|
-      if reason =~ pattern
+      if reason&.match?(pattern)
         return message
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-status
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.6.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-21 00:00:00.000000000 Z
+date: 2024-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -24,46 +24,60 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 description: 
@@ -81,8 +95,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - cfn-status.gemspec
 - lib/cfn-status.rb
 - lib/cfn_status.rb
@@ -108,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: CloudFormation status library

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "cfn_status"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here