cfn-flow 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d70dd0718f3ff8dd77315c1478efa29bde5b9411
-  data.tar.gz: a15a7d6ee25f1d91908d7d437cde77443f8e1a24
+  metadata.gz: a758c3ab1d93215d5c19a055eee983c2f5776b2c
+  data.tar.gz: 1b83fda8361c92793ef426042e6aafb13c3e6ebf
 SHA512:
-  metadata.gz: 50a5acc781978e22d1a8513d90b14609331de3951b93d51988c7e92c777842d7e7288e1f9dfe830fd9b84f6fad31d7bdaca36a64d5c51784eba2f39d1d78935d
-  data.tar.gz: b412de302fb2bab1ee786f9910354e656f4b60796a172e54705012502cf581847770244672afeec8d0ef13cdfebde09ae7808a455f4ea928bf9a52af557a4d24
+  metadata.gz: 50dee4788230e13a9af86471b9c7ac3fcb1df86b136bc29d7462ddcbb76a85a218edb1514d4c590311ea204d43dbe8ee1f2002668236f46e59215346dd4707de
+  data.tar.gz: 7ac38fd70956fbbd4409d0abfbfc452ec5e565605812def986e956edce459c3ba513e9c8928054ba7a4a95f12601864273dbfd69366af759d447e524929db202

data/README.md

@@ -37,7 +37,7 @@ It provides a *simple*, *standard*, and *flexible* process for using CloudFormat
 
 ## Opinions
 
-`cfn-flow` introduces a consist, convenient workflow that encourages good template organization
+`cfn-flow` introduces a consistent, convenient workflow that encourages good template organization
 and deploy practices.
 
 1. *Optimize for happiness.* The workflow should be easy & enjoyable to use.

data/lib/cfn_flow/cli.rb

@@ -68,6 +68,8 @@ module CfnFlow
       say "Polling for events..."
       invoke :events, [stack.name], ['--poll']
 
+      say "Stack Outputs:"
+      invoke :show, [stack.name], ['--format=outputs-table']
 
       # Optionally cleanup other stacks in this environment
       if options[:cleanup]
@@ -81,6 +83,41 @@ module CfnFlow
       end
     end
 
+    desc 'update ENVIRONMENT STACK', 'Updates a stack (use sparingly for mutable infrastructure)'
+    def update(environment, name)
+      # Export environment as an env var so it can be interpolated in config
+      ENV['CFN_FLOW_ENVIRONMENT'] = environment
+
+      stack = find_stack_in_service(name)
+
+      # Check that environment matches
+      unless stack.tags.any?{|tag| tag.key == 'CfnFlowEnvironment' && tag.value == environment }
+        raise Thor::Error.new "Stack #{name} is not tagged for environment #{environment}"
+      end
+
+      begin
+        params = CfnFlow.stack_params(environment)
+        params.delete(:tags) # No allowed for Stack#update
+        stack.update(params)
+      rescue Aws::CloudFormation::Errors::ValidationError => e
+        raise Thor::Error.new(e.message)
+      end
+
+      say "Updating stack #{stack.name}"
+
+      # NB: there's a potential race condition where polling for events would
+      # see the last complete state before the stack has a chance to begin updating.
+      # Consider putting a sleep, wait_for an UPDATE_IN_PROGRESS state beforehand,
+      # or look for events newer than the last event before updating.
+
+      # Invoke events
+      say "Polling for events..."
+      invoke :events, [stack.name], ['--poll']
+
+      say "Stack Outputs:"
+      invoke :show, [stack.name], ['--format=outputs-table']
+    end
+
     desc 'list [ENVIRONMENT]', 'List running stacks in all environments, or ENVIRONMENT'
     method_option 'no-header', type: :boolean, desc: 'Do not print column headers'
     def list(environment=nil)
@@ -105,10 +142,27 @@ module CfnFlow
     end
 
     desc 'show STACK', 'Show details about STACK'
-    method_option :json, type: :boolean, desc: 'Show stack as JSON (default is YAML)'
+    method_option :format, type: :string, default: 'yaml', enum: %w(yaml json outputs-table), desc: "Format in which to display the stack."
     def show(name)
-      data = find_stack_in_service(name).data.to_hash
-      say options[:json] ? MultiJson.dump(data, pretty: true) : data.to_yaml
+      formatters = {
+        'json' =>          ->(stack) { say MultiJson.dump(stack.data.to_hash, pretty: true) },
+        'yaml' =>          ->(stack) { say stack.data.to_hash.to_yaml },
+        'outputs-table' => ->(stack) do
+          outputs = stack.outputs.to_a
+          if outputs.any?
+            table_header = [['KEY',  'VALUE', 'DESCRIPTION']]
+            table_data = outputs.map do |s|
+              [ s.output_key, s.output_value, s.description ]
+            end
+
+            print_table(table_header + table_data)
+          else
+            say "No stack outputs to show."
+          end
+        end
+      }
+      stack = find_stack_in_service(name)
+      formatters[options[:format]].call(stack)
     end
 
     desc 'events STACK', 'List events for  STACK'
@@ -123,10 +177,14 @@ module CfnFlow
       if options[:poll]
         # Display events until we're COMPLETE/FAILED
         delay = (ENV['CFN_FLOW_EVENT_POLL_INTERVAL'] || 2).to_i
-        stack.wait_until(max_attempts: -1, delay: delay) do |s|
-          EventPresenter.present(s.events) {|p| say p }
-          # Wait until the stack status ends with _FAILED or _COMPLETE
-          s.stack_status.match(/_(FAILED|COMPLETE)$/)
+        begin
+          stack.wait_until(max_attempts: -1, delay: delay) do |s|
+            EventPresenter.present(s.events) {|p| say p }
+            # Wait until the stack status ends with _FAILED or _COMPLETE
+            s.stack_status.match(/_(FAILED|COMPLETE)$/)
+          end
+        rescue Aws::CloudFormation::Errors::ValidationError
+          # The stack was deleted. Keep on trucking.
         end
       end
     end
@@ -138,6 +196,9 @@ module CfnFlow
       if options[:force] || yes?("Are you sure you want to shut down #{name}?", :red)
         stack.delete
         say "Deleted stack #{name}"
+
+        say "Polling for events..."
+        invoke :events, [stack.name], ['--poll']
       end
     end
 

data/lib/cfn_flow/stack_params.rb

@@ -12,8 +12,7 @@ module CfnFlow
     end
 
     def with_symbolized_keys
-      self.inject(StackParams.new) do |accum, pair|
-        key, value = pair
+      self.reduce(StackParams.new) do |accum, (key, value)|
         accum.merge(key.to_sym => value)
       end
     end

data/lib/cfn_flow/version.rb

@@ -1,3 +1,3 @@
 module CfnFlow
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/spec/cfn_flow/cli_spec.rb

@@ -150,9 +150,10 @@ describe 'CfnFlow::CLI' do
     it 'can cleanup' do
 
       # Stubbing hacks alert!
-      # The first time we call :describe_stacks, return the stack we launch.
-      # The second time, we're loading 'another-stack' to clean it up
+      # The first two times we call :describe_stacks, return the stack we launch.
+      # The third time, we're loading 'another-stack' to clean it up
       stack_stubs = [
+        { stacks: [ stub_stack_data(stack_name: 'cfn-flow-spec-stack') ] },
         { stacks: [ stub_stack_data(stack_name: 'cfn-flow-spec-stack') ] },
         { stacks: [ stub_stack_data(stack_name: 'another-stack') ] }
       ]
@@ -173,6 +174,57 @@ describe 'CfnFlow::CLI' do
 
   end
 
+  describe '#update' do
+    it 'fails with no args' do
+      out, err = capture_io { cli.start [:update] }
+      out.must_equal ''
+      err.must_match(/ERROR.+no arguments/)
+    end
+
+    it 'returns an error when stack is not in service' do
+      stack_data = stub_stack_data
+      stack_data[:tags][0][:value] = 'none-such-service'
+      Aws.config[:cloudformation]= {
+        stub_responses: {
+          describe_stacks: { stacks: [ stack_data ] }
+        }
+      }
+      out, err = capture_io { cli.start [:update, 'production', 'none-such-stack'] }
+      out.must_equal ''
+      err.must_match "not tagged for service #{CfnFlow.service}"
+    end
+
+    it 'returns an error when stack environment does not match' do
+      stack_data = stub_stack_data
+      Aws.config[:cloudformation]= {
+        stub_responses: {
+          describe_stacks: { stacks: [ stack_data ] }
+        }
+      }
+      out, err = capture_io { cli.start [:update, 'none-such-env', 'mystack'] }
+      out.must_equal ''
+      err.must_match "not tagged for environment none-such-env"
+    end
+
+    it 'succeeds' do
+      stack_name = CfnFlow.config['stack']['stack_name']
+
+      Aws.config[:cloudformation]= {
+        stub_responses: {
+          describe_stacks: { stacks: [ stub_stack_data(stack_name: stack_name, stack_status: 'UPDATE_COMPLETE') ] },
+          describe_stack_events: { stack_events: [ stub_event_data(resource_status: 'UPDATE_COMPLETE') ] },
+        }
+      }
+      out, err = capture_io { cli.start [:update, 'production', stack_name] }
+
+      out.must_match "Updating stack #{stack_name}"
+      out.must_match "Polling for events..."
+      out.must_match "UPDATE_COMPLETE"
+      out.must_match "Stack Outputs:"
+      err.must_equal ''
+    end
+  end
+
   describe '#list' do
     it 'has no output with no stacks' do
       out, err = capture_io { cli.start [:list] }
@@ -257,11 +309,30 @@ describe 'CfnFlow::CLI' do
         err.must_equal ''
       end
 
-      it 'handles --json option' do
-        out, _ = capture_io { cli.start [:show, 'mystack', '--json'] }
+      it 'handles json format' do
+        out, _ = capture_io { cli.start [:show, 'mystack', '--format=json'] }
         expected = MultiJson.dump(CfnFlow.cfn_resource.stack('mystack').data.to_hash, pretty: true) + "\n"
         out.must_equal expected
       end
+
+      describe 'outputs-table format' do
+        it 'handles shows a table when there are events' do
+          out, _ = capture_io { cli.start [:show, 'mystack', '--format=outputs-table'] }
+          out.must_match(/KEY\s+VALUE\s+DESCRIPTION/)
+          out.must_match(/mykey\s+myvalue\s+My Output/)
+        end
+
+        it 'handles no events' do
+          Aws.config[:cloudformation]= {
+            stub_responses: {
+            describe_stacks: { stacks: [ stub_stack_data(outputs: nil) ] }
+            }
+          }
+          out, _ = capture_io { cli.start [:show, 'mystack', '--format=outputs-table'] }
+          out.must_match "No stack outputs to show."
+
+        end
+      end
     end
 
     it 'returns an error with missing stacks' do
@@ -351,14 +422,18 @@ describe 'CfnFlow::CLI' do
     describe 'with a stack' do
       before do
         Aws.config[:cloudformation] = {
-          stub_responses: { describe_stacks: { stacks: [ stub_stack_data ] } }
+          stub_responses: {
+            describe_stacks: { stacks: [ stub_stack_data ] },
+            describe_stack_events: { stack_events: [ stub_event_data ] }
+          }
         }
       end
 
       it 'deletes the stack' do
         Thor::LineEditor.stub :readline, "yes" do
           out, err = capture_io { cli.start [:delete, 'mystack'] }
-          out.must_equal "Deleted stack mystack\n"
+          out.must_match "Deleted stack mystack"
+          out.must_match "Polling for events..."
           err.must_equal ''
         end
       end
@@ -373,7 +448,7 @@ describe 'CfnFlow::CLI' do
 
       it 'does not ask when --force is set' do
           out, err = capture_io { cli.start [:delete, '--force', 'mystack'] }
-          out.must_equal "Deleted stack mystack\n"
+          out.must_match "Deleted stack mystack"
           err.must_equal ''
       end
     end

data/spec/helper.rb

@@ -50,7 +50,8 @@ class Minitest::Spec
       tags: [
         {key: 'CfnFlowService', value: CfnFlow.service},
         {key: 'CfnFlowEnvironment', value: 'production'}
-      ]
+      ],
+      outputs: [ output_key: 'mykey', output_value: 'myvalue', description: 'My Output' ]
     }.merge(attrs)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-flow
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Aaron Suggs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk