cfndsl 0.10.2 → 0.11.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTg3ZjhiNWQyYWZjY2Q5NmJiMWYzMGY4NjAzMmYwMTY1YTBjYjdkNg==
+    N2U4ZWRiYzQ2MTQ2OTAzMGFlNzM0YmY3N2Q2YWVmNDEzNDk3M2JiOQ==
   data.tar.gz: !binary |-
-    ZGI5NmUyMDczZmI3ZTE3NTI0ZjBiZTgxYTEzNmVjNWZlZDE2ZTdmYQ==
+    MzczODNhYWYzOWZkNjMyZTYyZDQyNTExMmE4OGY3NDk3YTk1ZDVhOA==
 SHA512:
   metadata.gz: !binary |-
-    NmQ2NDBmNTRjYjU2NWJjNzhmMjQwM2QxN2ZhMjBlMDZhNTk1YTllMDFiN2E0
-    MDRmOTIzMzcyZWQxMTlhOWUwZTYyMDU3YWY2MzQ0MzY5ODBkZTg1YTI2NGMx
-    ODQ1ZjBiYWMxMzRiOWVmMzAyZjFkZGI5OTFjODhhZGU4NGFmMWE=
+    ODc4ODAyNjQ2NDYzMTBjMWIzYjk5NTMzYWJjMWRlZTI2MjcxN2UzMzNmZTVh
+    NmE5ZjY3MzI2NmUxMGZhZjE0ZTZhOTM4NDZjZmM1NGI5ZTFiMjdkY2E4MWVm
+    ZDU0MWE3MzhkZjU2ZWZjMTA2MWM1ZTM4NjM4NGIxN2EwMTNkNmU=
   data.tar.gz: !binary |-
-    ZDBjZTVhYjdjNDFmNzAwYzcxMDdjOWE2M2JhYTliOWU1MWU5OWRmNTkzMTBm
-    NjA0MzM5ZjE2YjMxNTI4MWU0NmJmMDUyZTliM2E3ZjAyYWQ5MDNmMmI0NzE0
-    NjZjZjcxMWVhZWQyNjUyNmNlMjIxZmQwMzJiZTNmODA2MDUyYTg=
+    MDI2OThlM2M4NDQ3Njg4NmQ0ZjY2ODZlYjgxMTUzYzA3MGNmZjgzNWE4YjNk
+    MjczOTQwOGI4MjBjYTUyN2IyYTIyNDhlZGE0NTVmNDViNjRmZDA1NjhhY2Ix
+    ZTUyMzM5MjdmYzg1NWRlOTZjNTdkMmVjNWYyMTBhODk1MWM4MjE=

data/README.md

@@ -85,6 +85,333 @@ chris@raspberrypi:~/git/cfndsl$ cfndsl test.rb | json_pp
 *Aside: that is correct - a significant amount of the development for
 this gem was done on a [Raspberry Pi](http://www.raspberrypi.org).*
 
+## Syntax
+
+`cfndsl` comes with a number of helper methods defined on _each_ resource and/or the stack as a whole.
+
+### Template Metadata
+
+Metadata is a special template section described [here](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html). The argument supplied must be JSON-able. Some CloudFormation features reference special keys if included in the `Metadata`, check the AWS documentation for specifics.
+
+```ruby
+CloudFormation do
+  Metadata(foo: 'bar')
+
+  EC2_Instance(:myInstance) do
+    ImageId 'ami-12345678'
+    Type 't1.micro'
+  end
+end
+```
+
+### Template Parameters
+
+At a bare minumum, parameters need a name, and default to having Type `String`. Specify the parameter in the singular, not plural:
+
+```ruby
+CloudFormation do
+  Parameter 'foo'
+end
+```
+
+```json
+{
+  "AWSTemplateFormatVersion": "2010-09-09",
+  "Parameters": {
+    "foo": {
+      "Type": "String"
+    }
+  }
+}
+```
+
+However, they can accept all of the following additional keys per the [documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html):
+
+```ruby
+Parameter('foo') do
+  Description           'This is a sample parameter definition'
+  Type                  'String'
+  Default               'foo'
+  NoEcho                true
+  AllowedValues         %w(foo bar)
+  AllowedPattern        '/pattern/'
+  MaxLength             5
+  MinLength             3
+  MaxValue              10
+  MinValue              2
+  ConstraintDescription 'The error message printed when a parameter outside the constraints is given'
+end
+```
+
+Parameters can be referenced later in your template:
+
+```ruby
+EC2_Instance(:myInstance) do
+  InstanceType 'm3.xlarge'
+  UserData Ref('foo')
+end
+```
+
+### Template Mappings
+
+[Mappings](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html) are a hash-based lookup for your template. They can be specified in the singular or plural.
+
+```ruby
+CloudFormation do
+  Mapping('foo', letters: { a: 'a', b: 'b' }, numbers: { 1: 1, 2: 2 })
+end
+```
+
+```json
+{
+  "AWSTemplateFormatVersion": "2010-09-09",
+    "Mappings": {
+      "foo": {
+	"letters": {
+	  "a": "a",
+	  "b": "b"
+	},
+	"numbers": {
+	  "one": 1,
+	  "two": 2
+	}
+      }
+    }
+  }
+}
+```
+
+You can then reference them later in your template using the `FnFindInMap` method:
+
+```ruby
+EC2_Instance(:myInstance) do
+  InstanceType 'm3.xlarge'
+  UserData FnFindInMap('foo', :numbers, :one)
+end
+```
+
+### Template Outputs
+
+Outputs are declared one at a time and must be given a name and a value at a minimum, description is optional. Values are most typically obtained from other resources using `Ref` or `FnGetAtt`:
+
+```ruby
+CloudFormation do
+  EC2_Instance(:myInstance) do
+    ImageId 'ami-12345678'
+    Type 't1.micro'
+  end
+
+  Output(:myInstanceId) do
+    Description 'My instance Id'
+    Value Ref(:myInstance)
+  end
+end
+```
+
+```json
+{
+  "AWSTemplateFormatVersion": "2010-09-09",
+  "Resources": {
+    "myInstance": {
+      "Properties": {
+	"ImageId": "ami-12345678"
+      },
+      "Type": "AWS::EC2::Instance"
+    }
+  },
+  "Outputs": {
+    "myInstanceId": {
+      "Description": "My instance Id",
+      "Value": {
+	"Ref": "myInstance"
+      }
+    }
+  }
+}
+```
+
+### Template Conditions
+
+Conditions must be created with statements in three [sections](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html): a variable entry as a `Parameter`, a template-level `Condition` that holds the logic based upon the value of that `Parameter`, and a resource-level `Condition` that references the template-level one by logical id.
+
+```ruby
+CloudFormation do
+  Parameter(:environment) do
+    Default 'development'
+    AllowedValues %w(production development)
+  end
+
+  Condition(:createResource, FnEquals(Ref(:environment), 'production'))
+
+  EC2_Instance(:myInstance) do
+    Condition :createResource
+    ImageId 'ami-12345678'
+    Type 't1.micro'
+  end
+end
+```
+
+```json
+{
+  "AWSTemplateFormatVersion": "2010-09-09",
+  "Parameters": {
+    "environment": {
+      "Type": "String",
+      "Default": "development",
+      "AllowedValues": [
+	"production",
+	"development"
+      ]
+    }
+  },
+  "Conditions": {
+    "createResource": {
+      "Fn::Equals": [
+	{
+	  "Ref": "environment"
+	},
+	"production"
+      ]
+    }
+  },
+  "Resources": {
+    "myInstance": {
+      "Condition": "createResource",
+      "Properties": {
+	"ImageId": "ami-12345678"
+      },
+      "Type": "AWS::EC2::Instance"
+    }
+  }
+}
+```
+
+### Template Resources
+
+Cfndsl creates accessor methods for all of the resources listed [here](https://github.com/stevenjack/cfndsl/blob/master/lib/cfndsl/aws/types.yaml) and [here](https://github.com/stevenjack/cfndsl/blob/master/lib/cfndsl/os/types.yaml). If a resource is missing, or if you prefer to explicitly enter a resource in a template, you can do so. Keep in mind that since you are using the generic `Resource` class, you will also need to explicitly set the `Type` and that you no longer have access to the helper methods defined on that particular class, so you will have to use the `Property` method to set them.
+
+```ruby
+CloudFormation do
+  Resource(:myInstance) do
+    Type 'AWS::EC2::Instance'
+    Property('ImageId', 'ami-12345678')
+    Property('Type', 't1.micro')
+  end
+
+  # Will generate the same json as this
+  #
+  # EC2_Instance(:myInstance) do
+  #   ImageId 'ami-12345678'
+  #   Type 't1.micro'
+  # end
+end
+```
+
+```json
+{
+  "AWSTemplateFormatVersion": "2010-09-09",
+  "Resources": {
+    "myInstance": {
+      "Type": "AWS::ApiGateway::Resource",
+      "Properties": {
+	"ImageId": "ami-12345678",
+	"Type": "t1.micro"
+      }
+    }
+  }
+}
+```
+
+### Resource Types
+
+When using the generic `Resource` method, rather than the dsl methods, specify the type of resource using `Type` amd the properties using `Property`. See [Template Resources](#template-resources) for an example.
+
+### Resource Conditions
+
+Resource conditions are specified singularly, referencing a template-level condition by logical id. See [Template Conditions](#template-conditions) for an example.
+
+### Resource DependsOn
+
+Resources can depend upon other resources explicitly using `DependsOn`. It accepts one or more logical ids.
+
+```ruby
+CloudFormation do
+  EC2_Instance(:database) do
+    ImageId 'ami-12345678'
+    Type 't1.micro'
+  end
+
+  EC2_Instance(:webserver) do
+    DependsOn :database
+    ImageId 'ami-12345678'
+    Type 't1.micro'
+  end
+end
+```
+
+```json
+{
+  "AWSTemplateFormatVersion": "2010-09-09",
+  "Resources": {
+    "database": {
+      "Properties": {
+	"ImageId": "ami-12345678"
+      },
+      "Type": "AWS::EC2::Instance"
+    },
+    "webserver": {
+      "Properties": {
+	"ImageId": "ami-12345678"
+      },
+      "Type": "AWS::EC2::Instance",
+      "DependsOn": "database"
+    }
+  }
+}
+```
+
+### Resource DeletionPolicy
+
+Resources can have [deletion policies](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) associated with them. Specify them one per resource as an attribute:
+
+```ruby
+CloudFormation do
+  EC2_Instance(:myInstance) do
+    DeletionPolicy 'Retain'
+    ImageId 'ami-12345678'
+    Type 't1.micro'
+  end
+end
+```
+
+### Resource Metadata
+
+You can attach arbitrary [metadata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html) as an attribute. Arguments provided must be able to be JSON-ified:
+
+```ruby
+CloudFormation do
+  EC2_Instance(:myInstance) do
+    Metadata(foo: 'bar')
+    ImageId 'ami-12345678'
+    Type 't1.micro'
+  end
+end
+```
+
+### Resource CreationPolicy/UpdatePolicy
+
+These attributes are only usable on particular [resources](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html). The name of the attribute is not arbitrary, it must match the policy name you are trying to attach. Different policies have different parameters.
+
+```ruby
+CloudFormation do
+  EC2_Instance(:myInstance) do
+    ImageId 'ami-12345678'
+    Type 't1.micro'
+    CreationPolicy(:ResourceSignal, { Count: 1, Timeout: 'PT1M' })
+  end
+end
+```
+
 ## Samples
 
 There is a more detailed example in the samples directory. The file

data/lib/cfndsl.rb

@@ -11,7 +11,6 @@ require 'cfndsl/creation_policy'
 require 'cfndsl/conditions'
 require 'cfndsl/mappings'
 require 'cfndsl/resources'
-require 'cfndsl/metadata'
 require 'cfndsl/parameters'
 require 'cfndsl/outputs'
 require 'cfndsl/aws/cloud_formation_template'

data/lib/cfndsl/orchestration_template.rb

@@ -7,13 +7,9 @@ module CfnDsl
   # Handles the overall template object
   # rubocop:disable Metrics/ClassLength
   class OrchestrationTemplate < JSONable
-    dsl_attr_setter :AWSTemplateFormatVersion, :Description
+    dsl_attr_setter :AWSTemplateFormatVersion, :Description, :Metadata
     dsl_content_object :Condition, :Parameter, :Output, :Resource, :Mapping
 
-    def initialize
-      @AWSTemplateFormatVersion = '2010-09-09'
-    end
-
     GlobalRefs = {
       'AWS::NotificationARNs' => 1,
       'AWS::Region' => 1,
@@ -23,6 +19,99 @@ module CfnDsl
       'AWS::NoValue' => 1
     }.freeze
 
+    class << self
+      def create_types
+        accessors = {}
+        types_mapping = {}
+        template_types['Resources'].each_pair do |resource, info|
+          resource_name = create_resource_def(resource, info)
+          parts = resource.split('::')
+          until parts.empty?
+            break if parts.first == 'Resource' # Don't allow us to define Resource as different method
+            abreve_name = parts.join('_')
+            if accessors.key? abreve_name
+              accessors.delete abreve_name # Delete potentially ambiguous names
+            else
+              accessors[abreve_name] = type_module.const_get resource_name
+              types_mapping[abreve_name] = resource
+            end
+            parts.shift
+          end
+        end
+        accessors.each_pair { |acc, res| create_resource_accessor(acc, res, types_mapping[acc]) }
+      end
+
+      def create_resource_def(name, info)
+        resource = Class.new ResourceDefinition
+        resource_name = name.gsub(/::/, '_')
+        type_module.const_set(resource_name, resource)
+        info['Properties'].each_pair do |pname, ptype|
+          if ptype.is_a? Array
+            pclass = type_module.const_get ptype.first
+            create_array_property_def(resource, pname, pclass)
+          else
+            pclass = type_module.const_get ptype
+            create_property_def(resource, pname, pclass)
+          end
+        end
+        resource_name
+      end
+
+      def create_property_def(resource, pname, pclass)
+        resource.class_eval do
+          CfnDsl.method_names(pname) do |method|
+            define_method(method) do |*values, &block|
+              values.push pclass.new if values.empty?
+              @Properties ||= {}
+              @Properties[pname] = PropertyDefinition.new(*values)
+              @Properties[pname].value.instance_eval(&block) if block
+              @Properties[pname].value
+            end
+          end
+        end
+      end
+
+      def create_array_property_def(resource, pname, pclass)
+        create_property_def(resource, pname, Array)
+
+        sname = CfnDsl::Plurals.singularize pname
+
+        unless sname == pname
+          resource.class_eval do
+            CfnDsl.method_names(sname) do |method|
+              define_method(method) do |value = nil, &block|
+                @Properties ||= {}
+                @Properties[pname] ||= PropertyDefinition.new([])
+                value = pclass.new unless value
+                @Properties[pname].value.push value
+                value.instance_eval(&block) if block
+                value
+              end
+            end
+          end
+        end
+      end
+
+      def create_resource_accessor(accessor, resource, type)
+        class_eval do
+          CfnDsl.method_names(accessor) do |method|
+            define_method(method) do |name, *values, &block|
+              name = name.to_s
+              @Resources ||= {}
+              @Resources[name] ||= resource.new(*values)
+              @Resources[name].instance_eval(&block) if block
+              @Resources[name].instance_variable_set('@Type', type)
+              @Resources[name]
+            end
+          end
+        end
+      end
+    end
+
+    def initialize
+      @AWSTemplateFormatVersion = '2010-09-09'
+    end
+
     # rubocop:disable Metrics/PerceivedComplexity
     def valid_ref?(ref, origin = nil)
       ref = ref.to_s
@@ -42,13 +131,11 @@ module CfnDsl
 
     def check_refs
       invalids = check_resource_refs + check_output_refs
-
-      invalids.empty? ? nil : invalids
+      invalids unless invalids.empty?
     end
 
     def check_resource_refs
       invalids = []
-
       @_resource_refs = {}
       if @Resources
         @Resources.keys.each do |resource|
@@ -60,13 +147,11 @@ module CfnDsl
           end
         end
       end
-
       invalids
     end
 
     def check_output_refs
       invalids = []
-
       output_refs = {}
       if @Outputs
         @Outputs.keys.each do |resource|
@@ -78,103 +163,8 @@ module CfnDsl
           end
         end
       end
-
       invalids
     end
-
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
-    def self.create_types
-      names = {}
-      nametypes = {}
-      template_types['Resources'].each_pair do |name, type|
-        # Subclass ResourceDefintion and generate property methods
-        klass = Class.new(CfnDsl::ResourceDefinition)
-        klassname = name.split('::').join('_')
-        type_module.const_set(klassname, klass)
-        type['Properties'].each_pair do |pname, ptype|
-          if ptype.instance_of?(String)
-            create_klass = type_module.const_get(ptype)
-
-            klass.class_eval do
-              CfnDsl.method_names(pname) do |method|
-                define_method(method) do |*values, &block|
-                  values.push create_klass.new if values.empty?
-
-                  @Properties ||= {}
-                  @Properties[pname] = CfnDsl::PropertyDefinition.new(*values)
-                  @Properties[pname].value.instance_eval(&block) if block
-                  @Properties[pname].value
-                end
-              end
-            end
-          else
-            # Array version
-            klass.class_eval do
-              CfnDsl.method_names(pname) do |method|
-                define_method(method) do |*values, &block|
-                  values.push [] if values.empty?
-                  @Properties ||= {}
-                  @Properties[pname] ||= PropertyDefinition.new(*values)
-                  @Properties[pname].value.instance_eval(&block) if block
-                  @Properties[pname].value
-                end
-              end
-            end
-
-            sing_name = CfnDsl::Plurals.singularize(pname)
-            create_klass = type_module.const_get(ptype[0])
-            sing_names = sing_name == pname ? [ptype[0]] : [ptype[0], sing_name]
-
-            klass.class_eval do
-              sing_names.each do |sname|
-                CfnDsl.method_names(sname) do |method|
-                  define_method(method) do |value = nil, &block|
-                    @Properties ||= {}
-                    @Properties[pname] ||= PropertyDefinition.new([])
-                    value = create_klass.new unless value
-                    @Properties[pname].value.push value
-                    value.instance_eval(&block) if block
-                    value
-                  end
-                end
-              end
-            end
-          end
-        end
-        parts = name.split('::')
-        until parts.empty?
-          break if parts[0] == 'Resource'
-          abreve_name = parts.join('_')
-          if names.key?(abreve_name)
-            # this only happens if there is an ambiguity
-            names[abreve_name] = nil
-          else
-            names[abreve_name] = type_module.const_get(klassname)
-            nametypes[abreve_name] = name
-          end
-          parts.shift
-        end
-      end
-
-      # Define property setter methods for each of the unambiguous type names
-      names.each_pair do |typename, type|
-        next unless type
-
-        class_eval do
-          CfnDsl.method_names(typename) do |method|
-            define_method(method) do |name, *values, &block|
-              name = name.to_s
-              @Resources ||= {}
-              resource = @Resources[name] ||= type.new(*values)
-              resource.instance_eval(&block) if block
-              resource.instance_variable_set('@Type', nametypes[typename])
-              resource
-            end
-          end
-        end
-      end
-    end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
   end
   # rubocop:enable Metrics/ClassLength
 end

data/lib/cfndsl/resources.rb

@@ -1,13 +1,12 @@
 require 'cfndsl/jsonable'
-require 'cfndsl/metadata'
 require 'cfndsl/properties'
 require 'cfndsl/update_policy'
 
 module CfnDsl
   # Handles Resource objects
   class ResourceDefinition < JSONable
-    dsl_attr_setter :Type, :DependsOn, :DeletionPolicy, :Condition
-    dsl_content_object :Property, :Metadata, :UpdatePolicy, :CreationPolicy
+    dsl_attr_setter :Type, :DependsOn, :DeletionPolicy, :Condition, :Metadata
+    dsl_content_object :Property, :UpdatePolicy, :CreationPolicy
 
     def addTag(name, value, propagate = nil)
       add_tag(name, value, propagate)

data/lib/cfndsl/version.rb

@@ -1,3 +1,3 @@
 module CfnDsl
-  VERSION = '0.10.2'.freeze
+  VERSION = '0.11.0'.freeze
 end

data/spec/cloud_formation_template_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe CfnDsl::CloudFormationTemplate do
+  it_behaves_like 'an orchestration template'
+end

data/spec/heat_template_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe CfnDsl::HeatTemplate do
+  it_behaves_like 'an orchestration template'
+end

data/spec/metadata_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'Metadata' do
+  let(:template) { CfnDsl::OrchestrationTemplate.new }
+
+  it 'is settable for a template' do
+    template.Metadata(foo: 'bar')
+    expect(template.to_json).to match(/"Metadata":{"foo":"bar"}/)
+  end
+
+  it 'is settable for a resource' do
+    resource = template.Resource(:foo) { Metadata(foo: 'bar') }
+    expect(resource.to_json).to match(/"Metadata":{"foo":"bar"}/)
+  end
+end

data/spec/resources_spec.rb

@@ -1,21 +1,8 @@
 require 'spec_helper'
 
-describe CfnDsl::ResourceDefinition do
-  subject { CfnDsl::CloudFormationTemplate.new.EC2_Instance(:single_server) }
-  context '#all_refs' do
-    it 'checks that the type is AWS::EC2::Instance' do
-      expect(subject.instance_variable_get('@Type')).to eq('AWS::EC2::Instance')
-    end
-  end
-end
-
 describe CfnDsl::ResourceDefinition do
   subject { CfnDsl::CloudFormationTemplate.new.AutoScalingGroup(:web_servers) }
-  context '#all_refs' do
-    it 'checks that the type is AWS::AutoScaling::AutoScalingGroup' do
-      expect(subject.instance_variable_get('@Type')).to eq('AWS::AutoScaling::AutoScalingGroup')
-    end
-  end
+
   context '#addTag' do
     it 'is a pass-through method to add_tag' do
       expect(subject).to receive(:add_tag).with('role', 'web-server', true)

data/spec/spec_helper.rb

@@ -3,3 +3,5 @@ require 'aruba/rspec'
 
 bindir = File.expand_path('../../bin', __FILE__)
 ENV['PATH'] = [ENV['PATH'], bindir].join(':')
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }

data/spec/support/shared_examples/orchestration_template.rb

@@ -0,0 +1,97 @@
+shared_examples 'an orchestration template' do
+  context '#valid_ref?' do
+    it 'returns true if ref is global' do
+      expect(subject.valid_ref?('AWS::Region')).to eq(true)
+    end
+
+    it 'returns true if ref is a parameter' do
+      subject.Parameter(:foo)
+      expect(subject.valid_ref?(:foo)).to eq(true)
+    end
+  end
+
+  context '#check_refs' do
+    it 'returns an array of invalid refs if present' do
+      subject.EC2_Instance(:foo) { UserData Ref(:bar) }
+      expect(subject.check_refs).to_not be_empty
+    end
+
+    it 'returns nil if no invalid refs are present' do
+      subject.EC2_Instance(:foo) { UserData Ref('AWS::Region') }
+      expect(subject.check_refs).to eq(nil)
+    end
+  end
+
+  context '#check_resource_refs' do
+    it 'returns an array with an error message if invalid refs are present' do
+      subject.EC2_Instance(:foo) { UserData Ref(:bar) }
+      expect(subject.check_resource_refs).to eq(['Invalid Reference: Resource foo refers to bar'])
+    end
+
+    it 'returns an empty array ' do
+      subject.EC2_Instance(:foo) { UserData Ref('AWS::AccountId') }
+      expect(subject.check_resource_refs).to eq([])
+    end
+  end
+
+  context '#check_output_refs' do
+    it 'returns an array with an error message if invalid refs are present' do
+      subject.EC2_Instance(:foo)
+      subject.Output(:baz) { Value Ref(:bar) }
+      expect(subject.check_output_refs).to eq(['Invalid Reference: Output baz refers to bar'])
+    end
+
+    it 'returns an empty array' do
+      subject.EC2_Instance(:foo)
+      subject.Output(:baz) { Value Ref(:foo) }
+      expect(subject.check_output_refs).to eq([])
+    end
+  end
+
+  context '.create_types' do
+    it 'creates a type class for each entry' do
+      expect(described_class.type_module).to be_const_defined('AWS_EC2_Instance')
+      expect(described_class.type_module.const_get('AWS_EC2_Instance')).to be < CfnDsl::ResourceDefinition
+    end
+
+    it 'defines case-insensitive properties for each type class' do
+      ec2_instance = described_class.type_module.const_get('AWS_EC2_Instance').new
+      expect(ec2_instance).to respond_to(:imageId)
+      expect(ec2_instance).to respond_to(:ImageId)
+    end
+
+    it 'defines singular and plural methods for array properties' do
+      ec2_instance = described_class.type_module.const_get('AWS_EC2_Instance').new
+      ec2_instance.SecurityGroup(foo: 'bar')
+      singular_value = ec2_instance.instance_variable_get('@Properties')['SecurityGroups'].value
+      expect(singular_value).to eq([{ foo: 'bar' }])
+      ec2_instance = described_class.type_module.const_get('AWS_EC2_Instance').new
+      ec2_instance.SecurityGroups([{ foo: 'bar' }])
+      plural_value = ec2_instance.instance_variable_get('@Properties')['SecurityGroups'].value
+      expect(plural_value).to eq([{ foo: 'bar' }])
+    end
+
+    it 'defines accessor methods for each of the entries' do
+      expect(subject).to respond_to(:AWS_EC2_Instance)
+      expect(subject).to respond_to(:EC2_Instance)
+    end
+
+    it 'avoids ambiguous accessor methods' do
+      expect(subject).to_not respond_to(:Instance)
+    end
+
+    it 'avoids duplicating singular and plural methods' do
+      security_group = described_class.type_module.const_get('AWS_EC2_SecurityGroup').new
+      security_group.SecurityGroupIngress([{ foo: 'bar' }])
+      plural_value = security_group.instance_variable_get('@Properties')['SecurityGroupIngress'].value
+      expect(plural_value).to eq([{ foo: 'bar' }])
+    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')
+      ec2_instance = subject.Resource(:bar) { Type 'AWS::EC2::Instance' }
+      expect(ec2_instance.instance_variable_get('@Type')).to eq('AWS::EC2::Instance')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfndsl
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Steven Jack
@@ -55,7 +55,6 @@ files:
 - lib/cfndsl/json_serialisable_object.rb
 - lib/cfndsl/jsonable.rb
 - lib/cfndsl/mappings.rb
-- lib/cfndsl/metadata.rb
 - lib/cfndsl/module.rb
 - lib/cfndsl/names.rb
 - lib/cfndsl/orchestration_template.rb
@@ -88,14 +87,18 @@ files:
 - sample/vpc_with_vpn_example.rb
 - spec/cfndsl_spec.rb
 - spec/cli_spec.rb
+- spec/cloud_formation_template_spec.rb
 - spec/external_parameters_spec.rb
 - spec/fixtures/heattest.rb
 - spec/fixtures/test.rb
+- spec/heat_template_spec.rb
 - spec/jsonable_spec.rb
+- spec/metadata_spec.rb
 - spec/names_spec.rb
 - spec/plurals_spec.rb
 - spec/resources_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples/orchestration_template.rb
 homepage: https://github.com/stevenjack/cfndsl
 licenses:
 - MIT
@@ -124,11 +127,15 @@ summary: AWS Cloudformation DSL
 test_files:
 - spec/cfndsl_spec.rb
 - spec/cli_spec.rb
+- spec/cloud_formation_template_spec.rb
 - spec/external_parameters_spec.rb
 - spec/fixtures/heattest.rb
 - spec/fixtures/test.rb
+- spec/heat_template_spec.rb
 - spec/jsonable_spec.rb
+- spec/metadata_spec.rb
 - spec/names_spec.rb
 - spec/plurals_spec.rb
 - spec/resources_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples/orchestration_template.rb

data/lib/cfndsl/metadata.rb

@@ -1,14 +0,0 @@
-require 'cfndsl/jsonable'
-
-module CfnDsl
-  # Handles Metadata objects
-  class MetadataDefinition < JSONable
-    include JSONSerialisableObject
-
-    attr_reader :value
-
-    def initialize(value)
-      @value = value
-    end
-  end
-end