cloudformula 1.1.2

data/spec/cloudformula/template_spec.rb

@@ -0,0 +1,303 @@
+require 'spec_helper'
+
+module CloudFormula
+  describe Template do
+    describe 'source attribute' do
+      it 'should exist' do
+        template = CloudFormula::Template.new
+        expect(template).to respond_to(:source)
+      end
+
+      it 'should be set properly upon initialization with a value' do
+        template = CloudFormula::Template.new('source_file.json.erb', { :param1 => 'value1' })
+        expect(template.source).to eq('source_file.json.erb')
+      end
+
+      it 'should be set properly upon initialization with no value' do
+        template = CloudFormula::Template.new
+        expect(template.source).to eq('')
+      end
+    end
+
+    describe 'parameters attribute' do
+      it 'should exist' do
+        template = CloudFormula::Template.new
+        expect(template).to respond_to(:parameters)
+      end
+
+      it 'should be set properly upon initialization with a value' do
+        template = CloudFormula::Template.new('source_file.json.erb', { :param1 => 'value1' })
+        expect(template.parameters).to eq({ :param1 => 'value1' })
+      end
+
+      it 'should be set properly upon initialization with no value' do
+        template = CloudFormula::Template.new()
+        expect(template.parameters).to eq({})
+      end
+    end
+
+    describe 'stack_options method' do
+      it 'should return an empty hash if no options are set in the template' do
+        template_path = File.expand_path('../fixtures/without_erb_parameters.erb', File.dirname(__FILE__))
+        template = CloudFormula::Template.new(template_path)
+        expect(template.stack_options).to eq({})
+      end
+
+      it 'should return an options hash if one is provided in the template' do
+        template_path = File.expand_path('../fixtures/with_stack_options.json.erb', File.dirname(__FILE__))
+        template = CloudFormula::Template.new(template_path)
+        expect(template.stack_options).to eq({ :disable_rollback => true })
+      end
+    end
+
+    describe 'generate method' do
+      it 'should exist' do
+        template = CloudFormula::Template.new
+        expect(template).to respond_to(:generate)
+      end
+
+      it 'should return the template contents as-is when there are no parameters' do
+        template_path = File.expand_path('../fixtures/without_erb_parameters.erb', File.dirname(__FILE__))
+        template = CloudFormula::Template.new(template_path)
+        expect(template.generate).to eq(File.read(template_path))
+      end
+
+      it 'should return the modified template contents when there are parameters' do
+        template_path = File.expand_path('../fixtures/with_erb_parameters.erb', File.dirname(__FILE__))
+        answer_path = File.expand_path('../fixtures/with_erb_parameters_answer.txt', File.dirname(__FILE__))
+        template = CloudFormula::Template.new(template_path, { :param1 => 'value1', :param2 => 'value2' })
+        expect(template.generate).to eq(File.read(answer_path))
+      end
+
+      describe 'should raise an error when' do
+        it 'the source is empty' do
+          template = CloudFormula::Template.new
+          expect { template.generate }.to raise_error
+        end
+
+        it 'the source file does not exist or cannot be read' do
+          template = CloudFormula::Template.new('does_not_exist')
+          expect { template.generate }.to raise_error
+        end
+      end
+
+      it 'with partial should return the modified template and partial contents when there are parameters' do
+        template_path = File.expand_path('../fixtures/with_partial.json.erb', File.dirname(__FILE__))
+        answer_path = File.expand_path('../fixtures/with_partial_answer.json', File.dirname(__FILE__))
+        template = CloudFormula::Template.new(template_path, { :param1 => 'value1', :param2 => 'value2', :param3 => 'value3' })
+        expect(template.generate).to eq(File.read(answer_path))
+      end
+
+      it 'with raw helper should not escape parameter content' do
+        template_path = File.expand_path('../fixtures/with_raw.json.erb', File.dirname(__FILE__))
+        answer_path = File.expand_path('../fixtures/with_raw_answer.json', File.dirname(__FILE__))
+        template = CloudFormula::Template.new(template_path, { :param1 => 'value1' })
+        expect(template.generate).to eq(File.read(answer_path))
+      end
+
+      describe 'with template validations' do
+        good_params = { :presence_param => 'value1', :length_param => 'value2', :nclusion_param => 'foo', :format_param => 'abc' }
+
+        describe 'valid? method' do
+          it 'should return false when invalid' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params.merge({ :presence_param => '' }))
+            expect(template.valid?).to be_false
+          end
+
+          it 'should return true when valid' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params)
+            expect(template.valid?).to be_true
+          end
+        end
+
+        describe 'invalid? method' do
+          it 'should return true when invalid' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params.merge({ :presence_param => '' }))
+            expect(template.invalid?).to be_true
+          end
+
+          it 'should return false when valid' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params)
+            expect(template.invalid?).to be_false
+          end
+        end
+
+        describe 'generation' do
+          it 'should raise an error when invalid' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params.merge({ :presence_param => '' }))
+            expect { template.generate }.to raise_error
+
+            template_path = File.expand_path('../fixtures/with_custom_erb_validations.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params.merge({ :presence_param => '' }))
+            expect { template.generate }.to raise_error
+          end
+
+          it 'should be successful when valid' do
+            template_path = File.expand_path('../fixtures/with_custom_erb_validations.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params)
+            expect { template.generate }.to_not raise_error
+          end
+        end
+
+        describe 'exclusion helper' do
+          it 'should include a value in errors[] when invalid' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params.merge({ :nclusion_param => 'baz' }))
+            expect(template.errors.length).to be > 0
+          end
+
+          it 'should not include a value in errors[] when valid' do
+            template_path = File.expand_path('../fixtures/with_custom_erb_validations.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params)
+            expect(template.errors.length).to eq(0)
+          end
+        end
+
+        describe 'inclusion helper' do
+          it 'should include a value in errors[] when invalid' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params.merge({ :nclusion_param => 'bad' }))
+            expect(template.errors.length).to be > 0
+          end
+
+          it 'should not include a value in errors[] when valid' do
+            template_path = File.expand_path('../fixtures/with_custom_erb_validations.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params)
+            expect(template.errors.length).to eq(0)
+          end
+        end
+
+        describe 'length helper' do
+          it 'should include a value in errors[] when invalid' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params.merge({ :length_param => 'short' }))
+            expect(template.errors.length).to be > 0
+          end
+
+          it 'should not include a value in errors[] when valid' do
+            template_path = File.expand_path('../fixtures/with_custom_erb_validations.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params)
+            expect(template.errors.length).to eq(0)
+          end
+        end
+
+        describe 'numericality helper' do
+          it 'should include a value in errors[] when invalid' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params.merge({ :numericality_param_1 => '1' }))
+            expect(template.errors.length).to be > 0
+          end
+
+          it 'should not include a value in errors[] when valid' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params.merge({ :numericality_param_1 => '2' }))
+            expect(template.errors.length).to eq(0)
+          end
+        end
+
+        describe 'format helper' do
+          it 'should include a value in errors[] when invalid' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params.merge({ :format_param => '123' }))
+            expect(template.errors.length).to be > 0
+          end
+
+          it 'should not include a value in errors[] when valid' do
+            template_path = File.expand_path('../fixtures/with_custom_erb_validations.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params)
+            expect(template.errors.length).to eq(0)
+          end
+        end
+
+        describe 'presence helper' do
+          it 'should include a value in errors[] when invalid' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params.merge({ :presence_param => '' }))
+            expect(template.errors.length).to be > 0
+          end
+
+          it 'should not include a value in errors[] when valid' do
+            template_path = File.expand_path('../fixtures/with_custom_erb_validations.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, good_params)
+            expect(template.errors.length).to eq(0)
+          end
+        end
+
+        describe 'multiple rules' do
+          it 'should include a value in errors[] for each rule failure' do
+            template_path = File.expand_path('../fixtures/with_erb_validations.json.erb', File.dirname(__FILE__))
+            template = CloudFormula::Template.new(template_path, {})
+            expect(template.errors.length).to be > 1
+          end
+        end
+      end
+    end
+
+    describe 'generate_hash method' do
+      it 'should exist' do
+        template = CloudFormula::Template.new
+        expect(template).to respond_to(:generate_hash)
+      end
+
+      it 'should raise an error if the template is not valid JSON' do
+        template_path = File.expand_path('../fixtures/without_erb_parameters.erb', File.dirname(__FILE__))
+        template = CloudFormula::Template.new(template_path)
+        expect { template.generate_hash }.to raise_error
+      end
+
+      it 'should return the template contents as a Hash with valid JSON and no parameters' do
+        template_path = File.expand_path('../fixtures/without_erb_parameters.json.erb', File.dirname(__FILE__))
+        template = CloudFormula::Template.new(template_path)
+        expect(template.generate_hash).to eq(JSON.parse(File.read(template_path)))
+      end
+
+      it 'should return the modified template contents when there are parameters' do
+        template_path = File.expand_path('../fixtures/with_erb_parameters.json.erb', File.dirname(__FILE__))
+        answer_path = File.expand_path('../fixtures/with_erb_parameters_answer.json', File.dirname(__FILE__))
+        template = CloudFormula::Template.new(template_path, { :param1 => 'value1', :param2 => 'value2' })
+        expect(template.generate_hash).to eq(JSON.parse(File.read(answer_path)))
+      end
+
+      it 'should escape parameter values properly' do
+        template_path = File.expand_path('../fixtures/with_erb_parameters.json.erb', File.dirname(__FILE__))
+        answer_path = File.expand_path('../fixtures/with_erb_parameters_escaped_answer.json', File.dirname(__FILE__))
+        template = CloudFormula::Template.new(template_path, { :param1 => '"value1"', :param2 => '"value2"' })
+        expect(template.generate_hash).to eq(JSON.parse(File.read(answer_path)))
+      end
+    end
+
+    describe 'aws_options method' do
+      it 'should exist' do
+        template = CloudFormula::Template.new
+        expect(template).to respond_to(:aws_options)
+      end
+
+      it 'should return a properly merged Hash object' do
+        template_path = File.expand_path('../fixtures/with_erb_parameters_and_stack_options.json.erb', File.dirname(__FILE__))
+        template = CloudFormula::Template.new(template_path)
+        override_options = {
+            :timeout => 180
+        }
+        parameters = {
+            :param1 => 'value1',
+            :param2 => 'value2'
+        }
+        answer = {
+            :disable_rollback => true,
+            :timeout => 180,
+            :parameters => {
+                :param1 => 'value1',
+                :param2 => 'value2'
+            }
+        }
+        expect(template.aws_options(override_options, parameters)).to eql(answer)
+      end
+    end
+
+  end
+end

data/spec/fixtures/_partial.json.erb

@@ -0,0 +1 @@
+"param3" : <%= @param3 %>

data/spec/fixtures/with_custom_erb_validations.erb

@@ -0,0 +1,4 @@
+<%
+# Validate parameters
+raise 'Required parameter "@presence_param" is missing.' if @presence_param.nil? || @presence_param.empty?
+%>

data/spec/fixtures/with_erb_parameters.erb

@@ -0,0 +1,3 @@
+This file contains parameters.
+<%= @param1 %>
+<%= @param2 %>

data/spec/fixtures/with_erb_parameters.json.erb

@@ -0,0 +1,4 @@
+{
+    "param1" : <%= @param1 %>,
+    "param2" : <%= @param2 %>
+}

data/spec/fixtures/with_erb_parameters_and_stack_options.json.erb

@@ -0,0 +1,5 @@
+<% @stack_options = { :disable_rollback => true } %>
+{
+    "param1" : <%= @param1 %>,
+    "param2" : <%= @param2 %>
+}

data/spec/fixtures/with_erb_parameters_answer.json

@@ -0,0 +1,4 @@
+{
+    "param1" : "value1",
+    "param2" : "value2"
+}

data/spec/fixtures/with_erb_parameters_answer.txt

@@ -0,0 +1,3 @@
+This file contains parameters.
+"value1"
+"value2"

data/spec/fixtures/with_erb_parameters_escaped_answer.json

@@ -0,0 +1,4 @@
+{
+    "param1" : "\"value1\"",
+    "param2" : "\"value2\""
+}

data/spec/fixtures/with_erb_validations.json.erb

@@ -0,0 +1,53 @@
+<%
+@validations = {
+    :presence_param => { :presence => true },
+    :length_param => {
+        :presence => true,
+        :length => {
+            :minimum => 6,
+            :maximum => 6,
+            :in => 6..6,
+            :is => 6
+        }
+    },
+    :nclusion_param => {
+        :exclusion => ['baz'],
+        :inclusion => ['foo', 'bar']
+    },
+    :format_param => {
+        :format => /^[a-z]+$/
+    },
+    :numericality_param_1 => {
+        :numericality => {
+            :only_integer => true,
+            :equal_to => 2,
+            :greater_than => 1,
+            :greater_than_or_equal_to => 2,
+            :less_than => 3,
+            :less_than_or_equal_to => 2,
+            :even => true,
+            :odd => false
+        }
+    },
+    :numericality_param_2 => {
+        :numericality => {
+            :odd => true
+        }
+    }
+}
+%>
+{
+    "AWSTemplateFormatVersion" : "2010-09-09",
+    "Parameters" : {
+        "Param1" : {
+            "Description" : "Test param 1",
+            "Type" : "String",
+            "Default" : "foo"
+        },
+        "Param2" : {
+            "Description" : "Test param 2",
+            "Type" : "String",
+            "Default" : "bar"
+        }
+    }
+}

data/spec/fixtures/with_partial.json.erb

@@ -0,0 +1,5 @@
+{
+    "param1" : <%= @param1 %>,
+    "param2" : <%= @param2 %>,
+    <%= render 'spec/fixtures/_partial.json.erb', { :param3 => @param3 } %>
+}

data/spec/fixtures/with_partial_answer.json

@@ -0,0 +1,5 @@
+{
+    "param1" : "value1",
+    "param2" : "value2",
+    "param3" : "value3"
+}

data/spec/fixtures/with_raw.json.erb

@@ -0,0 +1,3 @@
+{
+    "param1" : <%= raw @param1 %>
+}

data/spec/fixtures/with_raw_answer.json

@@ -0,0 +1,3 @@
+{
+    "param1" : value1
+}

data/spec/fixtures/with_stack_options.json.erb

@@ -0,0 +1,4 @@
+<% @stack_options = { :disable_rollback => true } %>
+{
+    "param1" : "value1"
+}

data/spec/fixtures/without_erb_parameters.erb

@@ -0,0 +1 @@
+This file simply has no parameters. Format doesn't matter.

data/spec/fixtures/without_erb_parameters.json.erb

@@ -0,0 +1,3 @@
+{
+    "param1" : "value1"
+}

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'cloudformula'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+
+    # `.should` is being deprecated. Let's disable it.
+    # https://github.com/rspec/rspec-expectations/blob/master/Should.md
+    c.syntax = :expect             # disables `should`
+
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: cloudformula
+version: !ruby/object:Gem::Version
+  version: 1.1.2
+platform: ruby
+authors:
+- Kabam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: CloudFormula is a tool which generates and uploads CloudFormation templates
+  from ERB templates.
+email: 
+executables:
+- cloudformula
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/cloudformula
+- cloudformula.gemspec
+- integration_tests/.ruby-gemset
+- integration_tests/.ruby-version
+- integration_tests/Gemfile
+- integration_tests/README.md
+- integration_tests/fixtures/minimal_cf_template.json
+- integration_tests/fixtures/minimal_cf_template_update.json
+- integration_tests/stack_create_update.rb
+- lib/cloudformula.rb
+- lib/cloudformula/cli.rb
+- lib/cloudformula/cloud_formation.rb
+- lib/cloudformula/help/create.txt
+- lib/cloudformula/help/generate.txt
+- lib/cloudformula/help/top.txt
+- lib/cloudformula/help/update.txt
+- lib/cloudformula/json_erb.rb
+- lib/cloudformula/string.rb
+- lib/cloudformula/template.rb
+- lib/cloudformula/validator.rb
+- lib/cloudformula/version.rb
+- spec/cloud_formula_spec.rb
+- spec/cloudformula/cloud_formation_spec.rb
+- spec/cloudformula/template_spec.rb
+- spec/fixtures/_partial.json.erb
+- spec/fixtures/with_custom_erb_validations.erb
+- spec/fixtures/with_erb_parameters.erb
+- spec/fixtures/with_erb_parameters.json.erb
+- spec/fixtures/with_erb_parameters_and_stack_options.json.erb
+- spec/fixtures/with_erb_parameters_answer.json
+- spec/fixtures/with_erb_parameters_answer.txt
+- spec/fixtures/with_erb_parameters_escaped_answer.json
+- spec/fixtures/with_erb_validations.json.erb
+- spec/fixtures/with_partial.json.erb
+- spec/fixtures/with_partial_answer.json
+- spec/fixtures/with_raw.json.erb
+- spec/fixtures/with_raw_answer.json
+- spec/fixtures/with_stack_options.json.erb
+- spec/fixtures/without_erb_parameters.erb
+- spec/fixtures/without_erb_parameters.json.erb
+- spec/spec_helper.rb
+homepage: https://github.com/Kabam/cloudformula
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: CloudFormula is a tool which generates and uploads CloudFormation templates
+  from ERB templates.
+test_files:
+- spec/cloud_formula_spec.rb
+- spec/cloudformula/cloud_formation_spec.rb
+- spec/cloudformula/template_spec.rb
+- spec/fixtures/_partial.json.erb
+- spec/fixtures/with_custom_erb_validations.erb
+- spec/fixtures/with_erb_parameters.erb
+- spec/fixtures/with_erb_parameters.json.erb
+- spec/fixtures/with_erb_parameters_and_stack_options.json.erb
+- spec/fixtures/with_erb_parameters_answer.json
+- spec/fixtures/with_erb_parameters_answer.txt
+- spec/fixtures/with_erb_parameters_escaped_answer.json
+- spec/fixtures/with_erb_validations.json.erb
+- spec/fixtures/with_partial.json.erb
+- spec/fixtures/with_partial_answer.json
+- spec/fixtures/with_raw.json.erb
+- spec/fixtures/with_raw_answer.json
+- spec/fixtures/with_stack_options.json.erb
+- spec/fixtures/without_erb_parameters.erb
+- spec/fixtures/without_erb_parameters.json.erb
+- spec/spec_helper.rb