cfndsl 1.0.5 → 1.3.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/globals.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'version'
+require 'fileutils'
 
 # Global variables to adjust CfnDsl behavior
 module CfnDsl

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
@@ -136,12 +136,13 @@ module CfnDsl
       check_names
       hash = {}
       instance_variables.each do |var|
-        name = var[1..-1]
+        name = var[1..]
 
-        if name =~ /^__/
+        case name
+        when /^__/
           # if a variable starts with double underscore, strip one off
-          name = name[1..-1]
-        elsif name =~ /^_/
+          name = name[1..]
+        when /^_/
           # Hide variables that start with single underscore
           name = nil
         end
@@ -169,7 +170,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 = {
@@ -83,7 +83,6 @@ module CfnDsl
         resource_name
       end
 
-      # rubocop:disable Metrics/PerceivedComplexity
       def create_array_property_def(resource, pname, pclass, info)
         singular_name = CfnDsl::Plurals.singularize pname
         plural_name = singular_name == pname ? CfnDsl::Plurals.pluralize(pname) : pname
@@ -111,7 +110,6 @@ module CfnDsl
         # Singular form understands concatenation and Fn::If property
         create_singular_property_def(resource, pname, pclass, singular_name) if singular_name
       end
-      # rubocop:enable Metrics/PerceivedComplexity
 
       def create_resource_accessor(accessor, resource, type)
         class_eval do
@@ -245,7 +243,7 @@ module CfnDsl
       end
     end
 
-    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/CyclomaticComplexity
     def _check_refs(container_name, method, source_containers)
       container = instance_variable_get("@#{container_name}s")
       return [] unless container
@@ -279,7 +277,7 @@ module CfnDsl
 
       invalids
     end
-    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def validate
       errors = check_refs || []

data/lib/cfndsl/plurals.rb

@@ -20,7 +20,7 @@ module CfnDsl
     @singles = @plurals.invert
 
     def pluralize(name)
-      @plurals.fetch(name.to_s) { |key| key + 's' }
+      @plurals.fetch(name.to_s) { |key| "#{key}s" }
     end
 
     def singularize(name)
@@ -29,7 +29,7 @@ module CfnDsl
         when /List$/
           key[0..-5]
         when /ies$/
-          key[0..-4] + 'y'
+          "#{key[0..-4]}y"
         when /s$/
           key[0..-2]
         else

data/lib/cfndsl/rake_task.rb

@@ -79,7 +79,7 @@ module CfnDsl
     #    then any existing file is considered sufficient, and 'latest' is the version used for downloading
     #
     # @todo Add capability to provide a user spec/patches dir
-    def specification(name: nil, file:, version: nil)
+    def specification(file:, name: nil, version: nil)
       if name
         desc 'Update Resource Specification' unless ::Rake.application.last_description
         task name, [:cfn_spec_version] => file
@@ -218,7 +218,7 @@ module CfnDsl
     end
 
     def verbose
-      (Rake.verbose? || cfndsl_opts&.fetch(:verbose, false)) && STDERR
+      (Rake.verbose? || cfndsl_opts&.fetch(:verbose, false)) && $stderr
     end
 
     def generate(opts)
@@ -238,8 +238,8 @@ module CfnDsl
       verbose&.puts("Writing to #{type}")
     end
 
-    def outputter(opts)
-      opts[:output].nil? ? yield(STDOUT) : file_output(opts[:output]) { |f| yield f }
+    def outputter(opts, &block)
+      opts[:output].nil? ? yield($stdout) : file_output(opts[:output], &block)
     end
 
     def model(filename)
@@ -253,8 +253,8 @@ module CfnDsl
       cfndsl_opts.fetch(:extras, [])
     end
 
-    def file_output(path)
-      File.open(File.expand_path(path), 'w') { |f| yield f }
+    def file_output(path, &block)
+      File.open(File.expand_path(path), 'w', &block)
     end
   end
   # rubocop:enable Metrics/ClassLength

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/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/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!
@@ -118,14 +117,14 @@ module CfnDsl
       end
 
       filename = File.expand_path(ARGV[0])
-      verbose = options[:verbose] && STDERR
+      verbose = options[:verbose] && $stderr
 
       verbose.puts "Using specification file #{CfnDsl.specification_file}" if verbose
 
       require_relative 'cloudformation'
       model = CfnDsl.eval_file_with_extras(filename, options[:extras], verbose)
 
-      output = STDOUT
+      output = $stdout
       if options[:output] != '-'
         verbose.puts("Writing to #{options[:output]}") if verbose
         output = File.open(File.expand_path(options[:output]), 'w')
@@ -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/specification.rb

@@ -70,20 +70,18 @@ module CfnDsl
         next unless %w[ResourceTypes PropertyTypes].include?(top_level_type)
 
         patches.each_pair do |property_type_name, patch_details|
-          begin
-            applies_to = spec[top_level_type]
-            unless property_type_name == 'patch'
-              # Patch applies within a specific property type
-              applies_to = applies_to[property_type_name]
-              patch_details = patch_details['patch']
-            end
-
-            Hana::Patch.new(patch_details['operations']).apply(applies_to) if patch_required?(patch_details)
-          rescue Hana::Patch::MissingTargetException => e
-            raise "Failed specification patch #{top_level_type} #{property_type_name} from #{from_file}" if fail_patches
-
-            warn "Ignoring failed specification patch #{top_level_type} #{property_type_name} from #{from_file} - #{e.class.name}:#{e.message}"
+          applies_to = spec[top_level_type]
+          unless property_type_name == 'patch'
+            # Patch applies within a specific property type
+            applies_to = applies_to[property_type_name]
+            patch_details = patch_details['patch']
           end
+
+          Hana::Patch.new(patch_details['operations']).apply(applies_to) if patch_required?(patch_details)
+        rescue Hana::Patch::MissingTargetException => e
+          raise "Failed specification patch #{top_level_type} #{property_type_name} from #{from_file}" if fail_patches
+
+          warn "Ignoring failed specification patch #{top_level_type} #{property_type_name} from #{from_file} - #{e.class.name}:#{e.message}"
         end
       end
     end

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/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|
@@ -43,7 +43,8 @@ module CfnDsl
             # resource name for uniqueness and connection
             property_type = resource_name.split('::').join + property_info['Type']
           else
-            warn "could not extract resource type from #{resource_name}"
+            warn "could not extract resource type for property #{property_name} from #{resource_name}, assuming Json"
+            property_type = 'Json'
           end
           extracted[property_name] = property_type
           extracted
@@ -52,9 +53,9 @@ module CfnDsl
         resources
       end
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize, 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',
@@ -99,6 +100,8 @@ module CfnDsl
               nested_prop_type =
                 if nested_prop_info['ItemType'] == 'Tag'
                   ['Tag']
+                elsif (nested_prop_info['ItemType'] == 'Json') && (nested_prop_info['Type'] == 'List')
+                  ['Json']
                 else
                   Array(root_resource_name + nested_prop_info['ItemType'])
                 end
@@ -106,7 +109,8 @@ module CfnDsl
             elsif nested_prop_info['Type']
               nested_prop_type = root_resource_name + nested_prop_info['Type']
             else
-              warn "could not extract property type from #{property_name}"
+              warn "could not extract property type for #{nested_prop_name} from #{property_name}, assuming Json"
+              nested_prop_type = 'Json'
               p nested_prop_info
             end
             extracted[nested_prop_name] = nested_prop_type
@@ -117,9 +121,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.5'
+  VERSION = '1.3.0'
 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')