cfndsl 0.5.0.pre → 0.5.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 0c3d2ac765697ae526e12354216d7c45845e07b0
-  data.tar.gz: 7ea0a5bb2eb5d16a611165bde335400d6fbdf29b
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjJkMDNjNjUzZWQ2NWRmZTFmOWJlMGI0MTc2ODYzM2RjY2I3NzhkNg==
+  data.tar.gz: !binary |-
+    NDRhNWQyOTIyYThjZmYxYmVhMDBiNmJiZGQxNWUxNTk2NmQyYzc0Mg==
 SHA512:
-  metadata.gz: efac56f41113e2ba016d176eeb23c5bf177d57c2ec22008eb029adea4f990d0ddcc975d13e87277efb07d192e227e76559b2bf567f04408e9641a432ba60c753
-  data.tar.gz: 27ed0952f74bf9841485d5236208b4315820bee91e737bbfa55d823281bc543245cb77e2ff6bd7f7a4fabb18f5472c6d13a0d023235da86d6677baa49958b340
+  metadata.gz: !binary |-
+    OTE4ZjhjYWVhZWE2ODZmM2RlZTE5ODEzZDc1N2ZjZTcyZmE4NzIwY2RmMWFm
+    NmI5MTY4NjgyYzY1MmE2MjQxNmQwNTk0NjVhOTdiMDE1MDJjZWY4M2M3OGE1
+    OGIwZTE5YmFmZjE2NzA3YWMzYjJiYThhNjIxMGY1NGMyMmI3MGU=
+  data.tar.gz: !binary |-
+    ZDgxYjQzNGYwNzg0MGYyMTM2MTc4NWI0NGY5N2IzZTEwNjcyNzE1OTZlYzMz
+    MTYwZmZjNWMzZDU1ZTFlNTY3ZjIxM2Q3NDE2MmE3MjQ0ODYwNTEwOTFiYzg2
+    ZjFiYThhOTM4YzBlOTIxYTI2MWM3Mzg5MzQ1YjNlYTI1NjExNmI=

data/.gitignore

@@ -1,3 +1,4 @@
 *.gem
 *~
 Gemfile.lock
+tmp/

data/.rubocop.yml

@@ -21,3 +21,7 @@ Style/MethodName:
 # Lone String
 Lint/Void:
   Enabled: false
+
+AllCops:
+  Exclude:
+    - 'tmp/**/*'

data/Gemfile

@@ -9,6 +9,7 @@ group :development, :test do
 end
 
 group :test do
+  gem 'aruba'
   gem 'rake'
   gem 'rspec'
 end

data/README.md

@@ -91,6 +91,8 @@ There is a more detailed example in the samples directory. The file
 "autoscale.template" is one of the standard Amazon sample templates.
 "autoscale.rb" generates an equivalent template file.
 
+There's also a larger set of examples available at [cfndsl_examples](https://github.com/neillturner/cfndsl_examples) thanks to @neillturner.
+
 ## Command Line Options
 
 The cfndsl command line program now accepts some command line options.

data/lib/cfndsl/resources.rb

@@ -9,6 +9,13 @@ module CfnDsl
     dsl_attr_setter :Type, :DependsOn, :DeletionPolicy, :Condition
     dsl_content_object :Property, :Metadata, :UpdatePolicy, :CreationPolicy
 
+    # rubocop:disable UnusedMethodArgument
+    # rubocop:disable UselessAssignment
+    def addTag(name, value, propagate = nil)
+      logstream.puts("This method is deprecated and will be removed in the next major release, please use 'add_tag' instead.") if logstream
+      add_tag(name, value, propagate = nil)
+    end
+
     def add_tag(name, value, propagate = nil)
       send(:Tag) do
         Key name

data/lib/cfndsl/version.rb

@@ -1,3 +1,3 @@
 module CfnDsl
-  VERSION = '0.5.0.pre'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/sample/vpc_example.rb

@@ -7,11 +7,11 @@ CloudFormation do
     EnableDnsSupport true
     EnableDnsHostnames true
     CidrBlock '10.1.0.0/16'
-    addTag('Name', 'Test VPC')
+    add_tag('Name', 'Test VPC')
   end
 
   InternetGateway(:InternetGateway) do
-    addTag('Name', 'Test VPC Gateway')
+    add_tag('Name', 'Test VPC Gateway')
   end
 
   VPCGatewayAttachment(:GatewayToInternet) do
@@ -27,12 +27,12 @@ CloudFormation do
     Subnet(subnet) do
       VpcId Ref(:VPC)
       CidrBlock "10.1.#{i}.0/24"
-      addTag('Name', "test vpc #{subnet}")
+      add_tag('Name', "test vpc #{subnet}")
     end
 
     RouteTable(route_table) do
       VpcId Ref(:VPC)
-      addTag('Name', route_table)
+      add_tag('Name', route_table)
     end
 
     SubnetRouteTableAssociation(route_table_assoc) do

data/sample/vpc_with_vpn_example.rb

@@ -25,11 +25,11 @@ CloudFormation do
     EnableDnsSupport true
     EnableDnsHostnames true
     CidrBlock '10.1.0.0/16'
-    addTag('Name', 'Test VPC')
+    add_tag('Name', 'Test VPC')
   end
 
   InternetGateway(:InternetGateway) do
-    addTag('Name', 'Test VPC Gateway')
+    add_tag('Name', 'Test VPC Gateway')
   end
 
   VPCGatewayAttachment(:GatewayToInternet) do
@@ -45,12 +45,12 @@ CloudFormation do
     Subnet(subnet) do
       VpcId Ref(:VPC)
       CidrBlock "10.1.#{i}.0/24"
-      addTag('Name', "test vpc #{subnet}")
+      add_tag('Name', "test vpc #{subnet}")
     end
 
     RouteTable(route_table) do
       VpcId Ref(:VPC)
-      addTag('Name', route_table)
+      add_tag('Name', route_table)
     end
 
     SubnetRouteTableAssociation(route_table_assoc) do
@@ -68,7 +68,7 @@ CloudFormation do
 
   VPNGateway(:VirtualPrivateNetworkGateway) do
     Type 'ipsec.1'
-    addTag('Name', 'Test VPN Gateway')
+    add_tag('Name', 'Test VPN Gateway')
   end
 
   VPCGatewayAttachment(:VPNGatewayAttachment) do
@@ -80,7 +80,7 @@ CloudFormation do
     Type 'ipsec.1'
     BgpAsn '65000'
     IpAddress Ref('RouterIPAddress')
-    addTag('Name', 'Test Customer VPN Gateway')
+    add_tag('Name', 'Test Customer VPN Gateway')
   end
 
   VPNConnection(:VPNConnection) do

data/spec/cli_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+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
+          -D, --define "VARIABLE=VALUE"    Directly set local VARIABLE as VALUE
+          -v, --verbose                    Turn on verbose ouptut
+          -h, --help                       Display this screen
+    USAGE
+  end
+
+  let(:template_content) do
+    <<-TEMPLATE.gsub(/^ {6}/, '')
+      CloudFormation do
+        DESC = 'default' unless defined? DESC
+        Description DESC
+      end
+    TEMPLATE
+  end
+
+  before(:each) { write_file('template.rb', template_content) }
+
+  context 'cfndsl' do
+    it 'displays the usage' do
+      run 'cfndsl'
+      expect(last_command_started).to have_output(usage)
+      expect(last_command_started).to have_exit_status(1)
+    end
+  end
+
+  context 'cfndsl --help' do
+    it 'displays the usage' do
+      run_simple 'cfndsl --help'
+      expect(last_command_started).to have_output(usage)
+    end
+  end
+
+  context 'cfndsl FILE' do
+    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"}')
+    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)
+        {
+          "AWSTemplateFormatVersion": "2010-09-09",
+          "Description": "default"
+        }
+      OUTPUT
+    end
+  end
+
+  context 'cfndsl FILE --output FILE' do
+    it 'writes the JSON CloudFormation template to a file' do
+      run_simple 'cfndsl template.rb --output template.json'
+      expect(read('template.json')).to eq(['{"AWSTemplateFormatVersion":"2010-09-09","Description":"default"}'])
+    end
+  end
+
+  context 'cfndsl FILE --yaml FILE' do
+    before { write_file('params.yaml', 'DESC: yaml') }
+
+    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"}')
+    end
+  end
+
+  context 'cfndsl FILE --json FILE' do
+    before { write_file('params.json', '{"DESC":"json"}') }
+
+    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"}')
+    end
+  end
+
+  context 'cfndsl FILE --ruby FILE' do
+    before { write_file('params.rb', 'DESC = "ruby"') }
+
+    it 'interpolates the JSON 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"}')
+    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"}')
+    end
+  end
+
+  context 'cfndsl FILE --verbose' do
+    before { write_file('params.yaml', 'DESC: yaml') }
+
+    it 'displays the variables as they are interpolated in the CloudFormation template' do
+      run_simple 'cfndsl template.rb --yaml params.yaml --verbose'
+      verbose = /
+        Loading \s YAML \s file \s .* params\.yaml \n
+        Setting \s local \s variable \s DESC \s to \s 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)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1 +1,5 @@
 require 'cfndsl'
+require 'aruba/rspec'
+
+bindir = File.expand_path('../../bin', __FILE__)
+ENV['PATH'] = [ENV['PATH'], bindir].join(':')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfndsl
 version: !ruby/object:Gem::Version
-  version: 0.5.0.pre
+  version: 0.5.0
 platform: ruby
 authors:
 - Steven Jack
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2016-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: DSL for creating AWS Cloudformation templates
@@ -34,9 +34,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
+- .gitignore
+- .rubocop.yml
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -85,6 +85,7 @@ files:
 - sample/vpc_example.rb
 - sample/vpc_with_vpn_example.rb
 - spec/cfndsl_spec.rb
+- spec/cli_spec.rb
 - spec/fixtures/heattest.rb
 - spec/fixtures/test.rb
 - spec/spec_helper.rb
@@ -98,22 +99,23 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: AWS Cloudformation DSL
 test_files:
 - spec/cfndsl_spec.rb
+- spec/cli_spec.rb
 - spec/fixtures/heattest.rb
 - spec/fixtures/test.rb
 - spec/spec_helper.rb