stack_master 2.3.0 → 2.14.1

data/lib/stack_master/stack.rb

@@ -27,23 +27,17 @@ module StackMaster
       template_default_parameters.merge(parameters)
     end
 
-    def missing_parameters?
-      parameters_with_defaults.any? do |key, value|
-        value == nil
-      end
-    end
-
     def self.find(region, stack_name)
       cf = StackMaster.cloud_formation_driver
-      cf_stack = cf.describe_stacks(stack_name: stack_name).stacks.first
+      cf_stack = cf.describe_stacks({ stack_name: stack_name }).stacks.first
       return unless cf_stack
       parameters = cf_stack.parameters.inject({}) do |params_hash, param_struct|
         params_hash[param_struct.parameter_key] = param_struct.parameter_value
         params_hash
       end
-      template_body ||= cf.get_template(stack_name: stack_name, template_stage: 'Original').template_body
+      template_body ||= cf.get_template({ stack_name: stack_name, template_stage: 'Original' }).template_body
       template_format = TemplateUtils.identify_template_format(template_body)
-      stack_policy_body ||= cf.get_stack_policy(stack_name: stack_name).stack_policy_body
+      stack_policy_body ||= cf.get_stack_policy({ stack_name: stack_name }).stack_policy_body
       outputs = cf_stack.outputs
 
       new(region: region,
@@ -62,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)
@@ -81,6 +75,25 @@ module StackMaster
           stack_policy_body: stack_policy_body)
     end
 
+    def self.generate_without_parameters(stack_definition, config)
+      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)
+      stack_policy_body = if stack_definition.stack_policy_file_path
+                            File.read(stack_definition.stack_policy_file_path)
+                          end
+      new(region: stack_definition.region,
+          stack_name: stack_definition.stack_name,
+          tags: stack_definition.tags,
+          parameters: {},
+          template_body: template_body,
+          template_format: template_format,
+          role_arn: stack_definition.role_arn,
+          notification_arns: stack_definition.notification_arns,
+          stack_policy_body: stack_policy_body)
+    end
+
     def max_template_size(use_s3)
       return TemplateUtils::MAX_S3_TEMPLATE_SIZE if use_s3
       TemplateUtils::MAX_TEMPLATE_SIZE

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/stack_differ.rb

@@ -10,13 +10,13 @@ module StackMaster
 
     def proposed_template
       return @proposed_stack.template_body unless @proposed_stack.template_format == :json
-      JSON.pretty_generate(JSON.parse(@proposed_stack.template_body))
+      JSON.pretty_generate(JSON.parse(@proposed_stack.template_body)) + "\n"
     end
 
     def current_template
       return '' unless @current_stack
       return @current_stack.template_body unless @current_stack.template_format == :json
-      JSON.pretty_generate(TemplateUtils.template_hash(@current_stack.template_body))
+      JSON.pretty_generate(TemplateUtils.template_hash(@current_stack.template_body)) + "\n"
     end
 
     def current_parameters
@@ -39,24 +39,30 @@ module StackMaster
     end
 
     def body_different?
-      body_diff != ''
+      body_diff.different?
     end
 
     def body_diff
-      @body_diff ||= Diffy::Diff.new(current_template, proposed_template, context: 7, include_diff_info: true).to_s
+      @body_diff ||= Diff.new(name: 'Stack',
+                              before: current_template,
+                              after: proposed_template,
+                              context: 7)
     end
 
     def params_different?
-      params_diff != ''
+      parameters_diff.different?
     end
 
-    def params_diff
-      @param_diff ||= Diffy::Diff.new(current_parameters, proposed_parameters, {}).to_s
+    def parameters_diff
+      @param_diff ||= Diff.new(name: 'Parameters',
+                               before: current_parameters,
+                               after: proposed_parameters)
     end
 
     def output_diff
-      display_diff('Stack', body_diff)
-      display_diff('Parameters', params_diff)
+      body_diff.display
+      parameters_diff.display
+
       unless noecho_keys.empty?
         StackMaster.stdout.puts " * can not tell if NoEcho parameters are different."
       end
@@ -83,38 +89,8 @@ module StackMaster
 
     private
 
-    def display_diff(thing, diff)
-      StackMaster.stdout.print "#{thing} diff: "
-      if diff == ''
-        StackMaster.stdout.puts "No changes"
-      else
-        StackMaster.stdout.puts
-        diff.each_line do |line|
-          if line.start_with?('+')
-            StackMaster.stdout.print colorize(line, :green)
-          elsif line.start_with?('-')
-            StackMaster.stdout.print colorize(line, :red)
-          else
-            StackMaster.stdout.print line
-          end
-        end
-      end
-    end
-
     def sort_params(hash)
       hash.sort.to_h
     end
-
-    def colorize(text, color)
-      if colorize?
-        text.colorize(color)
-      else
-        text
-      end
-    end
-
-    def colorize?
-      ENV.fetch('COLORIZE') { 'true' } == 'true'
-    end
   end
 end

data/lib/stack_master/stack_events/presenter.rb

@@ -10,7 +10,7 @@ module StackMaster
       end
 
       def print_event(event)
-        @io.puts "#{event.timestamp.localtime} #{event.logical_resource_id} #{event.resource_type} #{event.resource_status} #{event.resource_status_reason}".colorize(event_colour(event))
+        @io.puts Rainbow("#{event.timestamp.localtime} #{event.logical_resource_id} #{event.resource_type} #{event.resource_status} #{event.resource_status_reason}").color(event_colour(event))
       end
 
       def event_colour(event)

data/lib/stack_master/template_compilers/cfndsl.rb

@@ -2,14 +2,15 @@ module StackMaster::TemplateCompilers
   class Cfndsl
     def self.require_dependencies
       require 'cfndsl'
+      require 'json'
     end
 
     def self.compile(template_dir, 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)
       template_file_path = File.join(template_dir, template)
-      ::CfnDsl.eval_file_with_extras(template_file_path).to_json
+      json_hash = ::CfnDsl.eval_file_with_extras(template_file_path).as_json
+      JSON.pretty_generate(json_hash)
     end
 
     StackMaster::TemplateCompiler.register(:cfndsl, self)

data/lib/stack_master/template_compilers/sparkle_formation.rb

@@ -22,7 +22,7 @@ module StackMaster::TemplateCompilers
         sparkle_template.compile_state = create_state(definitions, compile_time_parameters)
       end
 
-      JSON.pretty_generate(sparkle_template)
+      JSON.pretty_generate(sparkle_template.dump)
     end
 
     private

data/lib/stack_master/template_compilers/yaml_erb.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module StackMaster::TemplateCompilers
+  class YamlErb
+    def self.require_dependencies
+      require 'yaml'
+    end
+
+    def self.compile(template_dir, template, compile_time_parameters, _compiler_options = {})
+      template_file_path = File.join(template_dir, template)
+      template = StackMaster::CloudFormationTemplateEruby.new(File.read(template_file_path))
+      template.filename = template_file_path
+
+      template.result(params: compile_time_parameters)
+    end
+
+    StackMaster::TemplateCompiler.register(:yaml_erb, self)
+  end
+end

data/lib/stack_master/template_utils.rb

@@ -2,12 +2,18 @@ module StackMaster
   module TemplateUtils
     MAX_TEMPLATE_SIZE = 51200
     MAX_S3_TEMPLATE_SIZE = 460800
+    # Matches if the first non-whitespace character is a '{', handling cases
+    # with leading whitespace and extra (whitespace-only) lines.
+    JSON_IDENTIFICATION_PATTERN = Regexp.new('\A\s*{', Regexp::MULTILINE)
 
     extend self
 
     def identify_template_format(template_body)
-      return :json if template_body =~ /^{/x # ignore leading whitespaces
-      :yaml
+      if template_body =~ JSON_IDENTIFICATION_PATTERN
+        :json
+      else
+        :yaml
+      end
     end
 
     def template_hash(template_body=nil)
@@ -28,4 +34,4 @@ module StackMaster
       JSON.dump(template_hash(template_body))
     end
   end
-end
+end

data/lib/stack_master/validator.rb

@@ -1,21 +1,22 @@
 module StackMaster
   class Validator
-    def self.valid?(stack_definition, config)
-      new(stack_definition, config).perform
+    def self.valid?(stack_definition, config, options)
+      new(stack_definition, config, options).perform
     end
 
-    def initialize(stack_definition, config)
+    def initialize(stack_definition, config, options)
       @stack_definition = stack_definition
       @config = config
+      @options = options
     end
 
     def perform
-      parameter_hash = ParameterLoader.load(@stack_definition.parameter_files)
-      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.compiler, @stack_definition.template_dir, @stack_definition.template, compile_time_parameters, @stack_definition.compiler_options)
-      cf.validate_template(template_body: TemplateUtils.maybe_compressed_template_body(template_body))
+      if validate_template_parameters? && parameter_validator.missing_parameters?
+        StackMaster.stdout.puts "invalid\n#{parameter_validator.error_message}"
+        return false
+      end
+      cf.validate_template(template_body: TemplateUtils.maybe_compressed_template_body(stack.template_body))
       StackMaster.stdout.puts "valid"
       true
     rescue Aws::CloudFormation::Errors::ValidationError => e
@@ -25,8 +26,24 @@ module StackMaster
 
     private
 
+    def validate_template_parameters?
+      @options.validate_template_parameters
+    end
+
     def cf
       @cf ||= StackMaster.cloud_formation_driver
     end
+
+    def stack
+      @stack ||= if validate_template_parameters?
+        Stack.generate(@stack_definition, @config)
+      else
+        Stack.generate_without_parameters(@stack_definition, @config)
+      end
+    end
+
+    def parameter_validator
+      @parameter_validator ||= ParameterValidator.new(stack: stack, stack_definition: @stack_definition)
+    end
   end
 end

data/lib/stack_master/version.rb

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

data/lib/stack_master.rb

@@ -7,7 +7,9 @@ require 'aws-sdk-ecr'
 require 'aws-sdk-s3'
 require 'aws-sdk-sns'
 require 'aws-sdk-ssm'
-require 'colorize'
+require 'aws-sdk-iam'
+require 'rainbow'
+require 'active_support'
 require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/inflections'
@@ -23,6 +25,7 @@ module StackMaster
   autoload :CLI, 'stack_master/cli'
   autoload :CtrlC, 'stack_master/ctrl_c'
   autoload :Command, 'stack_master/command'
+  autoload :Diff, 'stack_master/diff'
   autoload :VERSION, 'stack_master/version'
   autoload :Stack, 'stack_master/stack'
   autoload :Prompter, 'stack_master/prompter'
@@ -42,18 +45,23 @@ module StackMaster
   autoload :StackDefinition, 'stack_master/stack_definition'
   autoload :TemplateCompiler, 'stack_master/template_compiler'
   autoload :Identity, 'stack_master/identity'
+  autoload :CloudFormationInterpolatingEruby, 'stack_master/cloudformation_interpolating_eruby'
+  autoload :CloudFormationTemplateEruby, 'stack_master/cloudformation_template_eruby'
 
   autoload :StackDiffer, 'stack_master/stack_differ'
   autoload :Validator, 'stack_master/validator'
+  autoload :ParameterValidator, 'stack_master/parameter_validator'
 
   require 'stack_master/template_compilers/sparkle_formation'
   require 'stack_master/template_compilers/json'
   require 'stack_master/template_compilers/yaml'
+  require 'stack_master/template_compilers/yaml_erb'
   require 'stack_master/template_compilers/cfndsl'
 
   module Commands
     autoload :TerminalHelper, 'stack_master/commands/terminal_helper'
     autoload :Apply, 'stack_master/commands/apply'
+    autoload :Drift, 'stack_master/commands/drift'
     autoload :Events, 'stack_master/commands/events'
     autoload :Outputs, 'stack_master/commands/outputs'
     autoload :Init, 'stack_master/commands/init'
@@ -66,6 +74,7 @@ module StackMaster
     autoload :Delete, 'stack_master/commands/delete'
     autoload :Status, 'stack_master/commands/status'
     autoload :Tidy, 'stack_master/commands/tidy'
+    autoload :Nag, 'stack_master/commands/nag'
   end
 
   module ParameterResolvers
@@ -128,7 +137,7 @@ module StackMaster
 
   def debug(message)
     return unless debug?
-    stderr.puts "[DEBUG] #{message}".colorize(:green)
+    stderr.puts Rainbow("[DEBUG] #{message}").color(:green)
   end
 
   def quiet!
@@ -196,4 +205,16 @@ module StackMaster
   def stderr=(io)
     @stderr = io
   end
+
+  def colorize(text, color)
+    if colorize?
+      Rainbow(text).color(color)
+    else
+      text
+    end
+  end
+
+  def colorize?
+    ENV.fetch('COLORIZE') { 'true' } == 'true'
+  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.14.1
 platform: ruby
 authors:
 - Steve Hodgkiss
 - Glen Stampoultzis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,20 +143,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.5.2
+        version: 4.6.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.5.2
+        version: 4.6.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-acm
   requirement: !ruby/object:Gem::Requirement
@@ -255,6 +255,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-iam
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: sorted_set
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
@@ -284,7 +312,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -357,16 +385,16 @@ dependencies:
   name: cfndsl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -423,6 +451,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cfn-nag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 description: ''
 email:
 - steve@hodgkiss.me
@@ -432,6 +480,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - README.md
 - bin/stack_master
 - lib/stack_master.rb
@@ -439,15 +488,19 @@ files:
 - lib/stack_master/aws_driver/s3.rb
 - lib/stack_master/change_set.rb
 - lib/stack_master/cli.rb
+- lib/stack_master/cloudformation_interpolating_eruby.rb
+- lib/stack_master/cloudformation_template_eruby.rb
 - lib/stack_master/command.rb
 - lib/stack_master/commands/apply.rb
 - lib/stack_master/commands/compile.rb
 - lib/stack_master/commands/delete.rb
 - lib/stack_master/commands/diff.rb
+- lib/stack_master/commands/drift.rb
 - lib/stack_master/commands/events.rb
 - lib/stack_master/commands/init.rb
 - lib/stack_master/commands/lint.rb
 - lib/stack_master/commands/list_stacks.rb
+- lib/stack_master/commands/nag.rb
 - lib/stack_master/commands/outputs.rb
 - lib/stack_master/commands/resources.rb
 - lib/stack_master/commands/status.rb
@@ -456,6 +509,7 @@ files:
 - lib/stack_master/commands/validate.rb
 - lib/stack_master/config.rb
 - lib/stack_master/ctrl_c.rb
+- lib/stack_master/diff.rb
 - lib/stack_master/identity.rb
 - lib/stack_master/paged_response_accumulator.rb
 - lib/stack_master/parameter_loader.rb
@@ -472,6 +526,7 @@ files:
 - lib/stack_master/parameter_resolvers/security_group.rb
 - lib/stack_master/parameter_resolvers/sns_topic_name.rb
 - lib/stack_master/parameter_resolvers/stack_output.rb
+- lib/stack_master/parameter_validator.rb
 - lib/stack_master/prompter.rb
 - lib/stack_master/resolver_array.rb
 - lib/stack_master/role_assumer.rb
@@ -506,6 +561,7 @@ files:
 - lib/stack_master/template_compilers/json.rb
 - lib/stack_master/template_compilers/sparkle_formation.rb
 - lib/stack_master/template_compilers/yaml.rb
+- lib/stack_master/template_compilers/yaml_erb.rb
 - lib/stack_master/template_utils.rb
 - lib/stack_master/test_driver/cloud_formation.rb
 - lib/stack_master/test_driver/s3.rb
@@ -523,9 +579,9 @@ 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.3.0
-  source_code_uri: https://github.com/envato/stack_master/tree/v2.3.0
-post_install_message: 
+  documentation_uri: https://www.rubydoc.info/gems/stack_master/2.14.1
+  source_code_uri: https://github.com/envato/stack_master/tree/v2.14.1
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -540,8 +596,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: StackMaster is a sure-footed way of creating, updating and keeping track
   of Amazon (AWS) CloudFormation stacks.