stack_master 2.17.1 → 2.18.0

data/lib/stack_master/commands/terminal_helper.rb

@@ -4,9 +4,9 @@ module StackMaster
   module Commands
     module TerminalHelper
       def window_size
-        size = ENV.fetch("COLUMNS") { OS.windows? ? windows_window_size : unix_window_size }
+        size = ENV.fetch('COLUMNS') { OS.windows? ? windows_window_size : unix_window_size }
 
-        if size.nil? || size == ""
+        if size.nil? || size == ''
           80
         else
           size.to_i
@@ -18,7 +18,7 @@ module StackMaster
       end
 
       def windows_window_size
-        columns_regex = %r{^\s+Columns:\s+([0-9]+)$}
+        columns_regex = /^\s+Columns:\s+([0-9]+)$/
         output = `mode con`
         columns_line = output.split("\n").select { |line| line.match(columns_regex) }.last
         columns_line.match(columns_regex)[1]

data/lib/stack_master/commands/tidy.rb

@@ -8,23 +8,23 @@ module StackMaster
         used_templates = []
         used_parameter_files = []
 
-        templates = Set.new(find_templates())
-        parameter_files = Set.new(find_parameter_files())
+        templates = Set.new(find_templates)
+        parameter_files = Set.new(find_parameter_files)
 
         status = @config.stacks.each do |stack_definition|
           parameter_files.subtract(stack_definition.parameter_files_from_globs)
           template = File.absolute_path(stack_definition.template_file_path)
 
-          if template
-            templates.delete(template)
+          next unless template
 
-            if !File.exist?(template)
-              StackMaster.stdout.puts(
-                "Stack \"#{stack_definition.stack_name}\" in \"#{stack_definition.region}\" " \
-                "missing template \"#{rel_path(template)}\""
-              )
-            end
-          end
+          templates.delete(template)
+
+          next if File.exist?(template)
+
+          StackMaster.stdout.puts(
+            "Stack \"#{stack_definition.stack_name}\" in \"#{stack_definition.region}\" " \
+            "missing template \"#{rel_path(template)}\""
+          )
         end
 
         templates.each do |path|
@@ -46,21 +46,19 @@ module StackMaster
         # template directories) this won't find the right directory.
         template_dir = @config.template_dir || File.join(@config.base_dir, 'templates')
 
-        templates = Dir.glob(File.absolute_path(File.join(template_dir, '**', "*.{rb,yaml,yml,json}")))
+        templates = Dir.glob(File.absolute_path(File.join(template_dir, '**', '*.{rb,yaml,yml,json}')))
         dynamics_dir = File.join(template_dir, 'dynamics')
 
         # Exclude sparkleformation dynamics
         # TODO: Should this filter out anything with 'dynamics', not just the first
         # subdirectory?
-        templates = templates.select do |path|
+        templates.select do |path|
           !path.start_with?(dynamics_dir)
         end
-
-        templates
       end
 
       def find_parameter_files
-        Dir.glob(File.absolute_path(File.join(@config.base_dir, "parameters", "*.{yml,yaml}")))
+        Dir.glob(File.absolute_path(File.join(@config.base_dir, 'parameters', '*.{yml,yaml}')))
       end
     end
   end

data/lib/stack_master/config.rb

@@ -26,13 +26,13 @@ module StackMaster
     )
 
     def self.search_up_and_chdir(config_file)
-      return config_file unless File.dirname(config_file) == "."
+      return config_file unless File.dirname(config_file) == '.'
 
       dir = Dir.pwd
-      parent_dir = File.expand_path("..", Dir.pwd)
+      parent_dir = File.expand_path('..', Dir.pwd)
       while parent_dir != dir && !File.exist?(File.join(dir, config_file))
         dir = parent_dir
-        parent_dir = File.expand_path("..", dir)
+        parent_dir = File.expand_path('..', dir)
       end
 
       File.join(dir, config_file)
@@ -45,10 +45,9 @@ module StackMaster
       @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)|
+      @region_to_aliases = @region_aliases.each_with_object({}) do |(key, value), hash|
         hash[value] ||= []
         hash[value] << key
-        hash
       end
       @region_defaults = normalise_region_defaults(config.fetch('region_defaults', {}))
       @stacks = []
@@ -86,7 +85,7 @@ module StackMaster
       @template_compilers = default_template_compilers.merge(@template_compilers)
     end
 
-    def populate_template_compilers user_defined_compilers
+    def populate_template_compilers(user_defined_compilers)
       user_defined_compilers.each do |key, val|
         @template_compilers[key.to_sym] = val.to_sym
       end
@@ -98,7 +97,7 @@ module StackMaster
         json: :json,
         yml: :yaml,
         yaml: :yaml,
-        erb: :yaml_erb,
+        erb: :yaml_erb
       }
     end
 
@@ -108,9 +107,8 @@ module StackMaster
     end
 
     def resolve_region_aliases(stacks)
-      stacks.inject({}) do |hash, (region, attributes)|
+      stacks.each_with_object({}) do |(region, attributes), hash|
         hash[unalias_region(region)] = attributes
-        hash
       end
     end
 
@@ -141,10 +139,9 @@ module StackMaster
     end
 
     def normalise_region_defaults(region_defaults)
-      region_defaults.inject({}) do |normalised_aliases, (region_or_alias, value)|
+      region_defaults.each_with_object({}) do |(region_or_alias, value), normalised_aliases|
         region = unalias_region(region_or_alias)
         normalised_aliases[Utils.underscore_to_hyphen(region)] = value
-        normalised_aliases
       end
     end
   end

data/lib/stack_master/diff.rb

@@ -1,6 +1,6 @@
 module StackMaster
   class Diff
-    def initialize(name: nil, before:, after:, context: 10_000)
+    def initialize(before:, after:, name: nil, context: 10_000)
       @name = name
       @before = before
       @after = after
@@ -10,7 +10,7 @@ module StackMaster
     def display
       stdout.print "#{@name} diff: "
       if diff == ''
-        stdout.puts "No changes"
+        stdout.puts 'No changes'
       else
         stdout.puts
         display_colorized_diff

data/lib/stack_master/parameter_loader.rb

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

data/lib/stack_master/parameter_resolver.rb

@@ -15,13 +15,12 @@ module StackMaster
     end
 
     def resolve
-      @parameters.reduce({}) do |parameters, (key, value)|
+      @parameters.each_with_object({}) do |(key, value), parameters|
         begin
           parameters[key] = resolve_parameter_value(key, value)
         rescue InvalidParameter
           raise InvalidParameter, "Unable to resolve parameter #{key.inspect} value causing error: #{$!.message}"
         end
-        parameters
       end
     end
 
@@ -30,11 +29,9 @@ module StackMaster
     def require_parameter_resolver(file_name)
       require "stack_master/parameter_resolvers/#{file_name}"
     rescue LoadError
-      if file_name == file_name.singularize
-        raise ResolverNotFound.new(file_name)
-      else
-        require_parameter_resolver(file_name.singularize)
-      end
+      raise ResolverNotFound.new(file_name) if file_name == file_name.singularize
+
+      require_parameter_resolver(file_name.singularize)
     end
 
     def load_parameter_resolver(class_name)
@@ -46,9 +43,11 @@ module StackMaster
     end
 
     def resolve_parameter_value(key, parameter_value)
-      return parameter_value.to_s if Numeric === parameter_value || parameter_value == true || parameter_value == false
-      return resolve_array_parameter_values(key, parameter_value).join(',') if Array === parameter_value
-      return parameter_value unless Hash === parameter_value
+      if parameter_value.is_a?(Numeric) || parameter_value == true || parameter_value == false
+        return parameter_value.to_s
+      end
+      return resolve_array_parameter_values(key, parameter_value).join(',') if parameter_value.is_a?(Array)
+      return parameter_value unless parameter_value.is_a?(Hash)
 
       resolve_parameter_resolver_hash(key, parameter_value)
     rescue Aws::CloudFormation::Errors::ValidationError
@@ -73,15 +72,13 @@ module StackMaster
       end
     end
 
-    def assume_role_if_present(account, role, key)
+    def assume_role_if_present(account, role, key, &block)
       return yield if account.nil? && role.nil?
       if account.nil? || role.nil?
         raise InvalidParameter, "Both 'account' and 'role' are required to assume role for parameter '#{key}'"
       end
 
-      role_assumer.assume_role(account, role) do
-        yield
-      end
+      role_assumer.assume_role(account, role, &block)
     end
 
     def resolve_array_parameter_values(key, parameter_values)
@@ -114,9 +111,9 @@ module StackMaster
     end
 
     def validate_parameter_value!(key, parameter_value)
-      if parameter_value.keys.size != 1
-        raise InvalidParameter, "#{key} hash contained more than one key: #{parameter_value.inspect}"
-      end
+      return if parameter_value.keys.size == 1
+
+      raise InvalidParameter, "#{key} hash contained more than one key: #{parameter_value.inspect}"
     end
 
     def role_assumer

data/lib/stack_master/parameter_resolvers/ami_finder.rb

@@ -6,12 +6,11 @@ module StackMaster
       end
 
       def build_filters_from_string(value, prefix = nil)
-        filters = value.split(',').map do |name_with_value|
+        value.split(',').map do |name_with_value|
           name, value = name_with_value.strip.split('=')
           name = prefix ? "#{prefix}:#{name}" : name
           { name: name, values: [value] }
         end
-        filters
       end
 
       def build_filters_from_hash(hash)

data/lib/stack_master/parameter_resolvers/ejson.rb

@@ -22,10 +22,10 @@ module StackMaster
       private
 
       def validate_ejson_file_specified
-        if @stack_definition.ejson_file.nil?
-          raise ArgumentError, 'No ejson_file defined for stack definition ' \
-                               "#{@stack_definition.stack_name} in #{@stack_definition.region}"
-        end
+        return unless @stack_definition.ejson_file.nil?
+
+        raise ArgumentError, 'No ejson_file defined for stack definition ' \
+                             "#{@stack_definition.stack_name} in #{@stack_definition.region}"
       end
 
       def decrypt_ejson_file

data/lib/stack_master/parameter_resolvers/latest_ami_by_tags.rb

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

data/lib/stack_master/parameter_resolvers/latest_container.rb

@@ -10,7 +10,7 @@ module StackMaster
 
       def resolve(parameters)
         if parameters['repository_name'].nil?
-          raise ArgumentError, "repository_name parameter is required but was not supplied"
+          raise ArgumentError, 'repository_name parameter is required but was not supplied'
         end
 
         @region = parameters['region'] || @stack_definition.region
@@ -43,8 +43,8 @@ module StackMaster
             registry_id: registry_id,
             next_token: next_token,
             filter: {
-              tag_status: "TAGGED",
-            },
+              tag_status: 'TAGGED'
+            }
           }
         )
 

data/lib/stack_master/parameter_resolvers/one_password.rb

@@ -16,7 +16,7 @@ module StackMaster
       def resolve(params = {})
         if ENV.keys.grep(/OP_SESSION_\w+$/).empty?
           raise OnePasswordNotAbleToAuthenticate,
-                "1password requires the `OP_SESSION_<name>` to be set, (remember to sign in?)"
+                '1password requires the `OP_SESSION_<name>` to be set, (remember to sign in?)'
         end
 
         get_items(params)
@@ -25,7 +25,7 @@ module StackMaster
       private
 
       def validate_op_installed?
-        %x(op --version)
+        `op --version`
       rescue Errno::ENOENT => exception
         raise OnePasswordBinaryNotFound, "The op cli needs to be installed and in the PATH, #{exception}"
       end
@@ -53,7 +53,7 @@ module StackMaster
 
       def op_get_item(item, vault)
         validate_op_installed?
-        item = %x(op get item --vault='#{vault}' '#{item}' 2>&1)
+        item = `op get item --vault='#{vault}' '#{item}' 2>&1`
         item if validate_response?(item)
       end
 
@@ -79,9 +79,9 @@ module StackMaster
       def get_items(params)
         case params['type']
         when 'password'
-          return get_password(params['title'], params['vault'])
+          get_password(params['title'], params['vault'])
         when 'secureNote'
-          return get_secure_note(params['title'], params['vault'])
+          get_secure_note(params['title'], params['vault'])
         end
       end
     end

data/lib/stack_master/parameter_resolvers/sso_group_id.rb

@@ -15,7 +15,7 @@ module StackMaster
       private
 
       def sso_group_id_finder
-        StackMaster::SsoGroupIdFinder.new()
+        StackMaster::SsoGroupIdFinder.new
       end
     end
   end

data/lib/stack_master/parameter_resolvers/stack_output.rb

@@ -17,18 +17,14 @@ module StackMaster
       def resolve(value)
         region, stack_name, output_name = parse!(value)
         stack = find_stack(stack_name, region)
-        if stack
-          output = stack.outputs.find do |stack_output|
-            stack_output.output_key == output_name.camelize || stack_output.output_key == output_name
-          end
-          if output
-            output.output_value
-          else
-            raise StackOutputNotFound, "Stack exists (#{stack_name}), but output does not: #{output_name}"
-          end
-        else
-          raise StackNotFound, "Stack in StackOutput not found: #{value}"
+        raise StackNotFound, "Stack in StackOutput not found: #{value}" unless stack
+
+        output = stack.outputs.find do |stack_output|
+          stack_output.output_key == output_name.camelize || stack_output.output_key == output_name
         end
+        raise StackOutputNotFound, "Stack exists (#{stack_name}), but output does not: #{output_name}" unless output
+
+        output.output_value
       end
 
       private

data/lib/stack_master/parameter_validator.rb

@@ -14,11 +14,7 @@ module StackMaster
       missing_parameters.each do |parameter_name|
         message << " - #{parameter_name}\n"
       end
-      if @stack_definition.parameter_files.empty?
-        message << message_for_parameter_globs
-      else
-        message << message_for_parameter_files
-      end
+      message << (@stack_definition.parameter_files.empty? ? message_for_parameter_globs : message_for_parameter_files)
       message
     end
 

data/lib/stack_master/prompter.rb

@@ -10,7 +10,7 @@ module StackMaster
             StackMaster.stdin.getch.chomp
           else
             StackMaster.stdout.puts
-            StackMaster.stdout.puts "STDOUT or STDIN was not a TTY. Defaulting to no. To force yes use -y"
+            StackMaster.stdout.puts 'STDOUT or STDIN was not a TTY. Defaulting to no. To force yes use -y'
             'n'
           end
         else

data/lib/stack_master/resolver_array.rb

@@ -13,13 +13,13 @@ module StackMaster
       end
 
       def resolver_class
-        fail "Method resolver_class not implemented on #{self.class}"
+        raise "Method resolver_class not implemented on #{self.class}"
       end
     end
 
     class Resolver
       def self.array_resolver(options = {})
-        resolver_class ||= Object.const_get(self.name)
+        resolver_class ||= Object.const_get(name)
         array_resolver_class_name = options[:class_name] || resolver_class.to_s.demodulize.pluralize
 
         klass = Class.new(ResolverArray) do

data/lib/stack_master/role_assumer.rb

@@ -48,7 +48,7 @@ module StackMaster
           {
             region: StackMaster.cloud_formation_driver.region,
             role_arn: "arn:aws:iam::#{account}:role/#{role}",
-            role_session_name: "stack-master-role-assumer"
+            role_session_name: 'stack-master-role-assumer'
           }
         )
       end

data/lib/stack_master/security_group_finder.rb

@@ -15,10 +15,10 @@ module StackMaster
       groups = @resource.security_groups({
                                            filters: [
                                              {
-                                               name: "group-name",
-                                               values: [reference],
-                                             },
-                                           ],
+                                               name: 'group-name',
+                                               values: [reference]
+                                             }
+                                           ]
                                          })
 
       raise SecurityGroupNotFound, "No security group with name #{reference} found" unless groups.any?

data/lib/stack_master/sns_topic_finder.rb

@@ -21,7 +21,7 @@ module StackMaster
     private
 
     def topic_name_from_arn(arn)
-      arn.split(":")[5]
+      arn.split(':')[5]
     end
   end
 end

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

@@ -22,7 +22,7 @@ module StackMaster
 
         def invalid_values
           values = build_values(@definition, @parameter)
-          values.reject { |value| value.to_s.match(%r{#{@definition[KEY]}}) }
+          values.reject { |value| value.to_s.match(/#{@definition[KEY]}/) }
         end
 
         def create_error

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

@@ -4,7 +4,7 @@ module StackMaster
   module SparkleFormation
     module CompileTime
       class DefinitionsValidator
-        VALID_TYPES = [:string, :number]
+        VALID_TYPES = %i[string number]
         def initialize(definitions)
           @definitions = definitions
         end

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

@@ -21,16 +21,16 @@ module StackMaster
         end
 
         def convert_strings_to_array
-          if @definition[:multiple] && @value.is_a?(String)
-            @value = @value.split(',').map(&:strip)
-          end
+          return unless @definition[:multiple] && @value.is_a?(String)
+
+          @value = @value.split(',').map(&:strip)
         end
 
         def convert_strings_to_numbers
-          if @definition[:type] == :number
-            @value = @value.to_f if @value.is_a?(String)
-            @value = @value.map { |item| item.is_a?(String) ? item.to_f : item } if @value.is_a?(Array)
-          end
+          return if @definition[:type] != :number
+
+          @value = @value.to_f if @value.is_a?(String)
+          @value = @value.map { |item| item.is_a?(String) ? item.to_f : item } if @value.is_a?(Array)
         end
       end
     end

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

@@ -27,9 +27,7 @@ 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

data/lib/stack_master/sparkle_formation/template_file.rb

@@ -49,14 +49,14 @@ 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

data/lib/stack_master/sso_group_id_finder.rb

@@ -19,9 +19,9 @@ module StackMaster
             alternate_identifier: {
               unique_attribute: {
                 attribute_path: 'displayName',
-                attribute_value: match[:group_name],
-              },
-            },
+                attribute_value: match[:group_name]
+              }
+            }
           }
         )
         return response.group_id

data/lib/stack_master/stack.rb

@@ -20,9 +20,8 @@ module StackMaster
       TemplateUtils
         .template_hash(template)
         .fetch('Parameters', {})
-        .inject({}) do |result, (parameter_name, description)|
+        .each_with_object({}) do |(parameter_name, description), result|
           result[parameter_name] = description['Default']&.to_s
-          result
         end
     end
 
@@ -35,19 +34,22 @@ module StackMaster
       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,

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 &&
@@ -74,13 +74,12 @@ 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