cfndsl 0.17.5 → 1.0.0.pre.1

data/lib/cfndsl/update_policy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'cfndsl/jsonable'
+require_relative 'jsonable'
 
 module CfnDsl
   # Handles autoscaling group update policy objects for Resources

data/lib/cfndsl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CfnDsl
-  VERSION = '0.17.5'
+  VERSION = '1.0.0.pre.1'
 end

data/sample/autoscale.rb

@@ -16,7 +16,6 @@ availability zones in a region. The instances are load balanced with a
 simple health check. The web site is available on port 80, however,
 the instances can be configured to listen on any port (8888 by
 default).
-
 **WARNING** This template creates one or more Amazon EC2
 instances. You will be billed for the AWS resources used if you create
 a stack from this template.

data/sample/autoscale2.rb

@@ -16,7 +16,6 @@ availability zones in a region. The instances are load balanced with a
 simple health check. The web site is available on port 80, however,
 the instances can be configured to listen on any port (8888 by
 default).
-
 **WARNING** This template creates one or more Amazon EC2
 instances. You will be billed for the AWS resources used if you create
 a stack from this template.

data/sample/config_service.rb

@@ -12,7 +12,7 @@ CloudFormation do
   Bucket('ConfigServiceBucket') do
   end
 
-  Policy('ConfigServiceS3BucketAccessPolicy') do
+  IAM_Policy('ConfigServiceS3BucketAccessPolicy') do
     PolicyName 'ConfigServiceS3BucketAccessPolicy'
     PolicyDocument(
       'Version' => '2012-10-17',
@@ -68,7 +68,7 @@ CloudFormation do
     }]
   end
 
-  Policy('ConfigServiceSNSTopicAccessPolicy') do
+  IAM_Policy('ConfigServiceSNSTopicAccessPolicy') do
     PolicyName 'ConfigServiceSNSTopicAccessPolicy'
     PolicyDocument(
       'Version' => '2012-10-17',

data/sample/t1.rb

@@ -10,7 +10,7 @@ CloudFormation do
     name = "machine#{i}"
     EC2_Instance(name) do
       ImageId 'ami-12345678'
-      Type 't1.micro'
+      InstanceType 't1.micro'
     end
   end
 end

data/sample/vpc_example.rb

@@ -42,7 +42,7 @@ CloudFormation do
       RouteTableId Ref(route_table)
     end
 
-    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

@@ -60,7 +60,7 @@ CloudFormation do
       RouteTableId Ref(route_table)
     end
 
-    Route(subnet + 'GatewayRoute') do
+    EC2_Route(subnet + 'GatewayRoute') do
       DependsOn :GatewayToInternet
       RouteTableId Ref(route_table)
       DestinationCidrBlock '0.0.0.0/0'

data/spec/aws/list_type_patches_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe CfnDsl::CloudFormationTemplate do
+  subject(:template) { described_class.new }
+
+  describe 'Bogus Properties that are type List' do
+    it 'fixes Resource property type to a List of its item type' do
+      template.LakeFormation_DataLakeSettings('lake') do
+        Admin { DataLakePrincipalIdentifier 'principal' }
+      end
+      expect(template.to_json).to include('"Type":"AWS::LakeFormation::DataLakeSettings","Properties":{"Admins":[{"DataLakePrincipalIdentifier":"principal"')
+    end
+
+    it 'fixes Subtype property Tags to a list of Tags' do
+      template.AppSync_GraphQLApi('api') do
+        Tag do
+          Key 'tagkey'
+          Value 'tagvalue'
+        end
+      end
+      expect(template.to_json).to include('"Properties":{"Tags":[{"Key":"tagkey","Value":"tagvalue"}]}}}')
+    end
+
+    it 'fixes Subtype property type to a List of its item type' do
+      template.Glue_SecurityConfiguration('glue') do
+        EncryptionConfiguration do
+          S3Encryption { S3EncryptionMode 'mode' }
+        end
+      end
+      expect(template.to_json).to include('"EncryptionConfiguration":{"S3Encryptions":[{"S3EncryptionMode":"mode"}]}}}}}')
+    end
+  end
+end

data/spec/aws/nested_arrays_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe CfnDsl::CloudFormationTemplate do
   subject(:template) { described_class.new }
 
-  describe '#Nested_Arrays' do
+  describe 'Nested_Arrays' do
     it 'ensure nested arrays are not duplicated' do
       template.DirectoryService_SimpleAD(:Test) do
         VpcSettings do
@@ -17,7 +17,7 @@ describe CfnDsl::CloudFormationTemplate do
       expect(template.to_json).not_to include('"SubnetIds":[["subnet-a","subnet-b"],["subnet-a","subnet-b"]]')
     end
 
-    it 'check multiple invocations work' do
+    it 'appends entries with multiple invocations' do
       template.DirectoryService_SimpleAD(:Test) do
         VpcSettings do
           SubnetId 'subnet-a'
@@ -28,7 +28,7 @@ describe CfnDsl::CloudFormationTemplate do
       expect(template.to_json).to include('"SubnetIds":["subnet-a","subnet-b"]}')
     end
 
-    it 'check multiple invocation with arrays works' do
+    it 'appends entries with multiple array invocations' do
       template.DirectoryService_SimpleAD(:Test) do
         VpcSettings do
           SubnetId %w[subnet-a subnet-b]
@@ -38,5 +38,157 @@ describe CfnDsl::CloudFormationTemplate do
 
       expect(template.to_json).to include('"SubnetIds":["subnet-a","subnet-b","subnet-c","subnet-d"]')
     end
+
+    # Previous behaviour produces valid result, but appends rather than replaces (inconsistent with top level item)
+    it 'appends entries when plural form is used' do
+      template.DirectoryService_SimpleAD(:Test) do
+        VpcSettings do
+          SubnetId 'subnet-x'
+          SubnetIds %w[subnet-a subnet-b]
+        end
+      end
+
+      expect(template.to_json).to include('"SubnetIds":["subnet-a","subnet-b"]}')
+    end
+
+    it 'plural form accepts a Ref' do
+      template.EC2_LaunchTemplate(:test) do
+        LaunchTemplateData do
+          SecurityGroupIds Ref('AListParam')
+        end
+      end
+      expect(template.to_json).to include('"LaunchTemplateData":{"SecurityGroupIds":{"Ref":"AListParam"}')
+    end
+  end
+
+  describe 'Nested Arrays With Subtype items' do
+    it 'can add a subtype to a list' do
+      template.EC2_SpotFleet('SpotFleet') do
+        SpotFleetRequestConfigData do
+          LaunchSpecification do
+            ImageId 'ami-1234'
+          end
+        end
+      end
+      expect(template.to_json).to include('"LaunchSpecifications":[{"ImageId":"ami-1234"}]')
+    end
+
+    it 'can conditionally add a subtype to a list' do
+      template.EC2_SpotFleet('SpotFleet') do
+        SpotFleetRequestConfigData do
+          # We want all the DSL goodness
+          LaunchSpecification fn_if: 'ACondition' do
+            ImageId 'ami-1234'
+          end
+        end
+      end
+      json = template.to_json
+      expect(json).to include('"LaunchSpecifications":[{"Fn::If":["ACondition",{"ImageId":"ami-1234"},{"Ref":"AWS::NoValue"}]}]')
+    end
+  end
+
+  describe 'Top level Lists' do
+    it 'appends item if singular form != plural form is passed a single item' do
+      template.AutoScaling_AutoScalingGroup('ASG') do
+        AvailabilityZone 'region-2a'
+        AvailabilityZone 'region-2b'
+      end
+      expect(template.to_json).to include('"AvailabilityZones":["region-2a","region-2b"]')
+    end
+
+    # Change from prior behaviour which produced an invalid result
+    it 'appends multiple items if singular form != plural form is passed an array' do
+      template.AutoScaling_AutoScalingGroup('ASG') do
+        AvailabilityZone %w[region-2a region-2b]
+        AvailabilityZone ['region-2c']
+      end
+      expect(template.to_json).to include('"AvailabilityZones":["region-2a","region-2b","region-2c"]')
+    end
+
+    it 'replaces items if plural form is passed an array' do
+      template.AutoScaling_AutoScalingGroup('ASG') do
+        AvailabilityZones ['region-2z']
+        AvailabilityZones ['region-2a']
+      end
+      expect(template.to_json).to include('"AvailabilityZones":["region-2a"]')
+    end
+
+    it 'accepts a Ref in plural form' do
+      template.AutoScaling_AutoScalingGroup('ASG') do
+        AvailabilityZones Ref('AListParam')
+      end
+      expect(template.to_json).to include('"AvailabilityZones":{"Ref":"AListParam"}')
+    end
+
+    # This produces an invalid result (item not encapsulated as a List), so could be changed
+    # later
+    it 'replaces items if plural form is passed a single item' do
+      template.AutoScaling_AutoScalingGroup('ASG') do
+        AvailabilityZones 'region-xx'
+        AvailabilityZones 'region-2a'
+      end
+      expect(template.to_json).to include('"AvailabilityZones":"region-2a"')
+    end
+
+    it 'replaces items if list attribute is singlar, and plural form is passed an array' do
+      template.AutoScaling_AutoScalingGroup('ASG') do
+        VPCZoneIdentifiers ['subnet-9999']
+        VPCZoneIdentifiers ['subnet-1234']
+      end
+      expect(template.to_json).to include('"VPCZoneIdentifier":["subnet-1234"]')
+    end
+
+    it 'replaces items if list attribute is singlar, and plural form is passed an array' do
+      template.AutoScaling_AutoScalingGroup('ASG') do
+        VPCZoneIdentifier 'subnet-9999'
+        VPCZoneIdentifiers ['subnet-1234']
+      end
+      expect(template.to_json).to include('"VPCZoneIdentifier":["subnet-1234"]')
+    end
+
+    it 'appends items if list attribute is singlar and passed arrays' do
+      template.AutoScaling_AutoScalingGroup('ASG') do
+        VPCZoneIdentifier ['subnet-9999']
+        VPCZoneIdentifier ['subnet-1234']
+      end
+      expect(template.to_json).to include('"VPCZoneIdentifier":["subnet-9999","subnet-1234"]')
+    end
+
+    it 'appends items if plural form == singular form and passed a single item' do
+      template.AutoScaling_AutoScalingGroup('ASG') do
+        VPCZoneIdentifier 'subnet-9999'
+        VPCZoneIdentifier 'subnet-1234'
+      end
+      expect(template.to_json).to include('"VPCZoneIdentifier":["subnet-9999","subnet-1234"]')
+    end
+
+    it 'does not create plural method if both singlular and plural forms are legitimate properties' do
+      template.CodePipeline_Pipeline('pipeline') do
+        ArtifactStore do
+          Location 'abucketname'
+          Type 'S3'
+        end
+        ArtifactStores do
+          ArtifactStore do
+            Location 'a different bucket'
+            Type 'S3'
+          end
+          Region 'ax-eastwest-5'
+        end
+      end
+      json = template.to_json
+      expect(json).to include('"ArtifactStore":{"Location":"abucketname"')
+      expect(json).to include('"ArtifactStores":[{"ArtifactStore":{')
+    end
+
+    it 'can conditionally add a subtype to a list property' do
+      template.SSM_MaintenanceWindowTask('Task') do
+        # We want all the DSL goodness
+        Target fn_if: 'ACondition' do
+          Key 'AKey'
+        end
+      end
+      expect(template.to_json).to include('"Targets":[{"Fn::If":["ACondition",{"Key":"AKey"},{"Ref":"AWS::NoValue"}]}]')
+    end
   end
 end

data/spec/aws/serverless_spec.rb

@@ -30,7 +30,6 @@ describe CfnDsl::CloudFormationTemplate do
         }
       )
     end
-    # File.open('/tmp/dump', 'w') { |f| f.write(template.to_json) }
     expect(JSON.parse(template.to_json)).to eq(read_json_fixture('serverless-function.json'))
   end
 
@@ -42,7 +41,6 @@ describe CfnDsl::CloudFormationTemplate do
       CacheClusterSize '512M'
       Variables(Var1: 'value1')
     end
-    File.open('/tmp/dump', 'w') { |f| f.write(template.to_json) }
     expect(JSON.parse(template.to_json)).to eq(read_json_fixture('serverless-api.json'))
   end
 end

data/spec/cfndsl_spec.rb

@@ -4,44 +4,12 @@ require 'spec_helper'
 
 describe CfnDsl do
   let(:test_template_file_name) { "#{File.dirname(__FILE__)}/fixtures/test.rb" }
-  let(:heat_test_template_file_name) { "#{File.dirname(__FILE__)}/fixtures/heattest.rb" }
 
   after(:example) { CfnDsl::ExternalParameters.refresh! }
 
   it 'evaluates a cloud formation' do
     subject.eval_file_with_extras(test_template_file_name, [[:raw, 'test=123']])
   end
-
-  it 'evaluates a heat' do
-    subject.eval_file_with_extras(heat_test_template_file_name)
-  end
-
-  context 'when binding is disabed' do
-    let(:param_value) { 'www.google.com?a=1&b=2' }
-    before do
-      CfnDsl.disable_binding
-    end
-
-    it 'evaluates parameters correctly when its value contains "="' do
-      template = subject.eval_file_with_extras(test_template_file_name, [[:raw, "three=#{param_value}"]]).to_json
-      parsed_template = JSON.parse(template)
-      expect(parsed_template['Parameters']['Three']['Default']).to eq param_value
-    end
-  end
-end
-
-describe CfnDsl::HeatTemplate do
-  it 'honors last-set value for non-array properties' do
-    spec = self
-    subject.declare do
-      Server('myserver') do
-        flavor 'foo'
-        flavor 'bar'
-        f = @Properties['flavor'].value
-        spec.expect(f).to spec.eq('bar')
-      end
-    end
-  end
 end
 
 describe CfnDsl::CloudFormationTemplate do
@@ -69,16 +37,97 @@ describe CfnDsl::CloudFormationTemplate do
     end
   end
 
-  it 'validates references' do
+  it 'detects cyclic Resource references' do
     q = subject.Resource('q') { DependsOn ['r'] }
     r = subject.Resource('r') { Property('z', Ref('q')) }
-    q_refs = q.build_references({})
-    r_refs = r.build_references({})
-    expect(q_refs).to have_key('r')
-    expect(q_refs).to_not have_key('q')
-    expect(r_refs).to have_key('q')
-    expect(r_refs).to_not have_key('r')
-    expect(subject.check_refs.length).to eq(2)
+    q_refs = q.build_references
+    r_refs = r.build_references
+    expect(q_refs).to include('r')
+    expect(q_refs).to_not include('q')
+    expect(r_refs).to include('q')
+    expect(r_refs).to_not include('r')
+    expect(subject.check_refs.first).to match(/cyclic reference/i)
+  end
+
+  it 'detects a self reference in a Resource' do
+    q = subject.Resource('q') { Property('p', SomeDeepPropery: ['x', Ref('q')]) }
+    q_refs = q.build_references
+    expect(q_refs).to include('q')
+    messages = subject.check_refs
+    expect(messages.size).to eq(1) # Expect a self reference
+    expect(messages.first).to match(/references itself/i)
+  end
+
+  it 'detects a self reference in a Condition' do
+    q = subject.Condition('q', subject.FnAnd([subject.FnEquals('x', 'x'), subject.Condition('q')]))
+    q_refs = q.build_references([], nil, :condition_refs)
+    expect(q_refs).to include('q')
+    messages = subject.check_refs
+    expect(messages.size).to eq(1) # Expect a self reference
+    expect(messages.first).to match(/references itself/i)
+  end
+
+  it 'detects deep cycles in a Resource' do
+    subject.Condition('c', subject.FnEquals('a', 'b'))
+    subject.Resource('q') { Property('p', Ref('r')) }
+    subject.Resource('r') { Property('p', FnIf('c', FnGetAtt('s', 'attr'), 'x')) }
+    subject.Resource('s') { Property('p', FnSub('Something ${q}')) }
+    messages = subject.check_refs
+    expect(messages.size).to eq(1)
+    expect(messages.first).to match(/cyclic reference/i)
+  end
+
+  it 'detects deep cycles in Conditions' do
+    subject.Condition('c', subject.FnEquals('a', 'b'))
+    subject.Condition('d', subject.FnAnd([subject.FnEquals('x', 'x'), subject.Condition('c')]))
+    subject.Condition('q', subject.FnAnd([subject.FnEquals('x', 'x'), subject.Condition('r')]))
+    subject.Condition('r', subject.FnAnd([subject.FnEquals('x', 'x'), subject.Condition('s')]))
+    subject.Condition('s', subject.FnAnd([subject.FnEquals('x', 'x'), subject.Condition('q')]))
+    messages = subject.check_refs
+    expect(messages.size).to eq(1)
+    expect(messages.first).to match(/cyclic reference/i)
+  end
+
+  it 'detects invalid parameter references in Condition expressions' do
+    subject.Condition('x', subject.FnEquals('a', subject.Ref('p')))
+    messages = subject.check_refs
+    expect(messages.size).to eq(1)
+    expect(messages.first).to match(/^Invalid Reference: Conditions.*x.*p/)
+  end
+
+  it 'detects invalid condition references in Condition expressions' do
+    subject.Condition('d', subject.FnAnd([subject.FnEquals('x', 'x'), subject.Condition('c')]))
+    messages = subject.check_refs
+    expect(messages.size).to eq(1)
+    expect(messages.first).to match(/^Invalid Reference: Conditions.*d.*c/)
+  end
+
+  it 'detects invalid condition references in Resource Conditions' do
+    subject.Resource('r') { Condition 'd' }
+    messages = subject.check_refs
+    expect(messages.size).to eq(1)
+    expect(messages.first).to match(/^Invalid Reference: Resources.*r.*d/)
+  end
+
+  it 'detects invalid condition references in FnIf expressions deep inside Resources' do
+    subject.Resource('r') { Property(:p, FnIf(:d, 'vx', 'vy')) }
+    messages = subject.check_refs
+    expect(messages.size).to eq(1)
+    expect(messages.first).to match(/^Invalid Reference: Resources.*r.*d/)
+  end
+
+  it 'detects invalid condition references in Output Conditions' do
+    subject.Output('o') { Condition 'd' }
+    messages = subject.check_refs
+    expect(messages.size).to eq(1)
+    expect(messages.first).to match(/^Invalid Reference: Outputs.*o.*d/)
+  end
+
+  it 'detects invalid condition references in FnIf expressions deep inside Outputs' do
+    subject.Output('o') { Value(FnIf(:d, 'vx', 'vy')) }
+    messages = subject.check_refs
+    expect(messages.size).to eq(1)
+    expect(messages.first).to match(/^Invalid Reference: Outputs.*o.*d/)
   end
 
   it 'is a data-driven language' do
@@ -96,7 +145,7 @@ describe CfnDsl::CloudFormationTemplate do
   end
 
   it 'singularizes indirectly' do
-    user = subject.User 'TestUser'
+    user = subject.IAM_User 'TestUser'
     policy = user.Policy 'stuff'
     expect(policy).to eq('stuff')
 
@@ -120,8 +169,8 @@ describe CfnDsl::CloudFormationTemplate do
     ].each do |param|
       ref = subject.Ref param
       expect(ref.to_json).to eq("{\"Ref\":\"#{param}\"}")
-      refs = ref.build_references({})
-      expect(refs).to have_key(param)
+      refs = ref.build_references
+      expect(refs).to include(param)
     end
   end
 
@@ -156,8 +205,8 @@ describe CfnDsl::CloudFormationTemplate do
     it 'Ref' do
       ref = subject.Ref 'X'
       expect(ref.to_json).to eq('{"Ref":"X"}')
-      refs = ref.build_references({})
-      expect(refs).to have_key('X')
+      refs = ref.build_references
+      expect(refs).to include('X')
     end
 
     it 'FnBase64' do
@@ -218,39 +267,6 @@ describe CfnDsl::CloudFormationTemplate do
       end
     end
 
-    context 'FnFormat', 'String' do
-      it 'formats correctly' do
-        func = subject.FnFormat('abc%0def%1ghi%%x', 'A', 'B')
-        expect(func.to_json).to eq('{"Fn::Join":["",["abc","A","def","B","ghi","%","x"]]}')
-      end
-    end
-
-    context 'FnFormat', 'Hash' do
-      it 'formats correctly' do
-        func = subject.FnFormat('abc%{first}def%{second}ghi%%x', first: 'A', second: 'B')
-        expect(func.to_json).to eq('{"Fn::Join":["",["abc","A","def","B","ghi","%","x"]]}')
-      end
-    end
-
-    context 'FnFormat', 'Multiline' do
-      it 'formats correctly' do
-        multiline = <<-TEXT.gsub(/^ {10}/, '')
-          This is the first line
-          This is the %0 line
-          This is a %% sign
-        TEXT
-        func = subject.FnFormat(multiline, 'second')
-        expect(func.to_json).to eq('{"Fn::Join":["",["This is the first line\nThis is the ","second"," line\nThis is a ","%"," sign\n"]]}')
-      end
-    end
-
-    context 'FnFormat', 'Ref' do
-      it 'formats correctly' do
-        func = subject.FnFormat '123%{Test}456'
-        expect(func.to_json).to eq('{"Fn::Join":["",["123",{"Ref":"Test"},"456"]]}')
-      end
-    end
-
     context 'FnCidr', 'Array' do
       it 'formats correctly' do
         func = subject.FnCidr('10.0.0.0', '256', '8')