cuffsert 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e2a534e878fbb69920af515d5829138351c4937
-  data.tar.gz: 9697ef60c78c97f5823f089d8efd67f95723a411
+  metadata.gz: 77fc923eb6792bb5c118dbaaafaf161737395a4d
+  data.tar.gz: 444d658ff0249ef336e9871cfe60b481eb2cfbf7
 SHA512:
-  metadata.gz: 37643076b4d503a37ac1d12f997c27230a90904386157fcad1b4a668b126b886091f775e4244c9442d62f027e0b40fac9b7cc94e6c5b60c219563cc46da6690d
-  data.tar.gz: 46a6d4ba65176322eb3da8c3abb4fe5641ba0157d7885670410849b324880b5090b4c457251d6fed61feb2230e75a1e2e0126d2c49685b22ed28fc327ad702cc
+  metadata.gz: 06338fc5162660886d719014786818d31cdd576560607bd5f5ef09b867aab98d73512b34d8e8993a7b703d22f6b11b0b12a0fd64bd8f8fbeb522a36e09360d28
+  data.tar.gz: ad4322d3b92ac52271bb6dec5d535e3dc935c4021990b93ced699d34b08548043d5f59c0630650fc90e997b9bcb4e698bee55853b46957b00f08f782caa31ae4

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    cuffsert (0.12.0)
+    cuffsert (0.13.0)
       aws-sdk-cloudformation (~> 1.3.0)
       aws-sdk-s3 (~> 1.8.0)
       colorize
+      hashdiff
       ruby-termios
       rx
 
@@ -33,7 +34,8 @@ GEM
     colorize (0.8.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    jmespath (1.4.0)
+    hashdiff (0.3.7)
+    jmespath (1.3.1)
     json (2.0.2)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)

data/cuffsert.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'aws-sdk-cloudformation', '~> 1.3.0'
   spec.add_runtime_dependency 'aws-sdk-s3', '~> 1.8.0'
   spec.add_runtime_dependency 'colorize'
+  spec.add_runtime_dependency 'hashdiff'
   spec.add_runtime_dependency 'ruby-termios'
   spec.add_runtime_dependency 'rx'
 

data/lib/cuffdown/main.rb

@@ -10,7 +10,7 @@ module CuffDown
     parser = OptionParser.new do |opts|
       opts.banner = 'Output CuffSert-formatted metadata from an existing stack.'
       opts.separator('')
-      opts.separator('Usage: cuffdown stack-name')
+      opts.separator('Usage: cuffdown <stack-name>')
       CuffBase.shared_cli_args(opts, args)
     end
     stackname, _ = parser.parse(argv)

data/lib/cuffsert/actions.rb

@@ -1,6 +1,7 @@
 require 'cuffsert/actions'
 require 'cuffsert/cfarguments'
 require 'cuffsert/messages'
+require 'yaml'
 require 'rx'
 
 module CuffSert
@@ -34,6 +35,20 @@ module CuffSert
     end
   end
 
+  class MessageAction < BaseAction
+    def initialize(message)
+      super(nil, nil)
+      @message = message
+    end
+
+    def validate!
+    end
+
+    def as_observable
+      @message.as_observable
+    end
+  end
+
   class CreateStackAction < BaseAction
     def validate!
       if @meta.stack_uri.nil?
@@ -75,12 +90,31 @@ module CuffSert
       upload_uri, maybe_upload = upload_template_if_oversized(cfargs)
       cfargs[:template_url] = upload_uri if upload_uri
       maybe_upload
-        .concat(@cfclient.prepare_update(cfargs).map {|change_set| CuffSert::ChangeSet.new(change_set) })
+        .concat(prepare_update(cfargs))
         .flat_map(&method(:on_event))
     end
 
     private
 
+    def prepare_update(cfargs)
+      @cfclient.get_template(@meta)
+      .map do |current_template|
+        pending_template = if cfargs[:template_body]
+          YAML.load(cfargs[:template_body])
+        elsif @meta.stack_uri && @meta.stack_uri.scheme == 'file'
+          CuffSert.load_template(@meta.stack_uri)
+        else
+          current_template
+        end
+        CuffSert::Templates.new([current_template, pending_template])
+      end.merge(
+        @cfclient.prepare_update(cfargs)
+        .map do |change_set|
+          CuffSert::ChangeSet.new(change_set)
+        end
+      )
+    end
+
     def on_event(event)
       Rx::Observable.concat(
         Rx::Observable.just(event),

data/lib/cuffsert/cfarguments.rb

@@ -1,5 +1,6 @@
 require 'open-uri'
 require 'yaml'
+require 'cuffsert/yaml-ext'
 
 # TODO:
 # - propagate timeout here (from config?)
@@ -83,13 +84,13 @@ module CuffSert
     "https://#{host}/#{bucket}#{key}"
   end
 
-  private_class_method
-
-  def self.load_minified_template(file)
-    template = open(file).read
-    YAML.load(template).to_json
+  def self.load_template(stack_uri)
+    file = stack_uri.to_s.sub(/^file:\/+/, '/')
+    YAML.load(open(file).read)
   end
 
+  private_class_method
+
   def self.template_parameters(meta)
     template_parameters = {}
 
@@ -102,8 +103,7 @@ module CuffSert
         raise 'Only HTTPS URLs pointing to amazonaws.com supported.'
       end
     elsif meta.stack_uri.scheme == 'file'
-      file = meta.stack_uri.to_s.sub(/^file:\/+/, '/')
-      template = self.load_minified_template(file)
+      template = CuffSert.load_template(meta.stack_uri).to_json
       if template.size <= 51200
         template_parameters[:template_body] = template
       end

data/lib/cuffsert/cfstates.rb

@@ -12,13 +12,13 @@ module CuffSert
     CREATE_COMPLETE
     ROLLBACK_COMPLETE
     UPDATE_COMPLETE
-    UPDATE_ROLLBACK_COMPLETE
     DELETE_COMPLETE
     DELETE_SKIPPED
   ]
 
   BAD_STATES = %w[
     CREATE_FAILED
+    UPDATE_ROLLBACK_COMPLETE
     UPDATE_ROLLBACK_FAILED
     UPDATE_FAILED
     DELETE_FAILED

data/lib/cuffsert/errors.rb

@@ -0,0 +1,4 @@
+module CuffSert
+  class CuffSertError < RuntimeError ; end
+  class RxCFError < CuffSertError ; end
+end

data/lib/cuffsert/main.rb

@@ -15,7 +15,8 @@ module CuffSert
     found = cfclient.find_stack_blocking(meta)
 
     if found && INPROGRESS_STATES.include?(found[:stack_status])
-      action = Abort.new('Stack operation already in progress')
+      message = Abort.new('Stack operation already in progress')
+      action = MessageAction.new(message)
     else
       if found.nil?
         action = CreateStackAction.new(meta, nil)

data/lib/cuffsert/messages.rb

@@ -23,5 +23,6 @@ module CuffSert
       super('Done.')
     end
   end
+  class Templates < Message ; end
   class ChangeSet < Message ; end
 end

data/lib/cuffsert/presenters.rb

@@ -1,7 +1,9 @@
 require 'aws-sdk-cloudformation'
 require 'colorize'
 require 'cuffsert/cfstates'
+require 'cuffsert/errors'
 require 'cuffsert/messages'
+require 'hashdiff'
 require 'rx'
 
 # TODO: Animate in-progress states
@@ -55,6 +57,8 @@ module CuffSert
 
     def on_event(event)
       case event
+      when ::CuffSert::Templates
+        @renderer.templates(*event.message)
       when Aws::CloudFormation::Types::StackEvent
         on_stack_event(event)
       when ::CuffSert::ChangeSet
@@ -73,6 +77,16 @@ module CuffSert
       end
     end
 
+    def on_error(err)
+      case err
+      when CuffSertError
+        @renderer.abort(err)
+      else
+        super(err)
+      end
+      exit(1)
+    end
+
     def on_complete
     end
 
@@ -134,6 +148,7 @@ module CuffSert
       @verbosity = options[:verbosity] || 1
     end
 
+    def templates(current, pending) ; end
     def change_set(change_set) ; end
     def event(event, resource) ; end
     def clear ; end
@@ -144,6 +159,13 @@ module CuffSert
   end
 
   class JsonRenderer < BaseRenderer
+    def templates(current, pending)
+      if @verbosity >= 1
+        @output.write(current.to_json)
+        @output.write(pending.to_json)
+      end
+    end
+
     def change_set(change_set)
       @output.write(change_set.to_h.to_json) unless @verbosity < 1
     end
@@ -182,11 +204,12 @@ module CuffSert
         ]
       end.map do |change|
         rc = change[:resource_change]
-        sprintf("%s[%s] %-10s %s\n",
+        sprintf("%s[%s] %-10s %s\n%s",
           rc[:logical_resource_id],
           rc[:resource_type],
           action_color(action(rc)),
-          scope_desc(rc)
+          scope_desc(rc),
+          change_details(rc)
         )
       end.each { |row| @output.write(row) }
     end
@@ -283,12 +306,22 @@ module CuffSert
       ))
     end
 
+    def templates(current, pending)
+      @current_template = current
+      @pending_template = pending
+      @template_changes = HashDiff.best_diff(current, pending, array_path: true)
+      @template_changes.each {|c| p c} if ENV['CUFFSERT_EXPERIMENTAL']
+      present_changes(extract_changes(@template_changes, 'Conditions'), 'Conditions') unless @verbosity < 1
+      present_changes(extract_changes(@template_changes, 'Parameters'), 'Parameters') unless @verbosity < 1
+      present_changes(extract_changes(@template_changes, 'Outputs'), 'Outputs') unless @verbosity < 1
+    end
+
     def report(event)
       @output.write(event.message.colorize(:white) + "\n") unless @verbosity < 2
     end
 
     def abort(event)
-      @error.write(event.message.colorize(:red) + "\n") unless @verbosity < 1
+      @error.write("\n" + event.message.colorize(:red) + "\n") unless @verbosity < 1
     end
 
     def done(event)
@@ -297,6 +330,57 @@ module CuffSert
 
     private
 
+    def change_details(rc)
+      (rc[:details] || []).flat_map do |detail|
+        target_path = case detail[:target][:attribute]
+        when 'Properties'
+          [rc[:logical_resource_id], detail[:target][:attribute], detail[:target][:name]]
+        when 'Tags'
+          [rc[:logical_resource_id], 'Properties', detail[:target][:attribute]]
+        else
+          nil
+        end
+        extract_changes(@template_changes, 'Resources', *target_path)
+      end
+      .map do |(ch, path, l, r)|
+        format_change(ch, path[3..-1], l, r)
+      end
+      .join
+    end
+
+    def extract_changes(changes, type, *target_path)
+      changes
+        .select {|(_, path, _)| path[0..target_path.size] == [type, *target_path] }
+        .map {|(ch, path, *rest)| [ch, path, *rest] }
+    end
+
+    def present_changes(changes, type)
+      return unless changes.size > 0
+      @output.write("#{type}:\n")
+      changes.each do |(ch, path, l, r)|
+        @output.write(format_change(ch, path, l, r))
+      end
+    end
+
+    def format_change(ch, path, l, r = nil)
+      sprintf("%s %s: %s\n",
+        change_color(ch),
+        path.join('/'),
+        ch == '~' ? "#{l} -> #{r}" : l,
+      )
+    end
+
+    def change_color(ch)
+      ch.colorize(
+        case ch
+        when '-' then :red
+        when '+' then :green
+        when '~' then :yellow
+        else :white
+        end
+      )
+    end
+
     def interpret_states(resource)
       case resource[:states]
       when [:progress]

data/lib/cuffsert/rxcfclient.rb

@@ -1,5 +1,7 @@
 require 'aws-sdk-cloudformation'
 require 'cuffsert/cfstates'
+require 'cuffsert/errors'
+require 'yaml'
 require 'rx'
 
 module CuffSert
@@ -19,6 +21,14 @@ module CuffSert
       nil
     end
 
+    def get_template(meta)
+      Rx::Observable.create do |observer|
+        template = @cf.get_template(:stack_name => meta.stackname)
+        observer.on_next(YAML.load(template[:template_body]))
+        observer.on_completed
+      end
+    end
+
     def create_stack(cfargs)
       Rx::Observable.create do |observer|
         start_time = record_start_time
@@ -48,8 +58,12 @@ module CuffSert
       Rx::Observable.create do |observer|
         start_time = record_start_time
         @cf.execute_change_set(change_set_name: change_set_id)
-        stack_events(stack_id, start_time) do |event|
-          observer.on_next(event)
+        begin
+          stack_events(stack_id, start_time) do |event|
+            observer.on_next(event)
+          end
+        rescue => e
+          observer.on_error(e)
         end
         observer.on_completed
       end
@@ -84,9 +98,8 @@ module CuffSert
       DateTime.now - 5.0 / 86400
     end
 
-    def stack_finished?(stack_id, event)
-      event[:physical_resource_id] == stack_id &&
-        FINAL_STATES.include?(event[:resource_status])
+    def terminal_event?(stack_id, event)
+      event[:physical_resource_id] == stack_id && CuffSert.state_category(event[:resource_status]) != :progress
     end
 
     def flatten_events(stack_id)
@@ -101,16 +114,22 @@ module CuffSert
       eventid_cache = Set.new
       loop do
         events = []
-        done = false
+        terminal_event = nil
         flatten_events(stack_id) do |event|
           break if event[:timestamp].to_datetime < start_time
           next unless eventid_cache.add?(event[:event_id])
           events.unshift(event)
-          done = true if stack_finished?(stack_id, event)
+          terminal_event ||= event if terminal_event?(stack_id, event)
         end
         events.each { |event| yield event }
-        break if done
-        sleep(@pause)
+        case terminal_event && CuffSert.state_category(terminal_event[:resource_status])
+        when :good
+          break
+        when :bad
+          raise RxCFError, "Stack #{terminal_event.logical_resource_id} finished in state #{terminal_event.resource_status}"
+        else
+          sleep(@pause)
+        end
       end
     end
   end

data/lib/cuffsert/version.rb

@@ -1,3 +1,3 @@
 module CuffSert
-  VERSION = '0.12.0'
+  VERSION = '0.13.0'
 end

data/lib/cuffsert/yaml-ext.rb

@@ -0,0 +1,26 @@
+require 'yaml'
+
+module YAML
+  %w[Ref].each do |name|
+    add_domain_type('cuffsert', name) do |tag, value|
+      {name => value}
+    end
+  end
+
+  add_domain_type('cuffsert', 'GetAtt') do |_, value|
+    if value.is_a? String
+      {'Fn::GetAtt' => value.split('.')}
+    else
+      {'Fn::GetAtt' => value}
+    end
+  end
+
+  %w[
+    Base64 Cidr FindInMap GetAZs ImportValue Join Select Split Sub Transform
+    And Equals If Not Or
+  ].each do |name|
+    add_domain_type('cuffsert', name) do |tag, value|
+      {['Fn', name].join('::') => value}
+    end
+  end
+end

data/lib/cuffup.rb

@@ -7,7 +7,10 @@ module CuffUp
       :output => '/dev/stdout'
     }
     parser = OptionParser.new do |opts|
-      opts.on('--output metadata', '-o metadata', 'File to write metadata file to; decaults to stdout') do |f|
+      opts.banner = 'Output CuffSert-formatted metadata defaults based on a stack template.'
+      opts.separator('')
+      opts.separator('Usage: cuffup <template.json>')
+      opts.on('--output metadata', '-o metadata', 'File to write metadata file to; defaults to stdout') do |f|
         args[:output] = f
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuffsert
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Anders Qvist
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2019-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  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: ruby-termios
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +193,7 @@ files:
 - lib/cuffsert/cfstates.rb
 - lib/cuffsert/cli_args.rb
 - lib/cuffsert/confirmation.rb
+- lib/cuffsert/errors.rb
 - lib/cuffsert/main.rb
 - lib/cuffsert/messages.rb
 - lib/cuffsert/metadata.rb
@@ -186,6 +201,7 @@ files:
 - lib/cuffsert/rxcfclient.rb
 - lib/cuffsert/rxs3client.rb
 - lib/cuffsert/version.rb
+- lib/cuffsert/yaml-ext.rb
 - lib/cuffup.rb
 homepage: https://github.com/bittrance/cuffsert
 licenses: