Added the posting of matching results to DAO

updated interface, implementation and tests

Author: Johannes Duesing

src/main/scala/de/upb/cs/swt/delphi/instanceregistry/daos/DynamicInstanceDAO.scala

@@ -23,6 +23,7 @@ import scala.io.Source
 class DynamicInstanceDAO (configuration : Configuration) extends InstanceDAO with AppLogging with JsonSupport {
 
   private val instances : mutable.Set[Instance] = new mutable.HashSet[Instance]()
+  private val instanceMatchingResults : mutable.Map[Long, mutable.MutableList[Boolean]] = new mutable.HashMap[Long,mutable.MutableList[Boolean]]()
 
   implicit val system : ActorSystem = Server.system
   implicit val materializer : ActorMaterializer = ActorMaterializer()
@@ -39,6 +40,7 @@ class DynamicInstanceDAO (configuration : Configuration) extends InstanceDAO wit
       //Verify id is not already present in instances!
       if(!hasInstance(instance.id.get)){
         instances.add(instance)
+        instanceMatchingResults.put(instance.id.get, mutable.MutableList())
         dumpToRecoveryFile()
         Success(log.info(s"Added instance ${instance.name} with id ${instance.id} to database."))
       } else {
@@ -59,6 +61,7 @@ class DynamicInstanceDAO (configuration : Configuration) extends InstanceDAO wit
     if(hasInstance(id)){
       //AddInstance verifies that id is always present, hasInstance verifies that find will return an instance
       instances.remove(instances.find(i => i.id.get == id).get)
+      instanceMatchingResults.remove(id)
       dumpToRecoveryFile()
       Success(log.info(s"Successfully removed instance with id $id."))
     } else {
@@ -88,11 +91,38 @@ class DynamicInstanceDAO (configuration : Configuration) extends InstanceDAO wit
 
   override def removeAll() : Unit = {
     instances.clear()
+    instanceMatchingResults.clear()
     dumpToRecoveryFile()
   }
 
+  override def addMatchingResult(id: Long, matchingSuccessful: Boolean): Try[Unit] = {
+    if(hasInstance(id)){
+      instanceMatchingResults.get(id) match {
+        case Some(resultList) =>
+          resultList += matchingSuccessful
+          Success(log.info(s"Successfully added matching result $matchingSuccessful to instance with id $id."))
+        case None =>
+          log.warning(s"Could not add matching result, list for instance with id $id not present!")
+          Failure(new RuntimeException("No matching result list present"))
+      }
+    } else {
+      log.warning(s"Cannot add matching result, instance with id $id not present.")
+      Failure(new RuntimeException(s"Cannot add matching result, instance with id $id not present."))
+    }
+  }
+
+  override def getMatchingResultsFor(id: Long): Try[List[Boolean]] = {
+    if(hasInstance(id) && instanceMatchingResults.contains(id)){
+      Success(List() ++ instanceMatchingResults(id))
+    } else {
+      log.warning(s"Cannot get matching results, id $id not present!")
+      Failure(new RuntimeException(s"Cannot get matching results, id $id not present!"))
+    }
+  }
+
   private[daos] def clearData() : Unit = {
     instances.clear()
+    instanceMatchingResults.clear()
   }
 
   private[daos] def dumpToRecoveryFile() : Unit = {

src/main/scala/de/upb/cs/swt/delphi/instanceregistry/daos/InstanceDAO.scala

@@ -56,4 +56,18 @@ trait InstanceDAO {
     */
   def removeAll() : Unit
 
+  /**
+    * Add a matching result for the specified instance
+    * @param id Id of the instance to post a result for
+    * @param matchingSuccessful Boolean indicating whether the matching was successful
+    */
+  def addMatchingResult(id: Long, matchingSuccessful : Boolean) : Try[Unit]
+
+  /**
+    * Gets the list of matching results for the instance with the specified id
+    * @param id Id of the instance
+    * @return List of boolean values
+    */
+  def getMatchingResultsFor(id: Long) : Try[List[Boolean]]
+
 }

src/test/scala/de/upb/cs/swt/delphi/instanceregistry/daos/DynamicInstanceDAOTest.scala

@@ -3,7 +3,7 @@ package de.upb.cs.swt.delphi.instanceregistry.daos
 import de.upb.cs.swt.delphi.instanceregistry.Configuration
 import de.upb.cs.swt.delphi.instanceregistry.io.swagger.client.model.Instance
 import de.upb.cs.swt.delphi.instanceregistry.io.swagger.client.model.InstanceEnums.ComponentType
-import org.scalatest.{BeforeAndAfterAll, BeforeAndAfterEach, FlatSpec, Matchers}
+import org.scalatest.{BeforeAndAfterEach, FlatSpec, Matchers}
 
 class DynamicInstanceDAOTest extends FlatSpec with Matchers with BeforeAndAfterEach{
 
@@ -81,6 +81,29 @@ class DynamicInstanceDAOTest extends FlatSpec with Matchers with BeforeAndAfterE
     assert(dao.getAllInstances().isEmpty)
   }
 
+  it must "have an empty list of matching results for newly added instances" in {
+    dao.addInstance(buildInstance(4))
+    assert(dao.getMatchingResultsFor(4).isSuccess)
+    assert(dao.getMatchingResultsFor(4).get.isEmpty)
+  }
+
+  it must "keep the correct order of matching results posted" in {
+    assert(dao.addMatchingResult(3, matchingSuccessful = true).isSuccess)
+    assert(dao.addMatchingResult(3, matchingSuccessful = true).isSuccess)
+    assert(dao.addMatchingResult(3, matchingSuccessful = false).isSuccess)
+
+    assert(dao.getMatchingResultsFor(3).isSuccess)
+    assert(dao.getMatchingResultsFor(3).get.head)
+    assert(dao.getMatchingResultsFor(3).get (1))
+    assert(!dao.getMatchingResultsFor(3).get (2))
+
+  }
+
+  it must "remove the matching results when the instance is removed" in {
+    assert(dao.removeInstance(3).isSuccess)
+    assert(dao.getMatchingResultsFor(3).isFailure)
+  }
+
   "The DAO" must "be able to read multiple instances from the recovery file" in {
     dao.dumpToRecoveryFile()
     dao.clearData()
@@ -113,6 +136,8 @@ class DynamicInstanceDAOTest extends FlatSpec with Matchers with BeforeAndAfterE
   }
 
 
+
+
   override protected def afterEach() : Unit = {
     dao.removeAll()
     dao.deleteRecoveryFile()