kumo_keisei 4.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c116cab1d7427e80c7e517cc1a62c5dc380704b
-  data.tar.gz: 6f540668685e80674a94f897c20a5b8e752c4fe6
+  metadata.gz: 7db2c2392cfe443b1f4b92254438a92ec6628034
+  data.tar.gz: eb0d0948727fdc934617f441500a4f254527738c
 SHA512:
-  metadata.gz: b21ed2b0f957a06986da3854ac3a348a7781b98c23052a812218159fa781fe4fa1581a73ab299764539ca8cff8fb70ec6fb624d9bc04ba2ada46161e460bff21
-  data.tar.gz: 17446fcdaf29d7c7c21b820c66724ae7a18ab06a0bf1b46c074f2f758993f38802ec357827b9d70d68e3b4df69deda640fe894a2b9c6e589fea768117fb446ec
+  metadata.gz: 01756da3af8883007f9b8766b8503450539ee0732caf7eecdc354ee260a270566066e8d52a45097c0650db29a50dbd3105ba662a7a3dbc270c6a5bfacd37f1b1
+  data.tar.gz: 2f7ec5597b8380d9624daa22efda61cc82b3b98216ce0c9fd148fe4ff9ff7c532cb086fe23867ad6206ab465daa9080775423a712f15da29bd64b084fc70e166

data/.buildkite/pipeline.yml

@@ -3,6 +3,15 @@ steps:
     command: script/unit_test.sh
     agents:
       location: aws
+  - name: ':rspec: integration-test'
+    command: script/integration_test.sh
+    agents:
+      location: aws
+    env:
+      AWS_REGION: us-east-1
+
+  - wait
+
   - name: ':gem: build'
     command: script/build.sh
     agents:

data/README.md

@@ -205,6 +205,16 @@ This gem is tested with Ruby (MRI) versions 1.9.3 and 2.2.3.
 
 ## Testing changes
 
+### Automated AWS Integration Tests
+
+You can test the Cloudformation responsibilities of this gem by extending the integration tests at `spec/integration`.
+
+To run these tests you need a properly configured AWS environment (with AWS_DEFAULT_REGION, AWS_ACCESS_KEY and AWS_SECRET_ACCESS_KEY set) and then run `./script/integration_test.sh`.
+
+If you run this within a Buildkite job then you will have a stack named "kumokeisei-test-$buildnumber" created and torn down for each integration test context. If you run this outside of a Buildkite job then the stack will be named "kumokeisei-test-$username".
+
+### Manual testing with Kumo Tools container
+
 Changes to the gem can be manually tested end to end in a project that uses the gem (i.e. http-wala).
 
 1. First start the dev-tools container: `kumo tools debug non-production`

data/VERSION

@@ -1 +1 @@
-4.0.3
+4.0.4

data/kumo_keisei.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "pry", "~> 0.10"
 end

data/lib/kumo_keisei/environment_config.rb

@@ -25,9 +25,6 @@ module KumoKeisei
       elsif options[:config_dir_path]
           @log.warn "[DEPRECATION] `:config_dir_path` is deprecated, please pass in `:config_path` instead"
           @config_file_loader = KumoKeisei::FileLoader.new(config_dir_path: options[:config_dir_path])
-      else
-          @log.fatal "Please provide a :config_path"
-          raise ConfigurationError.new("Please provide a :config_path")
       end
 
     end
@@ -52,10 +49,10 @@ module KumoKeisei
     def cf_params
       # returns a list of Cfn friendly paramater_value, paramater_key pairs for
       # consumption by cloudformation.
-      return [] unless params
+      return [] unless params_template_erb
       config
 
-      stack_params = YAML.load(params.result(binding))
+      stack_params = YAML.load(params_template_erb.result(binding))
       KumoKeisei::ParameterBuilder.new(stack_params).params
     end
 
@@ -69,8 +66,8 @@ module KumoKeisei
       @kms ||= KumoKi::KMS.new
     end
 
-    def params
-      return nil unless @params_template_file_path
+    def params_template_erb
+      return nil unless @params_template_file_path && File.exist?(@params_template_file_path)
       template_file_loader = KumoKeisei::FileLoader.new(config_dir_path: File.dirname(@params_template_file_path))
       template_file_loader.load_erb(File.basename(@params_template_file_path))
     end

data/script/integration_test.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -e
+
+echo "--- :clock1: :clock2: running specs :clock3: :clock4:"
+bundle install && bundle exec rspec --pattern "spec/integration/*_spec.rb"
+
+function inline_image {
+  printf '\033]1338;url='"$1"';alt='"$2"'\a\n'
+}
+
+echo "+++ Done! :thumbsup: :shipit:"
+inline_image "https://giftoppr.desktopprassets.com/uploads/f828c372186b5fa80a1c553adbcd4bc4d331396b/tumblr_m2cg550aq21ql201ao1_500.gif" "Yuss"

data/script/unit_test.sh

@@ -3,7 +3,7 @@
 set -e
 
 echo "--- :clock1: :clock2: running specs :clock3: :clock4:"
-bundle install && bundle exec rspec
+bundle install && bundle exec rspec --exclude-pattern "spec/integration/*_spec.rb"
 
 function inline_image {
   printf '\033]1338;url='"$1"';alt='"$2"'\a\n'

data/spec/integration/fixtures/development.yml

@@ -0,0 +1 @@
+SGDescription: "FOO"

data/spec/integration/fixtures/no-parameter-section.json

@@ -0,0 +1,12 @@
+{
+    "AWSTemplateFormatVersion": "2010-09-09",
+    "Description": "A simple CFN stack to test KumoKeisei",
+    "Resources": {
+        "KumoTestSecurityGroup": {
+            "Type": "AWS::EC2::SecurityGroup",
+            "Properties": {
+                "GroupDescription": "A security group to test KumoKeisei"
+            }
+        }
+    }
+}

data/spec/integration/fixtures/one-parameter-no-matching-parameter-template.json

@@ -0,0 +1,18 @@
+{
+    "AWSTemplateFormatVersion": "2010-09-09",
+    "Description": "A simple CFN stack to test KumoKeisei",
+    "Parameters": {
+        "SGDescription": {
+            "Type": "String",
+            "Description": "Description of the security group"
+        }
+    },
+    "Resources": {
+        "KumoTestSecurityGroup": {
+            "Type": "AWS::EC2::SecurityGroup",
+            "Properties": {
+                "GroupDescription": { "Ref": "SGDescription" }
+            }
+        }
+    }
+}

data/spec/integration/fixtures/one-parameter.json

@@ -0,0 +1,18 @@
+{
+    "AWSTemplateFormatVersion": "2010-09-09",
+    "Description": "A simple CFN stack to test KumoKeisei",
+    "Parameters": {
+        "SGDescription": {
+            "Type": "String",
+            "Description": "Description of the security group"
+        }
+    },
+    "Resources": {
+        "KumoTestSecurityGroup": {
+            "Type": "AWS::EC2::SecurityGroup",
+            "Properties": {
+                "GroupDescription": { "Ref": "SGDescription" }
+            }
+        }
+    }
+}

data/spec/integration/fixtures/one-parameter.yml.erb

@@ -0,0 +1 @@
+SGDescription: "<%= config['SGDescription'] %>"

data/spec/integration/stack_spec.rb

@@ -0,0 +1,79 @@
+require 'aws-sdk'
+
+def stack_exists?(stack_name)
+  cloudformation = Aws::CloudFormation::Client.new
+  cloudformation.describe_stacks({ stack_name: stack_name })
+  true
+rescue Aws::CloudFormation::Errors::ValidationError
+  false
+end
+
+describe KumoKeisei::Stack do
+  let(:environment_name) { ENV.fetch('BUILDKITE_BUILD_NUMBER', `whoami`.strip) }
+  let(:stack_name) { "kumokeisei-test" }
+  let(:stack_full_name) { "#{stack_name}-#{environment_name}" }
+
+  let(:stack_timeout_options) do
+    {
+      confirmation_timeout: 30,
+      waiter_delay: 1,
+      waiter_attempts: 90
+    }
+  end
+
+  after do
+    if stack_exists?(stack_full_name)
+      cloudformation = Aws::CloudFormation::Client.new
+      cloudformation.delete_stack(stack_name: stack_full_name)
+      cloudformation.wait_until(:stack_delete_complete, stack_name: stack_full_name) { |waiter| waiter.delay = 1; waiter.max_attempts = 90 }
+    end
+  end
+
+  describe "#apply!" do
+    let(:stack) { KumoKeisei::Stack.new(stack_name, environment_name, stack_timeout_options) }
+    subject { stack.apply!(stack_config) }
+
+    context "when given a CloudFormation template" do
+      context "and a parameter template file exists" do
+        let(:stack_config) do
+          {
+            config_path: File.join(File.dirname(__FILE__), 'fixtures'),
+            template_path: File.join(File.dirname(__FILE__), 'fixtures', 'one-parameter.json')
+          }
+        end
+
+        it "creates a stack" do
+          subject
+          expect(stack_exists?(stack_full_name)).to be true
+        end
+      end
+
+      context "and a parameter template file is not required and does not exist" do
+        let(:stack_config) do
+          {
+            template_path: File.join(File.dirname(__FILE__), 'fixtures', 'no-parameter-section.json')
+          }
+        end
+
+        it "creates a stack" do
+          subject
+          expect(stack_exists?(stack_full_name)).to be true
+        end
+      end
+
+      context "and a parameter template file is required but does not exist" do
+        let(:stack_config) do
+          {
+            template_path: File.join(File.dirname(__FILE__), 'fixtures', 'one-parameter-no-matching-parameter-template.json')
+          }
+        end
+
+        it "does not create a stack" do
+          expect { subject }.to raise_error(Aws::CloudFormation::Errors::ValidationError)
+          expect(stack_exists?(stack_full_name)).to be false
+        end
+      end
+    end
+
+  end
+end

data/spec/lib/kumo_keisei/environment_config_spec.rb

@@ -10,7 +10,7 @@ describe KumoKeisei::EnvironmentConfig do
   end
   let(:file_loader) { instance_double(KumoKeisei::FileLoader) }
   let(:file_loader_cloudformation) { instance_double(KumoKeisei::FileLoader) }
-  let(:parameters) { ERB.new("") }
+  let(:parameters_erb) { ERB.new("") }
   let(:params_template_file_path) { 'junk.txt' }
   let(:environment_config_file_name) { "#{env_name}.yml" }
   let(:kms) { instance_double(KumoKi::KMS) }
@@ -20,58 +20,43 @@ describe KumoKeisei::EnvironmentConfig do
   before do
     allow(KumoKeisei::FileLoader).to receive(:new).and_return(file_loader)
     allow(KumoKi::KMS).to receive(:new).and_return(kms)
-    allow(file_loader).to receive(:load_erb).with(params_template_file_path).and_return(parameters)
+    allow(file_loader).to receive(:load_erb).with(params_template_file_path).and_return(parameters_erb)
     allow(File).to receive(:dirname).and_return('/tmp')
   end
 
   context 'backward compatibility' do
-      context 'config_path' do
-        let(:options) do
-          {
-            env_name: env_name,
-            config_path: config_dir_path
-          }
-        end
-        it 'will be used without complaint' do
-            expect(KumoKeisei::FileLoader).to receive(:new).with(config_dir_path: config_dir_path).and_return(nil)
-            expect(logger).to receive(:warn).at_most(0).times
-            expect(logger).to receive(:fatal).at_most(0).times
-            described_class.new(options, logger)
-        end
+    context 'config_path' do
+      let(:options) do
+        {
+          env_name: env_name,
+          config_path: config_dir_path
+        }
       end
-
-      context 'config_dir_path' do
-        let(:options) do
-          {
-            env_name: env_name,
-            config_dir_path: config_dir_path
-          }
-        end
-
-        it 'will be used if given and raise a deprecation warning' do
-            expect(KumoKeisei::FileLoader).to receive(:new).with(config_dir_path: config_dir_path).and_return(nil)
-            expect(logger).to receive(:warn).with("[DEPRECATION] `:config_dir_path` is deprecated, please pass in `:config_path` instead")
-            described_class.new(options, logger)
-        end
+      it 'will be used without complaint' do
+          expect(KumoKeisei::FileLoader).to receive(:new).with(config_dir_path: config_dir_path).and_return(nil)
+          expect(logger).to receive(:warn).at_most(0).times
+          expect(logger).to receive(:fatal).at_most(0).times
+          described_class.new(options, logger)
       end
+    end
 
-      context 'neither config_path nor config_dir_path' do
-        let(:options) do
-          {
-            env_name: env_name
-          }
-        end
+    context 'config_dir_path' do
+      let(:options) do
+        {
+          env_name: env_name,
+          config_dir_path: config_dir_path
+        }
+      end
 
-        it 'will raise an error' do
-          expect(logger).to receive(:fatal).with("Please provide a :config_path")
-          expect { described_class.new(options, logger)}.to raise_error(KumoKeisei::EnvironmentConfig::ConfigurationError)
-        end
+      it 'will be used if given and raise a deprecation warning' do
+          expect(KumoKeisei::FileLoader).to receive(:new).with(config_dir_path: config_dir_path).and_return(nil)
+          expect(logger).to receive(:warn).with("[DEPRECATION] `:config_dir_path` is deprecated, please pass in `:config_path` instead")
+          described_class.new(options, logger)
       end
+    end
   end
 
   context 'unit tests' do
-    let(:fake_environment_binding) { binding }
-
     describe '#get_binding' do
       subject { environment_config.get_binding }
 
@@ -97,25 +82,31 @@ describe KumoKeisei::EnvironmentConfig do
       end
 
       context 'params is empty' do
-        let(:parameters) { nil }
+        let(:parameters_erb) { nil }
 
         it 'creates an empty array' do
           expect(subject).to eq([])
         end
       end
 
+      context 'no config_path' do
+        let(:options) { { params_template_file_path: "not-a-real-file.yml.erb" } }
+
+        it { is_expected.to eq([]) }
+      end
+
       context 'a hard-coded param' do
-        let(:parameters) { ERB.new("stack_name: \"foo-stack\"") }
-        let(:parameters) { ERB.new("parameter_key: \"parameter_value\"") }
+        let(:parameters_erb) { ERB.new("foo: \"bar\"") }
 
         before do
+          allow(File).to receive(:exist?).with(params_template_file_path).and_return(true)
           allow(file_loader).to receive(:load_hash).with('common.yml').and_return({})
           allow(file_loader).to receive(:load_hash).with('the_jungle.yml').and_return({})
           allow(file_loader).to receive(:load_hash).with('development.yml').and_return({})
         end
 
         it 'creates a array containing an aws formatted parameter hash' do
-          expect(subject).to eq([{parameter_key: "parameter_key", parameter_value: "parameter_value"}])
+          expect(subject).to eq([{parameter_key: "foo", parameter_value: "bar"}])
         end
       end
 
@@ -256,7 +247,9 @@ describe KumoKeisei::EnvironmentConfig do
         subject { environment_config.cf_params }
 
         context 'templated params' do
-          let(:parameters) { ERB.new("stack_name: \"<%= config['stack_name'] %>\"" ) }
+          before { allow(File).to receive(:exist?).with(params_template_file_path).and_return(true) }
+
+          let(:parameters_erb) { ERB.new("stack_name: \"<%= config['stack_name'] %>\"" ) }
           let(:common_config) { { "stack_name" => "common"} }
           let(:staging_config) { { "stack_name" => "staging" } }
           let(:development_config) { { "stack_name" => "development" } }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kumo_keisei
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.4
 platform: ruby
 authors:
 - Redbubble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: 
 email:
 - delivery-engineering@redbubble.com
@@ -108,8 +122,15 @@ files:
 - lib/kumo_keisei/parameter_builder.rb
 - lib/kumo_keisei/stack.rb
 - script/build.sh
+- script/integration_test.sh
 - script/release-gem
 - script/unit_test.sh
+- spec/integration/fixtures/development.yml
+- spec/integration/fixtures/no-parameter-section.json
+- spec/integration/fixtures/one-parameter-no-matching-parameter-template.json
+- spec/integration/fixtures/one-parameter.json
+- spec/integration/fixtures/one-parameter.yml.erb
+- spec/integration/stack_spec.rb
 - spec/lib/kumo_keisei/cloud_formation_stack_spec.rb
 - spec/lib/kumo_keisei/console_jockey_spec.rb
 - spec/lib/kumo_keisei/environment_config_spec.rb
@@ -138,11 +159,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A collection of utilities for dealing with AWS Cloud Formation.
 test_files:
+- spec/integration/fixtures/development.yml
+- spec/integration/fixtures/no-parameter-section.json
+- spec/integration/fixtures/one-parameter-no-matching-parameter-template.json
+- spec/integration/fixtures/one-parameter.json
+- spec/integration/fixtures/one-parameter.yml.erb
+- spec/integration/stack_spec.rb
 - spec/lib/kumo_keisei/cloud_formation_stack_spec.rb
 - spec/lib/kumo_keisei/console_jockey_spec.rb
 - spec/lib/kumo_keisei/environment_config_spec.rb