Add max queue age stats report item

lib/ssh_scan_api/api.rb

@@ -209,6 +209,7 @@ class API < Sinatra::Base
             "ERRORED" => settings.db.error_count,
             "COMPLETED" => settings.db.complete_count,
           },
+          "QUEUED_MAX_AGE" => settings.db.queued_max_age,
           "GRADE_REPORT" => settings.db.grade_report
         }.to_json
       end

lib/ssh_scan_api/database.rb

@@ -37,6 +37,10 @@ def error_count
       @database.error_count
     end
 
+    def queued_max_age
+      @database.queued_max_age
+    end
+
     def complete_count
       @database.complete_count
     end

lib/ssh_scan_api/database/mongo.rb

@@ -30,6 +30,7 @@ def queue_scan(uuid, socket)
           "port" => socket["port"].to_i,
           "status" => "QUEUED",
           "scan" => nil,
+          "queue_time" => Time.now,
           "worker_id" => nil,
         )
       end
@@ -54,6 +55,20 @@ def total_count
         @collection.count
       end
 
+      # The age of the oldest record in QUEUED state, in seconds
+      def queued_max_age
+        max_age = 0
+
+        @collection.find(status: 'QUEUED').each do |item|
+          age = Time.now - item["queue_time"]
+          if age > max_age
+            max_age = age
+          end
+        end
+
+        return max_age
+      end
+
       def run_scan(uuid)
         @collection.find(uuid: uuid).update_one(
           '$set'=> { 'status' => 'RUNNING' }

spec/ssh_scan_api/api_spec.rb

@@ -55,6 +55,14 @@ def app
     }.to_json)
   end
 
+  # it "should generate a stats report" do
+  #   get "/api/v1/stats"
+  #   expect(last_response.status).to eql(200)
+  #   expect(last_response.body["SCAN_STATES"]).not_to be nil
+  #   expect(last_response.body["QUEUED_MAX_AGE"]).not_to be nil
+  #   expect(last_response.body["GRADE_REPORT"]).not_to be nil
+  # end
+
   it "should return string uuid" do
     ip = "192.168.1.1"
     port = 22

spec/ssh_scan_api/database/mongodb_spec.rb

@@ -166,4 +166,33 @@
     doc = docs.first
     expect(doc["uuid"]).to eql(uuid2)
   end
+
+  it "should be able to find the max queue age" do
+    uuid1 = SecureRandom.uuid
+    uuid2 = SecureRandom.uuid
+
+    socket1 = {"target" => "127.0.0.1", "port" => 1337}
+    socket2 = {"target" => "127.0.0.2", "port" => 1337}
+
+    @mongodb.queue_scan(uuid1, socket1)
+    sleep 5
+    @mongodb.queue_scan(uuid2, socket2)
+
+    age = @mongodb.queued_max_age
+
+    expect(age).to be > 5.0
+    expect(age).to be < 6.0
+  end
+
+  it "should return zero when there are no queued scans" do
+    uuid1 = SecureRandom.uuid
+    socket1 = {"target" => "127.0.0.1", "port" => 1337}
+
+    @mongodb.queue_scan(uuid1, socket1)
+    @mongodb.run_scan(uuid1)
+
+    age = @mongodb.queued_max_age
+    expect(age).to eql(0)
+  end
+
 end

spec/ssh_scan_api/database_spec.rb

@@ -22,6 +22,7 @@
     expect(@abstract_database.respond_to?(:next_scan_in_queue)).to be true
     expect(@abstract_database.respond_to?(:find_recent_scans)).to be true
     expect(@abstract_database.respond_to?(:find_scans)).to be true
+    expect(@abstract_database.respond_to?(:queued_max_age)).to be true
   end
 
   it "should defer #run_count calls to the specific DB implementation" do