stack_master 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f146a3b9b4ca20e6c3fdf98d3620886663ec113cb81f7d763918aad28d5d42c
-  data.tar.gz: c7ebfef287797cff8cbb1ee74bafcbe583da1eb14079ea4b94d2102fbc48ea18
+  metadata.gz: f94d2bab69225428425d5e3bc426ca572c781aa5d9e069420c198c86640f84c5
+  data.tar.gz: f4f164e4390d568e9a7511013a33796ad04862d18510ec5683c2024b9952781f
 SHA512:
-  metadata.gz: 45ca7571feb3989ba167eec7b7dc27ba3ed003aec6890e6c172c4ced6dc432fb29bcc618481880604783f02138ca644b17d9f329f73dcab81d73585104a768c9
-  data.tar.gz: dead78c859b1d6cda3148a045c99d31c116a2849ccb2112d231561ae708e619236e4951754d7cdeecf53e08dd68ce99f2f8e242f255c6a168257c6b7cdaec021
+  metadata.gz: 81122997265f0aa25d24f54ee3ccbb5a0a3689b362b37445bd0c12435dc0fcbb24e0d8ce277c949c1e3af5c01d3b5ff938227f6b6f051b97cc8da66f400519d6
+  data.tar.gz: b5f8114a90fc7cc402e07e34676b7142b3849c4e8eecdc43cb67651358e5e7e6228ab04b68ef5b769b98ff91e7efd2ec9667a5c197699bccbfb96d49848585ed

data/README.md

@@ -123,6 +123,7 @@ stack_defaults:
 ```
 
 Additional files can be configured to be uploaded to S3 alongside the templates:
+
 ```yaml
 stacks:
   production:
@@ -131,6 +132,7 @@ stacks:
       files:
         - userdata.sh
 ```
+
 ## Directories
 
 - `templates` - CloudFormation, SparkleFormation or CfnDsl templates.
@@ -155,7 +157,8 @@ template_compilers:
 
 ## Parameters
 
-Parameters are loaded from multiple YAML files, merged from the following lookup paths from bottom to top:
+By default, 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
@@ -170,6 +173,30 @@ A simple parameter file could look like this:
 key_name: myapp-us-east-1
 ```
 
+Alternatively, a `parameter_files` array can be defined to explicitly list
+parameter files that will be loaded. If `parameter_files` are defined, the
+automatic search locations will not be used.
+
+```yaml
+parameters_dir: parameters # the default
+stacks:
+  us-east-1:
+    my-app:
+      parameter_files:
+        - my-app.yml # parameters/my-app.yml
+```
+
+Parameters can also be defined inline with stack definitions:
+
+```yaml
+stacks:
+  us-east-1:
+    my-app:
+      parameters:
+        VpcId:
+          stack_output: my-vpc/VpcId
+```
+
 ### Compile Time Parameters
 
 Compile time parameters can be used for [SparkleFormation](http://www.sparkleformation.io) templates. It conforms and

data/lib/stack_master/commands/tidy.rb

@@ -12,7 +12,7 @@ module StackMaster
         parameter_files = Set.new(find_parameter_files())
 
         status = @config.stacks.each do |stack_definition|
-          parameter_files.subtract(stack_definition.parameter_files)
+          parameter_files.subtract(stack_definition.parameter_files_from_globs)
           template = File.absolute_path(stack_definition.template_file_path)
 
           if template

data/lib/stack_master/config.rb

@@ -17,6 +17,7 @@ module StackMaster
     attr_accessor :stacks,
                   :base_dir,
                   :template_dir,
+                  :parameters_dir,
                   :stack_defaults,
                   :region_defaults,
                   :region_aliases,
@@ -39,6 +40,7 @@ module StackMaster
       @config = config
       @base_dir = base_dir
       @template_dir = config.fetch('template_dir', nil)
+      @parameters_dir = config.fetch('parameters_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)|
@@ -115,6 +117,7 @@ module StackMaster
             'stack_name' => stack_name,
             'base_dir' => @base_dir,
             'template_dir' => @template_dir,
+            'parameters_dir' => @parameters_dir,
             'additional_parameter_lookup_dirs' => @region_to_aliases[region])
           stack_attributes['allowed_accounts'] = attributes['allowed_accounts'] if attributes['allowed_accounts']
           @stacks << StackDefinition.new(stack_attributes)

data/lib/stack_master/parameter_loader.rb

@@ -5,10 +5,10 @@ module StackMaster
 
     COMPILE_TIME_PARAMETERS_KEY = 'compile_time_parameters'
 
-    def self.load(parameter_files)
+    def self.load(parameter_files: [], parameters: {})
       StackMaster.debug 'Searching for parameter files...'
-      parameter_files.reduce({template_parameters: {}, compile_time_parameters: {}}) do |hash, file_name|
-        parameters = load_parameters(file_name)
+      all_parameters = parameter_files.map { |file_name| load_parameters(file_name) } + [parameters]
+      all_parameters.reduce({template_parameters: {}, compile_time_parameters: {}}) do |hash, parameters|
         template_parameters = create_template_parameters(parameters)
         compile_time_parameters = create_compile_time_parameters(parameters)
 
@@ -16,7 +16,6 @@ module StackMaster
         merge_and_camelize(hash[:compile_time_parameters], compile_time_parameters)
         hash
       end
-
     end
 
     private

data/lib/stack_master/parameter_validator.rb

@@ -9,15 +9,14 @@ module StackMaster
 
     def error_message
       return nil unless missing_parameters?
-      message = "Empty/blank parameters detected. Please provide values for these parameters:"
+      message = "Empty/blank parameters detected. Please provide values for these parameters:\n"
       missing_parameters.each do |parameter_name|
-        message << "\n - #{parameter_name}"
+        message << " - #{parameter_name}\n"
       end
-      message << "\nParameters will be read from files matching the following globs:"
-      base_dir = Pathname.new(@stack_definition.base_dir)
-      @stack_definition.parameter_file_globs.each do |glob|
-        parameter_file = Pathname.new(glob).relative_path_from(base_dir)
-        message << "\n - #{parameter_file}"
+      if @stack_definition.parameter_files.empty?
+        message << message_for_parameter_globs
+      else
+        message << message_for_parameter_files
       end
       message
     end
@@ -28,6 +27,24 @@ module StackMaster
 
     private
 
+    def message_for_parameter_files
+      "Parameters are configured to be read from the following files:\n".tap do |message|
+        @stack_definition.parameter_files.each do |parameter_file|
+          message << " - #{parameter_file}\n"
+        end
+      end
+    end
+
+    def message_for_parameter_globs
+      "Parameters will be read from files matching the following globs:\n".tap do |message|
+        base_dir = Pathname.new(@stack_definition.base_dir)
+        @stack_definition.parameter_file_globs.each do |glob|
+          parameter_file = Pathname.new(glob).relative_path_from(base_dir)
+          message << " - #{parameter_file}\n"
+        end
+      end
+    end
+
     def missing_parameters
       @missing_parameters ||=
         @stack.parameters_with_defaults.select { |_key, value| value.nil? }.keys

data/lib/stack_master/stack.rb

@@ -56,7 +56,7 @@ module StackMaster
     end
 
     def self.generate(stack_definition, config)
-      parameter_hash = ParameterLoader.load(stack_definition.parameter_files)
+      parameter_hash = ParameterLoader.load(parameter_files: stack_definition.all_parameter_files, parameters: stack_definition.parameters)
       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.compiler, stack_definition.template_dir, stack_definition.template, compile_time_parameters, stack_definition.compiler_options)
@@ -76,7 +76,7 @@ module StackMaster
     end
 
     def self.generate_without_parameters(stack_definition, config)
-      parameter_hash = ParameterLoader.load(stack_definition.parameter_files)
+      parameter_hash = ParameterLoader.load(parameter_files: stack_definition.all_parameter_files, parameters: stack_definition.parameters)
       compile_time_parameters = ParameterResolver.resolve(config, stack_definition, parameter_hash[:compile_time_parameters])
       template_body = TemplateCompiler.compile(config, stack_definition.compiler, stack_definition.template_dir, stack_definition.template, compile_time_parameters, stack_definition.compiler_options)
       template_format = TemplateUtils.identify_template_format(template_body)

data/lib/stack_master/stack_definition.rb

@@ -16,7 +16,10 @@ module StackMaster
                   :additional_parameter_lookup_dirs,
                   :s3,
                   :files,
-                  :compiler_options
+                  :compiler_options,
+                  :parameters_dir,
+                  :parameters,
+                  :parameter_files
 
     attr_reader :compiler
 
@@ -32,8 +35,12 @@ module StackMaster
       @compiler = nil
       super
       @additional_parameter_lookup_dirs ||= []
+      @base_dir ||= ""
       @template_dir ||= File.join(@base_dir, 'templates')
+      @parameters_dir ||= File.join(@base_dir, 'parameters')
       @allowed_accounts = Array(@allowed_accounts)
+      @parameters ||= {}
+      @parameter_files ||= []
     end
 
     def ==(other)
@@ -56,13 +63,9 @@ module StackMaster
         @compiler_options == other.compiler_options
     end
 
-    def compiler=(compiler)
-      @compiler = compiler.&to_sym
-    end
-
     def template_file_path
       return unless template
-      File.expand_path(File.join(template_dir, template))
+      File.expand_path(template, template_dir)
     end
 
     def files_dir
@@ -85,7 +88,15 @@ module StackMaster
       Utils.change_extension(template, 'json')
     end
 
-    def parameter_files
+    def all_parameter_files
+      if parameter_files.empty?
+        parameter_files_from_globs
+      else
+        parameter_files
+      end
+    end
+
+    def parameter_files_from_globs
       parameter_file_globs.map(&Dir.method(:glob)).flatten
     end
 
@@ -101,20 +112,26 @@ module StackMaster
       !s3.nil?
     end
 
+    def parameter_files
+      Array(@parameter_files).map do |file|
+        File.expand_path(file, parameters_dir)
+      end
+    end
+
     private
 
     def additional_parameter_lookup_globs
       additional_parameter_lookup_dirs.map do |a|
-        File.join(base_dir, 'parameters', a, "#{stack_name_glob}.y*ml")
+        File.join(parameters_dir, a, "#{stack_name_glob}.y*ml")
       end
     end
 
     def region_parameter_glob
-      File.join(base_dir, 'parameters', "#{region}", "#{stack_name_glob}.y*ml")
+      File.join(parameters_dir, "#{region}", "#{stack_name_glob}.y*ml")
     end
 
     def default_parameter_glob
-      File.join(base_dir, 'parameters', "#{stack_name_glob}.y*ml")
+      File.join(parameters_dir, "#{stack_name_glob}.y*ml")
     end
 
     def stack_name_glob

data/lib/stack_master/version.rb

@@ -1,3 +1,3 @@
 module StackMaster
-  VERSION = "2.6.1"
+  VERSION = "2.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -539,8 +539,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/envato/stack_master/issues
   changelog_uri: https://github.com/envato/stack_master/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/stack_master/2.6.1
-  source_code_uri: https://github.com/envato/stack_master/tree/v2.6.1
+  documentation_uri: https://www.rubydoc.info/gems/stack_master/2.7.0
+  source_code_uri: https://github.com/envato/stack_master/tree/v2.7.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -556,7 +556,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: StackMaster is a sure-footed way of creating, updating and keeping track