cfndsl 0.5.2 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWZhOTliZTdkNDFlNDE4NWMzYzFhZmExZDBkOGE5YTk3OGE0Njk3NQ==
+    NjRiMGI3NjU1M2NjYzQyOGZlZmUzOTQ2MDIyNTc5MGIyYzRkNjIwZA==
   data.tar.gz: !binary |-
-    OThlZjYyZmVmNTczZmE1MzQ2YjU5YjM1MTZhZGEyOTlhNGJiZDFhZA==
+    ZDYzZDU1YTc1MmNmYTE0NGI3NDQwNDU0MThkYmQxNzJkNjY0ZTViMA==
 SHA512:
   metadata.gz: !binary |-
-    YTJhZGMzOGYyN2IyYjc2MDhlOGQ2MWRkZGMyOWU5OGQ5YWZmYjliOTUxNjFh
-    MTZjMWM3M2M5ZGM5ZmFjMzViOWQ0ZWRkNjE0NTUzYzExOGJhYmJhYTU0MDBi
-    OTYyNDEwN2IyOWE2NDc5NDljZDE3NTIxM2EwY2IzNzhhZjJjM2Q=
+    ODRmOWU4NGVjNzE3MjQ2ZDBkNDk1MWUyYmFlNWRmZjQ5MzE5MDJiNzA4ODA2
+    MTI0ZTdkNjBjNjIyNDhmOGUxNjQ4ODYzNzAwOTk5YzAyMTAyYmM4ZDQ4YmNi
+    ZWIyODRlOTBiMjQwMmJkZWQzNDI4YzIwNmQ2NWRkNGRhZWZmYmY=
   data.tar.gz: !binary |-
-    YmM4ZjJjNTBjM2U1ZWIzZDVhMmJhYTJjYzRkZjYwM2Y3Mjk5YzdhZTljZWIx
-    Mzk1ZGUwYTZhMGVkYjRhOGQxYWJiYTMwMDg1NGI1OTJkYTZhZGQxZGZmMTkx
-    MmYwY2U3ZDlkNTkzY2Q0Mjk4Y2FmNmMzZDlhNmQxNjZkNmM4MDc=
+    NWVjMzQ5YWE0ZDhhOGU5NzE5YTAwYTlhY2E3NDg0OTM4NDMwODVlZThlNDE0
+    ZTE1MmE0MWRhMzFiOGM3YmYyMmNiNzcwOGNiZDZhZjc0Njk4MTkzYzUzY2Y2
+    NGYxYTY2ZDBkNjdhNTg0YmRmYTg0ZGJiYTY2MGRmZGNkOTk3ZDM=

data/README.md

@@ -55,27 +55,27 @@ chris@raspberrypi:~/git/cfndsl$ cfndsl test.rb | json_pp
 {
    "Parameters" : {
       "One" : {
-         "Type" : "String",
-         "Default" : "Test",
-         "MaxLength" : 15
+	 "Type" : "String",
+	 "Default" : "Test",
+	 "MaxLength" : 15
       }
    },
    "Resources" : {
       "MyInstance" : {
-         "Type" : "AWS::EC2::Instance",
-         "Properties" : {
-            "ImageId" : "ami-12345678"
-         }
+	 "Type" : "AWS::EC2::Instance",
+	 "Properties" : {
+	    "ImageId" : "ami-12345678"
+	 }
       }
    },
    "AWSTemplateFormatVersion" : "2010-09-09",
    "Outputs" : {
       "One" : {
-         "Value" : {
-            "Fn::Base64" : {
-               "Ref" : "One"
-            }
-         }
+	 "Value" : {
+	    "Fn::Base64" : {
+	       "Ref" : "One"
+	    }
+	 }
       }
    },
    "Description" : "Test"
@@ -106,6 +106,7 @@ Usage: cfndsl [options] FILE
     -p, --pretty                     Pretty-format output JSON
     -D, --define "VARIABLE=VALUE"    Directly set local VARIABLE as VALUE
     -v, --verbose                    Turn on verbose ouptut
+    -b, --disable-binding            Disable binding configuration
     -h, --help                       Display this screen
 ```
 
@@ -124,26 +125,26 @@ This is best illustrated with a example. Consider the following cfndsl
 template
 
 ```ruby
-# cfndsl template t1.rb
-CloudFormation {
+# cfndsl template sample/t1.rb
+CloudFormation do
 
-  DESCRIPTION ||= "default description"
-  MACHINES ||= 1
+  description = external_parameters.fetch(:description, 'default description')
+  machines = external_parameters.fetch(:machines, 1).to_i
 
-  Description DESCRIPTION
+  Description description
 
-  (1..MACHINES).each do |i|
+  (1..machines).each do |i|
     name = "machine#{i}"
-    EC2_Instance(name) {
-      ImageId "ami-12345678"
-      Type "t1.micro"
-    }
+    EC2_Instance(name) do
+      ImageId 'ami-12345678'
+      Type 't1.micro'
+    end
   end
 
-}
+end
 ```
 
-Note the two variables "DESCRIPTION" and "MACHINES". The template
+Note the two variables `description` and `machines`. The template
 sets these to some reasonable default values, and if you run cfndsl
 on it without changing them in any way you get the following cloudformation
 template:
@@ -154,7 +155,7 @@ template:
     "machine1": {
       "Type": "AWS::EC2::Instance",
       "Properties": {
-        "ImageId": "ami-12345678"
+	"ImageId": "ami-12345678"
       }
     }
   },
@@ -166,7 +167,7 @@ template:
 However if you run the command
 
 ```bash
-$ cfndsl t1.rb -D 'DESCRIPTION="3 machine cluster"' -D 'MACHINES=3'
+$ cfndsl sample/t1.rb -D 'description=3 machine cluster' -D 'machines=3'
 ```
 
 you get the following generated template.
@@ -177,19 +178,19 @@ you get the following generated template.
     "machine3": {
       "Type": "AWS::EC2::Instance",
       "Properties": {
-        "ImageId": "ami-12345678"
+	"ImageId": "ami-12345678"
       }
     },
     "machine2": {
       "Type": "AWS::EC2::Instance",
       "Properties": {
-        "ImageId": "ami-12345678"
+	"ImageId": "ami-12345678"
       }
     },
     "machine1": {
       "Type": "AWS::EC2::Instance",
       "Properties": {
-        "ImageId": "ami-12345678"
+	"ImageId": "ami-12345678"
       }
     }
   },
@@ -199,26 +200,26 @@ you get the following generated template.
 ```
 
 The -y and -j options allow you to group several variable definitions
-into a single file (formated as either yaml or ruby respectively). If
+into a single file (formated as either yaml or json respectively). If
 you had a file called 't1.yaml' that contained the following,
 
 ```yaml
-# t1.yaml
-DESCRIPTION: 5 machine cluster
-MACHINES: 5
+# sample/t1.yaml
+description: 5 machine cluster
+machines: 5
 ```
 
 the command
 
 ```bash
-$ cfndsl t1.rb -y t1.yaml
+$ cfndsl sample/t1.rb -y sample/t1.yaml
 ```
 
 would generate a template with 5 instances declared.
 
 Finally, the -r option gives you the opportunity to execute some
 arbitrary ruby code in the evaluation context before the cloudformation
-template is evaluated.
+template is evaluated (this is not available if `--disable-binding` is used).
 
 ### Rake task
 Simply add the following to your `Rakefile`:

data/bin/cfndsl

@@ -41,6 +41,10 @@ optparse = OptionParser.new do |opts|
     options[:verbose] = true
   end
 
+  opts.on('-b', '--disable-binding', 'Disable binding configuration') do
+    options[:disable_binding] = true
+  end
+
   # This displays the help screen, all programs are
   # assumed to have this option.
   opts.on('-h', '--help', 'Display this screen') do
@@ -57,6 +61,16 @@ end
 
 filename = File.expand_path(ARGV[0])
 verbose = options[:verbose] && STDERR
+if options[:disable_binding]
+  CfnDsl.disable_binding
+else
+  STDERR.puts <<-MSG
+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/stevenjack/cfndsl/issues/170
+Use the --disable-binding flag to suppress this message
+MSG
+end
 
 model = CfnDsl.eval_file_with_extras(filename, options[:extras], verbose)
 

data/lib/cfndsl.rb

@@ -1,3 +1,4 @@
+require 'forwardable'
 require 'json'
 
 require 'cfndsl/module'
@@ -15,9 +16,17 @@ require 'cfndsl/parameters'
 require 'cfndsl/outputs'
 require 'cfndsl/aws/cloud_formation_template'
 require 'cfndsl/os/heat_template'
+require 'cfndsl/external_parameters'
 
 # CfnDsl
 module CfnDsl
+  def self.disable_binding
+    @disable_binding = true
+  end
+
+  def self.disable_binding?
+    @disable_binding
+  end
   # This function handles the eval of the template file and returns the
   # results. It does this with a ruby "eval", but it builds up a customized
   # binding environment before it calls eval. The environment can be
@@ -42,41 +51,43 @@ module CfnDsl
   #         side effects) will persist into the context where the template
   #         is evaluated
   #
-  # :raw  - the seccond elements is treated as a ruby statement and is
+  # :raw  - the second element is treated as a ruby statement and is
   #         evaluated in the binding context, similar to the contents of
   #         a ruby file.
   #
   # Note that the order is important, as later extra sections can overwrite
   # or even undo things that were done by earlier sections.
+
+  # rubocop:disable all
   def self.eval_file_with_extras(filename, extras = [], logstream = nil)
     b = binding
-    extras.each do |pair|
-      type, file = pair
+    params = CfnDsl::ExternalParameters.new
+    extras.each do |type, file|
       case type
       when :yaml, :json
         klass_name = type.to_s.upcase
-        klass = Object.const_get(klass_name)
         logstream.puts("Loading #{klass_name} file #{file}") if logstream
-        parameters = klass.load(File.read(file))
-        parameters.each do |k, v|
-          logstream.puts("Setting local variable #{k} to #{v}") if logstream
-          b.eval("#{k} = #{v.inspect}")
-        end
-
+        params.load_file file
+        params.add_to_binding(b, logstream) unless disable_binding?
       when :ruby
-        logstream.puts("Runnning ruby file #{file}") if logstream
-        b.eval(File.read(file), file)
-
+        if disable_binding?
+          logstream.puts("Interpreting Ruby files was disabled. #{file} will not be read") if logstream
+        else
+          logstream.puts("Running ruby file #{file}") if logstream
+          b.eval(File.read(file), file)
+        end
       when :raw
-        logstream.puts("Running raw ruby code #{file}") if logstream
-        b.eval(file, 'raw code')
+        params.set_param(*file.split('='))
+        unless disable_binding?
+          logstream.puts("Running raw ruby code #{file}") if logstream
+          b.eval(file, 'raw code')
+        end
       end
     end
 
+    CfnDsl::CloudFormationTemplate.external_parameters params
     logstream.puts("Loading template file #{filename}") if logstream
-    model = b.eval(File.read(filename), filename)
-
-    model
+    b.eval(File.read(filename), filename)
   end
 end
 

data/lib/cfndsl/external_parameters.rb

@@ -0,0 +1,47 @@
+module CfnDsl
+  # Handles all external parameters
+  class ExternalParameters
+    extend Forwardable
+
+    def_delegators :parameters, :fetch, :keys, :values, :each_pair
+
+    attr_reader :parameters
+
+    def initialize
+      @parameters = {}
+    end
+
+    def set_param(k, v)
+      parameters[k.to_sym] = v
+    end
+
+    def get_param(k)
+      parameters[k.to_sym]
+    end
+    alias [] get_param
+
+    def to_h
+      parameters
+    end
+
+    def add_to_binding(bind, logstream)
+      parameters.each_pair do |key, val|
+        logstream.puts("Setting local variable #{key} to #{val}") if logstream
+        bind.eval "#{key} = #{val.inspect}"
+      end
+    end
+
+    def load_file(fname)
+      format = File.extname fname
+      case format
+      when /ya?ml/
+        params = YAML.load_file fname
+      when /json/
+        params = JSON.load File.read(fname)
+      else
+        raise "Unrecognized extension #{format}"
+      end
+      params.each { |key, val| set_param(key, val) }
+    end
+  end
+end

data/lib/cfndsl/orchestration_template.rb

@@ -10,6 +10,15 @@ module CfnDsl
     dsl_attr_setter :AWSTemplateFormatVersion, :Description
     dsl_content_object :Condition, :Parameter, :Output, :Resource, :Mapping
 
+    def self.external_parameters(params = nil)
+      @external_parameters = params if params
+      @external_parameters
+    end
+
+    def external_parameters
+      self.class.external_parameters
+    end
+
     def initialize
       @AWSTemplateFormatVersion = '2010-09-09'
     end

data/lib/cfndsl/version.rb

@@ -1,3 +1,3 @@
 module CfnDsl
-  VERSION = '0.5.2'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/sample/t1.rb

@@ -1,12 +1,12 @@
 CloudFormation do
-  DESCRIPTION ||= 'default description'.freeze
-  MACHINES ||= 1
+  description = external_parameters.fetch(:description, 'default description')
+  machines = external_parameters.fetch(:machines, 1).to_i
 
-  Description DESCRIPTION
+  Description description
 
-  (1..MACHINES).each do |i|
+  (1..machines).each do |i|
     name = "machine#{i}"
-    Instance(name) do
+    EC2_Instance(name) do
       ImageId 'ami-12345678'
       Type 't1.micro'
     end

data/sample/t1.yaml

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

data/spec/cli_spec.rb

@@ -11,6 +11,7 @@ describe 'cfndsl', type: :aruba do
           -p, --pretty                     Pretty-format output JSON
           -D, --define "VARIABLE=VALUE"    Directly set local VARIABLE as VALUE
           -v, --verbose                    Turn on verbose ouptut
+          -b, --disable-binding            Disable binding configuration
           -h, --help                       Display this screen
     USAGE
   end
@@ -18,8 +19,7 @@ describe 'cfndsl', type: :aruba do
   let(:template_content) do
     <<-TEMPLATE.gsub(/^ {6}/, '')
       CloudFormation do
-        DESC = 'default' unless defined? DESC
-        Description DESC
+        Description(external_parameters[:DESC] || 'default')
       end
     TEMPLATE
   end
@@ -42,16 +42,26 @@ describe 'cfndsl', type: :aruba do
   end
 
   context 'cfndsl FILE' do
+    it 'gives a deprecation warning about bindings' do
+      run_simple '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/stevenjack/cfndsl/issues/170
+        Use the --disable-binding flag to suppress this message
+      WARN
+    end
+
     it 'generates a JSON CloudFormation template' do
       run_simple 'cfndsl template.rb'
-      expect(last_command_started).to have_output('{"AWSTemplateFormatVersion":"2010-09-09","Description":"default"}')
+      expect(last_command_started).to have_output_on_stdout('{"AWSTemplateFormatVersion":"2010-09-09","Description":"default"}')
     end
   end
 
   context 'cfndsl FILE --pretty' do
     it 'generates a pretty JSON CloudFormation template' do
       run_simple 'cfndsl template.rb --pretty'
-      expect(last_command_started).to have_output(<<-OUTPUT.gsub(/^ {8}/, '').chomp)
+      expect(last_command_started).to have_output_on_stdout(<<-OUTPUT.gsub(/^ {8}/, '').chomp)
         {
           "AWSTemplateFormatVersion": "2010-09-09",
           "Description": "default"
@@ -72,7 +82,7 @@ describe 'cfndsl', type: :aruba do
 
     it 'interpolates the YAML file in the CloudFormation template' do
       run_simple 'cfndsl template.rb --yaml params.yaml'
-      expect(last_command_started).to have_output('{"AWSTemplateFormatVersion":"2010-09-09","Description":"yaml"}')
+      expect(last_command_started).to have_output_on_stdout('{"AWSTemplateFormatVersion":"2010-09-09","Description":"yaml"}')
     end
   end
 
@@ -81,23 +91,39 @@ describe 'cfndsl', type: :aruba do
 
     it 'interpolates the JSON file in the CloudFormation template' do
       run_simple 'cfndsl template.rb --json params.json'
-      expect(last_command_started).to have_output('{"AWSTemplateFormatVersion":"2010-09-09","Description":"json"}')
+      expect(last_command_started).to have_output_on_stdout('{"AWSTemplateFormatVersion":"2010-09-09","Description":"json"}')
     end
   end
 
   context 'cfndsl FILE --ruby FILE' do
-    before { write_file('params.rb', 'DESC = "ruby"') }
+    let(:template_content) do
+      <<-TEMPLATE.gsub(/^ {8}/, '')
+        CloudFormation do
+          DESC = 'default' unless defined? DESC
+          Description DESC
+        end
+      TEMPLATE
+    end
 
-    it 'interpolates the JSON file in the CloudFormation template' do
+    before(:each) { write_file('params.rb', 'DESC = "ruby"') }
+
+    it 'interpolates the Ruby file in the CloudFormation template' do
       run_simple 'cfndsl template.rb --ruby params.rb'
-      expect(last_command_started).to have_output('{"AWSTemplateFormatVersion":"2010-09-09","Description":"ruby"}')
+      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_simple '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_simple "cfndsl template.rb --define \"DESC='cli'\""
-      expect(last_command_started).to have_output('{"AWSTemplateFormatVersion":"2010-09-09","Description":"cli"}')
+      run "cfndsl template.rb --define \"DESC='cli'\""
+      expect(last_command_started).to have_output_on_stdout("{\"AWSTemplateFormatVersion\":\"2010-09-09\",\"Description\":\"'cli'\"}")
     end
   end
 

data/spec/external_parameters_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe CfnDsl::ExternalParameters do
+  subject do
+    exp = described_class.new
+    exp.set_param(:username, 'Wiz Khalifa')
+    exp.set_param(:password, 'BlackAndYellow')
+    exp
+  end
+
+  context '#set_param' do
+    it 'treats keys as symbols only' do
+      subject.set_param('reminder', 'You Know What It Is')
+      expect(subject[:reminder]).to eq('You Know What It Is')
+    end
+  end
+
+  context '#get_param' do
+    it 'treats keys as symbols only' do
+      subject.set_param(:reminder, 'You Know What It Is')
+      expect(subject.get_param('reminder')).to eq('You Know What It Is')
+    end
+  end
+
+  context '#to_h' do
+    it 'returns the current parameters as a Hash' do
+      expect(subject.to_h).to eq(username: 'Wiz Khalifa', password: 'BlackAndYellow')
+    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"}') }
+
+    it 'merges a JSON file as parameters' do
+      subject.load_file File.join(expand_path('./params.json'))
+      expect(subject[:reminder]).to eq('You Know What It Is')
+    end
+  end
+
+  context '#load_file YAML', type: :aruba do
+    before { write_file('params.yaml', '{"reminder":"You Know What It Is"}') }
+
+    it 'merges a YAML file as parameters' do
+      subject.load_file File.join(expand_path('./params.yaml'))
+      expect(subject[:reminder]).to eq('You Know What It Is')
+    end
+  end
+
+  context '#[]' do
+    it 'accesses the parameters like a Hash' do
+      expect(subject).to respond_to(:[])
+      expect(subject[:username]).to eq('Wiz Khalifa')
+    end
+  end
+
+  [:fetch, :keys, :values, :each_pair].each do |meth|
+    context "##{meth}" do
+      it "delegates the method #{meth} to the underlying parameters" do
+        expect(subject.parameters).to receive(meth)
+        subject.send meth
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfndsl
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Steven Jack
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,6 +50,7 @@ files:
 - lib/cfndsl/conditions.rb
 - lib/cfndsl/creation_policy.rb
 - lib/cfndsl/errors.rb
+- lib/cfndsl/external_parameters.rb
 - lib/cfndsl/generate_types.rb
 - lib/cfndsl/jsonable.rb
 - lib/cfndsl/mappings.rb
@@ -86,6 +87,7 @@ files:
 - sample/vpc_with_vpn_example.rb
 - spec/cfndsl_spec.rb
 - spec/cli_spec.rb
+- spec/external_parameters_spec.rb
 - spec/fixtures/heattest.rb
 - spec/fixtures/test.rb
 - spec/spec_helper.rb
@@ -117,6 +119,7 @@ summary: AWS Cloudformation DSL
 test_files:
 - spec/cfndsl_spec.rb
 - spec/cli_spec.rb
+- spec/external_parameters_spec.rb
 - spec/fixtures/heattest.rb
 - spec/fixtures/test.rb
 - spec/spec_helper.rb