cfn-status 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9955f7649ab904d7ecc3625a47db9d22badcf19cb1eec2d66a58781bfb8a3d1a
+  data.tar.gz: de4d99a18f7f1b0591647192b6c1832209c9eee7272f5fd855b189de7bc05a6a
+SHA512:
+  metadata.gz: bcf0f0b4a676cdd04869c17a4023ab7025e26dd11b3784f5189e7a63ef16d65a87c6ded748002b1955efc9905d7d95153f9a9085b0972f1d4c51adc76a6c4014
+  data.tar.gz: 2cb014ef87a89ac99a63baedba39b62c5ac4f3d711a3488b3070d0a740c4aa90fbd1e84176581f0463c348ee380f98074ffa7bf68154c768bf6bb05b88888da3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 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.
+
+## [0.1.0]
+- Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cfn-status.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tung Nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Cfn Status
+
+Helper library provides status of CloudFormation stack.
+
+## Usage
+
+Add this line to your gem's gemspec:
+
+```ruby
+  gem.add_development_dependency "cfn-status"
+```
+
+Require it to your library:
+
+```ruby
+require "cfn/status"
+```
+
+Use like so:
+
+```ruby
+status = Cfn::Status.new(stack_name)
+status.run # prints out stack events
+```
+
+The `status.run` will:
+
+* print out the most recent stack events and return right away if the stack is in a completed state.
+* print out the most recent stack events and poll for more events until the stack in a completed state.
+
+To find out whether the most recent completed state of the stack was a success or a fail, you can use `status.success?`.
+
+```ruby
+status.success?
+```
+
+If you need to just wait for the stack to complete, you can also use `status.wait`.
+
+```ruby
+status.wait
+status.success?
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cfn-status.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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

data/cfn-status.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cfn/status/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cfn-status"
+  spec.version       = Cfn::Status::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+
+  spec.summary       = "CloudFormation status library"
+  spec.homepage      = "https://github.com/tongueroo/cfn-status"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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"
+end

data/lib/cfn/aws_service.rb

@@ -0,0 +1,51 @@
+require "aws-sdk-cloudformation"
+
+module Cfn
+  module AwsService
+    def cfn
+      @cfn ||= Aws::CloudFormation::Client.new
+    end
+
+    def stack_exists?(stack_name)
+      return true if ENV['TEST']
+      return false if @options[:noop]
+
+      exist = nil
+      begin
+        # When the stack does not exist an exception is raised. Example:
+        # Aws::CloudFormation::Errors::ValidationError: Stack with id blah does not exist
+        cfn.describe_stacks(stack_name: stack_name)
+        exist = true
+      rescue Aws::CloudFormation::Errors::ValidationError => e
+        if e.message =~ /does not exist/
+          exist = false
+        elsif e.message.include?("'stackName' failed to satisfy constraint")
+          # Example of e.message when describe_stack with invalid stack name
+          # "1 validation error detected: Value 'instance_and_route53' at 'stackName' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/._+]*"
+          puts "Invalid stack name: #{stack_name}"
+          puts "Full error message: #{e.message}"
+          exit 1
+        else
+          raise # re-raise exception  because unsure what other errors can happen
+        end
+      end
+      exist
+    end
+
+    def find_stack(stack_name)
+      resp = cfn.describe_stacks(stack_name: stack_name)
+      resp.stacks.first
+    rescue Aws::CloudFormation::Errors::ValidationError => e
+      # example: Stack with id demo-web does not exist
+      if e.message =~ /Stack with/ && e.message =~ /does not exist/
+        nil
+      else
+        raise
+      end
+    end
+
+    def rollback_complete?(stack)
+      stack.stack_status == 'ROLLBACK_COMPLETE'
+    end
+  end
+end

data/lib/cfn/status.rb

@@ -0,0 +1,219 @@
+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

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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: cfn-status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudformation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: 
+email:
+- tongueroo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cfn-status.gemspec
+- lib/cfn/aws_service.rb
+- lib/cfn/status.rb
+- lib/cfn/status/version.rb
+homepage: https://github.com/tongueroo/cfn-status
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: CloudFormation status library
+test_files: []