cfndsl 1.0.6 → 1.3.1

data/lib/cfndsl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CfnDsl
-  VERSION = '1.0.6'
+  VERSION = '1.3.1'
 end

data/lib/deep_merge/core.rb

@@ -120,16 +120,16 @@ module DeepMerge
           puts "#{di} looping: #{src_key.inspect} => #{src_value.inspect} :: #{dest.inspect}" if merge_debug
           if dest[src_key]
             puts "#{di} ==>merging: #{src_key.inspect} => #{src_value.inspect} :: #{dest[src_key].inspect}" if merge_debug
-            dest[src_key] = deep_merge!(src_value, dest[src_key], options.merge(debug_indent: di + '  '))
+            dest[src_key] = deep_merge!(src_value, dest[src_key], options.merge(debug_indent: "#{di}  "))
           else # dest[src_key] doesn't exist so we want to create and overwrite it (but we do this via deep_merge!)
             puts "#{di} ==>merging over: #{src_key.inspect} => #{src_value.inspect}" if merge_debug
-            # note: we rescue here b/c some classes respond to "dup" but don't implement it (Numeric, TrueClass, FalseClass, NilClass among maybe others)
+            # NOTE: we rescue here b/c some classes respond to "dup" but don't implement it (Numeric, TrueClass, FalseClass, NilClass among maybe others)
             begin
               src_dup = src_value.dup # we dup src_value if possible because we're going to merge into it (since dest is empty)
             rescue TypeError
               src_dup = src_value
             end
-            dest[src_key] = deep_merge!(src_value, src_dup, options.merge(debug_indent: di + '  '))
+            dest[src_key] = deep_merge!(src_value, src_dup, options.merge(debug_indent: "#{di}  "))
           end
         elsif dest.is_a?(Array) && extend_existing_arrays
           dest.push(source)
@@ -181,12 +181,12 @@ module DeepMerge
             list = []
             dest.each_index do |i|
               list[i] = deep_merge!(source[i] || {}, dest[i],
-                                    options.merge(debug_indent: di + '  '))
+                                    options.merge(debug_indent: "#{di}  "))
             end
-            list += source[dest.count..-1] if source.count > dest.count
+            list += source[dest.count..] if source.count > dest.count
             dest = list
           elsif keep_array_duplicates
-            dest = dest.concat(source)
+            dest.concat(source)
           else
             dest |= source
           end
@@ -215,9 +215,10 @@ module DeepMerge
     knockout_prefix = options[:knockout_prefix] || false
     di = options[:debug_indent] || ''
     if knockout_prefix && overwrite_unmergeable
-      src_tmp = if source.is_a?(String) # remove knockout string from source before overwriting dest
+      src_tmp = case source
+                when String # remove knockout string from source before overwriting dest
                   source.gsub(/^#{knockout_prefix}/, '')
-                elsif source.is_a?(Array) # remove all knockout elements before overwriting dest
+                when Array # remove all knockout elements before overwriting dest
                   source.delete_if { |ko_item| ko_item.is_a?(String) && ko_item.match(/^#{knockout_prefix}/) }
                 else
                   source

data/sample/vpc_example.rb

@@ -23,8 +23,8 @@ CloudFormation do
 
   10.times do |i|
     subnet = "subnet#{i}"
-    route_table = subnet + 'RouteTable'
-    route_table_assoc = route_table + 'Assoc'
+    route_table = "#{subnet}RouteTable"
+    route_table_assoc = "#{route_table}Assoc"
 
     Subnet(subnet) do
       VpcId Ref(:VPC)
@@ -42,7 +42,7 @@ CloudFormation do
       RouteTableId Ref(route_table)
     end
 
-    EC2_Route(subnet + 'GatewayRoute') do
+    EC2_Route("#{subnet}GatewayRoute") do
       DependsOn :GatewayToInternet
       RouteTableId Ref(route_table)
       DestinationCidrBlock '0.0.0.0/0'

data/sample/vpc_with_vpn_example.rb

@@ -41,8 +41,8 @@ CloudFormation do
 
   10.times do |i|
     subnet = "subnet#{i}"
-    route_table = subnet + 'RouteTable'
-    route_table_assoc = route_table + 'Assoc'
+    route_table = "#{subnet}RouteTable"
+    route_table_assoc = "#{route_table}Assoc"
 
     Subnet(subnet) do
       VpcId Ref(:VPC)
@@ -60,7 +60,7 @@ CloudFormation do
       RouteTableId Ref(route_table)
     end
 
-    EC2_Route(subnet + 'GatewayRoute') do
+    EC2_Route("#{subnet}GatewayRoute") do
       DependsOn :GatewayToInternet
       RouteTableId Ref(route_table)
       DestinationCidrBlock '0.0.0.0/0'

data/spec/cfndsl_spec.rb

@@ -188,6 +188,26 @@ describe CfnDsl::CloudFormationTemplate do
     end
   end
 
+  it 'composes DependsOn' do
+    spec = self
+    subject.Resource('SomeResource') do
+      d = DependsOn('X')
+      spec.expect(d).to spec.eq('X') # start with a single value, stays a single value
+      d = DependsOn(%w[Y Z])
+      spec.expect(d).to spec.eq(%w[X Y Z]) # concatenates values
+      d = DependsOn('Y') # uniqeness
+      spec.expect(d).to spec.eq(%w[X Y Z])
+    end
+    expect(subject.to_json).to eq('{"AWSTemplateFormatVersion":"2010-09-09","Resources":{"SomeResource":{"DependsOn":["X","Y","Z"]}}}')
+  end
+
+  it 'supports single value DependsOn' do
+    subject.Resource('SomeResource') do
+      DependsOn(:ADependency)
+    end
+    expect(subject.to_json).to eq('{"AWSTemplateFormatVersion":"2010-09-09","Resources":{"SomeResource":{"DependsOn":"ADependency"}}}')
+  end
+
   context 'built-in functions' do
     it 'FnGetAtt' do
       func = subject.FnGetAtt('A', 'B')

data/spec/cli_spec.rb

@@ -36,7 +36,9 @@ describe 'cfndsl', type: :aruba do
   before(:each) { write_file('template.rb', template_content) }
 
   # The known working version is the embedded version
+  # rubocop:disable Lint/ConstantDefinitionInBlock
   WORKING_SPEC_VERSION = JSON.parse(File.read(CfnDsl::LOCAL_SPEC_FILE))['ResourceSpecificationVersion']
+  # rubocop:enable Lint/ConstantDefinitionInBlock
 
   context "cfndsl -u #{WORKING_SPEC_VERSION}" do
     it 'updates the specification file' do

data/spec/cloud_formation_template_spec.rb

@@ -40,10 +40,31 @@ describe CfnDsl::CloudFormationTemplate do
         expect(subject.validate).to equal(subject)
       end
 
+      it 'returns self if there are valid Fn::Sub references to other resources' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.FnSub('prefix ${TestResource2}suffix'))
+
+        t2 = subject.Resource('TestResource2')
+        t2.Type('Custom-TestType')
+        expect(subject.validate).to equal(subject)
+      end
+
+      it 'returns self if there are valid Fn::Sub references to other resource attributes' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.FnSub('prefix ${TestResource2.AnAttribute}suffix'))
+
+        t2 = subject.Resource('TestResource2')
+        t2.Type('Custom-TestType')
+        expect(subject.validate).to equal(subject)
+      end
+
       it 'returns self if there are valid DependsOn to other resources' do
         tr = subject.Resource(:TestResource)
         tr.Type('Custom-TestType')
         tr.DependsOn(:TestResource2)
+        tr.DependsOn(:TestResource2)
 
         t2 = subject.Resource('TestResource2')
         t2.Type('Custom-TestType')
@@ -119,6 +140,13 @@ describe CfnDsl::CloudFormationTemplate do
         expect { subject.validate }.to raise_error(CfnDsl::Error, /TestResource.*itself/i)
       end
 
+      it 'raises CfnDsl::Error if a resourcs references itself in Fn::Sub attribute expression' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.FnSub('${TestResource.attr}'))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /TestResource.*itself/i)
+      end
+
       it 'raises CfnDsl::Error if there are cyclic DependsOn references' do
         tr = subject.Resource(:ResourceOne)
         tr.Type('Custom-TestType')
@@ -211,6 +239,12 @@ describe CfnDsl::CloudFormationTemplate do
         expect(subject.validate).to equal(subject)
       end
 
+      it 'returns self if there are valid Fn::Sub references to resource attributes' do
+        subject.Resource(:TestResource)
+        subject.Output('TestResourceOutput').Value(subject.FnSub('prefix ${TestResource.attr}suffix'))
+        expect(subject.validate).to equal(subject)
+      end
+
       it 'raises CfnDsl::Error if references a non existent condition' do
         subject.Output(:TestOutput).Condition('NoCondition')
         expect { subject.validate }.to raise_error(CfnDsl::Error, /TestOutput.*NoCondition/)

data/spec/support/shared_examples/orchestration_template.rb

@@ -102,6 +102,13 @@ shared_examples 'an orchestration template' do
       expect(plural_value).to eq([{ foo: 'bar' }])
     end
 
+    it 'allows array returning function for otherwise array value when singular name == plural name' do
+      security_group = described_class.type_module.const_get('AWS_EC2_SecurityGroup').new
+      security_group.Property('SecurityGroupIngress', security_group.FnFindInMap('x', 'y', 'z'))
+      plural_value = security_group.instance_variable_get('@Properties')['SecurityGroupIngress'].value
+      expect(plural_value.to_json).to eql('{"Fn::FindInMap":["x","y","z"]}')
+    end
+
     it 'sets the type of each resource correctly' do
       ec2_instance = subject.EC2_Instance(:foo)
       expect(ec2_instance.instance_variable_get('@Type')).to eq('AWS::EC2::Instance')

data/spec/types_definition_spec.rb

@@ -27,9 +27,10 @@ RSpec.describe 'Type Definitions' do
           it "#{name} has all property types defined" do
             type = type['Properties'] if type.is_a?(Hash) && type.key?('Properties')
             type = type.first if type.is_a?(Array)
-            if type.is_a?(String)
+            case type
+            when String
               expect(types).to have_key(type)
-            elsif type.is_a?(Hash)
+            when Hash
               type.values.flatten.each { |t| expect(types).to have_key(t) }
             else
               raise "A defined type should only be of the form String, Array or Hash, got #{type.class}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfndsl
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.3.1
 platform: ruby
 authors:
 - Steven Jack
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-23 00:00:00.000000000 Z
+date: 2021-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: hana
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +71,7 @@ files:
 - lib/cfndsl/aws/patches/100_sam.spec_DeploymentPreference_patch.json
 - lib/cfndsl/aws/patches/200_Scrutinies_patch.json
 - lib/cfndsl/aws/patches/500_BadTagsv13.0.0_patch.json
+- lib/cfndsl/aws/patches/500_BadTagsv16.2.0_patch.json
 - lib/cfndsl/aws/patches/500_Cognito_IdentityPoolRoleAttachment_patches.json
 - lib/cfndsl/aws/patches/500_IoT1Click_patch_PlacementTemplate_DeviceTemplates.json
 - lib/cfndsl/aws/patches/500_NetworkAclEntry_patch.json
@@ -83,6 +84,7 @@ files:
 - lib/cfndsl/aws/patches/600_RefKinds_patch.json
 - lib/cfndsl/aws/patches/700_SAM_Serverless_Function_InlineCode_patch.json
 - lib/cfndsl/aws/patches/800_List_types_patch.json
+- lib/cfndsl/aws/patches/900_SageMakerTags_patch.json
 - lib/cfndsl/aws/resource_specification.json
 - lib/cfndsl/aws/types.rb
 - lib/cfndsl/aws/types.yaml
@@ -182,17 +184,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: AWS Cloudformation DSL