Implemented missing RequestHandlerTest. Fixed some code style issues. Ignored recovery file.

Author: Johannes Duesing

.gitignore

@@ -3,3 +3,4 @@
 .idea
 project/target/
 target/
+dump.temp

src/main/scala/de/upb/cs/swt/delphi/instanceregistry/RequestHandler.scala

@@ -1,5 +1,6 @@
 package de.upb.cs.swt.delphi.instanceregistry
 
+import akka.actor.ActorSystem
 import de.upb.cs.swt.delphi.instanceregistry.daos.{DynamicInstanceDAO, InstanceDAO}
 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
@@ -8,15 +9,17 @@ import scala.util.{Failure, Success, Try}
 
 class RequestHandler (configuration: Configuration) extends AppLogging {
 
-  implicit val system = Registry.system
+  implicit val system : ActorSystem = Registry.system
 
   private val instanceDao : InstanceDAO = new DynamicInstanceDAO(configuration)
 
   def initialize() : Unit = {
     log.info("Initializing request handler...")
     instanceDao.initialize()
-    //Add default ES instance
-    registerNewInstance(Instance(None, "elasticsearch://localhost", 9200, "Default ElasticSearch Instance", ComponentType.ElasticSearch))
+    if(!instanceDao.allInstances().exists(instance => instance.name.equals("Default ElasticSearch Instance"))){
+      //Add default ES instance
+      registerNewInstance(Instance(None, "elasticsearch://localhost", 9200, "Default ElasticSearch Instance", ComponentType.ElasticSearch))
+    }
     log.info("Done initializing request handler.")
   }
 
@@ -25,10 +28,10 @@ class RequestHandler (configuration: Configuration) extends AppLogging {
   }
 
   def registerNewInstance(instance : Instance) : Try[Long] = {
-    val newID = if(instanceDao.getAllInstances().isEmpty){
+    val newID = if(instanceDao.allInstances().isEmpty){
       0L
     } else {
-      (instanceDao.getAllInstances().map(i => i.id.getOrElse(0L)) max) + 1L
+      (instanceDao.allInstances().map(i => i.id.getOrElse(0L)) max) + 1L
     }
 
     log.info(s"Assigned new id $newID to registering instance with name ${instance.name}.")
@@ -55,7 +58,7 @@ class RequestHandler (configuration: Configuration) extends AppLogging {
   }
 
   def getNumberOfInstances(compType : ComponentType) : Int = {
-    instanceDao.getAllInstances().count(i => i.componentType == compType)
+    instanceDao.allInstances().count(i => i.componentType == compType)
   }
 
   def getMatchingInstanceOfType(compType : ComponentType ) : Try[Instance] = {

src/main/scala/de/upb/cs/swt/delphi/instanceregistry/Server.scala

@@ -31,7 +31,7 @@ object Server extends HttpApp with JsonSupport with AppLogging {
       path("deregister") { deleteInstance() } ~
       path("instances" ) { fetchInstancesOfType() } ~
       path("numberOfInstances" ) { numberOfInstances() } ~
-      path("matchingInstance" ) { getMatchingInstance()} ~
+      path("matchingInstance" ) { matchingInstance()} ~
       path("matchingResult" ) {matchInstance()}
 
 
@@ -99,7 +99,7 @@ object Server extends HttpApp with JsonSupport with AppLogging {
     }
   }
 
-  def getMatchingInstance() : server.Route = parameters('ComponentType.as[String]){ compTypeString =>
+  def matchingInstance() : server.Route = parameters('ComponentType.as[String]){ compTypeString =>
     get{
       log.debug(s"GET /matchingInstance?ComponentType=$compTypeString has been called")
 

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

@@ -4,15 +4,14 @@ import java.io.{File, IOException, PrintWriter}
 
 import akka.actor.ActorSystem
 import akka.stream.ActorMaterializer
-import de.upb.cs.swt.delphi.instanceregistry.{AppLogging, Configuration, Registry, Server}
+import de.upb.cs.swt.delphi.instanceregistry.{AppLogging, Configuration, Registry}
 import de.upb.cs.swt.delphi.instanceregistry.io.swagger.client.model.{Instance, JsonSupport}
 import de.upb.cs.swt.delphi.instanceregistry.io.swagger.client.model.InstanceEnums.ComponentType
 
 import scala.collection.mutable
 import scala.concurrent.ExecutionContext
 import scala.util.{Failure, Success, Try}
 import spray.json._
-import spray.json.DefaultJsonProtocol._
 
 import scala.io.Source
 
@@ -85,7 +84,7 @@ class DynamicInstanceDAO (configuration : Configuration) extends InstanceDAO wit
     List() ++ instances filter {i => i.componentType == componentType}
   }
 
-  override def getAllInstances(): List[Instance] = {
+  override def allInstances(): List[Instance] = {
     List() ++ instances
   }
 
@@ -141,7 +140,7 @@ class DynamicInstanceDAO (configuration : Configuration) extends InstanceDAO wit
   private[daos] def dumpToRecoveryFile() : Unit = {
     log.debug(s"Dumping data to recovery file ${configuration.recoveryFileName} ...")
     val writer = new PrintWriter(new File(configuration.recoveryFileName))
-    writer.write(getAllInstances().toJson(listFormat(instanceFormat)).toString())
+    writer.write(allInstances().toJson(listFormat(instanceFormat)).toString())
     writer.flush()
     writer.close()
     log.debug(s"Successfully wrote to recovery file.")

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

@@ -49,7 +49,7 @@ trait InstanceDAO {
     * Retrieves all instances from the DAO
     * @return A list of all instances in the DAO
     */
-  def getAllInstances() : List[Instance]
+  def allInstances() : List[Instance]
 
   /**
     * Removes all instances from the DAO

src/test/scala/de/upb/cs/swt/delphi/instanceregistry/RequestHandlerTest.scala

@@ -1,17 +1,93 @@
 package de.upb.cs.swt.delphi.instanceregistry
 
-import org.scalatest.{BeforeAndAfterEach, FlatSpec, Matchers}
+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}
 
-class RequestHandlerTest extends FlatSpec with Matchers with BeforeAndAfterEach{
+class RequestHandlerTest extends FlatSpec with Matchers with BeforeAndAfterEach with BeforeAndAfterAll{
 
   val handler : RequestHandler = new RequestHandler(new Configuration())
 
+  private def buildInstance(id : Long) : Instance = {
+    Instance(Some(id), "https://localhost", 12345, "TestInstance", ComponentType.ElasticSearch)
+  }
+
+  override protected def beforeAll():Unit = {
+    //Delete recovery file for sure
+    handler.shutdown()
+  }
+
   override protected def beforeEach(): Unit = {
+    handler.initialize()
+  }
+
+  "The RequestHandler" must "assign new IDs to instances regardless of their actual id" in {
+    val registerNewInstance = handler.registerNewInstance(buildInstance(Long.MaxValue))
+    assert(registerNewInstance.isSuccess)
+    assert(registerNewInstance.get != Long.MaxValue)
 
+    val registerNewInstance2 = handler.registerNewInstance(buildInstance(1L))
+    assert(registerNewInstance2.isSuccess)
+    assert(registerNewInstance2.get != 1L)
   }
 
-  override protected def afterEach(): Unit = {
+  it must "be able to remove instances that have been added before" in {
+    val registerNewInstance = handler.registerNewInstance(buildInstance(-1L))
+    assert(registerNewInstance.isSuccess)
+    assert(registerNewInstance.get == 1)
+    assert(handler.removeInstance(1).isSuccess)
+  }
+
+  it must "not add two default ES instances on initializing" in {
+    assert(handler.getNumberOfInstances(ComponentType.ElasticSearch) == 1)
+    handler.initialize()
+    assert(handler.getNumberOfInstances(ComponentType.ElasticSearch) == 1)
+  }
+
+  it must "match to instance with most consecutive positive matching results" in {
+    val esInstance = handler.registerNewInstance(buildInstance(2))
+    assert(esInstance.isSuccess)
+    assert(esInstance.get == 1)
+
+    assert(handler.applyMatchingResult(0, result = false).isSuccess)
+    assert(handler.applyMatchingResult(0, result = true).isSuccess)
+    assert(handler.applyMatchingResult(0,result = true).isSuccess)
+
+    assert(handler.applyMatchingResult(1,result = true).isSuccess)
+    assert(handler.applyMatchingResult(1,result = false).isSuccess)
 
+    val matchingInstance = handler.getMatchingInstanceOfType(ComponentType.ElasticSearch)
+    assert(matchingInstance.isSuccess)
+    assert(matchingInstance.get.id.get == 0)
+
+    assert(handler.removeInstance(1L).isSuccess)
+  }
+
+  it must "match to instance with most positive matching results" in {
+    val esInstance = handler.registerNewInstance(buildInstance(2))
+    assert(esInstance.isSuccess)
+    assert(esInstance.get == 1)
+
+    assert(handler.applyMatchingResult(0, result = true).isSuccess)
+    assert(handler.applyMatchingResult(0,result = true).isSuccess)
+    assert(handler.applyMatchingResult(0, result = false).isSuccess)
+
+    assert(handler.applyMatchingResult(1,result = false).isSuccess)
+    assert(handler.applyMatchingResult(1,result = false).isSuccess)
+
+    val matchingInstance = handler.getMatchingInstanceOfType(ComponentType.ElasticSearch)
+    assert(matchingInstance.isSuccess)
+    assert(matchingInstance.get.id.get == 0)
+
+    assert(handler.removeInstance(1L).isSuccess)
+  }
+
+  it must "fail to match if no instance of type is present" in {
+    assert(handler.getMatchingInstanceOfType(ComponentType.Crawler).isFailure)
+  }
+
+  override protected def afterEach(): Unit = {
+    handler.shutdown()
   }
 
 }

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

@@ -22,14 +22,14 @@ class DynamicInstanceDAOTest extends FlatSpec with Matchers with BeforeAndAfterE
 
   "The instance DAO" must "be able to add an get an instance with a new id" in {
     assert(dao.addInstance(buildInstance(4)).isSuccess)
-    assert(dao.getAllInstances().size == 4)
+    assert(dao.allInstances().size == 4)
     assert(dao.hasInstance(4))
     assert(dao.removeInstance(4).isSuccess)
   }
 
   it must "not allow the addition of any id twice" in {
     assert(dao.addInstance(buildInstance(3)).isFailure)
-    assert(dao.getAllInstances().size == 3)
+    assert(dao.allInstances().size == 3)
   }
 
   it must "return true on hasInstance for any present id" in {
@@ -67,7 +67,7 @@ class DynamicInstanceDAOTest extends FlatSpec with Matchers with BeforeAndAfterE
       assert(dao.removeInstance(i).isSuccess)
       assert(!dao.hasInstance(i))
     }
-    assert(dao.getAllInstances().isEmpty)
+    assert(dao.allInstances().isEmpty)
   }
 
   it must "not change the data on removing invalid IDs" in {
@@ -78,7 +78,7 @@ class DynamicInstanceDAOTest extends FlatSpec with Matchers with BeforeAndAfterE
 
   it must "remove all instance on removeAll" in {
     dao.removeAll()
-    assert(dao.getAllInstances().isEmpty)
+    assert(dao.allInstances().isEmpty)
   }
 
   it must "have an empty list of matching results for newly added instances" in {
@@ -107,29 +107,29 @@ class DynamicInstanceDAOTest extends FlatSpec with Matchers with BeforeAndAfterE
   "The DAO" must "be able to read multiple instances from the recovery file" in {
     dao.dumpToRecoveryFile()
     dao.clearData()
-    assert(dao.getAllInstances().isEmpty)
+    assert(dao.allInstances().isEmpty)
     dao.tryInitFromRecoveryFile()
-    assert(dao.getAllInstances().size == 3)
+    assert(dao.allInstances().size == 3)
   }
 
   it must "fail to load from recovery file if it is not present" in {
     dao.dumpToRecoveryFile()
-    assert(dao.getAllInstances().size == 3)
+    assert(dao.allInstances().size == 3)
     dao.deleteRecoveryFile()
     dao.clearData()
-    assert(dao.getAllInstances().isEmpty)
+    assert(dao.allInstances().isEmpty)
     dao.tryInitFromRecoveryFile()
-    assert(dao.getAllInstances().isEmpty)
+    assert(dao.allInstances().isEmpty)
   }
 
   it must "contain the correct instance data after loading from recovery file" in {
     assert(dao.addInstance(buildInstance(4)).isSuccess)
     dao.dumpToRecoveryFile()
-    assert(dao.getAllInstances().size == 4)
+    assert(dao.allInstances().size == 4)
     dao.clearData()
-    assert(dao.getAllInstances().isEmpty)
+    assert(dao.allInstances().isEmpty)
     dao.tryInitFromRecoveryFile()
-    assert(dao.getAllInstances().size == 4)
+    assert(dao.allInstances().size == 4)
     val instance = dao.getInstance(4)
     assert(instance.isDefined)
     assert(instance.get.id.get == 4)