cfndsl 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c11f50695d1e13909473489585ada3f4f3e82817d1b79819c26cc3301dd74dc2
-  data.tar.gz: f944c74fdb59b4a52677a7816a4e65b97ad39ba8046124cbafeda3fe311a7304
+  metadata.gz: 903e5bbbe4c6bf5e02d3b3a9d6ca8582c0e2836d136347bbe7afd6baf7b2b4d5
+  data.tar.gz: cd8e5b739f8c2ef469cfa67a17ec90ab736aab0381e69f65b2fd9d7ad1a1e460
 SHA512:
-  metadata.gz: ff62869d9f35a74c25298669cfb3c36a1b9512a4b30991d4e374278eb6bbde19292f20c31fd079a6751b6db71728c4501f425b45f37350750382aec5f54b9dbf
-  data.tar.gz: a2db5440ca6d3dfce93f8cbc9cfc92bf2c98be149cd63476d6895bcb93e310f0b728a6dc3a90bc342b7915bd0b9a1643a1b6e6027ec4ec5097564f209e94d62c
+  metadata.gz: 023716cdcc14ff56fac40cfd7851ffb706969886147b42fe9ba3d1b2dee0749c1e819bb8507a4e3671549d15edb426c8022e80e00c90933cacc8ffbfc2ae8967
+  data.tar.gz: 12f33663d5de5405f109e7ad95d0b0235b35e19513af12081fb175887a5f86b0ae6652d3c3cd44415dce67a30dcebd309b41e82d091119eea1939fdaf5e496f0

data/CHANGELOG.md

@@ -1,8 +1,36 @@
 # Changelog
 
-## [1.1.1](https://github.com/cfndsl/cfndsl/tree/1.1.1) (2020-06-02)
+## [1.2.0](https://github.com/cfndsl/cfndsl/tree/1.2.0) (2020-07-30)
 
-[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v1.1.0...1.1.1)
+[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v1.1.1...1.2.0)
+
+**Implemented enhancements:**
+
+- Support for Fn::EachMemberEquals, Fn::EachMemberIn, Fn::RefAll, Fn::ValueOf , Fn::ValueOfAll  [\#250](https://github.com/cfndsl/cfndsl/issues/250)
+- Handle Serialization Generically [\#248](https://github.com/cfndsl/cfndsl/issues/248)
+- Clarify Functions [\#232](https://github.com/cfndsl/cfndsl/issues/232)
+- Support for rendering nested stacks [\#118](https://github.com/cfndsl/cfndsl/issues/118)
+- Config driven template generation [\#117](https://github.com/cfndsl/cfndsl/issues/117)
+- Unintended side effectos of PR \#64 - Need better error messages for ambiguous resources. [\#68](https://github.com/cfndsl/cfndsl/issues/68)
+- DependsOn should be constructive [\#63](https://github.com/cfndsl/cfndsl/issues/63)
+
+**Closed issues:**
+
+- SecurityGroupIngress is always an array - 1.1.1 [\#460](https://github.com/cfndsl/cfndsl/issues/460)
+- CloudFrontOriginAccessIdentity is an undefined method [\#448](https://github.com/cfndsl/cfndsl/issues/448)
+- Suggested way of splitting code to multiple files? [\#259](https://github.com/cfndsl/cfndsl/issues/259)
+- Move AWS Types to ruby Contracts for better and more flexible validation? [\#222](https://github.com/cfndsl/cfndsl/issues/222)
+
+**Merged pull requests:**
+
+- Support composeable DependsOn [\#465](https://github.com/cfndsl/cfndsl/pull/465) ([lwoggardner](https://github.com/lwoggardner))
+- test workaround for \#460 [\#463](https://github.com/cfndsl/cfndsl/pull/463) ([lwoggardner](https://github.com/lwoggardner))
+- Bring up to date [\#462](https://github.com/cfndsl/cfndsl/pull/462) ([lwoggardner](https://github.com/lwoggardner))
+- Update cfndsl raison d'être [\#461](https://github.com/cfndsl/cfndsl/pull/461) ([lwoggardner](https://github.com/lwoggardner))
+
+## [v1.1.1](https://github.com/cfndsl/cfndsl/tree/v1.1.1) (2020-06-02)
+
+[Full Changelog](https://github.com/cfndsl/cfndsl/compare/v1.1.0...v1.1.1)
 
 **Merged pull requests:**
 
@@ -950,10 +978,6 @@
 
 [Full Changelog](https://github.com/cfndsl/cfndsl/compare/v0.8.0...v0.8.1)
 
-**Implemented enhancements:**
-
-- Use as\_json instead of to\_json [\#157](https://github.com/cfndsl/cfndsl/pull/157) ([johnf](https://github.com/johnf))
-
 **Merged pull requests:**
 
 - Add in Route53 Health Check Tags as a type [\#185](https://github.com/cfndsl/cfndsl/pull/185) ([gergnz](https://github.com/gergnz))

data/README.md

@@ -6,21 +6,19 @@ cfndsl
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cfndsl/cfndsl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Join the chat at https://gitter.im/cfndsl/cfndsl](https://badges.gitter.im/cfndsl/cfndsl.svg)](https://gitter.im/cfndsl/cfndsl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 [AWS Cloudformation](http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/GettingStarted.html) templates are an incredibly powerful way to build
-sets of resources in Amazon's AWS environment. Unfortunately, because
-they are specified in JSON, they are also difficult to write and
-maintain:
+sets of resources in Amazon's AWS environment.
+Unfortunately, because they are specified in JSON or YAML, they are also difficult to write and maintain:
 
-* JSON does not allow comments
+* JSON does not allow comments, although CloudFormation now supports YAML
 
-* All structures are JSON, so it is sometimes easy for a person
-  reading a template to get lost.
+* JSON/YAML templates do not allow re-usable logic
 
-* References and internal functions have a particularly unpleasant syntax.
+* It is easy for a person reading a template to miss the association and dependencies between entries
 
+* References and internal functions have a particularly unpleasant syntax.
 
-The cnfdsl gem provides a simple DSL that allows you to write equivalent
-templates in a more friendly language and generate the correct json
-templates by running ruby.
+The cnfdsl gem provides a DSL that allows you to write templates using friendly Ruby logic to generate and validate
+  cloudformation templates.
 
 ## Getting Started
 

data/Rakefile

@@ -73,6 +73,8 @@ task :bump, :type do |_, args|
 
   GitHubChangelogGenerator::RakeTask.new :changelog do |config|
     config.future_release = version
+    config.user = 'cfndsl'
+    config.project = 'cfndsl'
   end
 
   puts "Bumping gem from version #{CfnDsl::VERSION} to #{version} as a '#{type.capitalize}' release"

data/lib/cfndsl/aws/patches/500_BadTagsv16.2.0_patch.json

@@ -0,0 +1,23 @@
+{
+  "broken": "16.2.0",
+  "ResourceTypes": {
+    "AWS::IoT::ProvisioningTemplate": {
+      "patch": {
+        "operations": [
+          {
+            "op": "replace",
+            "path": "/Properties/Tags",
+            "value": {
+              "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-provisioningtemplate.html#cfn-iot-provisioningtemplate-tags",
+              "UpdateType": "Mutable",
+              "Required": false,
+              "Type": "List",
+              "ItemType": "Tag"
+            }
+          }
+        ]
+      }
+    }
+  }
+}
+

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

@@ -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/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, :UpdateReplacePolicy, :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.1.1'
+  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/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

@@ -64,6 +64,7 @@ describe CfnDsl::CloudFormationTemplate do
         tr = subject.Resource(:TestResource)
         tr.Type('Custom-TestType')
         tr.DependsOn(:TestResource2)
+        tr.DependsOn(:TestResource2)
 
         t2 = subject.Resource('TestResource2')
         t2.Type('Custom-TestType')

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.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Steven Jack
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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
@@ -191,8 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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