sport_ngin_aws_auditor 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 073cee3003356deb0134ca9da9b30f840114e29d
-  data.tar.gz: 9bf761c1afd8c271c1d99bafcbdf8aa26d01d49c
+  metadata.gz: 9420e3fde54aac536e36c97eef5a8a1fdf33eac7
+  data.tar.gz: 5768c1734e3db6feaa33176526f4ec5f91b5528c
 SHA512:
-  metadata.gz: 53e5ece55ea759b443d8bd965a22bc0413ba3934051bd1eb14d075e22945a31a6a6239a194d0617d078336640ae369f7f8f5555eee67506cf121cfe6483e796e
-  data.tar.gz: a97b0d51779933df9e489164d81ed85eeed70b0b29dae2bc2d522270cb29a9b071d650eec86bea943f5062930a17f437e256a5809bbb9905e7057174cd3a9ee6
+  metadata.gz: 56209e4afd417d46fab66f048092912c384f4a24fa27c5c6e36b60583ad29caa52e69b0aa89e55935b2fa34410879ee100b3d5a640af3c6e040a334f8cbfb919
+  data.tar.gz: 46ba9993be65f4367016122e32988c69bf34850f799f26e69a4ac1d7aea4b7ceb6f690655198d8bcf31cc8d5e6ebd31e6d1017481cf35fb3090cd175eddbfd30

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+#### v3.7.0
+* Print retired tags into slack/terminal on audit
+
+  > Emma Sax: Brian Bergstrom: https://github.com/sportngin/sport_ngin_aws_auditor/pull/17
+
 #### v3.6.0
 * Print reserved instances that have retired in past week
 

data/lib/sport_ngin_aws_auditor/audit_data.rb

@@ -0,0 +1,64 @@
+require_relative './instance_helper'
+
+module SportNginAwsAuditor
+  class AuditData
+
+    attr_accessor :data, :retired_tags, :retired_ris, :selected_audit_type, :klass, :tag_name
+    def initialize(instances, reserved, class_type, tag_name)
+      self.selected_audit_type = (!instances && !reserved) ? "all" : (instances ? "instances" : "reserved")
+      self.klass = SportNginAwsAuditor.const_get(class_type)
+      self.tag_name = tag_name
+    end
+
+    def instances?
+      self.selected_audit_type == "instances"
+    end
+
+    def reserved?
+      self.selected_audit_type == "reserved"
+    end
+
+    def all?
+      self.selected_audit_type == "all"
+    end
+
+    def gather_data
+      if instances?
+        instance_hash, retired_tags = gather_instances_data
+      elsif reserved?
+        instance_hash = self.klass.instance_count_hash(self.klass.get_reserved_instances)
+      elsif all?
+        instance_hash, retired_tags, retired_ris = gather_all_data
+      end
+
+      compared_array = []
+      instance_hash.each do |key, value|
+        compared_array.push(Instance.new(key, value))
+      end
+
+      self.data = compared_array
+      self.retired_ris = retired_ris
+      self.retired_tags = retired_tags
+    end
+
+    def gather_instances_data
+      instances = self.klass.get_instances(tag_name)
+      retired_tags = self.klass.get_retired_tags(instances)
+      instances_with_tag = self.klass.filter_instances_with_tags(instances)
+      instances_without_tag = self.klass.filter_instance_without_tags(instances)
+      instance_hash = self.klass.instance_count_hash(instances_without_tag)
+      self.klass.add_instances_with_tag_to_hash(instances_with_tag, instance_hash)
+
+      return instance_hash, retired_tags
+    end
+
+    def gather_all_data
+      instances = self.klass.get_instances(tag_name)
+      retired_tags = self.klass.get_retired_tags(instances)
+      instance_hash = self.klass.compare(instances)
+      retired_ris = self.klass.get_recent_retired_reserved_instances
+
+      return instance_hash, retired_tags, retired_ris
+    end
+  end
+end

data/lib/sport_ngin_aws_auditor/instance_helper.rb

@@ -1,3 +1,6 @@
+require_relative './recently_retired_tag'
+require_relative './audit_data'
+
 module SportNginAwsAuditor
 	module InstanceHelper
 
@@ -27,9 +30,8 @@ module SportNginAwsAuditor
       instance_hash
     end
 
-    def compare(tag_name)
+    def compare(instances)
       differences = Hash.new()
-      instances = get_instances(tag_name)
       instances_with_tag = filter_instances_with_tags(instances)
       instances_without_tag = filter_instance_without_tags(instances)
       instance_hash = instance_count_hash(instances_without_tag)
@@ -69,6 +71,21 @@ module SportNginAwsAuditor
       end
     end
 
+    # this returns a hash of all instances that have retired between 1 week ago and today
+    def get_retired_tags(instances)
+      return_array = []
+      
+      instances.select do |instance|
+        value = gather_instance_tag_date(instance)
+        one_week_ago = (Date.today - 7).to_s
+        if (value && (one_week_ago < value.to_s) && (value.to_s < Date.today.to_s))
+          return_array << RecentlyRetiredTag.new(value.to_s, instance.to_s)
+        end
+      end
+      
+      return_array
+    end
+
     def gather_instance_tag_date(instance)
       value = instance.no_reserved_instance_tag_value
       unless value.nil?

data/lib/sport_ngin_aws_auditor/recently_retired_tag.rb

@@ -0,0 +1,12 @@
+require_relative './instance_helper'
+
+module SportNginAwsAuditor
+  class RecentlyRetiredTag
+
+    attr_accessor :value, :instance_name
+    def initialize(tag_value, instance_name)
+      self.value = tag_value
+      self.instance_name = instance_name
+    end
+  end
+end

data/lib/sport_ngin_aws_auditor/scripts/audit.rb

@@ -1,6 +1,7 @@
 require 'highline/import'
 require_relative "../notify_slack"
 require_relative "../instance"
+require_relative "../audit_data"
 
 module SportNginAwsAuditor
   module Scripts
@@ -34,55 +35,42 @@ module SportNginAwsAuditor
         end
 
         cycle.each do |c|
-          all_data = gather_data(c.first, tag_name) if (c.last || no_selection)
-          data = all_data.first unless all_data.nil?
-          retired_reserved_instances = all_data.last if (all_data.length == 2 && !all_data.nil?)
-          print_data(slack, environment, data, retired_reserved_instances, c.first) if (c.last || no_selection)
+          audit_results = AuditData.new(options[:instances], options[:reserved], c.first, tag_name)
+          audit_results.gather_data
+          print_data(slack, audit_results, c.first, environment) if (c.last || no_selection)
         end
       end
 
-      def self.gather_data(class_type, tag_name)
-        klass = SportNginAwsAuditor.const_get(class_type)
-
-        if options[:instances]
-          instances = klass.get_instances(tag_name)
-          instances_with_tag = klass.filter_instances_with_tags(instances)
-          instances_without_tag = klass.filter_instance_without_tags(instances)
-          instance_hash = klass.instance_count_hash(instances_without_tag)
-          klass.add_instances_with_tag_to_hash(instances_with_tag, instance_hash)
-        elsif options[:reserved]
-          instance_hash = klass.instance_count_hash(klass.get_reserved_instances)
-        else
-          instance_hash = klass.compare(tag_name)
-          retired_reserved_instances = klass.get_recent_retired_reserved_instances
-        end
-
-        compared_array = []
-        instance_hash.each do |key, value|
-          compared_array.push(Instance.new(key, value))
-        end
-
-        [compared_array, retired_reserved_instances]
-      end
-
-      def self.print_data(slack, environment, data, retired_reserved_instances, class_type)
-        data.sort_by! { |instance| [instance.type, instance.name] }
+      def self.print_data(slack, audit_results, class_type, environment)
+        audit_results.data.sort_by! { |instance| [instance.type, instance.name] }
 
         if slack
-          print_to_slack(data, retired_reserved_instances, class_type, environment)
+          print_to_slack(audit_results, class_type, environment)
         elsif options[:reserved] || options[:instances]
           puts header(class_type)
-          data.each{ |instance| say "<%= color('#{instance.name}: #{instance.count}', :white) %>" }
+          audit_results.data.each{ |instance| say "<%= color('#{instance.name}: #{instance.count}', :white) %>" }
         else
+          retired_ris = audit_results.retired_ris
+          retired_tags = audit_results.retired_tags
+
           puts header(class_type)
-          data.each{ |instance| colorize(instance) }
-          unless retired_reserved_instances.empty?
-            say "The following reserved #{class_type}Instance have recently expired in #{environment}:"
-            retired_reserved_instances.each { |ri| say "#{ri.to_s} (#{ri.count}) on #{ri.expiration_date}"}
-          end
+          audit_results.data.each{ |instance| colorize(instance) }
+
+          say_retired_ris(retired_ris, class_type, environment) unless retired_ris.empty?
+          say_retired_tags(retired_tags, class_type, environment) unless retired_tags.empty?
         end
       end
 
+      def self.say_retired_ris(retired_ris, class_type, environment)
+        say "The following reserved #{class_type}Instances have recently expired in #{environment}:"
+        retired_ris.each { |ri| say "#{ri.to_s} (#{ri.count}) on #{ri.expiration_date}" }
+      end
+
+      def self.say_retired_tags(retired_tags, class_type, environment)
+        say "The following #{class_type}Instance tags have recently expired in #{environment}:"
+        retired_tags.each { |tag| say "#{tag.instance_name} on #{tag.value}" }
+      end
+
       def self.colorize(instance)
         name = instance.name
         count = instance.count
@@ -90,10 +78,10 @@ module SportNginAwsAuditor
         say "<%= color('#{name}: #{count}', :#{color}) %>"
       end
 
-      def self.print_to_slack(instances_array, retired_instances_array, class_type, environment)
+      def self.print_to_slack(audit_results, class_type, environment)
         discrepancy_array = []
 
-        instances_array.each do |instance|
+        audit_results.data.each do |instance|
           unless instance.matched?
             discrepancy_array.push(instance)
           end
@@ -102,11 +90,11 @@ module SportNginAwsAuditor
         true_discrepancies = discrepancy_array.reject{ |instance| instance.tagged? }
 
         unless true_discrepancies.empty?
-          print_discrepancies(discrepancy_array, retired_instances_array, class_type, environment)
+          print_discrepancies(discrepancy_array, audit_results, class_type, environment)
         end
       end
 
-      def self.print_discrepancies(discrepancy_array, retired_instances_array, class_type, environment)
+      def self.print_discrepancies(discrepancy_array, audit_results, class_type, environment)
         title = "Some #{class_type} discrepancies for #{environment} exist:\n"
         slack_instances = NotifySlack.new(title)
 
@@ -119,19 +107,36 @@ module SportNginAwsAuditor
 
         slack_instances.perform
 
-        unless retired_instances_array.empty?
-          message = "The following reserved #{class_type} have recently expired in #{environment}:\n"
+        retired_ris = audit_results.retired_ris
+        retired_tags = audit_results.retired_tags
 
-          retired_instances_array.each do |ri|
-            name = ri.to_s
-            count = ri.count
-            expiration_date = ri.expiration_date
-            message << "*#{name}* (#{count}) on *#{expiration_date}*\n"
-          end
+        print_retired_ris(retired_ris, class_type, environment) unless retired_ris.empty?
+        print_retired_tags(retired_tags, class_type, environment) unless retired_tags.empty?
+      end
+
+      def self.print_retired_ris(retired_ris, class_type, environment)
+        message = "The following reserved #{class_type}s have recently expired in #{environment}:\n"
+
+        retired_ris.each do |ri|
+          name = ri.to_s
+          count = ri.count
+          expiration_date = ri.expiration_date
+          message << "*#{name}* (#{count}) on *#{expiration_date}*\n"
+        end
           
-          slack_retired_instances = NotifySlack.new(message)
-          slack_retired_instances.perform
+        slack_retired_ris = NotifySlack.new(message)
+        slack_retired_ris.perform
+      end
+
+      def self.print_retired_tags(retired_tags, class_type, environment)
+        message = "The following #{class_type} tags have recently expired in #{environment}:\n"
+
+        retired_tags.each do |tag|
+          message << "*#{tag.instance_name}* on *#{tag.value}*\n"
         end
+
+        slack_retired_tags = NotifySlack.new(message)
+        slack_retired_tags.perform
       end
 
       def self.color_chooser(instance)

data/lib/sport_ngin_aws_auditor/version.rb

@@ -1,3 +1,3 @@
 module SportNginAwsAuditor
-  VERSION = "3.6.0"
+  VERSION = "3.7.0"
 end

data/spec/sport_ngin_aws_auditor/audit_data_spec.rb

@@ -0,0 +1,141 @@
+require "sport_ngin_aws_auditor"
+
+module SportNginAwsAuditor
+  describe AuditData do
+    before :each do
+      @instance = double('instance')
+      @instance1 = double('ec2_instance1')
+      @instance2 = double('ec2_instance2')
+      @instance3 = double('ec2_instance3')
+      @instance4 = double('ec2_instance4')
+      @ec2_instances = [@instance1, @instance2]
+      @retired_ris = [@instance3, @instance4]
+      allow(SportNginAwsAuditor::EC2Instance).to receive(:get_instances).and_return(@ec2_instances)
+      allow(SportNginAwsAuditor::EC2Instance).to receive(:get_reserved_instances).and_return(@ec2_instances)
+      allow(SportNginAwsAuditor::EC2Instance).to receive(:get_retired_tags).and_return([])
+      allow(SportNginAwsAuditor::EC2Instance).to receive(:filter_instances_with_tags).and_return([])
+      allow(SportNginAwsAuditor::EC2Instance).to receive(:filter_instance_without_tags).and_return(@ec2_instances)
+      allow(SportNginAwsAuditor::EC2Instance).to receive(:instance_count_hash).and_return({'instance1' => 1,
+                                                                                           'instance2' => 1})
+      allow(SportNginAwsAuditor::EC2Instance).to receive(:add_instances_with_tag_to_hash).and_return({'instance1' => 1,
+                                                                                                      'instance2' => 1})
+      allow(SportNginAwsAuditor::EC2Instance).to receive(:compare).and_return({'instance1' => 1,
+                                                                               'instance2' => 1})
+      allow(SportNginAwsAuditor::EC2Instance).to receive(:get_recent_retired_reserved_instances).and_return(@retired_ris)
+      allow(Instance).to receive(:new).and_return(@instance)
+    end
+
+    context '#initialization' do
+      it 'should gather instance data' do
+        audit_results = AuditData.new(true, false, "EC2Instance", "no-reserved-instance")
+        expect(audit_results.selected_audit_type).to eq("instances")
+      end
+
+      it 'should gather reserved instance data' do
+        audit_results = AuditData.new(false, true, "EC2Instance", "no-reserved-instance")
+        expect(audit_results.selected_audit_type).to eq("reserved")
+      end
+
+      it 'should by default gather instance data' do
+        audit_results = AuditData.new(true, true, "EC2Instance", "no-reserved-instance")
+        expect(audit_results.selected_audit_type).to eq("instances")
+      end
+
+      it 'should gather all data to compare' do
+        audit_results = AuditData.new(false, false, "EC2Instance", "no-reserved-instance")
+        expect(audit_results.selected_audit_type).to eq("all")
+      end
+
+      it 'should use EC2Instance class' do
+        audit_results = AuditData.new(false, false, "EC2Instance", "no-reserved-instance")
+        expect(audit_results.klass).to eq(SportNginAwsAuditor::EC2Instance)
+      end
+
+      it 'should use EC2Instance class' do
+        audit_results = AuditData.new(false, false, "EC2Instance", "no-reserved-instance")
+        expect(audit_results.tag_name).to eq("no-reserved-instance")
+      end
+    end
+
+    context '#instances?' do
+      it 'should return true' do
+        audit_results = AuditData.new(true, false, "EC2Instance", "no-reserved-instance")
+        expect(audit_results.instances?).to eq(true)
+      end
+
+      it 'should return true' do
+        audit_results = AuditData.new(false, true, "EC2Instance", "no-reserved-instance")
+        expect(audit_results.instances?).to eq(false)
+      end
+    end
+
+    context '#reserved?' do
+      it 'should return true' do
+        audit_results = AuditData.new(true, false, "EC2Instance", "no-reserved-instance")
+        expect(audit_results.reserved?).to eq(false)
+      end
+
+      it 'should return true' do
+        audit_results = AuditData.new(false, true, "EC2Instance", "no-reserved-instance")
+        expect(audit_results.reserved?).to eq(true)
+      end
+    end
+
+    context '#all?' do
+      it 'should return true' do
+        audit_results = AuditData.new(true, false, "EC2Instance", "no-reserved-instance")
+        expect(audit_results.all?).to eq(false)
+      end
+
+      it 'should return true' do
+        audit_results = AuditData.new(false, false, "EC2Instance", "no-reserved-instance")
+        expect(audit_results.all?).to eq(true)
+      end
+    end
+
+    context '#gather_data' do
+      it 'should gather some empty results by comparison' do
+        audit_results = AuditData.new(false, false, "EC2Instance", "no-reserved-instance")
+        audit_results.gather_data
+        expect(audit_results.data).to eq([@instance, @instance])
+        expect(audit_results.retired_tags).to eq([])
+        expect(audit_results.retired_ris).to eq(@retired_ris)
+      end
+
+      it 'should gather some empty results from just instances' do
+        audit_results = AuditData.new(true, false, "EC2Instance", "no-reserved-instance")
+        audit_results.gather_data
+        expect(audit_results.data).to eq([@instance, @instance])
+        expect(audit_results.retired_tags).to eq([])
+        expect(audit_results.retired_ris).to eq(nil)
+      end
+
+      it 'should gather some empty results from just reserved' do
+        audit_results = AuditData.new(false, true, "EC2Instance", "no-reserved-instance")
+        audit_results.gather_data
+        expect(audit_results.data).to eq([@instance, @instance])
+        expect(audit_results.retired_tags).to eq(nil)
+        expect(audit_results.retired_ris).to eq(nil)
+      end
+    end
+
+    context '#gather_instances_data' do
+      it 'should gather some instances data but not convert' do
+        audit_results = AuditData.new(true, false, "EC2Instance", "no-reserved-instance")
+        result1, result2 = audit_results.gather_instances_data
+        expect(result1).to eq({'instance1' => 1, 'instance2' => 1})
+        expect(result2).to eq([])
+      end
+    end
+
+    context '#gather_all_data' do
+      it 'should gather some comparison data but not convert' do
+        audit_results = AuditData.new(false, false, "EC2Instance", "no-reserved-instance")
+        result1, result2, result3 = audit_results.gather_all_data
+        expect(result1).to eq({'instance1' => 1, 'instance2' => 1})
+        expect(result2).to eq([])
+        expect(result3).to eq(@retired_ris)
+      end
+    end
+  end
+end

data/spec/sport_ngin_aws_auditor/recently_retired_tag_spec.rb

@@ -0,0 +1,15 @@
+require "sport_ngin_aws_auditor"
+
+module SportNginAwsAuditor
+  describe RecentlyRetiredTag do
+    it 'should have an instance name as an instance_name' do
+      tag = RecentlyRetiredTag.new('09/01/2000', 'Linux VPC us-east-1b t2.small')
+      expect(tag.instance_name).to eq('Linux VPC us-east-1b t2.small')
+    end
+
+    it 'should have a string date as a value' do
+      tag = RecentlyRetiredTag.new('09/01/2000', 'Linux VPC us-east-1b t2.small')
+      expect(tag.value).to eq('09/01/2000')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sport_ngin_aws_auditor
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Elliot Hursh
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-26 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -204,6 +204,7 @@ files:
 - Rakefile
 - bin/sport-ngin-aws-auditor
 - lib/sport_ngin_aws_auditor.rb
+- lib/sport_ngin_aws_auditor/audit_data.rb
 - lib/sport_ngin_aws_auditor/aws.rb
 - lib/sport_ngin_aws_auditor/cache_instance.rb
 - lib/sport_ngin_aws_auditor/commands/audit.rb
@@ -219,12 +220,14 @@ files:
 - lib/sport_ngin_aws_auditor/notify_slack.rb
 - lib/sport_ngin_aws_auditor/output.rb
 - lib/sport_ngin_aws_auditor/rds_instance.rb
+- lib/sport_ngin_aws_auditor/recently_retired_tag.rb
 - lib/sport_ngin_aws_auditor/scripts/audit.rb
 - lib/sport_ngin_aws_auditor/scripts/export.rb
 - lib/sport_ngin_aws_auditor/scripts/inspect.rb
 - lib/sport_ngin_aws_auditor/stack.rb
 - lib/sport_ngin_aws_auditor/version.rb
 - spec/spec_helper.rb
+- spec/sport_ngin_aws_auditor/audit_data_spec.rb
 - spec/sport_ngin_aws_auditor/aws_spec.rb
 - spec/sport_ngin_aws_auditor/cache_instance_spec.rb
 - spec/sport_ngin_aws_auditor/config_spec.rb
@@ -232,6 +235,7 @@ files:
 - spec/sport_ngin_aws_auditor/instance_spec.rb
 - spec/sport_ngin_aws_auditor/notify_slack_spec.rb
 - spec/sport_ngin_aws_auditor/rds_instance_spec.rb
+- spec/sport_ngin_aws_auditor/recently_retired_tag_spec.rb
 - sport_ngin_aws_auditor.gemspec
 homepage: https://github.com/sportngin/sport_ngin_aws_auditor
 licenses:
@@ -259,6 +263,7 @@ specification_version: 4
 summary: AWS configuration as code
 test_files:
 - spec/spec_helper.rb
+- spec/sport_ngin_aws_auditor/audit_data_spec.rb
 - spec/sport_ngin_aws_auditor/aws_spec.rb
 - spec/sport_ngin_aws_auditor/cache_instance_spec.rb
 - spec/sport_ngin_aws_auditor/config_spec.rb
@@ -266,3 +271,4 @@ test_files:
 - spec/sport_ngin_aws_auditor/instance_spec.rb
 - spec/sport_ngin_aws_auditor/notify_slack_spec.rb
 - spec/sport_ngin_aws_auditor/rds_instance_spec.rb
+- spec/sport_ngin_aws_auditor/recently_retired_tag_spec.rb