stackup 0.8.4 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e91040410c92ac50cf90f111e189e4a3d945be8
-  data.tar.gz: bcd8623414938cf9e81a33b5a0f7023fc6ec7a55
+  metadata.gz: a8edc4a00c69a1f93ac2549985d3268aecc40c0c
+  data.tar.gz: 8d5c670e3c2b3fba4718df0368b363dd129ddf40
 SHA512:
-  metadata.gz: 826361e54138687d38e1b8aa90be70a4c1b5f816f73000528c30b92f405b7d054b929d1e6372ae4c37d3cb943da34d9d9e157d74a0ecde7e52b8211dcedb131a
-  data.tar.gz: 3971d9954a435d33ae91b19210f42068655f4383eaaeb2b44771c1ed360bc8f91f1c04e6bce5d06399f03b92466240f29913b1c191870e711de22f49710fa4c2
+  metadata.gz: dbf64ed470760758b6c6976724502d877f40f37a60537d80a82e708c480ffc9768b958c0532997d4f97b5893c7a3a4d3698276106c85d6e5bdecf8210fb1e21a
+  data.tar.gz: 120becc33de075bfadc14a5062375d83bdd2138b026eb4926e37256a6a5812b9ee04016069771f96ad785e0963d5052c732922510feb4b4c279a7067910985f6

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 0.9.2 (2016-08-04)
+
+* Make poll_interval (during deployment) configurable.
+* Add `--wait-poll-interval` option.
+* Minimise calls to "DescribeStackEvents" (esp. for older stacks).
+* Add `--no-wait` option.
+
 ## 0.8.4 (2016-07-08)
 
 * Ensure stack tag values are strings.

data/bin/stackup

@@ -37,6 +37,12 @@ Clamp do
     end
   end
 
+  option ["--[no-]wait"], :flag, "wait for stack updates to complete",
+    :default => true
+
+  option ["--wait-poll-interval"], "N", "polling interval while waiting for updates",
+    :default => 5, &method(:Integer)
+
   option "--debug", :flag, "enable debugging"
 
   option ["--version"], :flag, "display version" do
@@ -79,7 +85,7 @@ Clamp do
   end
 
   def stack
-    stackup.stack(stack_name)
+    stackup.stack(stack_name, :wait => wait?, :wait_poll_interval => wait_poll_interval)
   end
 
   def list_stacks

data/lib/stackup/stack.rb

@@ -11,16 +11,27 @@ module Stackup
   #
   class Stack
 
+    DEFAULT_WAIT_POLL_INTERVAL = 5 # seconds
+
     def initialize(name, client = {}, options = {})
       client = Aws::CloudFormation::Client.new(client) if client.is_a?(Hash)
       @name = name
       @cf_client = client
+      @wait = true
       options.each do |key, value|
         public_send("#{key}=", value)
       end
+      @wait_poll_interval ||= DEFAULT_WAIT_POLL_INTERVAL
     end
 
     attr_reader :name
+    attr_accessor :wait_poll_interval
+
+    attr_writer :wait
+
+    def wait?
+      @wait
+    end
 
     # Register a handler for reporting of stack events.
     # @param [Proc] event_handler
@@ -141,11 +152,9 @@ module Stackup
       rescue NoSuchStack
         return nil
       end
-      status = modify_stack do
+      modify_stack("DELETE_COMPLETE", "stack delete failed") do
         cf_stack.delete
       end
-      fail StackUpdateError, "stack delete failed" unless status == "DELETE_COMPLETE"
-      status
     ensure
       @stack_id = nil
     end
@@ -158,11 +167,9 @@ module Stackup
     # @raise [Stackup::StackUpdateError] if operation fails
     #
     def cancel_update
-      status = modify_stack do
+      modify_stack(/_COMPLETE$/, "update cancel failed") do
         cf_stack.cancel_update
       end
-      fail StackUpdateError, "update cancel failed" unless status =~ /_COMPLETE$/
-      status
     rescue InvalidStateError
       nil
     end
@@ -172,7 +179,7 @@ module Stackup
     # @return [String] status, once stable
     #
     def wait
-      modify_stack do
+      modify_stack(/./, "failed to stabilize") do
         # nothing
       end
     end
@@ -249,22 +256,18 @@ module Stackup
       options[:stack_name] = name
       options.delete(:stack_policy_during_update_body)
       options.delete(:stack_policy_during_update_url)
-      status = modify_stack do
+      modify_stack("CREATE_COMPLETE", "stack creation failed") do
         cf.create_stack(options)
       end
-      fail StackUpdateError, "stack creation failed" unless status == "CREATE_COMPLETE"
-      status
     end
 
     def update(options)
       options.delete(:disable_rollback)
       options.delete(:on_failure)
       options.delete(:timeout_in_minutes)
-      status = modify_stack do
+      modify_stack("UPDATE_COMPLETE", "stack update failed") do
         cf_stack.update(options)
       end
-      fail StackUpdateError, "stack update failed" unless status == "UPDATE_COMPLETE"
-      status
     rescue NoUpdateRequired
       logger.info "No update required"
       nil
@@ -283,11 +286,25 @@ module Stackup
       end
     end
 
+    # Execute a block, to modify the stack.
+    #
+    # @return the stack status
+    #
+    def modify_stack(target_status, failure_message, &block)
+      if wait?
+        status = modify_stack_synchronously(&block)
+        fail StackUpdateError, failure_message unless target_status === status
+        status
+      else
+        modify_stack_asynchronously(&block)
+      end
+    end
+
     # Execute a block, reporting stack events, until the stack is stable.
     #
     # @return the final stack status
     #
-    def modify_stack
+    def modify_stack_synchronously
       watch do |watcher|
         handling_validation_error do
           yield
@@ -297,11 +314,22 @@ module Stackup
           status = self.status
           logger.debug("stack_status=#{status}")
           return status if status.nil? || status =~ /_(COMPLETE|FAILED)$/
-          sleep(5)
+          sleep(wait_poll_interval)
         end
       end
     end
 
+    # Execute a block to instigate stack modification, but don't wait.
+    #
+    # @return the stack status
+    #
+    def modify_stack_asynchronously
+      handling_validation_error do
+        yield
+      end
+      self.status
+    end
+
     def normalize_tags(tags)
       if tags.is_a?(Hash)
         tags.map do |key, value|

data/lib/stackup/stack_watcher.rb

@@ -10,7 +10,6 @@ module Stackup
 
     def initialize(stack)
       @stack = stack
-      @processed_event_ids = Set.new
     end
 
     attr_accessor :stack
@@ -19,14 +18,14 @@ module Stackup
     #
     def each_new_event
       # rubocop:disable Lint/HandleExceptions
-      buffer = []
+      new_events = []
       stack.events.each do |event|
-        break if @processed_event_ids.include?(event.event_id)
-        buffer.unshift(event)
+        break if event.id == @last_processed_event_id
+        new_events.unshift(event)
       end
-      buffer.each do |event|
-        yield event if block_given?
-        @processed_event_ids.add(event.event_id)
+      new_events.each do |event|
+        yield event
+        @last_processed_event_id = event.id
       end
     rescue Aws::CloudFormation::Errors::ValidationError
     end
@@ -34,8 +33,11 @@ module Stackup
     # Consume all new events
     #
     def zero
-      each_new_event
+      # rubocop:disable Lint/HandleExceptions
+      last_event = stack.events.first
+      @last_processed_event_id = last_event.id unless last_event.nil?
       nil
+    rescue Aws::CloudFormation::Errors::ValidationError
     end
 
     private

data/lib/stackup/version.rb

@@ -1,5 +1,5 @@
 module Stackup
 
-  VERSION = "0.8.4"
+  VERSION = "0.9.2"
 
 end

data/spec/stackup/stack_spec.rb

@@ -8,8 +8,9 @@ describe Stackup::Stack do
 
   let(:stack_name) { "stack_name" }
   let(:unique_stack_id) { "ID:#{stack_name}" }
+  let(:stack_options) { {} }
 
-  subject(:stack) { described_class.new(stack_name, cf_client) }
+  subject(:stack) { described_class.new(stack_name, cf_client, stack_options) }
 
   before do
     cf_client.stub_responses(:describe_stacks, *describe_stacks_responses)
@@ -93,7 +94,28 @@ describe Stackup::Stack do
 
       let(:final_status) { "CREATE_COMPLETE" }
 
-      context "successful" do
+      it "calls :create_stack" do
+        expected_args = {
+          :stack_name => stack_name,
+          :template_body => template
+        }
+        create_or_update
+        expect(cf_client).to have_received(:create_stack)
+          .with(hash_including(expected_args))
+      end
+
+      it "it sleeps" do
+        create_or_update
+        expect(stack).to have_received(:sleep).with(5)
+      end
+
+      it "returns status" do
+        expect(create_or_update).to eq("CREATE_COMPLETE")
+      end
+
+      context "with :wait = false" do
+
+        let(:stack_options) { { :wait => false } }
 
         it "calls :create_stack" do
           expected_args = {
@@ -105,8 +127,13 @@ describe Stackup::Stack do
             .with(hash_including(expected_args))
         end
 
-        it "returns status" do
-          expect(create_or_update).to eq("CREATE_COMPLETE")
+        it "it does not sleep" do
+          create_or_update
+          expect(stack).not_to have_received(:sleep)
+        end
+
+        it "returns initial status" do
+          expect(create_or_update).to eq("CREATE_IN_PROGRESS")
         end
 
       end
@@ -122,6 +149,19 @@ describe Stackup::Stack do
 
       end
 
+      context "with a custom wait_poll_interval" do
+
+        let(:stack_options) do
+          { :wait_poll_interval => 12.3 }
+        end
+
+        it "it sleeps for the specified interval" do
+          create_or_update
+          expect(stack).to have_received(:sleep).with(12.3)
+        end
+
+      end
+
       context "with :template as data" do
 
         let(:options) do

data/spec/stackup/stack_watcher_spec.rb

@@ -1,6 +1,7 @@
 require "spec_helper"
 
 require "aws-sdk-resources"
+require "securerandom"
 require "stackup/stack_watcher"
 
 describe Stackup::StackWatcher do
@@ -11,13 +12,14 @@ describe Stackup::StackWatcher do
   subject(:monitor) { described_class.new(stack) }
 
   def add_event(description)
-    @event_id ||= 0
+    event_id = SecureRandom.uuid
     event = instance_double(
       Aws::CloudFormation::Event,
-      :event_id => @event_id, :resource_status_reason => description
+      :event_id => event_id,
+      :id => event_id,
+      :resource_status_reason => description
     )
     events.unshift(event)
-    @event_id += 1
   end
 
   def new_event_reasons

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stackup
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.2
 platform: ruby
 authors:
 - Mike Williams
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-08 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-resources
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Manage CloudFormation stacks