stack_master 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1acbc281b89ec3188892fac6692c4e885780efd8ba83f746a774557c0e1194ca
-  data.tar.gz: e18cb99eb7f3e99ac0b8fee4b952cb1d21b9f1467a4bbe8dac9250695649f543
+  metadata.gz: f64b125495590bdb3890f184b5ecb67e2b57d13d7e8cc023fb785a543e825e2c
+  data.tar.gz: 0f892956233a734941107967938357400c131d3280e687a5839531aa5dbaa275
 SHA512:
-  metadata.gz: bcc6882c647189f6f758896da7cd8084638b707af26faeb234435b99a1e5cd466c0ca90e2f30a67b4414f21f38d899414d7935e49d2a7355ccd84ad700c87ba9
-  data.tar.gz: b48a690acadd00aa426084cc3b3b7aeb100b6fbfeaad738cb645df77ca6bd3edce347acf71d2b28ec3ff80833f15e4c55f95f5719922f0d061b2102c0ae1760c
+  metadata.gz: d8fdc2f1e629e1620ef5144e5990706ff0e89f390df4cf3880671676bd6ef26091011d87adcdd55e21987311ff6c0cb8724dff58353e352e3e6531c8d915cf73
+  data.tar.gz: 026efc1dec847d78400ea70bf087d52a2601738145790b05d70cc77b6dbd5fde337872c6226fcacf52b5bd4c91f633755ff67147ff48d820ac1ed5626f8ea99f

data/README.md

@@ -570,7 +570,7 @@ stacks:
 
 ```yaml
 stacks:
-  us-east-1
+  us-east-1:
     my-stack:
       template: my-stack-with-dynamic.rb
       compiler_options:
@@ -588,6 +588,26 @@ end
 
 Note though that if a dynamic with the same name exists in your `templates/dynamics/` directory it will get loaded since it has higher precedence.
 
+Templates can be also loaded from sparkle packs by defining `sparkle_pack_template`. The name corresponds to the registered symbol rather than specific name. That means for a sparkle pack containing:
+
+```ruby
+SparkleFormation.new(:template_name) do
+  ...
+end
+```
+
+we can use stack defined as follows:
+
+```yaml
+stacks:
+  us-east-1:
+    my-stack:
+      sparkle_pack_template: template_name
+      compiler_options:
+        sparkle_packs:
+          - some-sparkle-pack
+```
+
 ## Allowed accounts
 
 The AWS account the command is executing in can be restricted to a specific list of allowed accounts. This is useful in reducing the possibility of applying non-production changes in a production account. Each stack definition can specify the `allowed_accounts` property with an array of AWS account IDs the stack is allowed to work with.

data/lib/stack_master/stack.rb

@@ -65,7 +65,7 @@ module StackMaster
       parameter_hash = ParameterLoader.load(stack_definition.parameter_files)
       template_parameters = ParameterResolver.resolve(config, stack_definition, parameter_hash[:template_parameters])
       compile_time_parameters = ParameterResolver.resolve(config, stack_definition, parameter_hash[:compile_time_parameters])
-      template_body = TemplateCompiler.compile(config, stack_definition.template_file_path, compile_time_parameters, stack_definition.compiler_options)
+      template_body = TemplateCompiler.compile(config, stack_definition.template_dir, stack_definition.template_file_path, stack_definition.sparkle_pack_template, compile_time_parameters, stack_definition.compiler_options)
       template_format = TemplateUtils.identify_template_format(template_body)
       stack_policy_body = if stack_definition.stack_policy_file_path
                             File.read(stack_definition.stack_policy_file_path)

data/lib/stack_master/stack_definition.rb

@@ -3,6 +3,7 @@ module StackMaster
     attr_accessor :region,
                   :stack_name,
                   :template,
+                  :sparkle_pack_template,
                   :tags,
                   :role_arn,
                   :allowed_accounts,
@@ -39,6 +40,7 @@ module StackMaster
         @region == other.region &&
         @stack_name == other.stack_name &&
         @template == other.template &&
+        @sparkle_pack_template == other.sparkle_pack_template &&
         @tags == other.tags &&
         @role_arn == other.role_arn &&
         @allowed_accounts == other.allowed_accounts &&
@@ -55,6 +57,7 @@ module StackMaster
     end
 
     def template_file_path
+      return unless template
       File.expand_path(File.join(template_dir, template))
     end
 

data/lib/stack_master/template_compiler.rb

@@ -2,12 +2,12 @@ module StackMaster
   class TemplateCompiler
     TemplateCompilationFailed = Class.new(RuntimeError)
 
-    def self.compile(config, template_file_path, compile_time_parameters, compiler_options = {})
-      compiler = template_compiler_for_file(template_file_path, config)
+    def self.compile(config, template_dir, template_file_path, sparkle_pack_template, compile_time_parameters, compiler_options = {})
+      compiler = template_compiler_for_stack(template_file_path, sparkle_pack_template, config)
       compiler.require_dependencies
-      compiler.compile(template_file_path, compile_time_parameters, compiler_options)
+      compiler.compile(template_dir, template_file_path, sparkle_pack_template, compile_time_parameters, compiler_options)
     rescue StandardError => e
-      raise TemplateCompilationFailed.new("Failed to compile #{template_file_path} with error #{e}.\n#{e.backtrace}")
+      raise TemplateCompilationFailed.new("Failed to compile #{template_file_path || sparkle_pack_template} with error #{e}.\n#{e.backtrace}")
     end
 
     def self.register(name, klass)
@@ -16,11 +16,16 @@ module StackMaster
     end
 
     # private
-    def self.template_compiler_for_file(template_file_path, config)
-      compiler_name = config.template_compilers.fetch(file_ext(template_file_path))
+    def self.template_compiler_for_stack(template_file_path, sparkle_pack_template, config)
+      ext = if sparkle_pack_template
+        :rb
+      else
+        file_ext(template_file_path)
+      end
+      compiler_name = config.template_compilers.fetch(ext)
       @compilers.fetch(compiler_name)
     end
-    private_class_method :template_compiler_for_file
+    private_class_method :template_compiler_for_stack
 
     def self.file_ext(template_file_path)
       File.extname(template_file_path).gsub('.', '').to_sym

data/lib/stack_master/template_compilers/cfndsl.rb

@@ -4,7 +4,7 @@ module StackMaster::TemplateCompilers
       require 'cfndsl'
     end
 
-    def self.compile(template_file_path, compile_time_parameters, _compiler_options = {})
+    def self.compile(_template_dir, template_file_path, _sparkle_pack_template, compile_time_parameters, _compiler_options = {})
       CfnDsl.disable_binding
       CfnDsl::ExternalParameters.defaults.clear # Ensure there's no leakage across invocations
       CfnDsl::ExternalParameters.defaults(compile_time_parameters.symbolize_keys)

data/lib/stack_master/template_compilers/json.rb

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

data/lib/stack_master/template_compilers/sparkle_formation.rb

@@ -12,8 +12,8 @@ module StackMaster::TemplateCompilers
       require 'stack_master/sparkle_formation/template_file'
     end
 
-    def self.compile(template_file_path, compile_time_parameters, compiler_options = {})
-      sparkle_template = compile_sparkle_template(template_file_path, compiler_options)
+    def self.compile(template_dir, template_file_path, sparkle_pack_template, compile_time_parameters, compiler_options = {})
+      sparkle_template = compile_sparkle_template(template_dir, template_file_path, sparkle_pack_template, compiler_options)
       definitions = sparkle_template.parameters
       validate_definitions(definitions)
       validate_parameters(definitions, compile_time_parameters)
@@ -27,9 +27,12 @@ module StackMaster::TemplateCompilers
 
     private
 
-    def self.compile_sparkle_template(template_file_path, compiler_options)
-      sparkle_path = compiler_options['sparkle_path'] ?
-                        File.expand_path(compiler_options['sparkle_path']) : File.dirname(template_file_path)
+    def self.compile_sparkle_template(template_dir, template_file_path, sparkle_pack_template, compiler_options)
+      sparkle_path = if compiler_options['sparkle_path']
+        File.expand_path(compiler_options['sparkle_path'])
+      else
+        template_dir
+      end
 
       collection = ::SparkleFormation::SparkleCollection.new
       root_pack = ::SparkleFormation::Sparkle.new(
@@ -44,6 +47,11 @@ module StackMaster::TemplateCompilers
         end
       end
 
+      if sparkle_pack_template
+        raise ArgumentError.new("Template #{sparkle_pack_template} not found in any sparkle pack") unless collection.templates['aws'].include? sparkle_pack_template
+        template_file_path = collection.templates['aws'][sparkle_pack_template].top['path']
+      end
+
       sparkle_template = compile_template_with_sparkle_path(template_file_path, sparkle_path)
       sparkle_template.sparkle.apply(collection)
       sparkle_template

data/lib/stack_master/template_compilers/yaml.rb

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

data/lib/stack_master/validator.rb

@@ -14,7 +14,7 @@ module StackMaster
       compile_time_parameters = ParameterResolver.resolve(@config, @stack_definition, parameter_hash[:compile_time_parameters])
 
       StackMaster.stdout.print "#{@stack_definition.stack_name}: "
-      template_body = TemplateCompiler.compile(@config, @stack_definition.template_file_path, compile_time_parameters, @stack_definition.compiler_options)
+      template_body = TemplateCompiler.compile(@config, @stack_definition.template_dir, @stack_definition.template_file_path, @stack_definition.sparkle_pack_template, compile_time_parameters, @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 = "1.15.0"
+  VERSION = "1.16.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2019-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -529,7 +529,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: StackMaster is a sure-footed way of creating, updating and keeping track