stack_master 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8693e4d791f64b4704d3e5b068d0e3a77fa8c6a6
-  data.tar.gz: 69c0fcb456e40b8dc933ea73697bc194b65e20ea
+  metadata.gz: 44ae5dfa519051496de9c2707df2441f8a0a9115
+  data.tar.gz: 8f2065b8c59a2a2399f0398a0dc6a8541d864287
 SHA512:
-  metadata.gz: 6805b7c93f992d0d83f6728732bf58001e5ebdda5bc2cb59d4438ede7e8ef725feb29f77512b5e3d673210405f7e869d197443b77545c602564f0704efe515ed
-  data.tar.gz: 42bc841676942028c0f8cc59206e5d7ca3dfb8c38301aa52e543c921eff25bd3afd97f0ba2e1a02bbf386e4d81d34684aa3c71e9e32390e69fa8cc35abb00bbd
+  metadata.gz: 50f3472de66c642581c80398f5430c9fcb596f5b973582834a65bfbca589265be7e2951a584e2459f42f2aa9fcdf1fd2c9fd9bfd07dca1397e8007d67641c6f4
+  data.tar.gz: 2a2e5221add3e4aa4c3910de36f73d26eb551d63b3272526e5329124d386feccc8566bcbe593a4e49833e8996c7835ab1d577b4e72d70326176fbc5242f45c1e

data/README.md

@@ -390,6 +390,37 @@ container_definitions array!(
 )
 ```
 
+## Compiler Options & Alternate Template Directories
+
+StackMaster allows you to separate your stack definitions and parameters from your templates by way of a `template_dir` key in your stack_master.yml.
+You can also pass compiler-specific options to the template compiler to further customize SparkleFormation or CfnDsl's behavior.  Combining the 2 lets you move your SFN templates away from your stack definitions.  For example, if your project is laid out as:
+
+```
+project-root
+|-- envs
+  |-- env-1
+    |-- stack_master.yml
+  |-- env-2
+    |-- stack_master.yml
+|-- sparkle
+  |-- templates
+    |-- my-stack.rb
+```
+
+Your env-1/stack_master.yml files can reference common templates by setting:
+
+```
+template_dir: ../../sparkle/templates
+stack_defaults:
+  compiler_options:
+    sparkle_path: ../../sparkle
+
+stacks:
+  us-east-1:
+    my-stack:
+      template: my-stack.rb
+```
+
 ## Commands
 
 ```bash

data/features/apply.feature

@@ -78,7 +78,7 @@ Feature: Apply command
       | +    "Vpc": {                                                                  |
       | Parameters diff:                                                               |
       | KeyName: my-key                                                                |
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
     Then the exit status should be 0
 
   Scenario: Run apply and don't create the stack
@@ -90,7 +90,7 @@ Feature: Apply command
       | Parameters diff: |
       | KeyName: my-key  |
       | aborted          |
-    And the output should not match /2020-10-29 00:00:00 \+[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should not match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
     Then the exit status should be 0
 
   Scenario: Run apply with region only and create 2 stacks
@@ -120,11 +120,11 @@ Feature: Apply command
       | +    "Vpc": {                                                                  |
       | Parameters diff:                                                               |
       | KeyName: my-key                                                                |
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-web AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-web AWS::CloudFormation::Stack CREATE_COMPLETE/
     Then the exit status should be 0
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-web AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-web AWS::CloudFormation::Stack CREATE_COMPLETE/
     Then the exit status should be 0
 
   Scenario: Create stack with --changed
@@ -154,11 +154,11 @@ Feature: Apply command
       | +    "Vpc": {                                                                  |
       | Parameters diff:                                                               |
       | KeyName: my-key                                                                |
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-web AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-web AWS::CloudFormation::Stack CREATE_COMPLETE/
     Then the exit status should be 0
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-web AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-web AWS::CloudFormation::Stack CREATE_COMPLETE/
     Then the exit status should be 0
 
   Scenario: Update a stack
@@ -324,7 +324,7 @@ Feature: Apply command
       | +    "TestSg": {                                                               |
       | Parameters diff:                                                               |
       | VpcId: vpc-xxxxxx                                                              |
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-web AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-web AWS::CloudFormation::Stack CREATE_COMPLETE/
     Then the exit status should be 0
 
   Scenario: Create a stack with a notification ARN and a stack update policy

data/features/apply_with_s3.feature

@@ -68,7 +68,7 @@ Feature: Apply command
       | +    "Vpc": {                                                                  |
       | Parameters diff:                                                               |
       | KeyName: my-key                                                                |
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
     And an S3 file in bucket "my-bucket" with key "cfn_templates/my-app/myapp_vpc.json" exists with content:
       """
       {

data/features/delete.feature

@@ -8,7 +8,7 @@ Feature: Delete command
       | stack_id | event_id | stack_name | logical_resource_id | resource_status | resource_type              | timestamp           |
       |        1 |        1 | myapp-vpc  | myapp-vpc           | DELETE_COMPLETE | AWS::CloudFormation::Stack | 2020-10-29 00:00:00 |
     When I run `stack_master delete us-east-1 myapp-vpc --trace`
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-vpc AWS::CloudFormation::Stack DELETE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-vpc AWS::CloudFormation::Stack DELETE_COMPLETE/
     Then the exit status should be 0
 
   Scenario: Run a delete command on a stack that does not exists

data/features/events.feature

@@ -30,4 +30,4 @@ Feature: Events command
       | 1        | 1        | myapp-vpc  | TestSg              | CREATE_COMPLETE | AWS::EC2::SecurityGroup    | 2020-10-29 00:00:00 |
       | 1        | 1        | myapp-vpc  | myapp-vpc           | CREATE_COMPLETE | AWS::CloudFormation::Stack | 2020-10-29 00:00:00 |
     When I run `stack_master events us-east-1 myapp-vpc --trace`
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/

data/features/region_aliases.feature

@@ -58,5 +58,5 @@ Feature: Region aliases
       | +    "Vpc": {                                                                  |
       | Parameters diff:                                                               |
       | KeyName: my-key                                                                |
-    And the output should match /2020-10-29 00:00:00 \+[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
+    And the output should match /2020-10-29 00:00:00 (\+|\-)[0-9]{4} myapp-vpc AWS::CloudFormation::Stack CREATE_COMPLETE/
     Then the exit status should be 0

data/lib/stack_master/config.rb

@@ -12,6 +12,7 @@ module StackMaster
 
     attr_accessor :stacks,
                   :base_dir,
+                  :template_dir,
                   :stack_defaults,
                   :region_defaults,
                   :region_aliases,
@@ -33,6 +34,7 @@ module StackMaster
     def initialize(config, base_dir)
       @config = config
       @base_dir = base_dir
+      @template_dir = config.fetch('template_dir', nil)
       @stack_defaults = config.fetch('stack_defaults', {})
       @region_aliases = Utils.underscore_keys_to_hyphen(config.fetch('region_aliases', {}))
       @region_to_aliases = @region_aliases.inject({}) do |hash, (key, value)|
@@ -108,6 +110,7 @@ module StackMaster
             'region' => region,
             'stack_name' => stack_name,
             'base_dir' => @base_dir,
+            'template_dir' => @template_dir,
             'additional_parameter_lookup_dirs' => @region_to_aliases[region])
           @stacks << StackDefinition.new(stack_attributes)
         end

data/lib/stack_master/stack.rb

@@ -63,7 +63,7 @@ module StackMaster
 
     def self.generate(stack_definition, config)
       parameter_hash = ParameterLoader.load(stack_definition.parameter_files)
-      template_body = TemplateCompiler.compile(config, stack_definition.template_file_path)
+      template_body = TemplateCompiler.compile(config, stack_definition.template_file_path, stack_definition.compiler_options)
       template_format = TemplateUtils.identify_template_format(template_body)
       parameters = ParameterResolver.resolve(config, stack_definition, parameter_hash)
       stack_policy_body = if stack_definition.stack_policy_file_path

data/lib/stack_master/stack_definition.rb

@@ -7,20 +7,24 @@ module StackMaster
                   :role_arn,
                   :notification_arns,
                   :base_dir,
+                  :template_dir,
                   :secret_file,
                   :stack_policy_file,
                   :additional_parameter_lookup_dirs,
                   :s3,
-                  :files
+                  :files,
+                  :compiler_options
 
     include Utils::Initializable
 
     def initialize(attributes = {})
       @additional_parameter_lookup_dirs = []
+      @compiler_options = {}
       @notification_arns = []
       @s3 = {}
       @files = []
       super
+      @template_dir ||= File.join(@base_dir, 'templates')
     end
 
     def ==(other)
@@ -35,15 +39,12 @@ module StackMaster
         @secret_file == other.secret_file &&
         @stack_policy_file == other.stack_policy_file &&
         @additional_parameter_lookup_dirs == other.additional_parameter_lookup_dirs &&
-        @s3 == other.s3
-    end
-
-    def template_dir
-      File.join(base_dir, 'templates')
+        @s3 == other.s3 &&
+        @compiler_options == other.compiler_options
     end
 
     def template_file_path
-      File.join(template_dir, template)
+      File.expand_path(File.join(template_dir, template))
     end
 
     def files_dir

data/lib/stack_master/template_compiler.rb

@@ -2,10 +2,10 @@ module StackMaster
   class TemplateCompiler
     TemplateCompilationFailed = Class.new(RuntimeError)
 
-    def self.compile(config, template_file_path)
+    def self.compile(config, template_file_path, compiler_options = {})
       compiler = template_compiler_for_file(template_file_path, config)
       compiler.require_dependencies
-      compiler.compile(template_file_path)
+      compiler.compile(template_file_path, compiler_options)
     rescue
       raise TemplateCompilationFailed.new("Failed to compile #{template_file_path}.")
     end

data/lib/stack_master/template_compilers/cfndsl.rb

@@ -4,10 +4,10 @@ module StackMaster::TemplateCompilers
       require 'cfndsl'
     end
 
-    def self.compile(template_file_path)
+    def self.compile(template_file_path, compiler_options = {})
       ::CfnDsl.eval_file_with_extras(template_file_path).to_json
     end
 
     StackMaster::TemplateCompiler.register(:cfndsl, self)
   end
-end
+end

data/lib/stack_master/template_compilers/json.rb

@@ -7,7 +7,7 @@ module StackMaster::TemplateCompilers
       require 'json'
     end
 
-    def self.compile(template_file_path)
+    def self.compile(template_file_path, compiler_options = {})
       template_body = File.read(template_file_path)
       if template_body.size > MAX_TEMPLATE_SIZE
         # Parse the json and rewrite compressed
@@ -19,4 +19,4 @@ module StackMaster::TemplateCompilers
 
     StackMaster::TemplateCompiler.register(:json, self)
   end
-end
+end

data/lib/stack_master/template_compilers/sparkle_formation.rb

@@ -5,11 +5,16 @@ module StackMaster::TemplateCompilers
       require 'stack_master/sparkle_formation/template_file'
     end
 
-    def self.compile(template_file_path)
-      ::SparkleFormation.sparkle_path = File.dirname(template_file_path)
+    def self.compile(template_file_path, compiler_options = {})
+      if compiler_options["sparkle_path"]
+        ::SparkleFormation.sparkle_path = File.expand_path(compiler_options["sparkle_path"])
+      else
+        ::SparkleFormation.sparkle_path = File.dirname(template_file_path)
+      end
+
       JSON.pretty_generate(::SparkleFormation.compile(template_file_path))
     end
 
     StackMaster::TemplateCompiler.register(:sparkle_formation, self)
   end
-end
+end

data/lib/stack_master/template_compilers/yaml.rb

@@ -5,7 +5,7 @@ module StackMaster::TemplateCompilers
       require 'json'
     end
 
-    def self.compile(template_file_path)
+    def self.compile(template_file_path, compiler_options = {})
       File.read(template_file_path)
     end
 

data/lib/stack_master/validator.rb

@@ -11,7 +11,7 @@ module StackMaster
 
     def perform
       StackMaster.stdout.print "#{@stack_definition.stack_name}: "
-      template_body = TemplateCompiler.compile(@config, @stack_definition.template_file_path)
+      template_body = TemplateCompiler.compile(@config, @stack_definition.template_file_path, @stack_definition.compiler_options)
       cf.validate_template(template_body: TemplateUtils.maybe_compressed_template_body(template_body))
       StackMaster.stdout.puts "valid"
       true

data/lib/stack_master/version.rb

@@ -1,3 +1,3 @@
 module StackMaster
-  VERSION = "0.14.0"
+  VERSION = "0.15.0"
 end

data/spec/stack_master/stack_spec.rb

@@ -87,7 +87,7 @@ RSpec.describe StackMaster::Stack do
     before do
       allow(StackMaster::ParameterLoader).to receive(:load).and_return(parameter_hash)
       allow(StackMaster::ParameterResolver).to receive(:resolve).and_return(resolved_parameters)
-      allow(StackMaster::TemplateCompiler).to receive(:compile).with(config, stack_definition.template_file_path).and_return(template_body)
+      allow(StackMaster::TemplateCompiler).to receive(:compile).with(config, stack_definition.template_file_path, stack_definition.compiler_options).and_return(template_body)
       allow(File).to receive(:read).with(stack_definition.stack_policy_file_path).and_return(stack_policy_body)
     end
 

data/spec/stack_master/template_compiler_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe StackMaster::TemplateCompiler do
 
     class TestTemplateCompiler
       def self.require_dependencies; end
-      def self.compile(template_file_path); end
+      def self.compile(template_file_path, compile_options); end
     end
 
     context 'when a template compiler is registered for the given file type' do
@@ -14,10 +14,16 @@ RSpec.describe StackMaster::TemplateCompiler do
       }
 
       it 'compiles the template using the relevant template compiler' do
-        expect(TestTemplateCompiler).to receive(:compile).with(template_file_path)
+        expect(TestTemplateCompiler).to receive(:compile).with(template_file_path, anything)
         StackMaster::TemplateCompiler.compile(config, template_file_path)
       end
 
+      it 'passes compile_options to the template compiler' do
+        opts = {foo: 1, bar: true, baz: "meh"}
+        expect(TestTemplateCompiler).to receive(:compile).with(template_file_path, opts)
+        StackMaster::TemplateCompiler.compile(config, template_file_path, opts)
+      end
+
       context 'when template compilation fails' do
         before { allow(TestTemplateCompiler).to receive(:compile).and_raise(RuntimeError) }
 

data/spec/stack_master/template_compilers/sparkle_formation_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe StackMaster::TemplateCompilers::SparkleFormation do
   describe '.compile' do
     def compile
-      described_class.compile(template_file_path)
+      described_class.compile(template_file_path, compiler_options)
     end
 
     before do
@@ -9,6 +9,7 @@ RSpec.describe StackMaster::TemplateCompilers::SparkleFormation do
     end
 
     let(:template_file_path) { '/base_dir/templates/template.rb' }
+    let(:compiler_options) { {} }
 
     it 'compiles with sparkleformation' do
       expect(compile).to eq("{\n}")
@@ -18,5 +19,19 @@ RSpec.describe StackMaster::TemplateCompilers::SparkleFormation do
       compile
       expect(SparkleFormation.sparkle_path).to eq File.dirname(template_file_path)
     end
+
+    context 'with a custom sparkle_path' do
+      let(:compiler_options)  { { "sparkle_path" => '../foo' } }
+
+      it 'does not use the default path' do
+        compile
+        expect(SparkleFormation.sparkle_path).to_not eq File.dirname(template_file_path)
+      end
+
+      it 'expands the given path' do
+        compile
+        expect(SparkleFormation.sparkle_path).to match %r{^/.+/foo}
+      end
+    end
   end
-end
+end

data/stack_master.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "erubis"
   spec.add_dependency "colorize"
   spec.add_dependency "activesupport", "~> 4.2"
-  spec.add_dependency "sparkle_formation", "~> 1.1"
+  spec.add_dependency "sparkle_formation"
   spec.add_dependency "table_print"
   spec.add_dependency "dotgpg"
   spec.add_dependency "deep_merge"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-28 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -211,16 +211,16 @@ dependencies:
   name: sparkle_formation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: table_print
   requirement: !ruby/object:Gem::Requirement
@@ -450,7 +450,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: StackMaster is a sure-footed way of creating, updating and keeping track