WIP default message handlers

Author: reinierl

cmd/src/main/scala/chargepoint/docile/test/InteractiveOcppTest.scala

@@ -2,7 +2,7 @@ package chargepoint.docile
 package test
 
 import chargepoint.docile.dsl._
-import com.thenewmotion.ocpp.VersionFamily
+import com.thenewmotion.ocpp.{Version, Version1X, VersionFamily}
 import com.thenewmotion.ocpp.messages.v1x.{CentralSystemReq, CentralSystemReqRes, CentralSystemRes, ChargePointReq, ChargePointReqRes, ChargePointRes}
 import com.thenewmotion.ocpp.messages.v20._
 import com.thenewmotion.ocpp.messages.{ReqRes, Request, Response}
@@ -61,6 +61,7 @@ object InteractiveOcpp1XTest {
 
   trait V1XPromptCommands extends InteractiveOcppTest.PromptCommands[
     VersionFamily.V1X.type,
+    Version1X,
     CentralSystemReq,
     CentralSystemRes,
     CentralSystemReqRes,
@@ -98,6 +99,7 @@ object InteractiveOcpp20Test {
 
   trait V20PromptCommands extends InteractiveOcppTest.PromptCommands[
     VersionFamily.V20.type,
+    Version.V20.type,
     CsmsRequest,
     CsmsResponse,
     CsmsReqRes,
@@ -114,7 +116,7 @@ object InteractiveOcppTest {
 
       new InteractiveOcpp1XTest {
 
-        private def connDat = connectionData
+        private def connDat = connection
 
         implicit val csmsMessageTypes = VersionFamily.V1XCentralSystemMessages
         implicit val csMessageTypes = VersionFamily.V1XChargePointMessages
@@ -139,7 +141,7 @@ object InteractiveOcppTest {
 
       new InteractiveOcpp20Test {
 
-        private def connDat = connectionData
+        private def connDat = connection
 
         implicit val csmsMessageTypes = VersionFamily.V20CsmsMessages
         implicit val csMessageTypes = VersionFamily.V20CsMessages
@@ -162,6 +164,7 @@ object InteractiveOcppTest {
 
   trait PromptCommands[
     VFam <: VersionFamily,
+    VersionBound <: Version,
     OutReq <: Request,
     InRes <: Response,
     OutReqRes[_ <: OutReq, _ <: InRes] <: ReqRes[_, _],
@@ -170,7 +173,7 @@ object InteractiveOcppTest {
     InReqRes[_ <: InReq, _ <: OutRes] <: ReqRes[_, _]
   ] {
 
-    protected def connectionData: OcppConnectionData[VFam, OutReq, InRes, OutReqRes, InReq, OutRes, InReqRes]
+    protected def connectionData: DocileConnection[VFam, VersionBound, OutReq, InRes, OutReqRes, InReq, OutRes, InReqRes]
 
     def q: Unit =
       connectionData.receivedMsgManager.currentQueueContents foreach println

core/src/main/scala/chargepoint/docile/dsl/CoreOps.scala

@@ -13,7 +13,6 @@ import scala.util.{Failure, Success, Try}
 import com.thenewmotion.ocpp.json.api.{OcppError, OcppException}
 import com.thenewmotion.ocpp.messages.{ReqRes, Request, Response}
 import com.typesafe.scalalogging.Logger
-import expectations.{IncomingMessage => GenericIncomingMessage}
 import org.slf4j.LoggerFactory
 
 trait CoreOps[
@@ -26,13 +25,16 @@ trait CoreOps[
   InReqRes[_ <: InReq, _ <: OutRes] <: ReqRes[_, _]
 ] extends OpsLogging with MessageLogging {
 
+  type IncomingMessage =
+    GenericIncomingMessage[OutReq, InRes, OutReqRes, InReq, OutRes, InReqRes]
+  type IncomingMessageProcessor[+T] =
+    GenericIncomingMessageProcessor[OutReq, InRes, OutReqRes, InReq, OutRes, InReqRes, T]
 
   implicit val csmsMessageTypes: CsmsMessageTypesForVersionFamily[VFam, OutReq, InRes, OutReqRes]
   implicit val csMessageTypes:     CsMessageTypesForVersionFamily[VFam, InReq, OutRes, InReqRes]
 
   implicit def executionContext: ExecutionContext
 
-  type IncomingMessage = GenericIncomingMessage[OutReq, InRes, OutReqRes, InReq, OutRes, InReqRes]
   object IncomingMessage {
     def apply(res: InRes): IncomingMessage = GenericIncomingMessage[OutReq, InRes, OutReqRes, InReq, OutRes, InReqRes](res)
     def apply(req: InReq, respond: OutRes => Unit): IncomingMessage = GenericIncomingMessage[OutReq, InRes, OutReqRes, InReq, OutRes, InReqRes](req, respond)
@@ -42,7 +44,7 @@ trait CoreOps[
   val logger = Logger(LoggerFactory.getLogger("script"))
   def say(m: String): Unit = logger.info(m)
 
-  protected def connectionData: OcppConnectionData[VFam, OutReq, InRes, OutReqRes, InReq, OutRes, InReqRes]
+  protected def connectionData: DocileConnection[VFam, _, OutReq, InRes, OutReqRes, InReq, OutRes, InReqRes]
 
   /**
    * Send an OCPP request to the Central System under test.
@@ -79,6 +81,15 @@ trait CoreOps[
     }
   }
 
+  // WIP an operation to add a default handler for a certain subset of incoming messages
+  def handlingIncomingMessages[T](proc: IncomingMessageProcessor[_])(f: => T): T = {
+    connectionData.pushIncomingMessageHandler(proc)
+    val result = f
+    connectionData.popIncomingMessageHandler()
+
+    result
+  }
+
   def awaitIncoming(num: Int)(implicit awaitTimeout: AwaitTimeout): Seq[IncomingMessage] = {
 
     val timeout = awaitTimeout.toDuration

core/src/main/scala/chargepoint/docile/dsl/expectations/IncomingMessage.scala renamed to core/src/main/scala/chargepoint/docile/dsl/GenericIncomingMessage.scala

@@ -1,12 +1,11 @@
-package chargepoint.docile
-package dsl
-package expectations
+package chargepoint.docile.dsl
 
-import scala.language.higherKinds
-import com.thenewmotion.ocpp.messages.{ReqRes, Request, Response}
 import com.thenewmotion.ocpp.json.api.OcppError
+import com.thenewmotion.ocpp.messages.{ReqRes, Request, Response}
+
+import scala.language.higherKinds
 
-sealed trait IncomingMessage[
+sealed trait GenericIncomingMessage[
   OutgoingReqBound <: Request,
   IncomingResBound <: Response,
   OutgoingReqRes[_ <: OutgoingReqBound, _ <: IncomingResBound] <: ReqRes[_, _],
@@ -15,7 +14,7 @@ sealed trait IncomingMessage[
   IncomingReqRes[_ <: IncomingReqBound, _ <: OutgoingResBound] <: ReqRes[_, _]
 ]
 
-object IncomingMessage {
+object GenericIncomingMessage {
   def apply[
     OutReq <: Request,
     InRes <: Response,
@@ -90,7 +89,7 @@ case class IncomingResponse[
   InReqRes[_ <: InReq, _ <: OutRes] <: ReqRes[_, _]
 ](
   res: InRes
-) extends IncomingMessage[
+) extends GenericIncomingMessage[
   OutReq,
   InRes,
   OutReqRes,
@@ -109,7 +108,7 @@ case class IncomingRequest[
 ](
   req: InReq,
   respond: OutRes => Unit
-) extends IncomingMessage[
+) extends GenericIncomingMessage[
   OutReq,
   InRes,
   OutReqRes,
@@ -125,7 +124,7 @@ case class IncomingError[
   InReq <: Request,
   OutRes <: Response,
   InReqRes[_ <: InReq, _ <: OutRes] <: ReqRes[_, _]
-](error: OcppError) extends IncomingMessage[
+](error: OcppError) extends GenericIncomingMessage[
   OutReq,
   InRes,
   OutReqRes,

core/src/main/scala/chargepoint/docile/dsl/GenericIncomingMessageProcessor.scala

@@ -0,0 +1,54 @@
+package chargepoint.docile.dsl
+
+import com.thenewmotion.ocpp.messages.{ReqRes, Request, Response}
+
+import scala.language.higherKinds
+
+/**
+ * A partial function with side effects working on incoming OCPP messages
+ */
+trait GenericIncomingMessageProcessor[
+  OutgoingReqBound <: Request,
+  IncomingResBound <: Response,
+  OutgoingReqRes[_ <: OutgoingReqBound, _ <: IncomingResBound] <: ReqRes[_, _],
+  IncomingReqBound <: Request,
+  OutgoingResBound <: Response,
+  IncomingReqRes[_ <: IncomingReqBound, _ <: OutgoingResBound] <: ReqRes[_, _],
+  +T
+] {
+  type IncomingMessage = GenericIncomingMessage[
+    OutgoingReqBound,
+    IncomingResBound,
+    OutgoingReqRes,
+    IncomingReqBound,
+    OutgoingResBound,
+    IncomingReqRes
+  ]
+
+  /** Whether this processor can do something with a certain incoming message */
+  def accepts(msg: IncomingMessage): Boolean
+
+  /**
+   * The outcome of applying this processor to the given incoming message.
+   *
+   *  Applying the processor do a message outside of its domain should throw
+   *  a MatchError.
+   */
+  def result(msg: IncomingMessage): T
+
+  /**
+   * Execute the side effects of this processor.
+   *
+   * In an OCPP test, this is supposed to happen when an assertion expecting a
+   * certain incoming message has received an inomcing message that matches
+   * the expectation.
+   */
+  def fireSideEffects(msg: IncomingMessage): Unit
+
+  def lift(msg: IncomingMessage): Option[T] =
+    if (accepts(msg))
+      Some(result(msg))
+    else
+      None
+}
+