stack_master 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2df973e8c51854049665bee6f11cff19b8a7aba
-  data.tar.gz: 2ce1a8f1de5d06e02a47aef292648d79c2c52d21
+  metadata.gz: a51b4fe56605619be180809d3e8b936beba108c0
+  data.tar.gz: 479573ec4534231f8cc2dad7a1d7396f240c3ed6
 SHA512:
-  metadata.gz: 869faae3d938ae4cee9e9e666c25077a308220eaa7544fb8a9e78aeeb6df9870df541871102651a3c45efef0f1258490b50be49f48f6bf68d733e5a57001e85e
-  data.tar.gz: b2958b04187ad83dea0e22909f07a66219214080ce097715d02a06775987dc0f86e86bd55482305e9cb8de59a86e4e02c371cab6834a6ff809cafcaec9280a16
+  metadata.gz: 9c7784db458ab74af7d4b7d1b18c4603c1227d73574d1624d013fded5bb6af8ec2f74239b7d30b50085fb6c5b781f62a46905b89f883fe00a77bc469621cdb8e
+  data.tar.gz: e5244c0803bd55d3462fb02f79d239a6b240fd3ca7dd88649021097bc0b20c9ac97fa5e9070667ef5a5d7e3bcc6f3a94cb2ec733a02329692f3fea66719da605

data/.travis.yml

@@ -1,11 +1,12 @@
 language: ruby
 matrix:
   include:
-    - rvm: 2.1.10
+    - rvm: 2.1
       gemfile: spec/support/gemfiles/Gemfile.activesupport-4.0.0
-    - rvm: 2.2.7
-    - rvm: 2.3.4
-    - rvm: 2.4.1
+    - rvm: 2.2
+    - rvm: 2.3
+    - rvm: 2.4
+    - rvm: 2.5
 sudo: false
 script:
   - bundle exec rake spec features

data/README.md

@@ -1,5 +1,9 @@
 ![StackMaster](/logo.png?raw=true)
 
+[![License MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/envato/stack_master/blob/master/LICENSE.md)
+[![Gem Version](https://badge.fury.io/rb/stack_master.svg)](https://badge.fury.io/rb/stack_master)
+[![Build Status](https://travis-ci.org/envato/stack_master.svg?branch=master)](https://travis-ci.org/envato/stack_master)
+
 StackMaster is a CLI tool to manage CloudFormation stacks, with the following features:
 
 - Synchronous visibility into stack updates. See exactly what is changing and
@@ -143,10 +147,13 @@ template_compilers:
 
 ## Parameters
 
-Parameters are loaded from multiple YAML files, merged from the following lookup paths:
+Parameters are loaded from multiple YAML files, merged from the following lookup paths from bottom to top:
 
+- parameters/[stack_name].yaml
 - parameters/[stack_name].yml
+- parameters/[region]/[underscored_stack_name].yaml
 - parameters/[region]/[underscored_stack_name].yml
+- parameters/[region_alias]/[underscored_stack_name].yaml
 - parameters/[region_alias]/[underscored_stack_name].yml
 
 A simple parameter file could look like this:
@@ -290,6 +297,15 @@ A set of possible attributes is available in the [AWS documentation](https://doc
 
 Any value can be an array of possible matches.
 
+### Environment Variable
+
+Lookup an environment variable:
+
+```yaml
+db_username:
+  env: DB_USERNAME
+```
+
 ### Custom parameter resolvers
 
 New parameter resolvers can be created in a separate gem.

data/features/apply.feature

@@ -207,8 +207,10 @@ Feature: Apply command
       | Stack diff:                                                                    |
       | -    "TestSg2": {                                                              |
       | Parameters diff: No changes                                                    |
+      | ========================================                                       |
       | Proposed change set:                                                           |
       | Replace                                                                        |
+      | ========================================                                       |
       | Apply change set (y/n)?                                                              |
     Then the exit status should be 0
 

data/features/apply_with_env_parameters.feature

@@ -0,0 +1,49 @@
+Feature: Apply command with environment parameter
+
+  Background:
+    Given a file named "stack_master.yml" with:
+      """
+      stacks:
+        us-east-2:
+          vpc:
+            template: vpc.rb
+      """
+    And a directory named "parameters"
+    And a file named "parameters/vpc.yml" with:
+      """
+      vpc_cidr:
+        env: VPC_CIDR
+      """
+    And a directory named "templates"
+    And a file named "templates/vpc.rb" with:
+      """
+      SparkleFormation.new(:vpc) do
+
+        parameters.vpc_cidr do
+          type 'String'
+        end
+
+        resources.vpc do
+          type 'AWS::EC2::VPC'
+          properties do
+            cidr_block ref!(:vpc_cidr)
+          end
+        end
+
+      end
+      """
+
+  Scenario: Run apply and create a new stack
+    Given I stub the following stack events:
+      | stack_id | event_id | stack_name | logical_resource_id | resource_status | resource_type              | timestamp           |
+      | 1        | 1        | vpc        | Vpc                 | CREATE_COMPLETE | AWS::EC2::VPC              | 2020-10-29 00:00:00 |
+      | 1        | 1        | vpc        | vpc                 | CREATE_COMPLETE | AWS::CloudFormation::Stack | 2020-10-29 00:00:00 |
+    And I set the environment variables to:
+      | variable | value       |
+      | VPC_CIDR | 10.0.0.0/16 |
+    When I run `stack_master apply us-east-2 vpc --trace`
+    And the output should contain all of these lines:
+      | +---                  |
+      | +VpcCidr: 10.0.0.0/16 |
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
+    Then the exit status should be 0

data/lib/stack_master.rb

@@ -60,6 +60,7 @@ module StackMaster
     autoload :SecurityGroup, 'stack_master/parameter_resolvers/security_group'
     autoload :LatestAmiByTags, 'stack_master/parameter_resolvers/latest_ami_by_tags'
     autoload :LatestAmi, 'stack_master/parameter_resolvers/latest_ami'
+    autoload :Env, 'stack_master/parameter_resolvers/env'
   end
 
   module AwsDriver

data/lib/stack_master/change_set.rb

@@ -42,10 +42,15 @@ module StackMaster
     end
 
     def display(io)
-      io.puts "Proposed change set:"
+      io.puts <<-EOL
+
+========================================
+Proposed change set:
+EOL
       @response.changes.each do |change|
         display_resource_change(io, change.resource_change)
       end
+io.puts "========================================"
     end
 
     def failed?

data/lib/stack_master/parameter_resolvers/env.rb

@@ -0,0 +1,18 @@
+module StackMaster
+  module ParameterResolvers
+    class Env < Resolver
+
+      def initialize(config, stack_definition)
+        @config = config
+        @stack_definition = stack_definition
+      end
+
+      def resolve(value)
+        environment_variable = ENV[value]
+        raise ArgumentError, "The environment variable #{value} is not set" if environment_variable.nil?
+        environment_variable
+      end
+
+    end
+  end
+end

data/lib/stack_master/stack_definition.rb

@@ -84,16 +84,16 @@ module StackMaster
     def additional_parameter_lookup_file_paths
       return unless additional_parameter_lookup_dirs
       additional_parameter_lookup_dirs.map do |a|
-        File.join(base_dir, 'parameters', a, "#{underscored_stack_name}.yml")
+        Dir.glob(File.join(base_dir, 'parameters', a, "#{underscored_stack_name}.y*ml"))
       end
     end
 
     def region_parameter_file_path
-      File.join(base_dir, 'parameters', "#{region}", "#{underscored_stack_name}.yml")
+      Dir.glob(File.join(base_dir, 'parameters', "#{region}", "#{underscored_stack_name}.y*ml"))
     end
 
     def default_parameter_file_path
-      File.join(base_dir, 'parameters', "#{underscored_stack_name}.yml")
+      Dir.glob(File.join(base_dir, 'parameters', "#{underscored_stack_name}.y*ml"))
     end
 
     def underscored_stack_name

data/lib/stack_master/version.rb

@@ -1,3 +1,3 @@
 module StackMaster
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/stack_master/parameter_loader_spec.rb

@@ -54,6 +54,23 @@ RSpec.describe StackMaster::ParameterLoader do
     end
   end
 
+  context 'yml and yaml region parameter files' do
+    let(:stack_file_returns) { {exists: false} }
+    let(:region_file_returns) { {exists: true, read: "Param2: value2"} }
+    let(:region_yaml_file_returns) { {exists: true, read: "Param1: value1\nParam2: valueX"} }
+    let(:region_yaml_file_name) { "/base_dir/parameters/us-east-1/stack_name.yaml" }
+
+    subject(:parameters) { StackMaster::ParameterLoader.load([stack_file_name, region_yaml_file_name, region_file_name]) }
+
+    before do
+      file_mock(region_yaml_file_name, region_yaml_file_returns)
+    end
+
+    it 'returns params from the region base stack_name.yml' do
+      expect(parameters).to eq(template_parameters: {'Param1' => 'value1', 'Param2' => 'value2'}, compile_time_parameters: {})
+    end
+  end
+
   context 'compile time parameters' do
 
     context 'stack parameter file' do

data/spec/stack_master/parameter_resolvers/env_spec.rb

@@ -0,0 +1,35 @@
+RSpec.describe StackMaster::ParameterResolvers::Env do
+
+  describe '#resolve' do
+
+    subject(:resolver) { described_class.new(nil, double(region: 'us-east-1')) }
+    let(:environment_variable_name) { 'TEST' }
+    let(:error) { "The environment variable #{environment_variable_name} is not set" }
+
+    before(:each) do
+      ENV.delete(environment_variable_name)
+    end
+
+    context 'the environment variable is defined' do
+      it 'should return the environment variable value' do
+        ENV[environment_variable_name] = 'a'
+        expect(resolver.resolve(environment_variable_name)).to eq 'a'
+      end
+    end
+
+    context 'the environment variable is undefined' do
+      it 'should raise and error' do
+        expect { resolver.resolve(environment_variable_name) }
+            .to raise_error(ArgumentError, error)
+      end
+    end
+
+    context 'the environment variable is defined but empty' do
+      it 'should return the empty string' do
+        ENV[environment_variable_name] = ''
+        expect(resolver.resolve(environment_variable_name)).to eq ''
+      end
+    end
+
+  end
+end

data/spec/stack_master/stack_definition_spec.rb

@@ -14,23 +14,56 @@ RSpec.describe StackMaster::StackDefinition do
   let(:tags) { {'environment' => 'production'} }
   let(:base_dir) { '/base_dir' }
 
+  before do
+    allow(Dir).to receive(:glob).with(
+      File.join(base_dir, 'parameters', "#{stack_name}.y*ml")
+    ).and_return(
+      [
+        "/base_dir/parameters/#{stack_name}.yaml",
+        "/base_dir/parameters/#{stack_name}.yml",
+      ]
+    )
+
+    allow(Dir).to receive(:glob).with(
+      File.join(base_dir, 'parameters', "#{region}", "#{stack_name}.y*ml")
+    ).and_return(
+      [
+        "/base_dir/parameters/#{region}/#{stack_name}.yaml",
+        "/base_dir/parameters/#{region}/#{stack_name}.yml",
+      ]
+    )
+  end
+
   it 'has default and region specific parameter file locations' do
     expect(stack_definition.parameter_files).to eq([
+      "/base_dir/parameters/#{stack_name}.yaml",
       "/base_dir/parameters/#{stack_name}.yml",
-      "/base_dir/parameters/#{region}/#{stack_name}.yml"
+      "/base_dir/parameters/#{region}/#{stack_name}.yaml",
+      "/base_dir/parameters/#{region}/#{stack_name}.yml",
     ])
   end
 
   context 'with additional parameter lookup dirs' do
     before do
       stack_definition.send(:additional_parameter_lookup_dirs=, ['production'])
+      allow(Dir).to receive(:glob).with(
+        File.join(base_dir, 'parameters', "production", "#{stack_name}.y*ml")
+      ).and_return(
+        [
+          "/base_dir/parameters/production/#{stack_name}.yaml",
+          "/base_dir/parameters/production/#{stack_name}.yml",
+        ]
+      )
     end
 
     it 'includes a parameter lookup dir for it' do
       expect(stack_definition.parameter_files).to eq([
+        "/base_dir/parameters/#{stack_name}.yaml",
         "/base_dir/parameters/#{stack_name}.yml",
+        "/base_dir/parameters/#{region}/#{stack_name}.yaml",
         "/base_dir/parameters/#{region}/#{stack_name}.yml",
-        "/base_dir/parameters/production/#{stack_name}.yml"
+        "/base_dir/parameters/production/#{stack_name}.yaml",
+        "/base_dir/parameters/production/#{stack_name}.yml",
       ])
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2018-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -303,6 +303,7 @@ files:
 - example/simple/templates/myapp_web.rb
 - features/apply.feature
 - features/apply_with_compile_time_parameters.feature
+- features/apply_with_env_parameters.feature
 - features/apply_with_s3.feature
 - features/delete.feature
 - features/diff.feature
@@ -339,6 +340,7 @@ files:
 - lib/stack_master/parameter_loader.rb
 - lib/stack_master/parameter_resolver.rb
 - lib/stack_master/parameter_resolvers/ami_finder.rb
+- lib/stack_master/parameter_resolvers/env.rb
 - lib/stack_master/parameter_resolvers/latest_ami.rb
 - lib/stack_master/parameter_resolvers/latest_ami_by_tags.rb
 - lib/stack_master/parameter_resolvers/secret.rb
@@ -412,6 +414,7 @@ files:
 - spec/stack_master/parameter_loader_spec.rb
 - spec/stack_master/parameter_resolver_spec.rb
 - spec/stack_master/parameter_resolvers/ami_finder_spec.rb
+- spec/stack_master/parameter_resolvers/env_spec.rb
 - spec/stack_master/parameter_resolvers/latest_ami_by_tags_spec.rb
 - spec/stack_master/parameter_resolvers/latest_ami_spec.rb
 - spec/stack_master/parameter_resolvers/secret_spec.rb
@@ -490,6 +493,7 @@ summary: StackMaster is a sure-footed way of creating, updating and keeping trac
 test_files:
 - features/apply.feature
 - features/apply_with_compile_time_parameters.feature
+- features/apply_with_env_parameters.feature
 - features/apply_with_s3.feature
 - features/delete.feature
 - features/diff.feature
@@ -526,6 +530,7 @@ test_files:
 - spec/stack_master/parameter_loader_spec.rb
 - spec/stack_master/parameter_resolver_spec.rb
 - spec/stack_master/parameter_resolvers/ami_finder_spec.rb
+- spec/stack_master/parameter_resolvers/env_spec.rb
 - spec/stack_master/parameter_resolvers/latest_ami_by_tags_spec.rb
 - spec/stack_master/parameter_resolvers/latest_ami_spec.rb
 - spec/stack_master/parameter_resolvers/secret_spec.rb