convection 2.2.29 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 076060eec9c4e8108a8f6bab08a8f5bf9dacfdd7
-  data.tar.gz: a4921ecbc1f0cde9308eebcd78209d7079085283
+  metadata.gz: 80472b7ae2163bf2c2bff8dc870c2e3571257a1d
+  data.tar.gz: b3b70747b74829069d110b96eccc74b1ae70e902
 SHA512:
-  metadata.gz: 1d9326cdef296ee8069a2506d008aad5206059a1f6a11ab7f0da3b3e3af4b303677aa7a748dbcef9e8ca3a6cad9485d41e1b8adedad14eb0e1e10e4c88f35ee2
-  data.tar.gz: 655a27c52359dba267a2b088932ba36179e297fb592e16bbfcaa55db464e7ab3dbb550cdcb6f7139857496f958e33156076cc129ca7350078c5a0c107d42804a
+  metadata.gz: fec53677c235b009423cc61dafb3ae9f0a4bd4400d3ee65e67f13441631b21993542d880663aa8017269fd7271e6f99ee083dd2fcb5459fa8cd4f6b9bcd5e989
+  data.tar.gz: 2f7011b1226f5397465f2c4a9d534cc63fab2c29dea4572d117cd346a024d38ec86e65498505d417e99da24256ac9df9101a0448a50294d7abe99584f20e276c

data/.rubocop.yml

@@ -28,6 +28,11 @@ Metrics/LineLength:
   Exclude:
     - 'lib/convection/dsl/terraform_intrinsic_functions.rb'
 
+# Ignore block length limits for DSLs
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
 # AbcSize:
 #   Max: 24
 # ClassLength:

data/lib/convection/model/diff.rb

@@ -7,13 +7,14 @@ module Convection
     # Difference between an item in two templates
     ##
     class Diff
+      include Comparable
       extend Mixin::Colorize
 
       attr_reader :key
-      attr_reader :action
+      attr_accessor :action
       attr_reader :ours
       attr_reader :theirs
-      colorize :action, :green => [:create], :yellow => [:update], :red => [:delete, :replace]
+      colorize :action, :green => [:create], :yellow => [:update, :retain], :red => [:delete, :replace]
 
       def initialize(key, ours, theirs)
         @key = key
@@ -40,10 +41,24 @@ module Convection
                   when :update then "#{ key }: #{ theirs } => #{ ours }"
                   when :replace then "#{ key }: #{ theirs } => #{ ours }"
                   when :delete then key
+                  when :retain then key
                   end
 
         [action, message, color]
       end
+
+      def <=>(other)
+        value = @key <=> other.key
+        return value if value != 0
+
+        value = @ours <=> other.ours
+        return value if value != 0
+
+        value = @theirs <=> other.theirs
+        return value if value != 0
+
+        @action <=> other.action
+      end
     end
   end
 end

data/lib/convection/model/template.rb

@@ -297,7 +297,45 @@ module Convection
       end
 
       def diff(other, stack_ = nil, retain: false)
-        render(stack_, retain: retain).diff(other).map { |diff| Diff.new(diff[0], *diff[1]) }
+        # We want to accurately show when the DeletionPolicy is getting deleted and also when resources are going to be retained.
+        # Sample DeletionPolicy Removal output
+        # us-east-1      compare  Compare local state of stack test-logs-deletion with remote template
+        # us-east-1       delete  Resources.sgtestConvectionDeletion.DeletionPolicy
+        #
+        # Sample Mixed Retain/Delete Resources
+        # us-east-1       retain  Resources.ELBLoggingPolicy.DependsOn.AWS::S3::BucketPolicy.0
+        # us-east-1       retain  Resources.ELBLoggingPolicy.DeletionPolicy
+        # us-east-1       delete  Resources.sgtestConvectionDeletion.Type
+        # us-east-1       delete  Resources.sgtestConvectionDeletion.Properties.AWS::EC2::SecurityGroup.GroupDescription
+        # us-east-1       delete  Resources.sgtestConvectionDeletion.Properties.AWS::EC2::SecurityGroup.VpcId
+        #
+        events = render(stack_, retain: retain).diff(other).map { |diff| Diff.new(diff[0], *diff[1]) }
+
+        # Top level events (changes to the resource directly) have keys with a format "Resources.{NAME}.{KEY}".
+        # So we can count the number of separators to find them.
+        top_level_events = events.select { |event| event.key.count('.') <= 2 }
+
+        # We know something's a deleted resource when it has a top level "Type" attribute.
+        type_suffix = '.Type'.freeze
+        deleted_resources = top_level_events.select do |event|
+          event.action == :delete && event.key.end_with?(type_suffix)
+        end
+        deleted_resources.map! { |event| event.key[0...-type_suffix.length] }
+
+        # We know something's a retainable resource when it has a top level "DeletionPolicy" attribute.
+        delete_policy_suffix = '.DeletionPolicy'.freeze
+        retainable_resources = top_level_events.select do |event|
+          event.action == :delete && event.key.end_with?(delete_policy_suffix) && event.theirs == 'Retain'
+        end
+        retainable_resources.map! { |event| event.key[0...-delete_policy_suffix.length] }
+        retainable_resources.keep_if { |name| deleted_resources.include?(name) }
+
+        events.each do |event|
+          retained = retainable_resources.any? { |name| event.action == :delete && event.key.start_with?(name) }
+          event.action = :retain if retained
+        end
+
+        events
       end
 
       def to_json(stack_ = nil, pretty = false, retain: false)

data/spec/convection/model/template/template_spec.rb

@@ -49,6 +49,79 @@ class Convection::Model::Template
       end
     end
 
+    describe '#diff' do
+      context 'when diffing resources with deletion_policy' do
+        it 'emits retain events when the entire resource is deleted' do
+          local = Convection.template do
+          end
+
+          remote = Convection.template do
+            resource 'Test' do
+              type 'Test'
+              property 'Key', 'Value'
+              deletion_policy 'Retain'
+            end
+          end
+
+          retained = [
+            Convection::Model::Diff.new('Resources.Test.Properties.Test.Key', nil, 'Value'),
+            Convection::Model::Diff.new('Resources.Test.DeletionPolicy', nil, 'Retain'),
+            Convection::Model::Diff.new('Resources.Test.Type', nil, 'Test')
+          ]
+          retained.each { |event| event.action = :retain }
+
+          events = local.diff(remote.render)
+          expect(events.sort).to eq(retained.sort)
+        end
+
+        it 'emits delete events when only part of the resource is deleted' do
+          local = Convection.template do
+            resource 'Test' do
+              type 'Test'
+            end
+          end
+
+          remote = Convection.template do
+            resource 'Test' do
+              type 'Test'
+              property 'Key', 'Value'
+              deletion_policy 'Retain'
+            end
+          end
+
+          deleted = [
+            Convection::Model::Diff.new('Resources.Test.Properties.Test.Key', nil, 'Value'),
+            Convection::Model::Diff.new('Resources.Test.DeletionPolicy', nil, 'Retain')
+          ]
+          deleted.each { |event| event.action = :delete }
+
+          events = local.diff(remote.render)
+          expect(events.sort).to eq(deleted.sort)
+        end
+
+        it 'emits delete events even when properties match Type and DeletePolicy' do
+          local = Convection.template do
+          end
+
+          remote = Convection.template do
+            resource 'Test' do
+              property 'Type', 'Test'
+              property 'DeletionPolicy', 'Retain'
+            end
+          end
+
+          deleted = [
+            Convection::Model::Diff.new('Resources.Test.Properties.Type', nil, 'Test'),
+            Convection::Model::Diff.new('Resources.Test.Properties.DeletionPolicy', nil, 'Retain')
+          ]
+          deleted.each { |event| event.action = :delete }
+
+          events = local.diff(remote.render)
+          expect(events.sort).to eq(deleted.sort)
+        end
+      end
+    end
+
     subject do
       template_json
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convection
 version: !ruby/object:Gem::Version
-  version: 2.2.29
+  version: 2.3.0
 platform: ruby
 authors:
 - John Manero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-27 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport