stack_master 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 365c8c1252350564177ff9a0827024d27a7600f31c7a76503cac20accfca5e12
-  data.tar.gz: '088c89fe1880f1879279b66b8eb26d59e6ec723ec842c81641f7e20f457aefb7'
+  metadata.gz: 6b2fd9ecb9882d2a0b00adee84d08975f5ae51b72297a449c5bd5218efbf8a17
+  data.tar.gz: c2eb23ba0ae38e6db17cc296a4a151aaaf7785bbff222d75ec671251ac398f1f
 SHA512:
-  metadata.gz: 6488da7b3d7ad2562e276246f76f2ec304c9b83c43d24469a76ccde609da290c648ac417232e42864b163dbb1b3111a06052322a8ba9037626eef7f0feb956ab
-  data.tar.gz: 0f7006a2c2f37f25e771727be69a5823407163ed9ac6a7970ea95a3a8ce07c25fc4f150c9a6fce46c0e5dae9219516699afd095962fdb08f745770a36eccea78
+  metadata.gz: e5832578334d932b9750b9aa2914c6c0fc9d2b391606c3ab8fc60868b151c5b9fa996d2b89636d14515aff3b9892c8a913c1e0531ac57262a67072931a2a8f1c
+  data.tar.gz: 87dd2728b566b6d775a0b8cb7137acc856f1ee854436e35789578c1c129798594375bc9ad06018be2285605878918cf89d872c3df72fe20a3260380407e32b25

data/README.md

@@ -157,14 +157,12 @@ template_compilers:
 
 Parameters are loaded from multiple YAML files, merged from the following lookup paths from bottom to top:
 
-- parameters/[underscored_stack_name].yaml
-- parameters/[underscored_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
-
-**Note:** The file names must be underscored, not hyphenated, even if the stack names are hyphenated.
+- parameters/[stack_name].yaml
+- parameters/[stack_name].yml
+- parameters/[region]/[stack_name].yaml
+- parameters/[region]/[stack_name].yml
+- parameters/[region_alias]/[stack_name].yaml
+- parameters/[region_alias]/[stack_name].yml
 
 A simple parameter file could look like this:
 

data/bin/stack_master

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
 require 'stack_master'
 
 if ENV['STUB_AWS'] == 'true'

data/lib/stack_master.rb

@@ -8,7 +8,9 @@ require 'aws-sdk-s3'
 require 'aws-sdk-sns'
 require 'aws-sdk-ssm'
 require 'colorize'
-require 'active_support/core_ext/string'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/inflections'
 require 'multi_json'
 
 MultiJson.use :json_gem

data/lib/stack_master/cli.rb

@@ -71,7 +71,7 @@ module StackMaster
           unless args.size == 2
             say "Invalid arguments. stack_master init [region] [stack_name]"
           else
-            StackMaster::Commands::Init.perform(options.overwrite, *args)
+            StackMaster::Commands::Init.perform(options, *args)
           end
         end
       end
@@ -119,7 +119,7 @@ module StackMaster
           options.defaults config: default_config_file
           say "Invalid arguments." if args.size > 0
           config = load_config(options.config)
-          StackMaster::Commands::ListStacks.perform(config)
+          StackMaster::Commands::ListStacks.perform(config, nil, options)
         end
       end
 
@@ -165,7 +165,7 @@ module StackMaster
           options.defaults config: default_config_file
           say "Invalid arguments. stack_master status" and return unless args.size == 0
           config = load_config(options.config)
-          StackMaster::Commands::Status.perform(config)
+          StackMaster::Commands::Status.perform(config, nil, options)
         end
       end
 
@@ -178,7 +178,7 @@ module StackMaster
           options.defaults config: default_config_file
           say "Invalid arguments. stack_master tidy" and return unless args.size == 0
           config = load_config(options.config)
-          StackMaster::Commands::Tidy.perform(config)
+          StackMaster::Commands::Tidy.perform(config, nil, options)
         end
       end
 
@@ -208,7 +208,7 @@ module StackMaster
 
           success = execute_if_allowed_account(allowed_accounts) do
             StackMaster.cloud_formation_driver.set_region(region)
-            StackMaster::Commands::Delete.perform(region, stack_name).success?
+            StackMaster::Commands::Delete.perform(region, stack_name, options).success?
           end
           @kernel.exit false unless success
         end

data/lib/stack_master/command.rb

@@ -27,6 +27,12 @@ module StackMaster
       end
     end
 
+    def initialize(config, stack_definition = nil, options = Commander::Command::Options.new)
+      @config = config
+      @stack_definition = stack_definition
+      @options = options
+    end
+
     def success?
       @failed != true
     end
@@ -36,9 +42,24 @@ module StackMaster
     def error_message(e)
       msg = "#{e.class} #{e.message}"
       msg << "\n Caused by: #{e.cause.class} #{e.cause.message}" if e.cause
+      if options.trace
+        msg << "\n#{backtrace(e)}"
+      else
+        msg << "\n Use --trace to view backtrace"
+      end
       msg
     end
 
+    def backtrace(error)
+      if error.respond_to?(:full_message)
+        error.full_message
+      else
+        # full_message was introduced in Ruby 2.5
+        # remove this conditional when StackMaster no longer supports Ruby 2.4
+        error.backtrace.join("\n")
+      end
+    end
+
     def failed(message = nil)
       StackMaster.stderr.puts(message) if message
       @failed = true
@@ -53,5 +74,9 @@ module StackMaster
       StackMaster.stdout.puts(message) if message
       throw :halt
     end
+
+    def options
+      @options ||= Commander::Command::Options.new
+    end
   end
 end

data/lib/stack_master/commands/apply.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 module StackMaster
   module Commands
     class Apply
@@ -6,14 +8,10 @@ module StackMaster
       include StackMaster::Prompter
       TEMPLATE_TOO_LARGE_ERROR_MESSAGE = 'The (space compressed) stack is larger than the limit set by AWS. See http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html'.freeze
 
-      def initialize(config, stack_definition, options = Commander::Command::Options.new)
-        @config = config
-        @s3_config = stack_definition.s3
-        @stack_definition = stack_definition
+      def initialize(*_args)
+        super
+        @s3_config = @stack_definition.s3
         @from_time = Time.now
-        @options = options
-        @options.on_failure ||= nil
-        @options.yes_param ||= nil
       end
 
       def perform
@@ -208,11 +206,16 @@ module StackMaster
 
       def ensure_valid_parameters!
         if @proposed_stack.missing_parameters?
-          StackMaster.stderr.puts "Empty/blank parameters detected, ensure values exist for those parameters. Parameters will be read from the following locations:"
-          @stack_definition.parameter_files.each do |parameter_file|
-            StackMaster.stderr.puts " - #{parameter_file}"
+          message = <<~MESSAGE
+            Empty/blank parameters detected, ensure values exist for those parameters.
+            Parameters will be read from the following locations:
+          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
-          halt!
+          failed!(message)
         end
       end
 

data/lib/stack_master/commands/compile.rb

@@ -4,11 +4,6 @@ module StackMaster
       include Command
       include Commander::UI
 
-      def initialize(config, stack_definition, options = {})
-        @config = config
-        @stack_definition = stack_definition
-      end
-
       def perform
         puts(proposed_stack.template_body)
       end

data/lib/stack_master/commands/delete.rb

@@ -4,7 +4,8 @@ module StackMaster
       include Command
       include StackMaster::Prompter
 
-      def initialize(region, stack_name)
+      def initialize(region, stack_name, options)
+        super(nil, nil, options)
         @region = region
         @stack_name = stack_name
         @from_time = Time.now

data/lib/stack_master/commands/diff.rb

@@ -4,11 +4,6 @@ module StackMaster
       include Command
       include Commander::UI
 
-      def initialize(config, stack_definition, options = {})
-        @config = config
-        @stack_definition = stack_definition
-      end
-
       def perform
         StackMaster::StackDiffer.new(proposed_stack, stack).output_diff
       end

data/lib/stack_master/commands/events.rb

@@ -4,12 +4,6 @@ module StackMaster
       include Command
       include Commander::UI
 
-      def initialize(config, stack_definition, options = {})
-        @config = config
-        @stack_definition = stack_definition
-        @options = options
-      end
-
       def perform
         events = StackEvents::Fetcher.fetch(@stack_definition.stack_name, @stack_definition.region)
         filter_events(events).each do |event|

data/lib/stack_master/commands/init.rb

@@ -5,8 +5,8 @@ module StackMaster
     class Init
       include Command
 
-      def initialize(overwrite, region, stack_name)
-        @overwrite = overwrite
+      def initialize(options, region, stack_name)
+        super(nil, nil, options)
         @region = region
         @stack_name = stack_name
       end
@@ -24,10 +24,10 @@ module StackMaster
       def check_files
         @stack_master_filename = "stack_master.yml"
         @stack_json_filename = "templates/#{@stack_name}.json"
-        @parameters_filename = File.join("parameters", "#{underscored_stack_name}.yml")
-        @region_parameters_filename = File.join("parameters", @region, "#{underscored_stack_name}.yml")
+        @parameters_filename = File.join("parameters", "#{@stack_name}.yml")
+        @region_parameters_filename = File.join("parameters", @region, "#{@stack_name}.yml")
 
-        if !@overwrite
+        if !@options.overwrite
           [@stack_master_filename, @stack_json_filename, @parameters_filename, @region_parameters_filename].each do |filename|
             if File.exists?(filename)
               StackMaster.stderr.puts("Aborting: #{filename} already exists. Use --overwrite to force overwriting file.")
@@ -89,10 +89,6 @@ module StackMaster
         File.join(StackMaster.base_dir, "stacktemplates", "parameter_region.yml")
       end
 
-      def underscored_stack_name
-        @stack_name.gsub('-', '_')
-      end
-
       def render(renderer)
         binding = InitBinding.new(region: @region, stack_name: @stack_name).get_binding
         renderer.result(binding)

data/lib/stack_master/commands/lint.rb

@@ -6,11 +6,6 @@ module StackMaster
       include Command
       include Commander::UI
 
-      def initialize(config, stack_definition, options = {})
-        @config = config
-        @stack_definition = stack_definition
-      end
-
       def perform
         unless cfn_lint_available
           failed! 'Failed to run cfn-lint. You may need to install it using'\

data/lib/stack_master/commands/list_stacks.rb

@@ -7,10 +7,6 @@ module StackMaster
       include Commander::UI
       include StackMaster::Commands::TerminalHelper
 
-      def initialize(config)
-        @config = config
-      end
-
       def perform
         tp.set :max_width, self.window_size
         tp @config.stacks, :region, :stack_name

data/lib/stack_master/commands/outputs.rb

@@ -7,11 +7,6 @@ module StackMaster
       include Commander::UI
       include StackMaster::Commands::TerminalHelper
 
-      def initialize(config, stack_definition, options = {})
-        @config = config
-        @stack_definition = stack_definition
-      end
-
       def perform
         if stack
           tp.set :max_width, self.window_size

data/lib/stack_master/commands/resources.rb

@@ -6,11 +6,6 @@ module StackMaster
       include Command
       include Commander::UI
 
-      def initialize(config, stack_definition, options = {})
-        @config = config
-        @stack_definition = stack_definition
-      end
-
       def perform
         if stack_resources
           tp stack_resources, :logical_resource_id, :resource_type, :timestamp, :resource_status, :resource_status_reason, :description

data/lib/stack_master/commands/status.rb

@@ -7,8 +7,8 @@ module StackMaster
       include Command
       include StackMaster::Commands::TerminalHelper
 
-      def initialize(config, show_progress = true)
-        @config = config
+      def initialize(config, options, show_progress = true)
+        super(config, nil, options)
         @show_progress = show_progress
       end
 

data/lib/stack_master/commands/tidy.rb

@@ -4,10 +4,6 @@ module StackMaster
       include Command
       include StackMaster::Commands::TerminalHelper
 
-      def initialize(config)
-        @config = config
-      end
-
       def perform
         used_templates = []
         used_parameter_files = []

data/lib/stack_master/commands/validate.rb

@@ -4,11 +4,6 @@ module StackMaster
       include Command
       include Commander::UI
 
-      def initialize(config, stack_definition, options = {})
-        @config = config
-        @stack_definition = stack_definition
-      end
-
       def perform
         failed unless Validator.valid?(@stack_definition, @config)
       end

data/lib/stack_master/parameter_resolvers/latest_ami.rb

@@ -12,7 +12,7 @@ module StackMaster
         owners = Array(value.fetch('owners', 'self').to_s)
         ami_finder = AmiFinder.new(@stack_definition.region)
         filters = ami_finder.build_filters_from_hash(value.fetch('filters'))
-        ami_finder.find_latest_ami(filters, owners).try(:image_id)
+        ami_finder.find_latest_ami(filters, owners)&.image_id
       end
     end
   end

data/lib/stack_master/parameter_resolvers/latest_ami_by_tags.rb

@@ -11,7 +11,7 @@ module StackMaster
 
       def resolve(value)
         filters = @ami_finder.build_filters_from_string(value, prefix = "tag")
-        @ami_finder.find_latest_ami(filters).try(:image_id)
+        @ami_finder.find_latest_ami(filters)&.image_id
       end
     end
   end

data/lib/stack_master/sparkle_formation/template_file.rb

@@ -71,7 +71,7 @@ module StackMaster
             newlines = lines.split("\n").map do |line|
               "#{line}#{newlines.pop}"
             end
-            if lines.starts_with?("\n")
+            if lines.start_with?("\n")
               newlines.insert(0, "\n")
             end
             newlines

data/lib/stack_master/stack_definition.rb

@@ -23,7 +23,6 @@ module StackMaster
     include Utils::Initializable
 
     def initialize(attributes = {})
-      @additional_parameter_lookup_dirs = []
       @compiler_options = {}
       @notification_arns = []
       @s3 = {}
@@ -32,6 +31,7 @@ module StackMaster
       @ejson_file_kms = true
       @compiler = nil
       super
+      @additional_parameter_lookup_dirs ||= []
       @template_dir ||= File.join(@base_dir, 'templates')
       @allowed_accounts = Array(@allowed_accounts)
     end
@@ -86,7 +86,11 @@ module StackMaster
     end
 
     def parameter_files
-      [ default_parameter_file_path, region_parameter_file_path, additional_parameter_lookup_file_paths ].flatten.compact
+      parameter_file_globs.map(&Dir.method(:glob)).flatten
+    end
+
+    def parameter_file_globs
+      [ default_parameter_glob, region_parameter_glob ] + additional_parameter_lookup_globs
     end
 
     def stack_policy_file_path
@@ -99,23 +103,22 @@ module StackMaster
 
     private
 
-    def additional_parameter_lookup_file_paths
-      return unless additional_parameter_lookup_dirs
+    def additional_parameter_lookup_globs
       additional_parameter_lookup_dirs.map do |a|
-        Dir.glob(File.join(base_dir, 'parameters', a, "#{underscored_stack_name}.y*ml"))
+        File.join(base_dir, 'parameters', a, "#{stack_name_glob}.y*ml")
       end
     end
 
-    def region_parameter_file_path
-      Dir.glob(File.join(base_dir, 'parameters', "#{region}", "#{underscored_stack_name}.y*ml"))
+    def region_parameter_glob
+      File.join(base_dir, 'parameters', "#{region}", "#{stack_name_glob}.y*ml")
     end
 
-    def default_parameter_file_path
-      Dir.glob(File.join(base_dir, 'parameters', "#{underscored_stack_name}.y*ml"))
+    def default_parameter_glob
+      File.join(base_dir, 'parameters', "#{stack_name_glob}.y*ml")
     end
 
-    def underscored_stack_name
-      stack_name.gsub('-', '_')
+    def stack_name_glob
+      stack_name.gsub('-', '[-_]')
     end
   end
 end

data/lib/stack_master/template_compiler.rb

@@ -11,7 +11,7 @@ module StackMaster
       compiler.require_dependencies
       compiler.compile(template_dir, template, compile_time_parameters, compiler_options)
     rescue StandardError => e
-      raise TemplateCompilationFailed.new("Failed to compile #{template} with error #{e}.\n#{e.backtrace}")
+      raise TemplateCompilationFailed, "Failed to compile #{template}"
     end
 
     def self.register(name, klass)

data/lib/stack_master/version.rb

@@ -1,3 +1,3 @@
 module StackMaster
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2020-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -523,8 +523,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.2.0
-  source_code_uri: https://github.com/envato/stack_master/tree/v2.2.0
+  documentation_uri: https://www.rubydoc.info/gems/stack_master/2.3.0
+  source_code_uri: https://github.com/envato/stack_master/tree/v2.3.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -540,7 +540,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: StackMaster is a sure-footed way of creating, updating and keeping track