cfndsl 1.0.4 → 1.2.0

data/lib/cfndsl/cfnlego/cloudformation.rb

@@ -14,7 +14,7 @@ module Cfnlego
     end
 
     def render
-      erb = ERB.new(File.read(TEMPLATE), nil, '-')
+      erb = ERB.new(File.read(TEMPLATE), trim_mode: '-')
       erb.result(binding)
     end
   end

data/lib/cfndsl/cloudformation.rb

@@ -43,9 +43,10 @@ module CfnDsl
         params.load_file file
       when :raw
         file_parts = file.split('=')
-        if file_parts[1].downcase == 'true'
+        case file_parts[1].downcase
+        when 'true'
           params.set_param(file_parts[0], true)
-        elsif file_parts[1].downcase == 'false'
+        when 'false'
           params.set_param(file_parts[0], false)
         else
           params.set_param(*file.split('='))

data/lib/cfndsl/jsonable.rb

@@ -87,7 +87,7 @@ module CfnDsl
     def FnSub(string, substitutions = nil)
       raise ArgumentError, 'The first argument passed to Fn::Sub must be a string' unless string.is_a? String
 
-      refs = string.scan(FN_SUB_SCANNER).map(&:first)
+      refs = string.scan(FN_SUB_SCANNER).map(&:first).map { |r| r.split('.', 2).first }
 
       if substitutions
         raise ArgumentError, 'The second argument passed to Fn::Sub must be a Hash' unless substitutions.is_a? Hash
@@ -169,7 +169,7 @@ module CfnDsl
     def check_names
       return if instance_variable_get('@Resources').nil?
 
-      instance_variable_get('@Resources').keys.each do |name|
+      instance_variable_get('@Resources').each_key do |name|
         next unless name !~ /\A\p{Alnum}+\z/
 
         warn "Resource name: #{name} is invalid"

data/lib/cfndsl/orchestration_template.rb

@@ -22,7 +22,7 @@ module CfnDsl
   # Handles the overall template object
   # rubocop:disable Metrics/ClassLength
   class OrchestrationTemplate < JSONable
-    dsl_attr_setter :AWSTemplateFormatVersion, :Description, :Metadata, :Transform
+    dsl_attr_setter :AWSTemplateFormatVersion, :Description, :Metadata, :Transform, :Hooks
     dsl_content_object :Condition, :Parameter, :Output, :Resource, :Mapping, :Rule
 
     GLOBAL_REFS = {
@@ -245,7 +245,7 @@ module CfnDsl
       end
     end
 
-    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
     def _check_refs(container_name, method, source_containers)
       container = instance_variable_get("@#{container_name}s")
       return [] unless container
@@ -279,7 +279,7 @@ module CfnDsl
 
       invalids
     end
-    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
     def validate
       errors = check_refs || []

data/lib/cfndsl/rake_task.rb

@@ -135,7 +135,8 @@ module CfnDsl
     # @param [Hash] yaml_opts, other options to pass to YAML generator
     def yaml(name:, files:, pathmap:, extras: [], **yaml_opts)
       generate_model_tasks(name: name, files: files, pathmap: pathmap, extras: extras) do |model, f|
-        YAML.dump(model, f, **yaml_opts)
+        simple_model = JSON.parse(model.to_json) # convert model to a simple ruby object to avoid yaml tags
+        YAML.dump(simple_model, f, **yaml_opts)
       end
       self
     end
@@ -189,7 +190,7 @@ module CfnDsl
       files.each do |source|
         matched_extras = build_extras_filelist(source, extras)
 
-        file source.pathmap(pathmap) => [source, :load_spec_types, matched_extras] do |task|
+        file source.pathmap(pathmap) => [source, :load_spec_types, *matched_extras] do |task|
           eval_extras = matched_extras.map { |e| [:yaml, e] } # eval treats yaml and json same
           puts "Generating Cloudformation for #{source} to #{task.name}"
           model = CfnDsl.eval_file_with_extras(source, eval_extras, verbose)

data/lib/cfndsl/ref_check.rb

@@ -10,7 +10,7 @@ module RefCheck
   end
 
   # Build up a set of references.
-  # rubocop:disable Metrics/PerceivedComplexity
+  # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
   def build_references(refs = [], origin = nil, method = :all_refs)
     if respond_to?(method)
       send(method).each do |ref|
@@ -30,7 +30,7 @@ module RefCheck
 
     refs
   end
-  # rubocop:enable Metrics/PerceivedComplexity
+  # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
   def ref_children
     []

data/lib/cfndsl/resources.rb

@@ -5,7 +5,7 @@ require_relative 'jsonable'
 module CfnDsl
   # Handles Resource objects
   class ResourceDefinition < JSONable
-    dsl_attr_setter :Type, :DependsOn, :DeletionPolicy, :Condition, :Metadata
+    dsl_attr_setter :Type, :UpdateReplacePolicy, :DeletionPolicy, :Condition, :Metadata
     dsl_content_object :Property, :UpdatePolicy, :CreationPolicy
 
     def add_tag(name, value, propagate = nil)
@@ -16,6 +16,23 @@ module CfnDsl
       end
     end
 
+    # DependsOn can be a single value or a list
+    def DependsOn(value)
+      case @DependsOn
+      when nil
+        @DependsOn = value
+      when Array
+        @DependsOn << value
+      else
+        @DependsOn = [@DependsOn, value]
+      end
+      if @DependsOn.is_a?(Array)
+        @DependsOn.flatten!
+        @DependsOn.uniq!
+      end
+      @DependsOn
+    end
+
     def condition_refs
       [@Condition].flatten.compact.map(&:to_s)
     end

data/lib/cfndsl/runner.rb

@@ -7,7 +7,6 @@ require_relative 'globals'
 
 module CfnDsl
   # Runner class to handle commandline invocation
-  # rubocop:disable Metrics/ClassLength
   class Runner
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
     def self.invoke!
@@ -143,4 +142,3 @@ module CfnDsl
   end
   # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 end
-# rubocop:enable Metrics/ClassLength

data/lib/cfndsl/types.rb

@@ -16,7 +16,7 @@ module CfnDsl
       { 'Resources' => resources, 'Types' => types, 'Version' => spec.version, 'File' => spec.file }
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/CyclomaticComplexity
     def self.extract_resources(spec)
       spec.each_with_object({}) do |(resource_name, resource_info), resources|
         properties = resource_info['Properties'].each_with_object({}) do |(property_name, property_info), extracted|
@@ -54,7 +54,7 @@ module CfnDsl
     end
     # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/MethodLength
 
-    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/MethodLength
     def self.extract_types(spec)
       primitive_types = {
         'String' => 'String',
@@ -117,9 +117,9 @@ module CfnDsl
         types
       end
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/MethodLength
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity
     def self.included(type_def)
       types_list = extract_from_resource_spec
       type_def.const_set('Types_Internal', types_list)

data/lib/cfndsl/version.rb

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

data/lib/deep_merge/core.rb

@@ -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/t1-extra.yaml

@@ -0,0 +1 @@
+description: 5 machine cluster

data/sample/t1.yaml

@@ -1,2 +1 @@
-description: 5 machine cluster
 machines: 5

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

@@ -12,6 +12,7 @@ describe Cfnlego do
       output << '# http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-domain'
       output << "\n    InstanceId String # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-instanceid"
       output << "\n    PublicIpv4Pool String # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-publicipv4pool"
+      output << "\n    Tags [List] # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-eip.html#cfn-ec2-eip-tags"
       output << "\n  end\nend\n"
       expect(template).to eq output
     end

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.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Steven Jack
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,8 @@ files:
 - lib/cfndsl/aws/patches/000_sam.spec.json
 - 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
@@ -128,6 +130,7 @@ files:
 - sample/import.rb
 - sample/lambda.rb
 - sample/s3.rb
+- sample/t1-extra.yaml
 - sample/t1.rb
 - sample/t1.yaml
 - sample/vpc_example.rb
@@ -182,15 +185,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 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