jets 2.3.3 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 011aa7990e458d1e5fa86a9819b2972f7076468f88c84026b04b56aff0d710d0
-  data.tar.gz: ccf4510c62e2d667bc3b17fc32b82db90ea68828529e7cb9238f4b3458d62753
+  metadata.gz: 31fd9a4da8f7d6f64364970bf06d6e82aeb8318b44a534460e52f7c6e5d971de
+  data.tar.gz: f4545b2deedc9e4bd6a2d2c4159517d07073beee1280d16e9e2b7763e1aaefee
 SHA512:
-  metadata.gz: ced86785418e3337fc85c0c5e0c300ccdd3200ee5eeb1c405eeba598aa0e1bc9beca95495cb3a8838a04ac1770a101fd4db6c7b424c9f7d7394c7cb75ad48069
-  data.tar.gz: 793c70ef4dc623f8b6fa218a1263ad8522752999f54f8fecc279975fccf3e8ca1ef00ac2366f5e1eef01930e09c71c361fab8239f3909eb304d4b0560ea03f4b
+  metadata.gz: a74e9ba9b81b69396852b7e26cb3cc247009ae8193d4bca5a211675b1147f8288ad324ff0d88f5a0abafcd908a8835284eb2e03fa56b425f18d0406408144930
+  data.tar.gz: 646965fe7717524614b1741e8e190f749e61ec53359d67f817bcaaa86942eb1cc6436e1dc74bac09a49847054fdb2c4ccfd123b5dde4928b955a3ec635c51dc9

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/cfn-status"]
+	path = vendor/cfn-status
+	url = https://github.com/tongueroo/cfn-status.git

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
 
+## [2.3.4]
+- #395 Stay under Outputs Limits for large Jets apps. remove unused outputs
+- use vendor/cfn-status: poll CloudFormation stack events for large stacks
+
 ## [2.3.3]
 - fix sqs_queue
 

data/lib/jets.rb

@@ -13,6 +13,11 @@ require "jets/gems"
 require "memoist"
 require "rainbow/ext/string"
 
+gem_root = File.dirname(__dir__)
+$:.unshift("#{gem_root}/lib")
+$:.unshift("#{gem_root}/vendor/cfn-status/lib")
+require "cfn_status"
+
 require "jets/autoloaders"
 Jets::Autoloaders.log! if ENV["JETS_AUTOLOAD_LOG"]
 Jets::Autoloaders.once.setup

data/lib/jets/cfn/status.rb

@@ -1,212 +1,10 @@
-module Jets::Cfn
-  class Status
-    include Jets::AwsServices
+require 'cfn_status'
 
-    attr_reader :events
+module Jets::Cfn
+  class Status < CfnStatus
     def initialize(options={})
-      @options = options
       @stack_name = Jets::Naming.parent_stack_name
-      reset
-    end
-
-    # used for the jets status command
-    def run
-      unless stack_exists?(@stack_name)
-        puts "The stack #{@stack_name.color(:green)} does not exist."
-        return
-      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
-    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
-      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
-
-      success = false
-      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)
-        success = true
-      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)
-        print_events(i)
-      else
-        i = find_index(:last_shown)
-        # puts "last_shown index #{i}"
-        print_events(i-1) unless i == 0
-      end
-
-      return if final
-      sleep 5 unless Jets.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)
-      send("#{name}_index")
-    end
-
-    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
+      super(@stack_name, options)
     end
   end
 end

data/lib/jets/resource/child_stack/api_gateway.rb

@@ -16,12 +16,6 @@ module Jets::Resource::ChildStack
       }
     end
 
-    def outputs
-      {
-        logical_id => "!Ref #{logical_id}",
-      }
-    end
-
     def template_filename
       "#{Jets.config.project_namespace}-api-gateway.yml"
     end

data/lib/jets/resource/child_stack/api_resource.rb

@@ -47,12 +47,6 @@ module Jets::Resource::ChildStack
       Page.logical_id(parameter)
     end
 
-    def outputs
-      {
-        logical_id => "!Ref #{logical_id}",
-      }
-    end
-
     def template_filename
       "#{Jets.config.project_namespace}-api-resources-#{@page}.yml"
     end

data/lib/jets/resource/child_stack/app_class.rb

@@ -102,10 +102,22 @@ module Jets::Resource::ChildStack
       "#{authorizer_stack}.Outputs.#{authorizer_logical_id}"
     end
 
+    def outputs
+      if controller? or job?
+        {}
+      else
+        super # { logical_id => "!Ref #{logical_id}" } in base.rb
+      end
+    end
+
     def controller?
       @path.include?('_controller.yml')
     end
 
+    def job?
+      @path.include?('_job.yml')
+    end
+
     def scoped_routes
       @routes ||= Jets::Router.routes.select do |route|
         route.controller_name == current_app_class.to_s

data/lib/jets/resource/child_stack/authorizer.rb

@@ -26,12 +26,6 @@ module Jets::Resource::ChildStack
       params
     end
 
-    def outputs
-      {
-        logical_id => "!Ref #{logical_id}",
-      }
-    end
-
     # map the path to a camelized logical_id. IE: ProtectAuthorizer
     def authorizer_logical_id
       regexp = Regexp.new(".*#{Jets.config.project_namespace}-authorizers-")

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "2.3.3"
+  VERSION = "2.3.4"
 end

data/vendor/cfn-status/CHANGELOG.md

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

data/vendor/cfn-status/Gemfile

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

data/vendor/cfn-status/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/vendor/cfn-status/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 = CfnStatus.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/vendor/cfn-status/Rakefile

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

data/vendor/cfn-status/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__)