sport_ngin_aws_auditor 3.11.3 → 4.0.0

data/lib/sport_ngin_aws_auditor/scripts/audit.rb

@@ -1,5 +1,6 @@
 require 'highline/import'
 require 'colorize'
+require 'aws-sdk'
 require_relative "../notify_slack"
 require_relative "../instance"
 require_relative "../audit_data"
@@ -10,71 +11,87 @@ module SportNginAwsAuditor
       extend AWSWrapper
 
       class << self
-        attr_accessor :options
+        attr_accessor :options, :audit_results
       end
 
-      def self.execute(environment, options=nil, global_options=nil)
-        aws(environment, global_options[:aws_roles])
-        @options = options
-        slack = options[:slack]
-        no_selection = !(options[:ec2] || options[:rds] || options[:cache])
+      #################### EXECUTION ####################
 
-        if options[:no_tag]
-          tag_name = nil
-        else
-          tag_name = options[:tag]
-        end
+      def self.execute(environment, options, global_options)
+        aws(environment, global_options)
+        collect_options(environment, options, global_options)
+        print_title
+        @regions.each { |region| audit_region(region) }
+        reset_credentials
+      end
 
-        ignore_instances_regexes = []
-        if options[:ignore_instances_patterns]
-          ignore_instances_patterns = options[:ignore_instances_patterns].split(', ')
-          ignore_instances_patterns.each do |r|
-            ignore_instances_regexes << Regexp.new(r)
-          end
-        end
-        
-        zone_output = options[:zone_output]
+      def self.audit_region(region)
+        @region_previously_printed = false
+        @message = ""
+        @instance_types.each { |type| audit_instance_type(type, region) }
+        add_region_to_message(region) unless @message == "" || @region_previously_printed || @slack
+        print_message unless @slack
+      end
 
-        cycle = [["EC2Instance", options[:ec2]],
-                 ["RDSInstance", options[:rds]],
-                 ["CacheInstance", options[:cache]]]
+      def self.audit_instance_type(type, region)
+        @class = type.first
+        @audit_results = AuditData.new({:instances => options[:instances], :reserved => options[:reserved],
+                                        :class => type.first.to_s, :tag_name => @tag_name,
+                                        :regexes => @ignore_instances_regexes, :region => region})
+        @audit_results.gather_data
 
-        if !slack
-          print "Gathering info, please wait..."; print "\r"
-        else
-          puts "Condensed results from this audit will print into Slack instead of directly to an output."
-        end
-
-        cycle.each do |c|
-          audit_results = AuditData.new(options[:instances], options[:reserved], c.first, tag_name, ignore_instances_regexes)
-          audit_results.gather_data
-          output_options = {:slack => slack, :class_type => c.first,
-                            :environment => environment, :zone_output => zone_output}
-          print_data(audit_results, output_options) if (c.last || no_selection)
+        unless @audit_results.data.empty?
+          add_instance_type_to_message(type)
+          print_audit_results(region) if (type.last || @no_selection)
         end
       end
 
-      def self.print_data(audit_results, output_options)
-        audit_results.data.sort_by! { |instance| [instance.category, instance.type] }
+      def self.print_audit_results(region)
+        @audit_results.data.sort_by! { |instance| [instance.category, instance.type] }
 
-        if output_options[:slack]
-          print_to_slack(audit_results, output_options)
+        if @slack
+          print_to_slack(region)
         elsif options[:reserved] || options[:instances]
-          puts header(output_options[:class_type])
-          audit_results.data.each{ |instance| say "<%= color('#{instance.type}: #{instance.count}', :white) %>" }
+          @audit_results.data.each{ |instance| @message << "#{instance.type}: #{instance.count}\n".colorize(:color => :white) }
         else
-          puts header(output_options[:class_type])
-          audit_results.data.each{ |instance| colorize(instance, output_options[:zone_output]) }
+          print_to_terminal
+        end
+      end
+
+      #################### PRINTING DATA TO TERMINAL ####################
+
+      def self.print_to_terminal
+        say_instances
+        say_retired_ris unless @audit_results.retired_ris.empty?
+        say_retired_tags unless @audit_results.retired_tags.empty?
+      end
 
-          say_retired_ris(audit_results, output_options) unless audit_results.retired_ris.empty?
-          say_retired_tags(audit_results, output_options) unless audit_results.retired_tags.empty?
+      def self.say_instances
+        @audit_results.data.each do |instance|
+          name = !@zone_output && (instance.tagged? || instance.running?) ? print_without_zone(instance.type) : instance.type
+          count = instance.count
+          color, rgb, prefix = color_chooser({:instance => instance, :retired_ri => false, :retired_tag => false})
+          
+          if instance.tagged?
+            if instance.reason
+              description = "#{prefix} #{name}: (expiring on #{instance.tag_value} because #{instance.reason})\n"
+            else
+              description = "#{prefix} #{name}: (expiring on #{instance.tag_value})\n"
+            end
+          elsif instance.ignored?
+            description = "#{prefix} #{name}\n"
+          else
+            description = "#{prefix} #{name}: #{count}\n"
+          end
+
+          @message << description.colorize(:color => color)
         end
       end
 
-      def self.say_retired_ris(audit_results, output_options)
-        retired_ris = audit_results.retired_ris
-        say "The following reserved #{output_options[:class_type]}Instances have recently expired in #{output_options[:environment]}:"
+      def self.say_retired_ris
+        retired_ris = @audit_results.retired_ris
+
         retired_ris.each do |ri|
+          color, rgb, prefix = color_chooser({:instance => ri, :retired_ri => true, :retired_tag => false})
           if ri.availability_zone.nil?
             # if ri.to_s = 'Linux VPC  t2.small'...
             my_match = ri.to_s.match(/(\w*\s*\w*\s{1})\s*(\s*\S*)/)
@@ -85,118 +102,75 @@ module SportNginAwsAuditor
             # and size = 't2.small'
             size = my_match[2] if my_match
 
-            n = "#{platform}#{audit_results.region} #{size}"
-            say "#{n} (#{ri.count}) on #{ri.expiration_date}"
+            n = "#{platform}#{@audit_results.region} #{size}"
           else
-            say "#{ri.to_s} (#{ri.count}) on #{ri.expiration_date}"
+            n = ri.to_s
           end
+
+          @message << "#{prefix} #{n} (#{ri.count}) on #{ri.expiration_date}\n".colorize(:color => color)
         end
       end
 
-      def self.say_retired_tags(audit_results, output_options)
-        retired_tags = audit_results.retired_tags
-        say "The following #{output_options[:class_type]}Instance tags have recently expired in #{output_options[:environment]}:"
+      def self.say_retired_tags
+        retired_tags = @audit_results.retired_tags
+
         retired_tags.each do |tag|
+          color, rgb, prefix = color_chooser({:instance => tag, :retired_ri => false, :retired_tag => true})
           if tag.reason
-            say "#{tag.instance_name} (#{tag.instance_type}) retired on #{tag.value} because #{tag.reason}"
+            description ="#{prefix} #{tag.instance_name} (#{tag.instance_type}) retired on #{tag.value} because #{tag.reason}\n"
           else
-            say "#{tag.instance_name} (#{tag.instance_type}) retired on #{tag.value}"
+            description = "#{prefix} #{tag.instance_name} (#{tag.instance_type}) retired on #{tag.value}"
           end
-        end
-      end
 
-      def self.colorize(instance, zone_output=nil)
-        name = !zone_output && (instance.tagged? || instance.running?) ? print_without_zone(instance.type) : instance.type
-        count = instance.count
-        color, rgb, prefix = color_chooser(instance)
-        
-        if instance.tagged?
-          if instance.reason
-            puts "#{prefix} #{name}: (expiring on #{instance.tag_value} because #{instance.reason})".blue
-          else
-            say "<%= color('#{prefix} #{name}: (expiring on #{instance.tag_value})', :#{color}) %>"
-          end
-        elsif instance.ignored?
-          say "<%= color('#{prefix} #{name}', :#{color}) %>"
-        else
-          say "<%= color('#{prefix} #{name}: #{count}', :#{color}) %>"
+          @message << description.colorize(:color => color)
         end
       end
 
-      def self.print_to_slack(audit_results, output_options)
-        discrepancy_array = []
-        tagged_ignored_array = []
-
-        audit_results.data.each do |instance|
-          unless instance.matched? || instance.tagged? || instance.ignored?
-            discrepancy_array.push(instance)
-          end
-        end
-
-        unless discrepancy_array.empty?
-          print_discrepancies(discrepancy_array, output_options)
-        end
+      #################### PRINTING DATA TO SLACK ####################
 
-       audit_results.data.each do |instance|
-          if instance.tagged? || instance.ignored?
-            tagged_ignored_array.push(instance)
-          end
-        end
+      def self.print_to_slack(region)
+        @slack_message = NotifySlack.new(@message, @options[:config_json])
 
-        unless tagged_ignored_array.empty?
-          print_tagged(tagged_ignored_array, output_options)
-        end
+        print_instances
+        print_retired_ris unless @audit_results.retired_ris.empty?
+        print_retired_tags unless @audit_results.retired_tags.empty?
 
-        print_retired_ris(audit_results, output_options) unless audit_results.retired_ris.empty?
-        print_retired_tags(audit_results, output_options) unless audit_results.retired_tags.empty?
+        add_region_to_message(region) unless @region_previously_printed
+        print_message
+        @region_previously_printed = true
+        @message = ""
       end
 
-      def self.print_discrepancies(discrepancy_array, output_options)
-        title = "Some #{output_options[:class_type]} discrepancies for #{output_options[:environment]} exist:\n"
-        slack_instances = NotifySlack.new(title, options[:config_json])
+      def self.print_instances
+        data_array = @audit_results.data.reject { |data| data.matched? }
 
-        discrepancy_array.each do |discrepancy|
-          type = !output_options[:zone_output] && discrepancy.running? ? print_without_zone(discrepancy.type) : discrepancy.type
-          count = discrepancy.count
-          color, rgb, prefix = color_chooser(discrepancy)
-
-          unless discrepancy.tagged?
-            text = "#{prefix} #{type}: #{count}"
-            slack_instances.attachments.push({"color" => rgb, "text" => text, "mrkdwn_in" => ["text"]})
-          end
-        end
-
-        slack_instances.perform        
-      end
-
-      def self.print_tagged(tagged_ignored_array, output_options)
-        title = "There are currently some tagged or ignored #{output_options[:class_type]}s in #{output_options[:environment]}:\n"
-        slack_instances = NotifySlack.new(title, options[:config_json])
-
-        tagged_ignored_array.each do |tagged_or_ignored|
-          type = output_options[:zone_output] ? tagged_or_ignored.type : print_without_zone(tagged_or_ignored.type)
-          count = tagged_or_ignored.count
-          color, rgb, prefix = color_chooser(tagged_or_ignored)
-          
-          if tagged_or_ignored.tagged?
-            if tagged_or_ignored.reason
-              text = "#{prefix} #{tagged_or_ignored.name}: (expiring on #{tagged_or_ignored.tag_value} because #{tagged_or_ignored.reason})"
+        if data_array.empty?
+          @slack_message.attachments.push({"color" => "#32CD32", "text" => "All RIs are properly matched here!", "mrkdwn_in" => ["text"]})
+        else
+          data_array.each do |data|
+            type = !@zone_output && (data.tagged? || data.running?) ? print_without_zone(data.type) : data.type
+            count = data.count
+            color, rgb, prefix = color_chooser({:instance => data, :retired_ri => false, :retired_tag => false})
+
+            if data.tagged?
+              if data.reason
+                text = "#{prefix} #{data.name}: (expiring on #{data.tag_value} because #{data.reason})"
+              else
+                text = "#{prefix} #{data.name}: (expiring on #{data.tag_value})"
+              end
+            elsif data.ignored?
+              text = "#{prefix} #{data.name}"
             else
-              text = "#{prefix} #{tagged_or_ignored.name}: (expiring on #{tagged_or_ignored.tag_value})"
+              text = "#{prefix} #{type}: #{count}"
             end
-          elsif tagged_or_ignored.ignored?
-            text = "#{prefix} #{tagged_or_ignored.name}"
-          end
 
-          slack_instances.attachments.push({"color" => rgb, "text" => text, "mrkdwn_in" => ["text"]})
+            @slack_message.attachments.push({"color" => rgb, "text" => text, "mrkdwn_in" => ["text"]})
+          end
         end
-
-        slack_instances.perform
       end
 
-      def self.print_retired_ris(audit_results, output_options)
-        retired_ris = audit_results.retired_ris
-        message = "The following reserved #{output_options[:class_type]}s have recently expired in #{output_options[:environment]}:\n"
+      def self.print_retired_ris
+        retired_ris = @audit_results.retired_ris
 
         retired_ris.each do |ri|
           if ri.availability_zone.nil?
@@ -209,64 +183,129 @@ module SportNginAwsAuditor
             # and size = 't2.small'
             size = my_match[2] if my_match
 
-            name = "#{platform}#{audit_results.region} #{size}"
+            name = "#{platform}#{@audit_results.region} #{size}"
           else
             name = ri.to_s
           end
           
           count = ri.count
+          color, rgb, prefix = color_chooser({:instance => ri, :retired_ri => true, :retired_tag => false})
           expiration_date = ri.expiration_date
-          message << "*#{name}* (#{count}) on *#{expiration_date}*\n"
+          text = "#{prefix} #{name} (#{count}) on #{expiration_date}"
+
+          @slack_message.attachments.push({"color" => rgb, "text" => text, "mrkdwn_in" => ["text"]})
         end
-          
-        slack_retired_ris = NotifySlack.new(message, options[:config_json])
-        slack_retired_ris.perform
       end
 
-      def self.print_retired_tags(audit_results, output_options)
-        retired_tags = audit_results.retired_tags
-        message = "The following #{output_options[:class_type]} tags have recently expired in #{output_options[:environment]}:\n"
+      def self.print_retired_tags
+        retired_tags = @audit_results.retired_tags
 
         retired_tags.each do |tag|
+          color, rgb, prefix = color_chooser({:instance => tag, :retired_ri => false, :retired_tag => true})
+
           if tag.reason
-            message << "*#{tag.instance_name}* (#{tag.instance_type}) retired on *#{tag.value}* because #{tag.reason}\n"
+            text = "#{prefix} #{tag.instance_name} (#{tag.instance_type}) retired on #{tag.value} because #{tag.reason}"
           else
-            message << "*#{tag.instance_name}* (#{tag.instance_type}) retired on *#{tag.value}*\n"
+            text = "#{prefix} #{tag.instance_name} (#{tag.instance_type}) retired on #{tag.value}"
           end
+
+          @slack_message.attachments.push({"color" => rgb, "text" => text, "mrkdwn_in" => ["text"]})
         end
+      end
+
+      #################### OTHER HELPFUL METHODS ####################
 
-        slack_retired_tags = NotifySlack.new(message, options[:config_json])
-        slack_retired_tags.perform
+      def self.gather_regions
+        ec2 = Aws::EC2::Client.new(region: 'us-east-1')
+        regions = ec2.describe_regions[:regions]
+        us_regions = regions.select { |region| region.region_name.include?("us") }
+        us_regions.collect { |r| r.region_name }
       end
 
-      def self.print_without_zone(type)
-        type.sub(/(-\d\w)/, '')
+      def self.collect_options(environment, options, global_options)
+        @options = options
+        @display_name = global_options[:display] || environment
+        @slack = options[:slack]
+        @no_selection = !(options[:ec2] || options[:rds] || options[:cache])
+        @zone_output = options[:zone_output]
+        @regions = (global_options[:region].split(', ') if global_options[:region]) || gather_regions
+
+        if options[:no_tag]
+          @tag_name = nil
+        else
+          @tag_name = options[:tag]
+        end
+
+        @ignore_instances_regexes = []
+        if options[:ignore_instances_patterns]
+          options[:ignore_instances_patterns].split(', ').each do |r|
+            @ignore_instances_regexes << Regexp.new(r)
+          end
+        end
+
+        @instance_types = [["EC2Instance", options[:ec2]],
+                           ["RDSInstance", options[:rds]],
+                           ["CacheInstance", options[:cache]]]
+      end
+
+      def self.print_title
+        if @slack
+          puts "Condensed results from this audit will print into Slack instead of directly to an output."
+          NotifySlack.new("_AWS AUDIT FOR #{@display_name}_", @options[:config_json]).perform
+        else
+          puts "AWS AUDIT FOR #{@display_name}".colorize(:color => :yellow, :background => :red).underline
+          puts
+        end
+      end
+
+      def self.print_message
+        unless @message == ""
+          if @slack
+            @slack_message.perform
+          else
+            puts @message
+          end
+        end
       end
 
-      def self.color_chooser(instance)
-        if instance.tagged?
-          return "blue", "#0000CC", "TAGGED -"
-        elsif instance.ignored?
-          return "blue", "#0000CC", "IGNORED -"
-        elsif instance.running?
-          return "yellow", "#FFD700", "MISSING RI -"
-        elsif instance.matched?
-          return "green", "#32CD32", "MATCHED RI -"
-        elsif instance.reserved?
-          return "red", "#BF1616", "UNUSED RI -"
+      def self.add_region_to_message(region)
+        if @slack
+          @message.prepend("_REGION: *_#{region}_*_\n")
+          @slack_message.text = @message
+        else
+          @message.prepend("REGION: #{region}\n".colorize(:color => :magenta).underline)
         end
       end
 
-      def self.header(type, length = 50)
-        type.upcase!.slice! "INSTANCE"
-        half_length = (length - type.length)/2.0 - 1
-        [
-          "*" * length,
-          "*" * half_length.floor + " #{type} " + "*" * half_length.ceil,
-          "*" * length
-        ].join("\n")
+      def self.add_instance_type_to_message(type)
+        if @slack
+          @message << "*#{type.first}s*\n"
+        else
+          @message << "#{type.first}s\n".underline
+        end
       end
 
+      def self.print_without_zone(type)
+        type.sub(/(-\d\w)/, '')
+      end
+
+      def self.color_chooser(data)
+        if data[:retired_ri]
+          return :light_black, "#595959", "RETIRED RI -"
+        elsif data[:retired_tag]
+          return :light_black, "#595959", "RETIRED TAG -"
+        elsif data[:instance].tagged?
+          return :blue, "#0000CC", "TAGGED -"
+        elsif data[:instance].ignored?
+          return :blue, "#0000CC", "IGNORED -"
+        elsif data[:instance].running?
+          return :yellow, "#FFD700", "MISSING RI -"
+        elsif data[:instance].matched?
+          return :green, "#32CD32", "MATCHED RI -"
+        elsif data[:instance].reserved?
+          return :red, "#BF1616", "UNUSED RI -"
+        end
+      end
     end
   end
 end

data/lib/sport_ngin_aws_auditor/scripts/inspect.rb

@@ -3,19 +3,32 @@ module SportNginAwsAuditor
     class Inspect
       extend AWSWrapper
       extend OpsWorksWrapper
+      extend EC2Wrapper
+      extend RDSWrapper
+      extend CacheWrapper
 
       def self.execute(environment, options=nil, global_options=nil)
-        aws(environment, global_options[:aws_roles])
+        aws(environment, global_options)
+        region = (global_options[:region].split(', ') if global_options[:region]) || 'us-east-1'
         no_selection = options.values.uniq == [false]
-        output("EC2Instance") if options[:ec2] || no_selection
-        output("RDSInstance") if options[:rds] || no_selection 
-        output("CacheInstance") if options[:cache] || no_selection
+        output("EC2Instance", region) if options[:ec2] || no_selection
+        output("RDSInstance", region) if options[:rds] || no_selection
+        output("CacheInstance", region) if options[:cache] || no_selection
       end
 
-      def self.output(class_type)
+      def self.output(class_type, region)
         klass = SportNginAwsAuditor.const_get(class_type)
+
+        if class_type == "EC2Instance"
+          client = EC2Wrapper.ec2(region)
+        elsif class_type == "RDSInstance"
+          client = RDSWrapper.rds(region)
+        elsif class_type == "CacheInstance"
+          client = CacheWrapper.cache(region)
+        end
+
         print "Gathering info, please wait..."; print "\r"
-        instances = class_type == "EC2Instance" ? klass.bucketize : klass.instance_hash
+        instances = class_type == "EC2Instance" ? klass.bucketize(client) : klass.instance_hash(client)
         say "<%= color('#{header(class_type)}', :white) %>"
         instances.each do |key, value|
           pretty_print(key, klass.instance_count_hash(Array(value)))
@@ -36,7 +49,7 @@ module SportNginAwsAuditor
         puts "======================================="
         puts "#{title}"
         puts "======================================="
-        body.each{ |key, value| say "<%= color('#{key}: #{value}', :white) %>" }
+        body.each{ |key, value| say "<%= color('#{key}: #{value[:count]}', :white) %>" }
         puts "\n"
       end
     end

data/lib/sport_ngin_aws_auditor/version.rb

@@ -1,3 +1,3 @@
 module SportNginAwsAuditor
-  VERSION = "3.11.3"
+  VERSION = "4.0.0"
 end