sport_ngin_aws_auditor 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49a159bfcd78d9a4084f11225a8a8eabf9161d5f
-  data.tar.gz: 8fdabe907c57537bb552cbfc974b0e6305da54f2
+  metadata.gz: 073cee3003356deb0134ca9da9b30f840114e29d
+  data.tar.gz: 9bf761c1afd8c271c1d99bafcbdf8aa26d01d49c
 SHA512:
-  metadata.gz: 95a2838c5ba80c0740b31f3875598ecaf085df1e2e8c59c583c3873f34c75c0a1c1b9ea2429f0b734cf2e67e82bbaa6f45a46468645277c2931a024b690c64f0
-  data.tar.gz: 2479ae3cc84a567bb5b6ca79c0eadb50863399a870fba1821c529e917f8dc675f77f175da8622da9dbc65c160c40ce4a8b4d798d65798b74c31469cf9b970445
+  metadata.gz: 53e5ece55ea759b443d8bd965a22bc0413ba3934051bd1eb14d075e22945a31a6a6239a194d0617d078336640ae369f7f8f5555eee67506cf121cfe6483e796e
+  data.tar.gz: a97b0d51779933df9e489164d81ed85eeed70b0b29dae2bc2d522270cb29a9b071d650eec86bea943f5062930a17f437e256a5809bbb9905e7057174cd3a9ee6

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+#### v3.6.0
+* Print reserved instances that have retired in past week
+
+  > Emma Sax: Andy Fleener: https://github.com/sportngin/sport_ngin_aws_auditor/pull/16
+
 #### v3.5.0
 * Cleaning up slack printouts with the audit command
 

data/lib/sport_ngin_aws_auditor/cache_instance.rb

@@ -7,7 +7,7 @@ module SportNginAwsAuditor
     extend AWSWrapper
 
     class << self
-      attr_accessor :instances, :reserved_instances
+      attr_accessor :instances, :reserved_instances, :retired_reserved_instances
 
       def get_instances(tag_name=nil)
         return @instances if @instances
@@ -25,9 +25,17 @@ module SportNginAwsAuditor
           new(instance)
         end.compact
       end
+
+      def get_retired_reserved_instances
+        return @retired_reserved_instances if @retired_reserved_instances
+        @retired_reserved_instances = cache.describe_reserved_cache_nodes.reserved_cache_nodes.map do |instance|
+          next unless instance.state == 'retired'
+          new(instance)
+        end.compact
+      end
     end
 
-    attr_accessor :id, :name, :instance_type, :engine, :count, :tag_value
+    attr_accessor :id, :name, :instance_type, :engine, :count, :tag_value, :expiration_date
     def initialize(cache_instance, account_id=nil, tag_name=nil, cache=nil)
       if cache_instance.class.to_s == "Aws::ElastiCache::Types::ReservedCacheNode"
         self.id = cache_instance.reserved_cache_node_id
@@ -35,6 +43,7 @@ module SportNginAwsAuditor
         self.instance_type = cache_instance.cache_node_type
         self.engine = cache_instance.product_description
         self.count = cache_instance.cache_node_count
+        self.expiration_date = cache_instance.start_time + cache_instance.duration if cache_instance.state == 'retired'
       elsif cache_instance.class.to_s == "Aws::ElastiCache::Types::CacheCluster"
         self.id = cache_instance.cache_cluster_id
         self.name = cache_instance.cache_cluster_id

data/lib/sport_ngin_aws_auditor/ec2_instance.rb

@@ -6,7 +6,7 @@ module SportNginAwsAuditor
     extend EC2Wrapper
 
     class << self
-      attr_accessor :instances, :reserved_instances
+      attr_accessor :instances, :reserved_instances, :retired_reserved_instances
 
       def get_instances(tag_name=nil)
         return @instances if @instances
@@ -21,9 +21,17 @@ module SportNginAwsAuditor
 
       def get_reserved_instances
         return @reserved_instances if @reserved_instances
-        @reserved_instances = ec2.describe_reserved_instances.reserved_instances.map do |ri|
-          next unless ri.state == 'active'
-          new(ri, nil, ri.instance_count)
+        @reserved_instances = ec2.describe_reserved_instances.reserved_instances.map do |instance|
+          next unless instance.state == 'active'
+          new(instance, nil, instance.instance_count)
+        end.compact
+      end
+
+      def get_retired_reserved_instances
+        return @retired_reserved_instances if @retired_reserved_instances
+        @retired_reserved_instances = ec2.describe_reserved_instances.reserved_instances.map do |instance|
+          next unless instance.state == 'retired'
+          new(instance, nil, instance.instance_count)
         end.compact
       end
 
@@ -52,7 +60,7 @@ module SportNginAwsAuditor
       private :get_more_info
     end
 
-    attr_accessor :id, :name, :platform, :availability_zone, :instance_type, :count, :stack_name, :tag_value
+    attr_accessor :id, :name, :platform, :availability_zone, :instance_type, :count, :stack_name, :tag_value, :expiration_date
     def initialize(ec2_instance, tag_name, count=1)
       if ec2_instance.class.to_s == "Aws::EC2::Types::ReservedInstances"
         self.id = ec2_instance.reserved_instances_id
@@ -62,6 +70,7 @@ module SportNginAwsAuditor
         self.instance_type = ec2_instance.instance_type
         self.count = count
         self.stack_name = nil
+        self.expiration_date = ec2_instance.end if ec2_instance.state == 'retired'
       elsif ec2_instance.class.to_s == "Aws::EC2::Types::Instance"
         self.id = ec2_instance.instance_id
         self.name = nil

data/lib/sport_ngin_aws_auditor/instance_helper.rb

@@ -34,15 +34,25 @@ module SportNginAwsAuditor
       instances_without_tag = filter_instance_without_tags(instances)
       instance_hash = instance_count_hash(instances_without_tag)
       ris = instance_count_hash(get_reserved_instances)
+      
       instance_hash.keys.concat(ris.keys).uniq.each do |key|
         instance_count = instance_hash.has_key?(key) ? instance_hash[key] : 0
         ris_count = ris.has_key?(key) ? ris[key] : 0
         differences[key] = ris_count - instance_count
       end
+      
       add_instances_with_tag_to_hash(instances_with_tag, differences)
       differences
     end
 
+    # this gets all retired reserved instances and filters out only the ones that have expired
+    # within the past week
+    def get_recent_retired_reserved_instances
+      get_retired_reserved_instances.select do |ri|
+        ri.expiration_date > (Time.now - 604800)
+      end
+    end
+
     # assuming the value of the tag is in the form: 01/01/2000 like a date
     def filter_instances_with_tags(instances)
       instances.select do |instance|

data/lib/sport_ngin_aws_auditor/rds_instance.rb

@@ -7,7 +7,7 @@ module SportNginAwsAuditor
     extend AWSWrapper
 
     class << self
-      attr_accessor :instances, :reserved_instances
+      attr_accessor :instances, :reserved_instances, :retired_reserved_instances
 
       def get_instances(tag_name=nil)
         return @instances if @instances
@@ -25,9 +25,17 @@ module SportNginAwsAuditor
           new(instance)
         end.compact
       end
+
+      def get_retired_reserved_instances
+        return @retired_reserved_instances if @retired_reserved_instances
+        @retired_reserved_instances = rds.describe_reserved_db_instances.reserved_db_instances.map do |instance|
+          next unless instance.state == 'retired'
+          new(instance)
+        end.compact
+      end
     end
 
-    attr_accessor :id, :name, :multi_az, :instance_type, :engine, :count, :tag_value
+    attr_accessor :id, :name, :multi_az, :instance_type, :engine, :count, :tag_value, :expiration_date
     def initialize(rds_instance, account_id=nil, tag_name=nil, rds=nil)
       if rds_instance.class.to_s == "Aws::RDS::Types::ReservedDBInstance"
         self.id = rds_instance.reserved_db_instances_offering_id
@@ -35,6 +43,7 @@ module SportNginAwsAuditor
         self.instance_type = rds_instance.db_instance_class
         self.engine = engine_helper(rds_instance.product_description)
         self.count = rds_instance.db_instance_count
+        self.expiration_date = rds_instance.start_time + rds_instance.duration if rds_instance.state == 'retired'
       elsif rds_instance.class.to_s == "Aws::RDS::Types::DBInstance"
         self.id = rds_instance.db_instance_identifier
         self.multi_az = rds_instance.multi_az ? "Multi-AZ" : "Single-AZ"

data/lib/sport_ngin_aws_auditor/scripts/audit.rb

@@ -23,20 +23,22 @@ module SportNginAwsAuditor
           tag_name = options[:tag]
         end
 
+        cycle = [["EC2Instance", options[:ec2]],
+                 ["RDSInstance", options[:rds]],
+                 ["CacheInstance", options[:cache]]]
+
         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
 
-        data = gather_data("EC2Instance", tag_name) if options[:ec2] || no_selection
-        print_data(slack, environment, data, "EC2Instance") if options[:ec2] || no_selection
-
-        data = gather_data("RDSInstance", tag_name) if options[:rds] || no_selection
-        print_data(slack, environment, data, "RDSInstance") if options[:rds] || no_selection
-
-        data = gather_data("CacheInstance", tag_name) if options[:cache] || no_selection
-        print_data(slack, environment, data, "CacheInstance") if options[:cache] || no_selection
+        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)
+        end
       end
 
       def self.gather_data(class_type, tag_name)
@@ -52,26 +54,32 @@ module SportNginAwsAuditor
           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
+
+        [compared_array, retired_reserved_instances]
       end
 
-      def self.print_data(slack, environment, data, class_type)
+      def self.print_data(slack, environment, data, retired_reserved_instances, class_type)
         data.sort_by! { |instance| [instance.type, instance.name] }
 
         if slack
-          print_to_slack(data, class_type, environment)
+          print_to_slack(data, retired_reserved_instances, class_type, environment)
         elsif options[:reserved] || options[:instances]
           puts header(class_type)
           data.each{ |instance| say "<%= color('#{instance.name}: #{instance.count}', :white) %>" }
         else
           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
         end
       end
 
@@ -82,8 +90,9 @@ module SportNginAwsAuditor
         say "<%= color('#{name}: #{count}', :#{color}) %>"
       end
 
-      def self.print_to_slack(instances_array, class_type, environment)
+      def self.print_to_slack(instances_array, retired_instances_array, class_type, environment)
         discrepancy_array = []
+
         instances_array.each do |instance|
           unless instance.matched?
             discrepancy_array.push(instance)
@@ -93,22 +102,36 @@ module SportNginAwsAuditor
         true_discrepancies = discrepancy_array.reject{ |instance| instance.tagged? }
 
         unless true_discrepancies.empty?
-          print_discrepancies(discrepancy_array, class_type, environment)
+          print_discrepancies(discrepancy_array, retired_instances_array, class_type, environment)
         end
       end
 
-      def self.print_discrepancies(discrepancy_array, class_type, environment)
+      def self.print_discrepancies(discrepancy_array, retired_instances_array, class_type, environment)
         title = "Some #{class_type} discrepancies for #{environment} exist:\n"
-        slack_job = NotifySlack.new(title)
+        slack_instances = NotifySlack.new(title)
 
         discrepancy_array.each do |discrepancy|
           name = discrepancy.name
           count = discrepancy.count
           color, rgb = color_chooser(discrepancy)
-          slack_job.attachments.push({"color" => rgb, "text" => "#{name}: #{count}", "mrkdwn_in" => ["text"]})
+          slack_instances.attachments.push({"color" => rgb, "text" => "#{name}: #{count}", "mrkdwn_in" => ["text"]})
         end
 
-        slack_job.perform
+        slack_instances.perform
+
+        unless retired_instances_array.empty?
+          message = "The following reserved #{class_type} have recently expired in #{environment}:\n"
+
+          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
+          
+          slack_retired_instances = NotifySlack.new(message)
+          slack_retired_instances.perform
+        end
       end
 
       def self.color_chooser(instance)

data/lib/sport_ngin_aws_auditor/version.rb

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

data/spec/sport_ngin_aws_auditor/cache_instance_spec.rb

@@ -99,6 +99,54 @@ module SportNginAwsAuditor
         expect(reserved_instance.instance_type).to eq("cache.t2.small")
         expect(reserved_instance.engine).to eq("redis")
       end
+
+      context "for retired_reserved_cache_instances" do
+        before :each do
+          @time = Time.now
+          retired_reserved_cache_instance1 = double('reserved_cache_instance', reserved_cache_node_id: "job-queue-cluster",
+                                                                               cache_node_type: "cache.t2.small",
+                                                                               product_description: "redis",
+                                                                               state: "retired",
+                                                                               cache_node_count: 1,
+                                                                               class: "Aws::ElastiCache::Types::ReservedCacheNode",
+                                                                               start_time: @time - 31536000,
+                                                                               duration: 31536000)
+          retired_reserved_cache_instance2 = double('reserved_cache_instance', reserved_cache_node_id: "job-queue-cluster",
+                                                                               cache_node_type: "cache.t2.medium",
+                                                                               product_description: "mysql",
+                                                                               state: "retired",
+                                                                               cache_node_count: 1,
+                                                                               class: "Aws::ElastiCache::Types::ReservedCacheNode",
+                                                                               start_time: @time - 31536000,
+                                                                               duration: 31536000)
+          reserved_cache_nodes = double('cache_cluster', reserved_cache_nodes: [retired_reserved_cache_instance1,
+                                                                                retired_reserved_cache_instance2])
+          cache_client = double('cache_client', describe_reserved_cache_nodes: reserved_cache_nodes)
+          allow(CacheInstance).to receive(:cache).and_return(cache_client)
+        end
+
+        it "should make a retired_reserved_cache_instance for each instance" do
+          retired_reserved_instances = CacheInstance.get_retired_reserved_instances
+          expect(retired_reserved_instances.first).to be_an_instance_of(CacheInstance)
+          expect(retired_reserved_instances.last).to be_an_instance_of(CacheInstance)
+        end
+
+        it "should return an array of retired_reserved_cache_instances" do
+          retired_reserved_instances = CacheInstance.get_retired_reserved_instances
+          expect(retired_reserved_instances).not_to be_empty
+          expect(retired_reserved_instances.length).to eq(2)
+        end
+
+        it "should have proper variables set" do
+          retired_reserved_instances = CacheInstance.get_retired_reserved_instances
+          retired_reserved_instance = retired_reserved_instances.first
+          expect(retired_reserved_instance.id).to eq("job-queue-cluster")
+          expect(retired_reserved_instance.name).to eq("job-queue-cluster")
+          expect(retired_reserved_instance.instance_type).to eq("cache.t2.small")
+          expect(retired_reserved_instance.engine).to eq("redis")
+          expect(retired_reserved_instance.expiration_date).to be >= @time - 31536000
+        end
+      end
     end
 
     context "for returning pretty string formats" do

data/spec/sport_ngin_aws_auditor/ec2_instance_spec.rb

@@ -122,6 +122,71 @@ module SportNginAwsAuditor
         expect(reserved_instance1.platform).to eq("Windows VPC")
         expect(reserved_instance2.platform).to eq("Linux VPC")
       end
+
+      context "for retired_reserved_ec2_instances" do
+        before :each do
+          @time = Time.now
+          retired_reserved_ec2_instance1 = double('reserved_ec2_instance', reserved_instances_id: "12345-dfas-1234-asdf-thisisfake!!",
+                                                                           instance_type: "t2.medium",
+                                                                           product_description: "Windows (Amazon VPC)",
+                                                                           state: "retired",
+                                                                           availability_zone: "us-east-1b",
+                                                                           instance_count: 4,
+                                                                           class: "Aws::EC2::Types::ReservedInstances",
+                                                                           end: @time - 86400)
+          retired_reserved_ec2_instance2 = double('reserved_ec2_instance', reserved_instances_id: "12345-dfas-1234-asdf-thisisalsofake",
+                                                                           instance_type: "t2.small",
+                                                                           product_description: "Linux/UNIX (Amazon VPC)",
+                                                                           state: "retired",
+                                                                           availability_zone: "us-east-1b",
+                                                                           instance_count: 2,
+                                                                           class: "Aws::EC2::Types::ReservedInstances",
+                                                                           end: @time - 86400)
+          reserved_ec2_instance1 = double('reserved_ec2_instance', reserved_instances_id: "12345-dfas-1234-asdf-thisisalsofake",
+                                                                   instance_type: "t2.small",
+                                                                   product_description: "Linux/UNIX (Amazon VPC)",
+                                                                   state: "active",
+                                                                   availability_zone: "us-east-1b",
+                                                                   instance_count: 2,
+                                                                   class: "Aws::EC2::Types::ReservedInstances")
+          reserved_ec2_instances = double('reserved_ec2_instances', reserved_instances: [retired_reserved_ec2_instance1,
+                                                                                         retired_reserved_ec2_instance2,
+                                                                                         reserved_ec2_instance1])
+          ec2_client = double('ec2_client', describe_reserved_instances: reserved_ec2_instances)
+          allow(EC2Instance).to receive(:ec2).and_return(ec2_client)
+        end
+
+        it "should make a retired_reserved_ec2_instance for each instance" do
+          retired_reserved_instances = EC2Instance.get_retired_reserved_instances
+          expect(retired_reserved_instances.first).to be_an_instance_of(EC2Instance)
+          expect(retired_reserved_instances.last).to be_an_instance_of(EC2Instance)
+        end
+
+        it "should return an array of retired_reserved_ec2_instances" do
+          retired_reserved_instances = EC2Instance.get_retired_reserved_instances
+          expect(retired_reserved_instances).not_to be_empty
+          expect(retired_reserved_instances.length).to eq(2)
+        end
+
+        it "should have proper variables set" do
+          retired_reserved_instances = EC2Instance.get_retired_reserved_instances
+          retired_reserved_instance = retired_reserved_instances.first
+          expect(retired_reserved_instance.id).to eq("12345-dfas-1234-asdf-thisisfake!!")
+          expect(retired_reserved_instance.platform).to eq("Windows VPC")
+          expect(retired_reserved_instance.availability_zone).to eq("us-east-1b")
+          expect(retired_reserved_instance.instance_type).to eq("t2.medium")
+          expect(retired_reserved_instance.count).to eq(4)
+          expect(retired_reserved_instance.expiration_date).to be >= @time - 86500
+        end
+
+        it "should recognize Windows vs. Linux" do
+          retired_reserved_instances = EC2Instance.get_retired_reserved_instances
+          retired_reserved_instance1 = retired_reserved_instances.first
+          retired_reserved_instance2 = retired_reserved_instances.last
+          expect(retired_reserved_instance1.platform).to eq("Windows VPC")
+          expect(retired_reserved_instance2.platform).to eq("Linux VPC")
+        end
+      end
     end
 
     context "for returning pretty string formats" do

data/spec/sport_ngin_aws_auditor/rds_instance_spec.rb

@@ -101,6 +101,56 @@ module SportNginAwsAuditor
         expect(reserved_instance.instance_type).to eq("db.t2.small")
         expect(reserved_instance.engine).to eq("Oracle SE Two")
       end
+
+      context "for retired_reserved_rds_instances" do
+        before :each do
+          @time = Time.now
+          retired_reserved_rds_instance1 = double('reserved_rds_instance', reserved_db_instances_offering_id: "555te4yy-1234-555c-5678-thisisafake!!",
+                                                                           multi_az: false,
+                                                                           db_instance_class: "db.t2.small",
+                                                                           state: "retired",
+                                                                           product_description: "oracle-se2 (byol)",
+                                                                           db_instance_count: 1,
+                                                                           class: "Aws::RDS::Types::ReservedDBInstance",
+                                                                           start_time: @time - 31536000,
+                                                                           duration: 31536000)
+          retired_reserved_rds_instance2 = double('reserved_rds_instance', reserved_db_instances_offering_id: "555te4yy-1234-555c-5678-thisisafake!!",
+                                                                           multi_az: false,
+                                                                           db_instance_class: "db.m3.large",
+                                                                           state: "retired",
+                                                                           product_description: "postgresql",
+                                                                           db_instance_count: 2,
+                                                                           class: "Aws::RDS::Types::ReservedDBInstance",
+                                                                           start_time: @time - 31536000,
+                                                                           duration: 31536000)
+        reserved_db_instances = double('db_instances', reserved_db_instances: [retired_reserved_rds_instance1,
+                                                                               retired_reserved_rds_instance2])
+        rds_client = double('rds_client', describe_reserved_db_instances: reserved_db_instances)
+        allow(RDSInstance).to receive(:rds).and_return(rds_client)
+        end
+
+        it "should make a retired_reserved_rds_instance for each instance" do
+          retired_reserved_instances = RDSInstance.get_retired_reserved_instances
+          expect(retired_reserved_instances.first).to be_an_instance_of(RDSInstance)
+          expect(retired_reserved_instances.last).to be_an_instance_of(RDSInstance)
+        end
+
+        it "should return an array of retired_reserved_rds_instances" do
+          retired_reserved_instances = RDSInstance.get_retired_reserved_instances
+          expect(retired_reserved_instances).not_to be_empty
+          expect(retired_reserved_instances.length).to eq(2)
+        end
+
+        it "should have proper variables set" do
+          retired_reserved_instances = RDSInstance.get_retired_reserved_instances
+          retired_reserved_instance = retired_reserved_instances.first
+          expect(retired_reserved_instance.id).to eq("555te4yy-1234-555c-5678-thisisafake!!")
+          expect(retired_reserved_instance.multi_az).to eq("Single-AZ")
+          expect(retired_reserved_instance.instance_type).to eq("db.t2.small")
+          expect(retired_reserved_instance.engine).to eq("Oracle SE Two")
+          expect(retired_reserved_instance.expiration_date).to be >= @time - 31536000
+        end
+      end
     end
 
     context "for returning pretty string formats" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sport_ngin_aws_auditor
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Elliot Hursh
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-25 00:00:00.000000000 Z
+date: 2016-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk