cfn-status 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20ff184a75d8e49d8a510a06a1840b5038b93e9e365a41c37504d8af708fec55
-  data.tar.gz: ee4a201d624daeeccd161ff42cbc3e5fdd83510dde35ac54f624a35543ce95de
+  metadata.gz: db0db619c3720d0b8aa596db7f48638b88ad4866b110647cba6af9bdef8a083b
+  data.tar.gz: f911ca63d21c025da730f3b96065982698d0e2f4b2321a01d74c4ce854a0095e
 SHA512:
-  metadata.gz: 62c536dfe7039ec34fc868bcf758afb40e94de5dc3c0b7f103e397b242147e1601076009995c9c3176a6de3aae47aea3b58abe7ef531c79964a1a63840b49540
-  data.tar.gz: 5320aa2e9668ccd173b3fdc9d991b0c909d29438529e6e8f03714ceb5d808d35d98a39cdc7f299eb39dd134fddfca413b09a0160f4fe8dbf89c7c986f7dd3b99
+  metadata.gz: 506a3a5fda2b73a8a33e5aac2afb7e94dcbf63a6d90e4e3dad7bee7f1e182360b559db97b5c721a2282e0ec199e12d0f615c8dd2483e6c1b3b1a99a1cd8cf3f0
+  data.tar.gz: 38991d9cdf18ea678061a4c0e60297b236a912cc208a49fc58ffad339d94864da229b92c25e649e7a290dc33c8590af37a8a6f2056bc00f2d94e9cca0e5574bb

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/CHANGELOG.md

@@ -1,7 +1,11 @@
 # Change Log
 
 All notable changes to this project will be documented in this file.
-This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
+This project *loosely* adheres to [Semantic Versioning](http://semver.org/), even before v1.0.
+
+## [0.3.0]
+- #1 Breaking change: rename Rename to CfnStatus, cfn/status to cfn_status
+- Handle large templates and long stack_events via paginating the cfn.describe_stack_events until
 
 ## [0.2.0]
 - allow require "cfn-status" to work also

data/README.md

@@ -1,5 +1,7 @@
 # Cfn Status
 
+[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
+
 Helper library provides status of CloudFormation stack.
 
 ## Usage
@@ -13,13 +15,13 @@ Add this line to your gem's gemspec:
 Require it to your library:
 
 ```ruby
-require "cfn/status"
+require "cfn_status"
 ```
 
 Use like so:
 
 ```ruby
-status = Cfn::Status.new(stack_name)
+status = CfnStatus.new(stack_name)
 status.run # prints out stack events
 ```
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "cfn/status"
+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.

data/cfn-status.gemspec

@@ -1,11 +1,11 @@
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "cfn/status/version"
+require "cfn_status/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "cfn-status"
-  spec.version       = Cfn::Status::VERSION
+  spec.version       = CfnStatus::VERSION
   spec.authors       = ["Tung Nguyen"]
   spec.email         = ["tongueroo@gmail.com"]
 

data/lib/cfn-status.rb

@@ -1 +1 @@
-require "cfn/status"
+require "cfn_status"

data/lib/cfn_status.rb

@@ -0,0 +1,245 @@
+require "cfn_status/version"
+
+class CfnStatus
+  class Error < StandardError; end
+
+  autoload :AwsService, "cfn_status/aws_service"
+  include AwsService
+
+  attr_reader :events
+  def initialize(stack_name, options={})
+    @stack_name = stack_name
+    @options = options
+    reset
+  end
+
+  def run
+    unless stack_exists?(@stack_name)
+      puts "The stack #{@stack_name.color(:green)} does not exist."
+      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$/
+      puts "Stack events (tailing):"
+      # tail all events until done
+      @hide_time_took = true
+      wait
+    else
+      puts "Stack events:"
+      # show the last events that was user initiated
+      refresh_events
+      show_events(final: true)
+    end
+    success?
+  end
+
+  def reset
+    @events = [] # constantly replaced with recent events
+    @last_shown_event_id = nil
+    @stack_deletion_completed = nil
+  end
+
+  # check for /(_COMPLETE|_FAILED)$/ status
+  def wait
+    puts "Waiting for stack to complete"
+    start_time = Time.now
+
+    refresh_events
+    until completed || @stack_deletion_completed
+      show_events(final: false)
+    end
+    show_events(final: true) # show the final event
+
+    if @stack_deletion_completed
+      puts "Stack #{@stack_name} deleted."
+      return
+    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/
+      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 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
+    took = Time.now - start_time
+    puts "Time took for stack deployment: #{pretty_time(took).color(:green)}."
+    success?
+  end
+
+  def completed
+    last_event_status =~ /(_COMPLETE|_FAILED)$/ &&
+    @events[0]["logical_resource_id"] == @stack_name &&
+    @events[0]["resource_type"] == "AWS::CloudFormation::Stack"
+  end
+
+  def last_event_status
+    @events.dig(0, "resource_status")
+  end
+
+  # Only shows new events
+  def show_events(final: false)
+    if @last_shown_event_id.nil?
+      i = start_index
+      print_events(i)
+    else
+      i = last_shown_index
+      # puts "last_shown index #{i}"
+      print_events(i-1) unless i == 0
+    end
+
+    return if final
+    sleep 5 unless ENV['TEST']
+    refresh_events
+  end
+
+  def print_events(i)
+    @events[0..i].reverse.each do |e|
+      print_event(e)
+    end
+
+    @last_shown_event_id = @events[0]["event_id"]
+    # puts "@last_shown_event_id #{@last_shown_event_id.inspect}"
+  end
+
+  def print_event(e)
+    message = [
+      event_time(e["timestamp"]),
+      e["resource_status"],
+      e["resource_type"],
+      e["logical_resource_id"],
+      e["resource_status_reason"]
+    ].join(" ")
+    message = message.color(:red) if e["resource_status"] =~ /_FAILED/
+    puts message
+  end
+
+  # https://stackoverflow.com/questions/18000432/rails-12-hour-am-pm-range-for-a-day
+  def event_time(timestamp)
+    Time.parse(timestamp.to_s).localtime.strftime("%I:%M:%S%p")
+  end
+
+  # Refreshes the @events in memory.
+  #
+  def refresh_events
+    resp = cfn.describe_stack_events(stack_name: @stack_name)
+    @events = resp["stack_events"]
+
+    # refresh_events uses add_events_pages and resp["next_token"] to load all events until:
+    #
+    #     1. @last_shown_event_id found - if @last_shown_event_id is set
+    #     2. User Initiated Event found - fallback when @last_shown_event_id is not set
+    #
+    if @last_shown_event_id
+      add_events_pages(resp, :last_shown_index)
+    else
+      add_events_pages(resp, :start_index)
+    end
+
+  rescue Aws::CloudFormation::Errors::ValidationError => e
+    if e.message =~ /Stack .* does not exis/
+      @stack_deletion_completed = true
+    else
+      raise
+    end
+  end
+
+  # Examples:
+  #
+  #     add_events_pages(:start_index)
+  #     add_events_pages(:last_shown_index)
+  #
+  # if index_method is start_index
+  #   loops add_events_pagess through describe_stack_events until "User Initiated" is found
+  #
+  # if index_method is last_shown_index
+  #   loops add_events_pagess through describe_stack_events until last_shown_index is found
+  #
+  def add_events_pages(resp, index_method)
+    found = !!send(index_method)
+    until found
+      resp = cfn.describe_stack_events(stack_name: @stack_name, next_token: resp["next_token"])
+      @events += resp["stack_events"]
+      found = !!send(index_method)
+    end
+  end
+
+  # Should always find a "User Initiated" stack event when @last_shown_index is not set
+  def start_index
+    @events.find_index do |event|
+      event["resource_type"] == "AWS::CloudFormation::Stack" &&
+      event["resource_status_reason"] == "User Initiated"
+    end
+  end
+
+  def last_shown_index
+    @events.find_index do |event|
+      event["event_id"] == @last_shown_event_id
+    end
+  end
+
+  def success?
+    resource_status = @events[0]["resource_status"]
+    %w[CREATE_COMPLETE UPDATE_COMPLETE].include?(resource_status)
+  end
+
+  def update_rollback?
+    @events[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"
+    end
+
+    @events[0..i].reverse.find do |e|
+      e["resource_status"] == "UPDATE_FAILED"
+    end
+  end
+
+  def rollback_error_message
+    return unless update_rollback?
+
+    event = find_update_failed_event
+    return unless event
+
+    reason = event["resource_status_reason"]
+    messages_map.each do |pattern, message|
+      if reason =~ pattern
+        return message
+      end
+    end
+
+    reason # default message is original reason if not found in messages map
+  end
+
+  def messages_map
+    {
+      /CloudFormation cannot update a stack when a custom-named resource requires replacing/ => "A workaround is to run ufo again with STATIC_NAME=0 and to switch to dynamic names for resources. Then run ufo again with STATIC_NAME=1 to get back to statically name resources. Note, there are caveats with the workaround.",
+      /cannot be associated with more than one load balancer/ => "There's was an issue updating the stack. Target groups can only be associated with one load balancer at a time. The workaround for this is to use UFO_FORCE_TARGET_GROUP=1 and run the command again. This will force the recreation of the target group resource.",
+      /SetSubnets is not supported for load balancers of type/ => "Changing subnets for Network Load Balancers is currently not supported. You can try workarouding this with UFO_FORCE_ELB=1 and run the command again. This will force the recreation of the elb resource."
+    }
+  end
+
+  # http://stackoverflow.com/questions/4175733/convert-duration-to-hoursminutesseconds-or-similar-in-rails-3-or-ruby
+  def pretty_time(total_seconds)
+    minutes = (total_seconds / 60) % 60
+    seconds = total_seconds % 60
+    if total_seconds < 60
+      "#{seconds.to_i}s"
+    else
+      "#{minutes.to_i}m #{seconds.to_i}s"
+    end
+  end
+end

data/lib/{cfn → cfn_status}/aws_service.rb

@@ -1,6 +1,6 @@
 require "aws-sdk-cloudformation"
 
-module Cfn
+class CfnStatus
   module AwsService
     def cfn
       @cfn ||= Aws::CloudFormation::Client.new
@@ -45,7 +45,7 @@ module Cfn
     end
 
     def rollback_complete?(stack)
-      stack.stack_status == 'ROLLBACK_COMPLETE'
+      stack&.stack_status == 'ROLLBACK_COMPLETE'
     end
   end
 end

data/lib/cfn_status/version.rb

@@ -0,0 +1,3 @@
+class CfnStatus
+  VERSION = "0.3.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-status
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-30 00:00:00.000000000 Z
+date: 2020-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -78,7 +78,6 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -86,9 +85,9 @@ files:
 - bin/setup
 - cfn-status.gemspec
 - lib/cfn-status.rb
-- lib/cfn/aws_service.rb
-- lib/cfn/status.rb
-- lib/cfn/status/version.rb
+- lib/cfn_status.rb
+- lib/cfn_status/aws_service.rb
+- lib/cfn_status/version.rb
 homepage: https://github.com/tongueroo/cfn-status
 licenses:
 - MIT
@@ -108,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: CloudFormation status library

data/Gemfile.lock

@@ -1,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cfn-status (0.1.0)
-      aws-sdk-cloudformation
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    aws-eventstream (1.0.3)
-    aws-partitions (1.170.0)
-    aws-sdk-cloudformation (1.22.0)
-      aws-sdk-core (~> 3, >= 3.53.0)
-      aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.54.1)
-      aws-eventstream (~> 1.0, >= 1.0.2)
-      aws-partitions (~> 1.0)
-      aws-sigv4 (~> 1.1)
-      jmespath (~> 1.0)
-    aws-sigv4 (1.1.0)
-      aws-eventstream (~> 1.0, >= 1.0.2)
-    diff-lcs (1.3)
-    jmespath (1.4.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  cfn-status!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.0.1

data/lib/cfn/status.rb

@@ -1,219 +0,0 @@
-require "cfn/status/version"
-
-module Cfn
-  autoload :AwsService, "cfn/aws_service"
-
-  class Status
-    class Error < StandardError; end
-
-    include AwsService
-
-    attr_reader :events
-    def initialize(stack_name, options={})
-      @stack_name = stack_name
-      @options = options
-      reset
-    end
-
-    def run
-      unless stack_exists?(@stack_name)
-        puts "The stack #{@stack_name.color(:green)} does not exist."
-        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$/
-        puts "Stack events (tailing):"
-        # tail all events until done
-        @hide_time_took = true
-        wait
-      else
-        puts "Stack events:"
-        # show the last events that was user initiated
-        refresh_events
-        show_events(true)
-      end
-      success?
-    end
-
-    def reset
-      @events = [] # constantly replaced with recent events
-      @last_shown_event_id = nil
-      @stack_deletion_completed = nil
-    end
-
-    # check for /(_COMPLETE|_FAILED)$/ status
-    def wait
-      puts "Waiting for stack to complete"
-      start_time = Time.now
-
-      refresh_events
-      until completed || @stack_deletion_completed
-        show_events
-      end
-      show_events(true) # show the final event
-
-      if @stack_deletion_completed
-        puts "Stack #{@stack_name} deleted."
-        return
-      end
-
-      if last_event_status =~ /_FAILED/
-        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 rolled back: #{last_event_status}".color(:red)
-      else # success
-        puts "Stack success status: #{last_event_status}".color(:green)
-      end
-
-      # Never gets here when deleting a stack because the describe stack returns nothing
-      # once the stack is deleted. Gets here for stack create and update though.
-      return if @hide_time_took # set in run
-      took = Time.now - start_time
-      puts "Time took for stack deployment: #{pretty_time(took).color(:green)}."
-      success?
-    end
-
-    def completed
-      last_event_status =~ /(_COMPLETE|_FAILED)$/ &&
-      @events[0]["logical_resource_id"] == @stack_name &&
-      @events[0]["resource_type"] == "AWS::CloudFormation::Stack"
-    end
-
-    def last_event_status
-      @events[0]["resource_status"]
-    end
-
-    # Only shows new events
-    def show_events(final=false)
-      if @last_shown_event_id.nil?
-        i = find_index(:start, final)
-        print_events(i)
-      else
-        i = find_index(:last_shown, final)
-        # puts "last_shown index #{i}"
-        print_events(i-1) unless i == 0
-      end
-
-      return if final
-      sleep 5 unless ENV['TEST']
-      refresh_events
-    end
-
-    def print_events(i)
-      @events[0..i].reverse.each do |e|
-        print_event(e)
-      end
-      @last_shown_event_id = @events[0]["event_id"]
-      # puts "@last_shown_event_id #{@last_shown_event_id.inspect}"
-    end
-
-    def print_event(e)
-      message = [
-        event_time(e["timestamp"]),
-        e["resource_status"],
-        e["resource_type"],
-        e["logical_resource_id"],
-        e["resource_status_reason"]
-      ].join(" ")
-      message = message.color(:red) if e["resource_status"] =~ /_FAILED/
-      puts message
-    end
-
-    # https://stackoverflow.com/questions/18000432/rails-12-hour-am-pm-range-for-a-day
-    def event_time(timestamp)
-      Time.parse(timestamp.to_s).localtime.strftime("%I:%M:%S%p")
-    end
-
-    # refreshes the loaded events in memory
-    def refresh_events
-      resp = cfn.describe_stack_events(stack_name: @stack_name)
-      @events = resp["stack_events"]
-    rescue Aws::CloudFormation::Errors::ValidationError => e
-      if e.message =~ /Stack .* does not exis/
-        @stack_deletion_completed = true
-      else
-        raise
-      end
-    end
-
-    def find_index(name, final=false)
-      send("#{name}_index", final)
-    end
-
-    def start_index(final=false)
-      index = @events.find_index do |event|
-        event["resource_type"] == "AWS::CloudFormation::Stack" &&
-        event["resource_status_reason"] == "User Initiated"
-      end
-      # Instead of paginating until until we find the first "User Initiated" "AWS::CloudFormation::Stack" event
-      # we'll use the max.
-      index ? index : @events.size - 1
-    end
-
-    def last_shown_index(_)
-      @events.find_index do |event|
-        event["event_id"] == @last_shown_event_id
-      end
-    end
-
-    def success?
-      resource_status = @events[0]["resource_status"]
-      %w[CREATE_COMPLETE UPDATE_COMPLETE].include?(resource_status)
-    end
-
-    def update_rollback?
-      @events[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"
-      end
-
-      @events[0..i].reverse.find do |e|
-        e["resource_status"] == "UPDATE_FAILED"
-      end
-    end
-
-    def rollback_error_message
-      return unless update_rollback?
-
-      event = find_update_failed_event
-      return unless event
-
-      reason = event["resource_status_reason"]
-      messages_map.each do |pattern, message|
-        if reason =~ pattern
-          return message
-        end
-      end
-
-      reason # default message is original reason if not found in messages map
-    end
-
-    def messages_map
-      {
-        /CloudFormation cannot update a stack when a custom-named resource requires replacing/ => "A workaround is to run ufo again with STATIC_NAME=0 and to switch to dynamic names for resources. Then run ufo again with STATIC_NAME=1 to get back to statically name resources. Note, there are caveats with the workaround.",
-        /cannot be associated with more than one load balancer/ => "There's was an issue updating the stack. Target groups can only be associated with one load balancer at a time. The workaround for this is to use UFO_FORCE_TARGET_GROUP=1 and run the command again. This will force the recreation of the target group resource.",
-        /SetSubnets is not supported for load balancers of type/ => "Changing subnets for Network Load Balancers is currently not supported. You can try workarouding this with UFO_FORCE_ELB=1 and run the command again. This will force the recreation of the elb resource."
-      }
-    end
-
-    # http://stackoverflow.com/questions/4175733/convert-duration-to-hoursminutesseconds-or-similar-in-rails-3-or-ruby
-    def pretty_time(total_seconds)
-      minutes = (total_seconds / 60) % 60
-      seconds = total_seconds % 60
-      if total_seconds < 60
-        "#{seconds.to_i}s"
-      else
-        "#{minutes.to_i}m #{seconds.to_i}s"
-      end
-    end
-  end
-end

data/lib/cfn/status/version.rb

@@ -1,5 +0,0 @@
-module Cfn
-  class Status
-    VERSION = "0.2.0"
-  end
-end