moonshot 2.0.0.beta6 → 3.0.4

data/lib/moonshot/doctor_helper.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 require 'colorize'
 
 module Moonshot
@@ -19,18 +20,16 @@ module Moonshot
       puts
       puts self.class.name.split('::').last
       private_methods.each do |meth|
-        begin
-          send(meth) if meth =~ /^doctor_check_/
-        rescue DoctorCritical
-          # Stop running checks in this Mechanism.
-          success = false
-          break
-        rescue => e
-          success = false
-          print '  ✗ '.red
-          puts "Exception while running check: #{e.class}: #{e.message.lines.first}"
-          break
-        end
+        send(meth) if meth =~ /^doctor_check_/
+      rescue DoctorCritical
+        # Stop running checks in this Mechanism.
+        success = false
+        break
+      rescue StandardError => e
+        success = false
+        print '  ✗ '.red
+        puts "Exception while running check: #{e.class}: #{e.message.lines.first}"
+        break
       end
 
       success
@@ -44,13 +43,13 @@ module Moonshot
     def warning(str, additional_info = nil)
       print '  ? '.yellow
       puts str
-      additional_info.lines.each { |l| puts "      #{l}" } if additional_info
+      additional_info&.lines&.each { |l| puts "      #{l}" }
     end
 
     def critical(str, additional_info = nil)
       print '  ✗ '.red
       puts str
-      additional_info.lines.each { |l| puts "      #{l}" } if additional_info
+      additional_info&.lines&.each { |l| puts "      #{l}" }
       raise DoctorCritical
     end
   end

data/lib/moonshot/dynamic_template.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module Moonshot
+  class TemplateExists < StandardError; end
+  class InvalidTemplate < StandardError; end
+
+  class DynamicTemplate
+    # A class to encapsulate template parameters, passing a hash to `process` is
+    # only available from Ruby 2.5.
+    class Parameters
+      def initialize(parameters)
+        parameters.each do |k, v|
+          instance_variable_set("@#{k}".to_sym, v)
+          # Adding an attribute reader for flexibility, this way you can add
+          # either `@parameter` or just `parameter` to your template.
+          self.class.send(:attr_reader, k.to_sym)
+        end
+      end
+
+      def expose_binding
+        binding
+      end
+    end
+
+    attr_writer :destination
+
+    def initialize(source:, parameters:, destination:)
+      @source = File.read(source)
+      @parameters = parameters
+      @destination = destination
+    end
+
+    def parameters_obj
+      @parameters_obj ||= Parameters.new(parameters_file)
+    end
+
+    def parameters_file
+      env_name = Moonshot.config.environment_name
+      @parameters.respond_to?(:call) ? @parameters.call(env_name) : @parameters
+    end
+
+    def process
+      validate_destination_exists
+      new_template = generate_template
+
+      validate_template(new_template)
+      write_output(new_template)
+    end
+
+    private
+
+    def validate_destination_exists
+      return unless File.file?(@destination)
+
+      raise TemplateExists, "Output file '#{@destination}' already exists."
+    end
+
+    def validate_template(template)
+      Aws::CloudFormation::Client.new.validate_template(
+        template_body: template
+      )
+    rescue Aws::CloudFormation::Errors::ValidationError => e
+      raise InvalidTemplate, "Invalid template:\n#{e}"
+    end
+
+    def generate_template
+      ERB.new(@source).result(parameters_obj.expose_binding)
+    end
+
+    def write_output(content)
+      File.write(@destination, content)
+    end
+  end
+end

data/lib/moonshot/interactive_logger_proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Moonshot
@@ -10,8 +12,7 @@ module Moonshot
         @logger = logger
       end
 
-      def blank
-      end
+      def blank; end
 
       def continue(str = nil)
         @logger.info(str) if str
@@ -21,8 +22,7 @@ module Moonshot
         @logger.error(str)
       end
 
-      def repaint
-      end
+      def repaint; end
 
       def success(str = 'Success')
         @logger.info(str)

data/lib/moonshot/json_stack_template.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'json'
+require_relative 'stack_template'
 
 module Moonshot
   # Handles JSON formatted AWS template files.

data/lib/moonshot/parameter_collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moonshot
   # A Rigid Hash-like structure that only accepts manipulation of
   # parameters defined in the Stack template. Anything else results in
@@ -6,6 +8,7 @@ module Moonshot
     extend Forwardable
 
     def_delegators :@hash, :key?, :fetch, :[], :keys, :values
+    attr_reader :hash
 
     def self.from_template(template)
       obj = new

data/lib/moonshot/parent_stack_parameter_loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moonshot
   class ParentStackParameterLoader
     def initialize(config)
@@ -8,30 +10,32 @@ module Moonshot
       @config.parent_stacks.each do |stack_name|
         count = 0
 
-        resp = cf_client.describe_stacks(stack_name: stack_name)
+        resp = cf_client.describe_stacks(stack_name:)
         raise "Parent Stack #{stack_name} not found!" unless resp.stacks.size == 1
 
         # If there is an input parameters matching a stack output, pass it.
         resp.stacks[0].outputs.each do |output|
           next unless @config.parameters.key?(output.output_key)
+
           # Our Stack has a Parameter matching this output. Set it's
           # value to the Output's value.
           count += 1
           @config.parameters.fetch(output.output_key).set(output.output_value)
         end
 
-        puts "Imported #{count} parameters from parent stack #{stack_name.blue}!" if count > 0
+        puts "Imported #{count} parameters from parent stack #{stack_name.blue}!" if count.positive?
       end
     end
 
     def load_missing_only!
       @config.parent_stacks.each do |stack_name|
-        resp = cf_client.describe_stacks(stack_name: stack_name)
+        resp = cf_client.describe_stacks(stack_name:)
         raise "Parent Stack #{stack_name} not found!" unless resp.stacks.size == 1
 
         # If there is an input parameters matching a stack output, pass it.
         resp.stacks[0].outputs.each do |output|
           next unless @config.parameters.key?(output.output_key)
+
           # Our Stack has a Parameter matching this output. Set it's
           # value to the Output's value, but only if we don't already
           # have a previous value we're using.

data/lib/moonshot/resources.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moonshot
   # Resources is a dependency container that holds references to instances
   # provided to a Mechanism (build, deploy, etc.).

data/lib/moonshot/resources_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moonshot
   # Provides shorthand methods for accessing resources provided by the Resources
   # container.
@@ -8,16 +10,18 @@ module Moonshot
 
     # TODO: Deprecate this interface.
     def log
-      @log ||= Logger.new(STDOUT)
+      @log ||= Logger.new($stdout)
     end
 
     def stack
       raise 'Resources not provided to Mechanism!' unless @resources
+
       @resources.stack
     end
 
     def ilog
       raise 'Resources not provided to Mechanism!' unless @resources
+
       @resources.ilog
     end
   end

data/lib/moonshot/shell.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'retriable'
 
@@ -17,7 +19,7 @@ module Moonshot::Shell
 
   # Run a command, returning stdout. Stderr is suppressed unless the command
   # returns non-zero.
-  def sh_out(cmd, fail: true, stdin: '')
+  def sh_out(cmd, fail = true, stdin = '')
     r_in, w_in = IO.pipe
     r_out, w_out = IO.pipe
     r_err, w_err = IO.pipe
@@ -53,13 +55,11 @@ module Moonshot::Shell
     define_method(meth) { |*args| shell.public_send(meth, *args) }
   end
 
-  def sh_step(cmd, args = {})
+  def sh_step(cmd, **args)
     msg = args.delete(:msg) || cmd
-    if msg.length > (terminal_width - 18)
-      msg = "#{msg[0..(terminal_width - 22)]}..."
-    end
+    msg = "#{msg[0..(terminal_width - 22)]}..." if msg.length > (terminal_width - 18)
     ilog.start_threaded(msg) do |step|
-      out = sh_out(cmd, args)
+      out = sh_out(cmd, **args)
       yield step, out if block_given?
       step.success
     end
@@ -73,9 +73,9 @@ module Moonshot::Shell
   # @param opts [Hash] Options for retriable.
   #
   # @return [String] Stdout form the command.
-  def sh_retry(cmd, fail: true, stdin: '', opts: {})
+  def sh_retry(cmd, fail = true, stdin = '', opts: {})
     Retriable.retriable(DEFAULT_RETRY_OPTIONS.merge(opts)) do
-      out = sh_out(cmd, stdin: stdin)
+      out = sh_out(cmd, stdin:)
       yield out if block_given?
       out
     end

data/lib/moonshot/ssh_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 
 module Moonshot

data/lib/moonshot/ssh_command_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'shellwords'
 
 module Moonshot
@@ -25,7 +27,7 @@ module Moonshot
       @instance_ip ||= Aws::EC2::Client.new
                                        .describe_instances(instance_ids: [@instance_id])
                                        .reservations.first.instances.first.public_ip_address
-    rescue
+    rescue StandardError
       raise "Failed to determine public IP address for instance #{@instance_id}!"
     end
   end

data/lib/moonshot/ssh_config.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Moonshot
   class SSHConfig
-    attr_accessor :ssh_identity_file
-    attr_accessor :ssh_user
+    attr_accessor :ssh_identity_file, :ssh_user
 
     def initialize
       @ssh_identity_file = ENV['MOONSHOT_SSH_KEY_FILE']

data/lib/moonshot/ssh_fork_executor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open3'
 
 module Moonshot

data/lib/moonshot/ssh_target_selector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moonshot
   # Choose a publically accessible instance to run commands on, given a Moonshot::Stack.
   class SSHTargetSelector
@@ -23,7 +25,7 @@ module Moonshot
       Aws::AutoScaling::Client.new.describe_auto_scaling_groups(
         auto_scaling_group_names: [asg.physical_resource_id]
       ).auto_scaling_groups.first.instances.map(&:instance_id).first
-    rescue => e
+    rescue StandardError => e
       raise "Failed to select an instance from the Auto Scaling Group: #{e.message}"
     end
   end

data/lib/moonshot/stack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module Moonshot
@@ -5,17 +7,36 @@ module Moonshot
   # stores the state of the active stack running on AWS, but contains a
   # reference to the StackTemplate that would be applied with an update
   # action.
-  class Stack # rubocop:disable ClassLength
+  class Stack # rubocop:disable Metrics/ClassLength
     include CredsHelper
     include DoctorHelper
 
-    attr_reader :app_name
-    attr_reader :name
+    attr_reader :app_name, :name
+
+    class << self
+      def generate_name(config)
+        [config.app_name, config.environment_name].join('-')
+      end
+
+      def make_tags(config)
+        default_tags = [
+          { key: 'moonshot_application', value: config.app_name },
+          { key: 'moonshot_environment', value: config.environment_name }
+        ]
+        name = generate_name(config)
+
+        if config.additional_tag
+          default_tags << { key: config.additional_tag, value: name }
+        end
+
+        default_tags + config.extra_tags
+      end
+    end
 
     def initialize(config)
       @config = config
       @ilog = config.interactive_logger
-      @name = [@config.app_name, @config.environment_name].join('-')
+      @name = self.class.generate_name(@config)
 
       yield @config if block_given?
     end
@@ -111,7 +132,7 @@ module Moonshot
       resource_summary = resource_summaries.find do |r|
         r.logical_resource_id == logical_id
       end
-      resource_summary.physical_resource_id if resource_summary
+      resource_summary&.physical_resource_id
     end
 
     # @return [Array<Aws::CloudFormation::Types::StackResourceSummary>]
@@ -152,13 +173,23 @@ module Moonshot
 
         # Support the legacy file location from Moonshot 1.0.
         YamlStackTemplate.new(
-          File.join(@config.project_root, 'cloud_formation', "#{@config.app_name}.yml")),
+          File.join(@config.project_root, 'cloud_formation', "#{@config.app_name}.yml")
+        ),
         JsonStackTemplate.new(
-          File.join(@config.project_root, 'cloud_formation', "#{@config.app_name}.json"))
+          File.join(@config.project_root, 'cloud_formation', "#{@config.app_name}.json")
+        )
       ]
 
+      # If a template file has been specified in the config, look there first.
+      if @config.template_file
+        templates.unshift YamlStackTemplate.new(@config.template_file)
+        templates.unshift JsonStackTemplate.new(@config.template_file)
+      end
+
       template = templates.find(&:exist?)
+
       raise 'No template found in moonshot/template.{yml,json}!' unless template
+
       template
     end
 
@@ -177,9 +208,7 @@ module Moonshot
     end
 
     def upload_template_to_s3
-      unless @config.template_s3_bucket
-        raise 'The S3 bucket to store the template in is not configured.'
-      end
+      raise 'The S3 bucket to store the template in is not configured.' unless @config.template_s3_bucket
 
       s3_object_key = "#{@name}-#{Time.now.getutc.to_i}-#{File.basename(template.filename)}"
       template_url = "http://#{@config.template_s3_bucket}.s3.amazonaws.com/#{s3_object_key}"
@@ -199,7 +228,7 @@ module Moonshot
     def create_stack
       parameters = {
         stack_name: @name,
-        capabilities: %w(CAPABILITY_IAM CAPABILITY_NAMED_IAM),
+        capabilities: %w[CAPABILITY_IAM CAPABILITY_NAMED_IAM],
         parameters: @config.parameters.values.map(&:to_cf),
         tags: make_tags
       }
@@ -221,11 +250,12 @@ module Moonshot
       ].join('-')
 
       parameters = {
-        change_set_name: change_set_name,
+        change_set_name:,
         description: "Moonshot update command for application '#{Moonshot.config.app_name}'",
         stack_name: @name,
-        capabilities:  %w(CAPABILITY_IAM CAPABILITY_NAMED_IAM),
-        parameters: @config.parameters.values.map(&:to_cf)
+        capabilities:  %w(CAPABILITY_IAM CAPABILITY_NAMED_IAM), # rubocop:disable Layout/HashAlignment,Style/PercentLiteralDelimiters
+        parameters: @config.parameters.values.map(&:to_cf),
+        tags: make_tags
       }
       if @config.template_s3_bucket
         parameters[:template_url] = upload_template_to_s3
@@ -248,52 +278,38 @@ module Moonshot
       events.show_only_errors unless @config.show_all_stack_events
 
       @ilog.start_threaded "Waiting for #{stack_name} to be successfully #{past_tense_verb}." do |s|
-        begin
-          cf_client.wait_until(wait_target, stack_name: stack_id) do |w|
-            w.delay = 10
-            w.max_attempts = 360 # 60 minutes.
-            w.before_wait do |attempt, resp|
-              begin
-                events.latest_events.each { |e| @ilog.error(format_event(e)) }
-                # rubocop:disable Lint/HandleExceptions
-              rescue Aws::CloudFormation::Errors::ValidationError
-                # Do nothing.  The above event logging block may result in
-                # a ValidationError while waiting for a stack to delete.
-              end
-              # rubocop:enable Lint/HandleExceptions
-
-              if attempt == w.max_attempts - 1
-                s.failure "#{stack_name} was not #{past_tense_verb} after 30 minutes."
-                result = false
-
-                # We don't want the interactive logger to catch an exception.
-                throw :success
-              end
-              s.continue "Waiting for CloudFormation Stack to be successfully #{past_tense_verb}, current status '#{resp.stacks.first.stack_status}'." # rubocop:disable LineLength
+        cf_client.wait_until(wait_target, stack_name: stack_id) do |w|
+          w.delay = 10
+          w.max_attempts = 360 # 60 minutes.
+          w.before_wait do |attempt, resp|
+            begin
+              events.latest_events.each { |e| @ilog.error(format_event(e)) }
+            rescue Aws::CloudFormation::Errors::ValidationError
+              # Do nothing.  The above event logging block may result in
+              # a ValidationError while waiting for a stack to delete.
             end
-          end
+            if attempt == w.max_attempts - 1
+              s.failure "#{stack_name} was not #{past_tense_verb} after 30 minutes."
+              result = false
 
-          s.success "#{stack_name} successfully #{past_tense_verb}." if result
-        rescue Aws::Waiters::Errors::FailureStateError
-          result = false
-          s.failure "#{stack_name} failed to update."
+              # We don't want the interactive logger to catch an exception.
+              throw :success
+            end
+            s.continue "Waiting for CloudFormation Stack to be successfully #{past_tense_verb}, current status '#{resp.stacks.first.stack_status}'." # rubocop:disable Layout/LineLength
+          end
         end
+
+        s.success "#{stack_name} successfully #{past_tense_verb}." if result
+      rescue Aws::Waiters::Errors::FailureStateError
+        result = false
+        s.failure "#{stack_name} failed to update."
       end
 
       result
     end
 
     def make_tags
-      default_tags = [
-        { key: 'moonshot_application', value: @config.app_name },
-        { key: 'moonshot_environment', value: @config.environment_name }
-      ]
-
-      if @config.additional_tag
-        default_tags << { key: @config.additional_tag, value: @name }
-      end
-
-      default_tags
+      self.class.make_tags(@config)
     end
 
     def format_event(event)
@@ -320,14 +336,15 @@ module Moonshot
     end
 
     def doctor_check_template_against_aws
+      validate_params = {}
       if @config.template_s3_bucket
-        parameters[:template_url] = upload_template_to_s3
+        validate_params[:template_url] = upload_template_to_s3
       else
-        parameters[:template_body] = template.body
+        validate_params[:template_body] = template.body
       end
-      cf_client.validate_template(parameters)
+      cf_client.validate_template(validate_params)
       success('CloudFormation template is valid.')
-    rescue => e
+    rescue StandardError => e
       critical('Invalid CloudFormation template!', e.message)
     end
 
@@ -351,6 +368,7 @@ module Moonshot
 
       success = wait_for_stack_state(:stack_update_complete, 'updated')
       raise 'Failed to update the CloudFormation Stack.' unless success
+
       success
     end
   end

data/lib/moonshot/stack_asg_printer.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'colorize'
 require 'ruby-duration'
 
@@ -16,8 +17,8 @@ module Moonshot
     def print
       asgs.each do |asg|
         asg_info = as_client.describe_auto_scaling_groups(
-          auto_scaling_group_names: [asg.physical_resource_id])
-                            .auto_scaling_groups.first
+          auto_scaling_group_names: [asg.physical_resource_id]
+        ).auto_scaling_groups.first
         t_asg_info = @table.add_leaf("ASG: #{asg.logical_resource_id}")
 
         add_asg_info(t_asg_info, asg_info)
@@ -70,7 +71,7 @@ module Moonshot
 
     # Get additional information about instances not returned by the ASG API.
     def get_addl_info(instance_ids)
-      resp = ec2_client.describe_instances(instance_ids: instance_ids)
+      resp = ec2_client.describe_instances(instance_ids:)
 
       data = {}
       resp.reservations.map(&:instances).flatten.each do |instance|
@@ -85,7 +86,7 @@ module Moonshot
 
       hc = asg_info.health_check_type.blue
       gp = (asg_info.health_check_grace_period.to_s << 's').blue
-      table.add_line "Using #{hc} health checks, with a #{gp} health check grace period." # rubocop:disable LineLength
+      table.add_line "Using #{hc} health checks, with a #{gp} health check grace period."
 
       dc = asg_info.desired_capacity.to_s.blue
       min = asg_info.min_size.to_s.blue
@@ -93,7 +94,7 @@ module Moonshot
       table.add_line "Desired Capacity is #{dc} (Min: #{min}, Max: #{max})."
 
       lbs = asg_info.load_balancer_names
-      table.add_line "Has #{lbs.count.to_s.blue} Load Balancer(s): #{lbs.map(&:blue).join(', ')}" # rubocop:disable LineLength
+      table.add_line "Has #{lbs.count.to_s.blue} Load Balancer(s): #{lbs.map(&:blue).join(', ')}"
     end
 
     def create_instance_table(asg_info)
@@ -112,11 +113,11 @@ module Moonshot
 
     def instance_row(asg_instance, ec2_instance)
       if ec2_instance
-        if ec2_instance.public_ip_address
-          ip_address = "#{ec2_instance.public_ip_address} (#{ec2_instance.private_ip_address})"
-        else
-          ip_address = "#{ec2_instance.private_ip_address} (PRV)"
-        end
+        ip_address = if ec2_instance.public_ip_address
+                       "#{ec2_instance.public_ip_address} (#{ec2_instance.private_ip_address})"
+                     else
+                       "#{ec2_instance.private_ip_address} (PRV)"
+                     end
         uptime = uptime_format(ec2_instance.launch_time)
       else
         # We've seen race conditions where ASG tells us about instances that EC2 is no longer
@@ -142,7 +143,8 @@ module Moonshot
     def add_recent_activity_leaf(table, asg_name)
       recent = table.add_leaf('Recent Activity')
       resp = as_client.describe_scaling_activities(
-        auto_scaling_group_name: asg_name).activities
+        auto_scaling_group_name: asg_name
+      ).activities
 
       rows = resp.sort_by(&:start_time).reverse.first(10).map do |activity|
         row_for_activity(activity)

data/lib/moonshot/stack_config.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module Moonshot
   # Configuration for the Moonshot::Stack class.
   class StackConfig
-    attr_accessor :parent_stacks
-    attr_accessor :show_all_events
+    attr_accessor :parent_stacks, :show_all_events
 
     def initialize
       @parent_stacks = []

data/lib/moonshot/stack_events_poller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Moonshot
   # The StackEventsPoller queries DescribeStackEvents every time #latest_events
   # is invoked, filtering out events that have already been returned. It can
@@ -32,7 +34,7 @@ module Moonshot
     def filter_events(events)
       if @errors_only
         events.select do |event|
-          %w(CREATE_FAILED UPDATE_FAILED DELETE_FAILED).include?(event.resource_status)
+          %w[CREATE_FAILED UPDATE_FAILED DELETE_FAILED].include?(event.resource_status)
         end
       else
         events