cfndsl 0.17.5 → 1.0.0.pre.1

data/spec/cli_spec.rb

@@ -2,21 +2,17 @@
 
 require 'spec_helper'
 
-WORKING_SPEC_VERSION = '2.19.0'
-
 describe 'cfndsl', type: :aruba do
   let(:usage) do
     <<-USAGE.gsub(/^ {6}/, '').chomp
       Usage: cfndsl [options] FILE
           -o, --output FILE                Write output to file
           -y, --yaml FILE                  Import yaml file as local variables
-          -r, --ruby FILE                  Evaluate ruby file before template
           -j, --json FILE                  Import json file as local variables
           -p, --pretty                     Pretty-format output JSON
           -f, --format FORMAT              Specify the output format (JSON default)
           -D, --define "VARIABLE=VALUE"    Directly set local VARIABLE as VALUE
           -v, --verbose                    Turn on verbose ouptut
-          -b, --disable-binding            Disable binding configuration
           -m, --disable-deep-merge         Disable deep merging of yaml
           -s, --specification-file FILE    Location of Cloudformation Resource Specification file
           -u [VERSION],                    Update the Resource Specification file to latest, or specific version
@@ -39,12 +35,15 @@ describe 'cfndsl', type: :aruba do
 
   before(:each) { write_file('template.rb', template_content) }
 
+  # The known working version is the embedded version
+  WORKING_SPEC_VERSION = JSON.parse(File.read(CfnDsl::LOCAL_SPEC_FILE))['ResourceSpecificationVersion']
+
   context "cfndsl -u #{WORKING_SPEC_VERSION}" do
     it 'updates the specification file' do
       run_command "cfndsl -u #{WORKING_SPEC_VERSION}"
       expect(last_command_started).to have_output_on_stderr(<<-OUTPUT.gsub(/^ {8}/, '').chomp)
         Updating specification file
-        Specification successfully written to #{ENV['HOME']}/.cfndsl/resource_specification.json
+        Specification #{WORKING_SPEC_VERSION} successfully written to #{ENV['HOME']}/.cfndsl/resource_specification.json
       OUTPUT
       expect(last_command_started).to have_exit_status(0)
     end
@@ -53,10 +52,11 @@ describe 'cfndsl', type: :aruba do
   context 'cfndsl -u' do
     it 'updates the specification file' do
       run_command 'cfndsl -u'
-      expect(last_command_started).to have_output_on_stderr(<<-OUTPUT.gsub(/^ {8}/, '').chomp)
-        Updating specification file
-        Specification successfully written to #{ENV['HOME']}/.cfndsl/resource_specification.json
-      OUTPUT
+
+      expected = %r{Updating specification file
+Specification ([0-9]+\.){2}[0-9]+ successfully written to #{ENV['HOME']}/.cfndsl/resource_specification.json}
+
+      expect(last_command_started).to have_output_on_stderr(expected)
       expect(last_command_started).to have_exit_status(0)
     end
   end
@@ -71,7 +71,7 @@ describe 'cfndsl', type: :aruba do
 
   context 'cfndsl' do
     it 'displays the usage' do
-      run_command 'cfndsl'
+      run_command'cfndsl'
       expect(last_command_started).to have_output(usage)
       expect(last_command_started).to have_exit_status(1)
     end
@@ -85,16 +85,6 @@ describe 'cfndsl', type: :aruba do
   end
 
   context 'cfndsl FILE' do
-    it 'gives a deprecation warning about bindings' do
-      run_command_and_stop 'cfndsl template.rb'
-      expect(last_command_started).to have_output_on_stderr(<<-WARN.gsub(/^ {8}/, '').chomp)
-        The creation of constants as config is deprecated!
-        Please switch to the #external_parameters method within your templates to access variables
-        See https://github.com/cfndsl/cfndsl/issues/170
-        Use the --disable-binding flag to suppress this message
-      WARN
-    end
-
     it 'generates a JSON CloudFormation template' do
       run_command_and_stop 'cfndsl template.rb'
       expect(last_command_started).to have_output_on_stdout('{"AWSTemplateFormatVersion":"2010-09-09","Description":"default"}')
@@ -138,31 +128,6 @@ describe 'cfndsl', type: :aruba do
     end
   end
 
-  context 'cfndsl FILE --ruby FILE' do
-    let(:template_content) do
-      <<-TEMPLATE.gsub(/^ {8}/, '')
-        CloudFormation do
-          DESC = 'default' unless defined? DESC
-          Description DESC
-        end
-      TEMPLATE
-    end
-
-    before(:each) { write_file('params.rb', 'DESC = "ruby"') }
-
-    it 'interpolates the Ruby file in the CloudFormation template' do
-      run_command_and_stop 'cfndsl template.rb --ruby params.rb'
-      expect(last_command_started).to have_output_on_stdout('{"AWSTemplateFormatVersion":"2010-09-09","Description":"ruby"}')
-    end
-
-    it 'gives a deprecation warning and does not interpolate if bindings are disabled' do
-      run_command_and_stop 'cfndsl template.rb --ruby params.rb --disable-binding --verbose'
-      deprecation_warning = /Interpreting Ruby files was disabled\. .*params.rb will not be read/
-      expect(last_command_started).to have_output_on_stderr(deprecation_warning)
-      expect(last_command_started).to have_output_on_stdout('{"AWSTemplateFormatVersion":"2010-09-09","Description":"default"}')
-    end
-  end
-
   context 'cfndsl FILE --define VARIABLE=VALUE' do
     it 'interpolates the command line variables in the CloudFormation template' do
       run_command "cfndsl template.rb --define \"DESC='cli'\""
@@ -175,15 +140,12 @@ describe 'cfndsl', type: :aruba do
 
     it 'displays the variables as they are interpolated in the CloudFormation template' do
       run_command_and_stop 'cfndsl template.rb --yaml params.yaml --verbose'
-      verbose = %r{The creation of constants as config is deprecated!
-Please switch to the #external_parameters method within your templates to access variables
-See https://github.com/cfndsl/cfndsl/issues/170
-Use the --disable-binding flag to suppress this message
-Using specification file .*\.json
-Loading YAML file .*params\.yaml
-Setting local variable DESC to yaml
-Loading template file .*template\.rb
-Writing to STDOUT}
+      verbose = /
+        Using \s specification \s file .* \.json \n
+        Loading \s YAML \s file \s .* params\.yaml \n
+        Loading \s template \s file \s .* template.rb \n
+        Writing \s to \s STDOUT
+      /x
       template = '{"AWSTemplateFormatVersion":"2010-09-09","Description":"yaml"}'
       expect(last_command_started).to have_output_on_stderr(verbose)
       expect(last_command_started).to have_output_on_stdout(template)

data/spec/cloud_formation_template_spec.rb

@@ -4,4 +4,237 @@ require 'spec_helper'
 
 describe CfnDsl::CloudFormationTemplate do
   it_behaves_like 'an orchestration template'
+
+  context '#validate' do
+    it 'returns self if the template is empty' do
+      # TODO: Strictly Cloudformation requires at least one resource, but this is not validated yet.
+      expect(subject.validate).to equal(subject)
+    end
+
+    context 'resources' do
+      it 'returns self if there are valid Refs to parameters' do
+        subject.Parameter('TestParameter').Type('String')
+        r = subject.Resource(:TestResource)
+        r.Type('Custom-TestType')
+        r.Property(:AProperty, r.Ref(:TestParameter))
+        expect(subject.validate).to equal(subject)
+      end
+
+      it 'returns self if there are valid Refs to other resources' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.Ref(:TestResource2))
+
+        t2 = subject.Resource('TestResource2')
+        t2.Type('Custom-TestType')
+        expect(subject.validate).to equal(subject)
+      end
+
+      it 'returns self if there are valid Fn::GetAtt references to other resources' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.FnGetAtt(:TestResource2, :AnAttribute))
+
+        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)
+
+        t2 = subject.Resource('TestResource2')
+        t2.Type('Custom-TestType')
+        expect(subject.validate).to equal(subject)
+      end
+
+      it 'raises CfnDsl::Error if references a non existent condition' do
+        tr = subject.Resource(:TestResource)
+        tr.Condition('NoCondition')
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /TestResource.*NoCondition/)
+      end
+
+      it 'raises CfnDsl::Error if there are invalid Refs' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.Ref(:TestResource2))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /^Invalid Reference:.*TestResource.*TestResource2/)
+      end
+
+      it 'raises CfnDsl::Error if there are invalid Fn::GetAtt references' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.FnGetAtt(:TestResource2, :AnAttribute))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /^Invalid Reference:.*TestResource.*TestResource2/)
+      end
+
+      it 'raises CfnDsl::Error if there are invalid Fn::Sub attribute references' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.FnBase64(tr.FnSub('${TestResource2.AnAttribute}')))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /^Invalid Reference:.*TestResource.*TestResource2/)
+      end
+
+      it 'raises CfnDsl::Error if there are invalid Fn::Sub references' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.FnBase64(tr.FnSub('${TestResource2}')))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /^Invalid Reference:.*TestResource.*TestResource2/)
+      end
+
+      it 'raises CfnDsl::Error if there are invalid DependsOn' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.DependsOn(['TestResource2'])
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /^Invalid Reference:.*TestResource.*TestResource2/)
+      end
+
+      it 'raises CfnDsl::Error if a resource explicitly DependsOn itself' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.DependsOn(['TestResource'])
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /TestResource.*references itself/)
+      end
+
+      it 'raises CfnDsl::Error if a resource Refs itself' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.Ref(:TestResource))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /TestResource.*itself/i)
+      end
+
+      it 'raises CfnDsl::Error if a resource references itself in Fn::GetAtt' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.FnGetAtt(:TestResource, :AnAttr))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /TestResource.*itself/i)
+      end
+
+      it 'raises CfnDsl::Error if a resourcs references itself in Fn::Sub expression' do
+        tr = subject.Resource(:TestResource)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.FnSub('${TestResource}'))
+        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')
+        tr.DependsOn(:ResourceTwo)
+
+        t2 = subject.Resource('ResourceTwo')
+        t2.Type('Custom-TestType')
+        t2.DependsOn(:ResourceOne)
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /cyclic.*ResourceTwo.*ResourceOne/i)
+      end
+
+      it 'raises CfnDsl::Error if there are cyclic Refs' do
+        tr = subject.Resource(:TestResourceOne)
+        tr.Type('Custom-TestType')
+        tr.Property(:AProperty, tr.Ref(:TestResourceTwo))
+
+        t2 = subject.Resource('TestResourceTwo')
+        t2.Type('Custom-TestType')
+        t2.DependsOn('TestResourceOne')
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /cyclic.*Two.*One/i)
+      end
+
+      it 'raises CfnDsl::Error if there are cyclic Fn::GetAtt references' do
+        tr = subject.Resource(:TestResource1)
+        tr.Property(:AProperty, tr.Ref(:TestResource2))
+
+        t2 = subject.Resource('TestResource2')
+        t2.DependsOn('TestResource3')
+
+        t3 = subject.Resource('TestResource3')
+        t3.Property(:OtherProperty, subject.FnGetAtt('TestResource1', :OtherAttribute))
+
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /cyclic.*3.*2.*1/i)
+      end
+
+      it 'raises CfnDsl::Error if there are cyclic Fn::Sub references' do
+        subject.Resource(:TestResource1)
+
+        t2 = subject.Resource('TestResource2')
+        t2.DependsOn(%w[TestResource3 TestResource1])
+
+        t3 = subject.Resource('TestResource3')
+        t3.Property(:OtherProperty, subject.FnSub('SomeValue ${TestResource2}'))
+
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /cyclic*.3?.*2/i)
+      end
+    end
+
+    context 'conditions' do
+      it 'returns self if there are valid condition references' do
+        subject.Parameter('TestParameter').Type('String')
+        subject.Condition(:TestCondition, subject.FnEquals(subject.Ref(:TestParameter), 'testvalue'))
+        expect(subject.validate).to equal(subject)
+      end
+
+      it 'raises CfnDsl::Error if invalid ref in condition' do
+        subject.Condition(:TestCondition, subject.FnEquals(subject.Ref(:NoParam), 'testvalue'))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /^Invalid Reference:.*TestCondition.*NoParam/)
+      end
+
+      it 'raises CfnDsl::Error if null value in Condition' do
+        subject.Condition(:TestCondition, subject.FnEquals(nil, 'testvalue'))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /Condition.*TestCondition.*null/)
+      end
+
+      it 'raises CfnDsl::Error if null value deep in Condition' do
+        subject.Condition(:TestCondition, subject.FnEquals({ Condition: nil }, 'testvalue'))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /Condition.*TestCondition.*null/)
+      end
+
+      # Note cycles in conditions tested in cfndsl_spec.rb
+    end
+
+    context 'outputs' do
+      it 'returns self if there are valid Refs to parameters' do
+        subject.Parameter('TestParameter').Type('String')
+        subject.Output('TestOutput').Value(subject.Ref(:TestParameter))
+        expect(subject.validate).to equal(subject)
+      end
+
+      it 'returns self if there are valid Refs to resources' do
+        subject.Resource(:TestResource)
+        subject.Output('TestResourceOutput').Value(subject.Ref(:TestResource))
+        expect(subject.validate).to equal(subject)
+      end
+
+      it 'returns self if there are valid Fn::GetAtt references to resources' do
+        subject.Resource(:TestResource)
+        subject.Output('TestResourceOutput').Value(subject.FnGetAtt(:TestResource, :AnAtt))
+        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/)
+      end
+
+      it 'raises CfnDsl::Error if there are invalid Refs' do
+        subject.Output('TestResourceOutput').Value(subject.Ref(:TestResource))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /Outputs.*TestResource/)
+      end
+
+      it 'raises CfnDsl::Error if there are invalid Fn::GetAtt references' do
+        subject.Output('TestResourceOutput').Value(subject.FnGetAtt(:TestResource, :Attr))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /Outputs.*TestResource/)
+      end
+
+      it 'raises CfnDsl::Error if there are invalid Fn::Sub attribute references' do
+        subject.Output('TestResourceOutput').Value(subject.FnSub('prefix ${SomeRef.attr}suffix'))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /Outputs.*TestResource/)
+      end
+
+      it 'raises CfnDsl::Error if there are invalid Fn::Sub references' do
+        subject.Output('TestResourceOutput').Value(subject.FnSub('prefix ${SomeRef}suffix'))
+        expect { subject.validate }.to raise_error(CfnDsl::Error, /Outputs.*TestResource/)
+      end
+    end
+  end
 end

data/spec/condition_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe CfnDsl::ConditionDefinition do
+  let(:template) { CfnDsl::OrchestrationTemplate.new }
+  let(:target) { File.read("#{File.dirname(__FILE__)}/fixtures/condition-assertion.json") }
+
+  context '#Condition' do
+    it 'formats correctly' do
+      template.declare do
+        Condition(:TestConditionTwo, FnNot(Condition(:TestConditionOne)))
+        Resource(:TestResource) do
+          Condition(:TestConditionTwo)
+        end
+        Output(:TestOutput) do
+          Condition(:TestConditionOne)
+        end
+      end
+      json = template.to_json
+      expect(json).to eq(target)
+    end
+  end
+end

data/spec/direct_ruby_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+class TemplateBuilder
+  include CfnDsl::CloudFormation
+end
+
+describe TemplateBuilder do
+  it 'includes Functions' do
+    expect(subject.FnSub('Substitution')).to be_an_instance_of(CfnDsl::Fn)
+  end
+
+  context('#CloudFormation') do
+    it 'returns a CloudFormationTemplate' do
+      expect(subject.CloudFormation('A Template')).to be_an_instance_of(CfnDsl::CloudFormationTemplate)
+    end
+  end
+end

data/spec/external_parameters_spec.rb

@@ -74,22 +74,9 @@ describe CfnDsl::ExternalParameters do
     end
   end
 
-  context '#add_to_binding' do
-    it 'defines the parameters as variables in the current binding' do
-      current = binding
-      subject.add_to_binding(current, nil)
-      expect(current).to be_local_variable_defined(:username)
-    end
-
-    it 'prints to a logstream if given' do
-      logstream = StringIO.new
-      subject.add_to_binding(binding, logstream)
-      logstream.rewind
-      expect(logstream.read).to match('Setting local variable username to Wiz Khalifa')
-    end
-  end
+  context '#load_file JSON', type: :aruba do
+    before { write_file('params.json', '{"reminder":"You Know What It Is"}') }
 
-  context '#load_file JSON' do
     it 'merges a JSON file as parameters' do
       subject.load_file(params_json)
       expect(subject[:reminder]).to eq('You Know What It Is')

data/spec/fixtures/condition-assertion.json

@@ -0,0 +1 @@
+{"AWSTemplateFormatVersion":"2010-09-09","Conditions":{"TestConditionTwo":{"Fn::Not":[{"Condition":"TestConditionOne"}]}},"Resources":{"TestResource":{"Condition":"TestConditionTwo"}},"Outputs":{"TestOutput":{"Condition":"TestConditionOne"}}}

data/spec/fixtures/test.rb

@@ -30,7 +30,8 @@ CloudFormation do
             FnAnd(
               [
                 FnEquals(Ref('One'), 'Test'),
-                FnNot(FnEquals(Ref('Two'), 'Test'))
+                FnNot(FnEquals(Ref('Two'), 'Test')),
+                Condition('OneIsTest')
               ]
             ))