cfndsl 0.15.0 → 1.0.0

data/lib/cfndsl/update_policy.rb

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

data/lib/cfndsl/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CfnDsl
-  VERSION = '0.15.0'.freeze
+  VERSION = '1.0.0'
 end

data/lib/deep_merge/core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # rubocop:disable Metrics/AbcSize, Metrics/BlockNesting, Metrics/CyclomaticComplexity, Metrics/MethodLength
 # rubocop:disable Metrics/ModuleLength, Metrics/PerceivedComplexity, Style/IfInsideElse, Style/Semicolon
 #
@@ -5,7 +7,7 @@
 module DeepMerge
   class InvalidParameter < StandardError; end
 
-  DEFAULT_FIELD_KNOCKOUT_PREFIX = '--'.freeze
+  DEFAULT_FIELD_KNOCKOUT_PREFIX = '--'
 
   # Deep Merge core documentation.
   # deep_merge! method permits merging of arbitrary child elements. The two top level
@@ -85,6 +87,7 @@ module DeepMerge
     knockout_prefix = options[:knockout_prefix] || nil
     raise InvalidParameter, 'knockout_prefix cannot be an empty string in deep_merge!' if knockout_prefix == ''
     raise InvalidParameter, 'overwrite_unmergeable must be true if knockout_prefix is specified in deep_merge!' if knockout_prefix && !overwrite_unmergeable
+
     # if present: we will split and join arrays on this char before merging
     array_split_char = options[:unpack_arrays] || false
     # request that we avoid merging arrays
@@ -103,6 +106,7 @@ module DeepMerge
     di = options[:debug_indent] || ''
     # do nothing if source is nil
     return dest if !merge_nil_values && source.nil?
+
     # if dest doesn't exist, then simply copy source to it
     if !dest && overwrite_unmergeable
       dest = source; return dest
@@ -146,9 +150,7 @@ module DeepMerge
         if array_split_char
           puts "#{di} split/join on source: #{source.inspect}" if merge_debug
           source = source.join(array_split_char).split(array_split_char)
-          if dest.is_a?(Array)
-            dest = dest.join(array_split_char).split(array_split_char)
-          end
+          dest = dest.join(array_split_char).split(array_split_char) if dest.is_a?(Array)
         end
         # if there's a naked knockout_prefix in source, that means we are to truncate dest
         if knockout_prefix && source.index(knockout_prefix)
@@ -204,7 +206,7 @@ module DeepMerge
     end
     puts "#{di}Returning #{dest.inspect}" if merge_debug
     dest
-  end # deep_merge!
+  end
 
   # allows deep_merge! to uniformly handle overwriting of unmergeable entities
   def self.overwrite_unmergeables(source, dest, options)
@@ -241,4 +243,6 @@ module DeepMerge
     end
     obj
   end
-end # module DeepMerge
+end
+# rubocop:enable Metrics/AbcSize, Metrics/BlockNesting, Metrics/CyclomaticComplexity, Metrics/MethodLength
+# rubocop:enable Metrics/ModuleLength, Metrics/PerceivedComplexity, Style/IfInsideElse, Style/Semicolon

data/lib/deep_merge/deep_merge.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Totally borrowed from https://github.com/danielsdeleo/deep_merge
 require 'deep_merge/core'
 
@@ -9,7 +11,7 @@ module DeepMerge
       default_opts = { preserve_unmergeables: false }
       DeepMerge.deep_merge!(source, self, default_opts.merge(options))
     end
-  end # DeepMergeHashExt
+  end
 end
 
 # Extends hash with deep merge

data/sample/autoscale.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # We start things off by calling the CloudFormation function.
 CloudFormation do
@@ -15,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # We start things off by calling the CloudFormation function.
 CloudFormation do
   # Declare the template format version
@@ -14,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.
@@ -89,8 +90,8 @@ a stack from this template.
   AutoScalingGroup('WebServerGroup') do
     UpdatePolicy('AutoScalingRollingUpdate',
                  'MinInstancesInService' => '1',
-                 'MaxBatchSize'          => '1',
-                 'PauseTime'             => 'PT15M')
+                 'MaxBatchSize' => '1',
+                 'PauseTime' => 'PT15M')
     AvailabilityZones FnGetAZs('')
     LaunchConfigurationName Ref('LaunchConfig')
     MinSize 1

data/sample/circular.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 CloudFormation do
   AWSTemplateFormatVersion '2010-09-09'
 

data/sample/codedeploy.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 CloudFormation do
-  DESCRIPTION ||= 'CodeDeploy description'.freeze
+  DESCRIPTION ||= 'CodeDeploy description'
 
   Description DESCRIPTION
 

data/sample/config_service.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 CloudFormation do
   AWSTemplateFormatVersion '2010-09-09'
 
   Description 'Creates SNS, SQS, S3 bucket and enables AWS Config.'
 
-  Queue('ConfigServiceQueue') do
+  SQS_Queue('ConfigServiceQueue') do
     QueueName 'ConfigServiceQueue'
   end
 
   Bucket('ConfigServiceBucket') do
   end
 
-  Policy('ConfigServiceS3BucketAccessPolicy') do
+  IAM_Policy('ConfigServiceS3BucketAccessPolicy') do
     PolicyName 'ConfigServiceS3BucketAccessPolicy'
     PolicyDocument(
       'Version' => '2012-10-17',
@@ -66,7 +68,7 @@ CloudFormation do
     }]
   end
 
-  Policy('ConfigServiceSNSTopicAccessPolicy') do
+  IAM_Policy('ConfigServiceSNSTopicAccessPolicy') do
     PolicyName 'ConfigServiceSNSTopicAccessPolicy'
     PolicyDocument(
       'Version' => '2012-10-17',

data/sample/ecs.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 CloudFormation do
-  DESCRIPTION ||= 'ecs description'.freeze
+  DESCRIPTION ||= 'ecs description'
 
   Description DESCRIPTION
 

data/sample/export.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 CloudFormation do
   EC2_SecurityGroup(:webSecurityGroup) do
     GroupDescription 'Allow incoming HTTP traffic from anywhere'
     SecurityGroupIngress [
       {
-        'CidrIp'     => '0.0.0.0/0',
+        'CidrIp' => '0.0.0.0/0',
         'IpProtocol' => 'tcp',
-        'FromPort'   => 80,
-        'ToPort'     => 80
+        'FromPort' => 80,
+        'ToPort' => 80
       }
     ]
   end

data/sample/iam_policies.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 CloudFormation do
   AWSTemplateFormatVersion '2010-09-09'
 

data/sample/import.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 CloudFormation do
   EC2_SecurityGroup(:databaseSecurityGroup) do
     GroupDescription 'Allow access from only web instances'
@@ -5,8 +7,8 @@ CloudFormation do
       {
         'SourceSecurityGroupId' => FnImportValue(:webSecurityGroupId),
         'IpProtocol' => 'tcp',
-        'FromPort'   => 7777,
-        'ToPort'     => 7777
+        'FromPort' => 7777,
+        'ToPort' => 7777
       }
     ]
   end

data/sample/lambda.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 CloudFormation do
-  DESCRIPTION ||= 'lambda description'.freeze
+  DESCRIPTION ||= 'lambda description'
 
   Description DESCRIPTION
 

data/sample/s3.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 CloudFormation do
   S3_Bucket('Bucket') do
     BucketName 'MyBucket'

data/sample/t1.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 CloudFormation do
   description = external_parameters.fetch(:description, 'default description')
   machines = external_parameters.fetch(:machines, 1).to_i
@@ -8,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cfndsl'
 
 CloudFormation do
@@ -40,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cfndsl'
 
 CloudFormation do
@@ -58,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/ec2_security_group_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe CfnDsl::CloudFormationTemplate do

data/spec/aws/ecs_task_definition_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe CfnDsl::CloudFormationTemplate do

data/spec/aws/iam_managed_policy_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe CfnDsl::CloudFormationTemplate do

data/spec/aws/kms_alias_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe CfnDsl::CloudFormationTemplate do

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/logs_log_group_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe CfnDsl::CloudFormationTemplate do

data/spec/aws/nested_arrays_spec.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe CfnDsl::CloudFormationTemplate do
+  subject(:template) { described_class.new }
+
+  describe 'Nested_Arrays' do
+    it 'ensure nested arrays are not duplicated' do
+      template.DirectoryService_SimpleAD(:Test) do
+        VpcSettings do
+          SubnetId %w[subnet-a subnet-b]
+        end
+      end
+
+      expect(template.to_json).to include('"SubnetIds":["subnet-a","subnet-b"]}')
+      expect(template.to_json).not_to include('"SubnetIds":[["subnet-a","subnet-b"],["subnet-a","subnet-b"]]')
+    end
+
+    it 'appends entries with multiple invocations' do
+      template.DirectoryService_SimpleAD(:Test) do
+        VpcSettings do
+          SubnetId 'subnet-a'
+          SubnetId 'subnet-b'
+        end
+      end
+
+      expect(template.to_json).to include('"SubnetIds":["subnet-a","subnet-b"]}')
+    end
+
+    it 'appends entries with multiple array invocations' do
+      template.DirectoryService_SimpleAD(:Test) do
+        VpcSettings do
+          SubnetId %w[subnet-a subnet-b]
+          SubnetId %w[subnet-c subnet-d]
+        end
+      end
+
+      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