stack_master 2.17.0 → 2.18.0

data/lib/stack_master/sparkle_formation/compile_time/value_validator.rb

@@ -2,7 +2,6 @@ module StackMaster
   module SparkleFormation
     module CompileTime
       class ValueValidator
-
         attr_reader :is_valid, :error
 
         def validate
@@ -28,13 +27,11 @@ module StackMaster
         private
 
         def convert_to_array(definition, parameter)
-          if definition[:multiple] && parameter.is_a?(String)
-            return parameter.split(',').map(&:strip)
-          end
+          return parameter.split(',').map(&:strip) if definition[:multiple] && parameter.is_a?(String)
+
           parameter.is_a?(Array) ? parameter : [parameter]
         end
-
       end
     end
   end
-end
+end

data/lib/stack_master/sparkle_formation/compile_time/value_validator_factory.rb

@@ -12,17 +12,16 @@ module StackMaster
   module SparkleFormation
     module CompileTime
       class ValueValidatorFactory
-
         VALIDATORS_TYPES = [
-            EmptyValidator,
-            StringValidator,
-            NumberValidator,
-            AllowedValuesValidator,
-            AllowedPatternValidator,
-            MaxLengthValidator,
-            MinLengthValidator,
-            MaxSizeValidator,
-            MinSizeValidator
+          EmptyValidator,
+          StringValidator,
+          NumberValidator,
+          AllowedValuesValidator,
+          AllowedPatternValidator,
+          MaxLengthValidator,
+          MinLengthValidator,
+          MaxSizeValidator,
+          MinSizeValidator
         ]
 
         def initialize(name, definition, parameter)
@@ -32,10 +31,9 @@ module StackMaster
         end
 
         def build
-          VALIDATORS_TYPES.map { |validator| validator.new(@name, @definition, @parameter)}
+          VALIDATORS_TYPES.map { |validator| validator.new(@name, @definition, @parameter) }
         end
-
       end
     end
   end
-end
+end

data/lib/stack_master/sparkle_formation/template_file.rb

@@ -17,7 +17,6 @@ module StackMaster
               value
             end
           end
-
         end.new(vars, prefix)
       end
 
@@ -50,18 +49,17 @@ module StackMaster
       def _joined_file(file_name, vars = {})
         join!(Template.render('joined_file', file_name, vars))
       end
-      alias_method :joined_file!, :_joined_file
+      alias joined_file! _joined_file
     end
 
     module UserDataFile
       def _user_data_file(file_name, vars = {})
         base64!(join!(Template.render('user_data', file_name, vars)))
       end
-      alias_method :user_data_file!, :_user_data_file
+      alias user_data_file! _user_data_file
     end
   end
 end
 
 SparkleFormation::SparkleAttribute::Aws.send(:include, StackMaster::SparkleFormation::UserDataFile)
 SparkleFormation::SparkleAttribute::Aws.send(:include, StackMaster::SparkleFormation::JoinedFile)
-

data/lib/stack_master/sso_group_id_finder.rb

@@ -6,28 +6,31 @@ module StackMaster
       output_regex = %r{(?:(?<region>[^:]+):)?(?<identity_store_id>[^:/]+)/(?<group_name>.+)}
 
       if !reference.is_a?(String) || !(match = output_regex.match(reference))
-          raise ArgumentError, 'Sso group lookup parameter must be in the form of [region:]identity-store-id/group_name'
+        raise ArgumentError, 'Sso group lookup parameter must be in the form of [region:]identity-store-id/group_name'
       end
 
       region = match[:region] || StackMaster.cloud_formation_driver.region
       client = Aws::IdentityStore::Client.new({ region: region })
 
       begin
-        response = client.get_group_id({
-          identity_store_id: match[:identity_store_id],
-          alternate_identifier: {
-            unique_attribute: {
-              attribute_path: 'displayName',
-              attribute_value: match[:group_name],
-            },
-          },
-        })
+        response = client.get_group_id(
+          {
+            identity_store_id: match[:identity_store_id],
+            alternate_identifier: {
+              unique_attribute: {
+                attribute_path: 'displayName',
+                attribute_value: match[:group_name]
+              }
+            }
+          }
+        )
         return response.group_id
       rescue Aws::IdentityStore::Errors::ServiceError => e
-          puts "Error calling GetGroupId: #{e.message}"
+        puts "Error calling GetGroupId: #{e.message}"
       end
 
-      raise SsoGroupNotFound, "No group with name #{match[:group_name]} found in identity store #{match[:identity_store_id]} in #{region}"
+      raise SsoGroupNotFound,
+            "No group with name #{match[:group_name]} found in identity store #{match[:identity_store_id]} in #{region}"
     end
   end
 end

data/lib/stack_master/stack.rb

@@ -17,10 +17,12 @@ module StackMaster
     include Utils::Initializable
 
     def template_default_parameters
-      TemplateUtils.template_hash(template).fetch('Parameters', {}).inject({}) do |result, (parameter_name, description)|
-        result[parameter_name] = description['Default']
-        result
-      end
+      TemplateUtils
+        .template_hash(template)
+        .fetch('Parameters', {})
+        .each_with_object({}) do |(parameter_name, description), result|
+          result[parameter_name] = description['Default']&.to_s
+        end
     end
 
     def parameters_with_defaults
@@ -31,19 +33,23 @@ module StackMaster
       cf = StackMaster.cloud_formation_driver
       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|
+
+      parameters = cf_stack.parameters.each_with_object({}) do |param_struct, params_hash|
         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_format = TemplateUtils.identify_template_format(template_body)
       stack_policy_body ||= cf.get_stack_policy({ stack_name: stack_name }).stack_policy_body
       outputs = cf_stack.outputs
+      tags = cf_stack.tags&.each_with_object({}) do |tag_struct, tags_hash|
+        tags_hash[tag_struct.key] = tag_struct.value
+      end || {}
 
       new(region: region,
           stack_name: stack_name,
           stack_id: cf_stack.stack_id,
           parameters: parameters,
+          tags: tags,
           template_body: template_body,
           template_format: template_format,
           outputs: outputs,
@@ -56,14 +62,27 @@ module StackMaster
     end
 
     def self.generate(stack_definition, config)
-      parameter_hash = ParameterLoader.load(parameter_files: stack_definition.all_parameter_files, parameters: stack_definition.parameters)
+      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)
+      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
+      stack_policy_body =
+        (File.read(stack_definition.stack_policy_file_path) if stack_definition.stack_policy_file_path)
       new(region: stack_definition.region,
           stack_name: stack_definition.stack_name,
           tags: stack_definition.tags,
@@ -76,13 +95,26 @@ module StackMaster
     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)
+      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
+      stack_policy_body =
+        (File.read(stack_definition.stack_policy_file_path) if stack_definition.stack_policy_file_path)
       new(region: stack_definition.region,
           stack_name: stack_definition.stack_name,
           tags: stack_definition.tags,
@@ -96,6 +128,7 @@ module StackMaster
 
     def max_template_size(use_s3)
       return TemplateUtils::MAX_S3_TEMPLATE_SIZE if use_s3
+
       TemplateUtils::MAX_TEMPLATE_SIZE
     end
 

data/lib/stack_master/stack_definition.rb

@@ -35,7 +35,7 @@ module StackMaster
       @compiler = nil
       super
       @additional_parameter_lookup_dirs ||= []
-      @base_dir ||= ""
+      @base_dir ||= ''
       @template_dir ||= File.join(@base_dir, 'templates')
       @parameters_dir ||= File.join(@base_dir, 'parameters')
       @allowed_accounts = Array(@allowed_accounts)
@@ -44,7 +44,7 @@ module StackMaster
     end
 
     def ==(other)
-      self.class === other &&
+      other.is_a?(self.class) &&
         @region == other.region &&
         @stack_name == other.stack_name &&
         @template == other.template &&
@@ -65,6 +65,7 @@ module StackMaster
 
     def template_file_path
       return unless template
+
       File.expand_path(template, template_dir)
     end
 
@@ -73,18 +74,18 @@ module StackMaster
     end
 
     def s3_files
-      files.inject({}) do |hash, file|
+      files.each_with_object({}) do |file, hash|
         path = File.join(files_dir, file)
         hash[file] = {
           path: path,
           body: File.read(path)
         }
-        hash
       end
     end
 
     def s3_template_file_name
       return template if ['.json', '.yaml', '.yml'].include?(File.extname(template))
+
       Utils.change_extension(template, 'json')
     end
 
@@ -101,7 +102,7 @@ module StackMaster
     end
 
     def parameter_file_globs
-      [ default_parameter_glob, region_parameter_glob ] + additional_parameter_lookup_globs
+      [default_parameter_glob, region_parameter_glob] + additional_parameter_lookup_globs
     end
 
     def stack_policy_file_path

data/lib/stack_master/stack_differ.rb

@@ -1,5 +1,5 @@
-require "diffy"
-require "hashdiff"
+require 'diffy'
+require 'hashdiff'
 
 module StackMaster
   class StackDiffer
@@ -10,12 +10,14 @@ 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)) + "\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)) + "\n"
     end
 
@@ -32,7 +34,7 @@ module StackMaster
       params = @proposed_stack.parameters_with_defaults
       if @current_stack
         noecho_keys.each do |key|
-          params[key] = "****"
+          params[key] = '****'
         end
       end
       YAML.dump(sort_params(params))
@@ -59,20 +61,43 @@ module StackMaster
                                after: proposed_parameters)
     end
 
+    def tags_different?
+      tags_diff.different?
+    end
+
+    def tags_diff
+      @tags_diff ||= Diff.new(name: 'Tags',
+                              before: current_tags,
+                              after: proposed_tags)
+    end
+
+    def current_tags
+      tags_hash = @current_stack&.tags
+      return '' if tags_hash.nil? || tags_hash.empty?
+
+      YAML.dump(sort_params(tags_hash))
+    end
+
+    def proposed_tags
+      tags_hash = @proposed_stack.tags
+      return '' if tags_hash.nil? || tags_hash.empty?
+
+      YAML.dump(sort_params(tags_hash))
+    end
+
     def output_diff
       body_diff.display
       parameters_diff.display
+      tags_diff.display
 
-      unless noecho_keys.empty?
-        StackMaster.stdout.puts " * can not tell if NoEcho parameters are different."
-      end
-      StackMaster.stdout.puts "No stack found" if @current_stack.nil?
+      StackMaster.stdout.puts ' * can not tell if NoEcho parameters are different.' unless noecho_keys.empty?
+      StackMaster.stdout.puts 'No stack found' if @current_stack.nil?
     end
 
     def noecho_keys
       if @current_stack
         @current_stack.parameters_with_defaults.select do |key, value|
-          value == "****"
+          value == '****'
         end.keys
       else
         []
@@ -81,10 +106,12 @@ module StackMaster
 
     def single_param_update?(param_name)
       return false if param_name.blank? || @current_stack.blank? || body_different?
+
       differences = Hashdiff.diff(@current_stack.parameters_with_defaults, @proposed_stack.parameters_with_defaults)
       return false if differences.count != 1
+
       diff = differences[0]
-      diff[0] == "~" && diff[1] == param_name
+      diff[0] == '~' && diff[1] == param_name
     end
 
     private

data/lib/stack_master/stack_events/fetcher.rb

@@ -31,7 +31,9 @@ module StackMaster
       end
 
       def fetch_events
-        PagedResponseAccumulator.call(cf, :describe_stack_events, { stack_name: @stack_name }, :stack_events).stack_events
+        PagedResponseAccumulator
+          .call(cf, :describe_stack_events, { stack_name: @stack_name }, :stack_events)
+          .stack_events
       end
     end
   end

data/lib/stack_master/stack_events/presenter.rb

@@ -10,7 +10,12 @@ module StackMaster
       end
 
       def print_event(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))
+        @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/stack_events/streamer.rb

@@ -7,7 +7,8 @@ module StackMaster
         new(stack_name, region, **args, &block).stream
       end
 
-      def initialize(stack_name, region, from: Time.now, break_on_finish_state: true, sleep_between_fetches: 1, io: nil, &block)
+      def initialize(stack_name, region, from: Time.now, break_on_finish_state: true, sleep_between_fetches: 1,
+                     io: nil, &block)
         @stack_name = stack_name
         @region = region
         @block = block
@@ -42,6 +43,7 @@ module StackMaster
         [].tap do |unseen_events|
           events.each do |event|
             next if @seen_events.include?(event.event_id)
+
             @seen_events << event.event_id
             unseen_events << event
           end

data/lib/stack_master/stack_status.rb

@@ -39,6 +39,7 @@ module StackMaster
 
     def stack
       return @stack if defined?(@stack)
+
       StackMaster.cloud_formation_driver.set_region(stack_definition.region)
       @stack = find_stack
     end

data/lib/stack_master/template_compilers/json.rb

@@ -1,6 +1,6 @@
 module StackMaster::TemplateCompilers
   class Json
-    MAX_TEMPLATE_SIZE = 51200
+    MAX_TEMPLATE_SIZE = 51_200
     private_constant :MAX_TEMPLATE_SIZE
 
     def self.require_dependencies

data/lib/stack_master/template_compilers/sparkle_formation.rb

@@ -4,7 +4,6 @@ require 'stack_master/sparkle_formation/compile_time/state_builder'
 
 module StackMaster::TemplateCompilers
   class SparkleFormation
-
     CompileTime = StackMaster::SparkleFormation::CompileTime
 
     def self.require_dependencies
@@ -28,27 +27,31 @@ module StackMaster::TemplateCompilers
     private
 
     def self.compile_sparkle_template(template_dir, template, compiler_options)
-      sparkle_path = if compiler_options['sparkle_path']
-        File.expand_path(compiler_options['sparkle_path'])
-      else
-        template_dir
-      end
+      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(
-        :root => sparkle_path,
+        root: sparkle_path
       )
       collection.set_root(root_pack)
       if compiler_options['sparkle_packs']
         compiler_options['sparkle_packs'].each do |pack_name|
           require pack_name
-          pack = ::SparkleFormation::SparklePack.new(:name => pack_name)
+          pack = ::SparkleFormation::SparklePack.new(name: pack_name)
           collection.add_sparkle(pack)
         end
       end
 
       if compiler_options['sparkle_pack_template']
-        raise ArgumentError.new("Template #{template.inspect} not found in any sparkle pack") unless collection.templates['aws'].include? template
+        unless collection.templates['aws'].include? template
+          raise ArgumentError.new("Template #{template.inspect} not found in any sparkle pack")
+        end
+
         template_file_path = collection.templates['aws'][template].top['path']
       else
         template_file_path = File.join(template_dir, template)

data/lib/stack_master/template_utils.rb

@@ -1,7 +1,7 @@
 module StackMaster
   module TemplateUtils
-    MAX_TEMPLATE_SIZE = 51200
-    MAX_S3_TEMPLATE_SIZE = 460800
+    MAX_TEMPLATE_SIZE = 51_200
+    MAX_S3_TEMPLATE_SIZE = 460_800
     # 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)
@@ -16,8 +16,9 @@ module StackMaster
       end
     end
 
-    def template_hash(template_body=nil)
+    def template_hash(template_body = nil)
       return unless template_body
+
       template_format = identify_template_format(template_body)
       case template_format
       when :json
@@ -30,7 +31,10 @@ module StackMaster
     def maybe_compressed_template_body(template_body)
       # Do not compress the template if it's not JSON because parsing YAML as a hash ignores
       # CloudFormation-specific tags such as !Ref
-      return template_body if template_body.size <= MAX_TEMPLATE_SIZE || identify_template_format(template_body) != :json
+      if template_body.size <= MAX_TEMPLATE_SIZE || identify_template_format(template_body) != :json
+        return template_body
+      end
+
       JSON.dump(template_hash(template_body))
     end
   end

data/lib/stack_master/test_driver/cloud_formation.rb

@@ -28,6 +28,14 @@ module StackMaster
                          parameter_value: hash[:parameter_value])
         end
       end
+
+      def tags
+        return [] if @tags.nil?
+
+        @tags.map do |hash|
+          OpenStruct.new(key: hash[:key], value: hash[:value])
+        end
+      end
     end
 
     class StackEvent
@@ -99,11 +107,27 @@ module StackMaster
         change_set_id = options.fetch(:change_set_name)
         change_set = @change_sets.fetch(change_set_id)
         change_details = [
-          OpenStruct.new(evaluation: 'Static', change_source: 'ResourceReference', target: OpenStruct.new(attribute: 'Properties', requires_recreation: 'Always', name: 'blah'))
+          OpenStruct.new(
+            evaluation: 'Static',
+            change_source: 'ResourceReference',
+            target: OpenStruct.new(
+              attribute: 'Properties',
+              requires_recreation: 'Always',
+              name: 'blah'
+            )
+          )
         ]
-        change = OpenStruct.new(action: 'Modify', replacement: 'True', scope: ['Properties'], details: change_details)
+        change = OpenStruct.new(
+          action: 'Modify',
+          replacement: 'True',
+          scope: ['Properties'],
+          details: change_details
+        )
         changes = [
-          OpenStruct.new(type: 'AWS::Resource', resource_change: change)
+          OpenStruct.new(
+            type: 'AWS::Resource',
+            resource_change: change
+          )
         ]
         OpenStruct.new(change_set.merge(changes: changes, status: 'CREATE_COMPLETE'))
       end
@@ -121,15 +145,16 @@ module StackMaster
 
       def describe_stacks(options = {})
         stack_name = options[:stack_name]
-        stacks = if stack_name
-          if @stacks[stack_name]
+        stacks =
+          if stack_name
+            unless @stacks[stack_name]
+              raise Aws::CloudFormation::Errors::ValidationError.new('', 'Stack does not exist')
+            end
+
             [@stacks[stack_name]]
           else
-            raise Aws::CloudFormation::Errors::ValidationError.new('', 'Stack does not exist')
+            @stacks.values
           end
-        else
-          @stacks.values
-        end
         OpenStruct.new(stacks: stacks, next_token: nil)
       end
 

data/lib/stack_master/test_driver/s3.rb

@@ -5,11 +5,10 @@ module StackMaster
         reset
       end
 
-      def set_region(_)
-      end
+      def set_region(_); end
 
       def reset
-        @files = Hash.new { |hash, key| hash[key] = Hash.new }
+        @files = Hash.new { |hash, key| hash[key] = {} }
       end
 
       def upload_files(bucket: nil, prefix: nil, region: nil, files: {})

data/lib/stack_master/utils.rb

@@ -22,17 +22,16 @@ module StackMaster
     end
 
     def hash_to_aws_parameters(params)
-      params.inject([]) do |params, (key, value)|
+      params.each_with_object([]) do |(key, value), params|
         params << { parameter_key: key, parameter_value: value }
-        params
       end
     end
 
     def hash_to_aws_tags(tags)
       return [] if tags.nil?
-      tags.inject([]) do |aws_tags, (key, value)|
+
+      tags.each_with_object([]) do |(key, value), aws_tags|
         aws_tags << { key: key, value: value }
-        aws_tags
       end
     end
 
@@ -41,9 +40,8 @@ module StackMaster
     end
 
     def underscore_keys_to_hyphen(hash)
-      hash.inject({}) do |hash, (key, value)|
+      hash.each_with_object({}) do |(key, value), hash|
         hash[underscore_to_hyphen(key)] = value
-        hash
       end
     end
   end