Merge pull request #89 from delphi-hub/feature/modelService

Feature/model service

Author: janniclas

app/controllers/ApiRouter.scala

@@ -36,6 +36,7 @@ class ApiRouter @Inject()(irController: InstanceRegistryController, sysControlle
     case GET(p"/numberOfInstances" ? q"componentType=$componentType") => irController.numberOfInstances(componentType)
     case GET(p"/instances" ? q"componentType=$componentType") => irController.instances(componentType)
     case GET(p"/systemInfo") => sysController.getInfo()
+    case GET(p"/network") => irController.getNetwork()
     case POST(p"/postInstance" ? q"componentType=$componentType"& q"name=$name") => irController.postInstance(componentType, name)
     case POST(p"/startInstance" ? q"instanceID=$instanceID") => irController.handleRequest(action="/start", instanceID)
     case POST(p"/stopInstance" ? q"instanceID=$instanceID") => irController.handleRequest(action="/stop", instanceID)

app/controllers/InstanceRegistryController.scala

@@ -20,7 +20,7 @@ package controllers
 
 import akka.actor.{ActorRef, ActorSystem}
 import javax.inject.Inject
-import play.api.Configuration
+import play.api.{Configuration, Logger}
 import play.api.libs.concurrent.CustomExecutionContext
 import play.api.libs.json._
 import play.api.libs.ws.WSClient
@@ -80,6 +80,17 @@ class InstanceRegistryController @Inject()(implicit system: ActorSystem, mat: Ma
     }
   }
 
+  def getNetwork(): Action[AnyContent] = Action.async {
+    ws.url(instanceRegistryUri + "/network").get().map { response =>
+      // TODO: possible handling of parsing the data can be done here
+      Logger.debug(response.body)
+      if (response.status == 200) {
+        Ok(response.body)
+      } else {
+        new Status(response.status)
+      }
+    }(myExecutionContext)
+  }
 
   def numberOfInstances(componentType: String) : Action[AnyContent] = Action.async {
     // TODO: handle what should happen if the instance registry is not reachable.

app/models/Event.scala

@@ -1,6 +1,7 @@
 package models
 
 import akka.http.scaladsl.marshallers.sprayjson.SprayJsonSupport
+import akka.http.scaladsl.model.DateTime
 import models.EventEnums.EventType
 import models.InstanceEnums.ComponentType
 import play.api.libs.json.{Reads, Writes}
@@ -80,9 +81,31 @@ trait EventJsonSupport extends SprayJsonSupport with DefaultJsonProtocol with In
     }
 
   }
+  //Custom JSON format for event TimeStamp.
+  implicit val timestampFormat: JsonFormat[DateTime] = new JsonFormat[DateTime] {
+    /**
+    * Custom write method for serialization of DateTime
+    * @param obj DateTime object to serialize
+    * @throws DeserializationException Exception in case of wrong input
+    */
+    override def write(obj: DateTime) = JsString(obj.toIsoDateTimeString())
+    /**
+      * Custom read method for deserialization of DateTime
+      * @param json JsValue that is to be deserialized
+      * @throws DeserializationException Exception when JsValue is in incorrect format
+      */
+    override def read(json: JsValue): DateTime = json match {
+      case JsString(value) =>
+        DateTime.fromIsoDateTimeString(value) match {
+          case Some(date) => date
+          case _ => throw DeserializationException("Failed to parse date time [" + value + "].")
+        }
+      case _ => throw DeserializationException("Failed to parse json string [" + json + "].")
+    }
+  }
 
   //JSON format for RegistryEvents
-  implicit val eventFormat : JsonFormat[RegistryEvent] = jsonFormat2(RegistryEvent)
+  implicit val eventFormat : JsonFormat[RegistryEvent] = jsonFormat3(RegistryEvent)
 
   //JSON format for an NumbersChangedPayload
   implicit val numbersChangedPayloadFormat: JsonFormat[NumbersChangedPayload] = jsonFormat2(NumbersChangedPayload)
@@ -96,18 +119,20 @@ trait EventJsonSupport extends SprayJsonSupport with DefaultJsonProtocol with In
 
   //JSON format for an InstanceLinkPayload
   implicit val instanceLinkPayloadFormat: JsonFormat[InstanceLinkPayload] =
-    jsonFormat1(InstanceLinkPayload)
+    jsonFormat3(InstanceLinkPayload)
 
 }
 
 /**
   * The RegistryEvent used for communicating with the management application
   * @param eventType Type of the event
   * @param payload Payload of the event, depends on the type
+  * @param timestamp TimeStamp of the event
   */
 final case class RegistryEvent (
   eventType: EventType.Value,
-  payload: RegistryEventPayload
+  payload: RegistryEventPayload,
+  timestamp: DateTime
 )
 
 /**
@@ -119,59 +144,59 @@ object RegistryEventFactory {
     * Creates a new NumbersChangedEvent. Sets EventType and payload accordingly.
     * @param componentType ComponentType which's numbers have been updated
     * @param newNumber New number of components of the specified type
-    * @return RegistryEvent with the respective type and payload.
+    * @return RegistryEvent with the respective respective type, payload and current timestamp.
     */
   def createNumbersChangedEvent(componentType: ComponentType, newNumber: Int) : RegistryEvent =
-    RegistryEvent(EventType.NumbersChangedEvent, NumbersChangedPayload(componentType, newNumber))
+    RegistryEvent(EventType.NumbersChangedEvent, NumbersChangedPayload(componentType, newNumber), DateTime.now)
 
   /**
     * Creates a new InstanceAddedEvent. Sets EventType and payload accordingly.
     * @param instance Instance that has been added.
-    * @return RegistryEvent with the respective type and payload.
+    * @return RegistryEvent with the respective type, payload and current timestamp.
     */
   def createInstanceAddedEvent(instance: Instance) : RegistryEvent =
-    RegistryEvent(EventType.InstanceAddedEvent, InstancePayload(instance))
+    RegistryEvent(EventType.InstanceAddedEvent, InstancePayload(instance), DateTime.now)
 
   /**
     * Creates a new InstanceRemovedEvent. Sets EventType and payload accordingly.
     * @param instance Instance that has been removed.
-    * @return RegistryEvent with the respective type and payload.
+    * @return RegistryEvent with the respective type, payload and current timestamp.
     */
   def createInstanceRemovedEvent(instance: Instance) : RegistryEvent =
-    RegistryEvent(EventType.InstanceRemovedEvent, InstancePayload(instance))
+    RegistryEvent(EventType.InstanceRemovedEvent, InstancePayload(instance), DateTime.now)
 
   /**
     * Creates a new StateChangedEvent. Sets EventType and payload accordingly.
     * @param instance Instance which's state was changed.
-    * @return RegistryEvent with tht respective type and payload.
+    * @return RegistryEvent with tht respective type, payload and current timestamp.
     */
   def createStateChangedEvent(instance: Instance) : RegistryEvent =
-    RegistryEvent(EventType.StateChangedEvent, InstancePayload(instance))
+    RegistryEvent(EventType.StateChangedEvent, InstancePayload(instance), DateTime.now)
 
   /**
     * Creates a new DockerOperationErrorEvent. Sets EventType and payload accordingly.
     * @param affectedInstance Option[Instance] containing the instance that may be affected
     * @param message Error message
-    * @return RegistryEvent with the respective type and payload.
+    * @return RegistryEvent with the respective respective type, payload and current timestamp.
     */
   def createDockerOperationErrorEvent(affectedInstance: Option[Instance], message: String) : RegistryEvent =
-    RegistryEvent(EventType.DockerOperationErrorEvent, DockerOperationErrorPayload(affectedInstance, message))
+    RegistryEvent(EventType.DockerOperationErrorEvent, DockerOperationErrorPayload(affectedInstance, message),DateTime.now)
 
   /**
     * Creates a new LinkAddedEvent. Sets EventType and payload accordingly
     * @param link Link that was added
-    * @return RegistryEvent with the respective type and payload
+    * @return RegistryEvent with the respective type, payload and current timestamp.
     */
-  def createLinkAddedEvent(link: InstanceLink) : RegistryEvent =
-    RegistryEvent(EventType.LinkAddedEvent, InstanceLinkPayload(link))
+  def createLinkAddedEvent(link: InstanceLink, instanceFrom: Instance, instanceTo: Instance) : RegistryEvent =
+    RegistryEvent(EventType.LinkAddedEvent, InstanceLinkPayload(link, instanceFrom, instanceTo),DateTime.now)
 
   /**
     * Creates a new LinkStateChangedEvent. Sets EventType and payload accordingly.
     * @param link Link whichs state has been changed
-    * @return RegistryEvent with the respective type and payload
+    * @return RegistryEvent with the respective type, payload and current timestamp.
     */
-  def createLinkStateChangedEvent(link: InstanceLink) : RegistryEvent =
-    RegistryEvent(EventType.LinkStateChangedEvent, InstanceLinkPayload(link))
+  def createLinkStateChangedEvent(link: InstanceLink, instanceFrom: Instance, instanceTo: Instance) : RegistryEvent =
+    RegistryEvent(EventType.LinkStateChangedEvent, InstanceLinkPayload(link, instanceFrom, instanceTo),DateTime.now)
 }
 
 /**
@@ -209,7 +234,8 @@ final case class DockerOperationErrorPayload(affectedInstance: Option[Instance],
   * link that was added / changed.
   * @param link Link that caused the event
   */
-final case class InstanceLinkPayload(link: InstanceLink) extends RegistryEventPayload
+final case class InstanceLinkPayload(link: InstanceLink, instanceFrom: Instance, instanceTo: Instance)
+  extends RegistryEventPayload
 
 
 /**
@@ -235,5 +261,5 @@ object EventEnums {
 
     implicit val EventTypeReads: Reads[EventType] = Reads.enumNameReads(EventType)
     implicit val EventTypeWrites: Writes[EventType] = Writes.enumNameWrites
-  }
+    }
 }

app/models/Instance.scala

@@ -7,7 +7,7 @@ import spray.json.{DefaultJsonProtocol, DeserializationException, JsString, JsVa
 /**
   * Trait defining the implicit JSON formats needed to work with Instances
   */
-trait InstanceJsonSupport extends SprayJsonSupport with DefaultJsonProtocol {
+trait InstanceJsonSupport extends SprayJsonSupport with DefaultJsonProtocol with InstanceLinkJsonSupport {
 
   //Custom JSON format for an ComponentType
   implicit val componentTypeFormat : JsonFormat[ComponentType] = new JsonFormat[ComponentType] {
@@ -69,7 +69,7 @@ trait InstanceJsonSupport extends SprayJsonSupport with DefaultJsonProtocol {
   }
 
   //JSON format for Instances
-  implicit val instanceFormat : JsonFormat[Instance] = jsonFormat8(Instance)
+  implicit val instanceFormat : JsonFormat[Instance] = jsonFormat10(Instance)
 }
 
 /**
@@ -83,15 +83,17 @@ trait InstanceJsonSupport extends SprayJsonSupport with DefaultJsonProtocol {
   * @param instanceState State of the instance
   */
 final case class Instance (
-     id: Option[Long],
-     host: String,
-     portNumber: Long,
-     name: String,
-     componentType: ComponentType,
-     dockerId: Option[String],
-     instanceState: InstanceState,
-     labels: List[String]
-)
+                            id: Option[Long],
+                            host: String,
+                            portNumber: Long,
+                            name: String,
+                            componentType: ComponentType,
+                            dockerId: Option[String],
+                            instanceState: InstanceState,
+                            labels: List[String],
+                            linksTo: List[InstanceLink],
+                            linksFrom: List[InstanceLink]
+                          )
 
 /**
   * Enumerations concerning instances