Serialize SubmissionFileNameAdded message

Author: schbetsy

persistence-model/src/main/protobuf/SubmissionEvents.proto

@@ -31,4 +31,9 @@ message SubmissionCreatedMessage {
 message SubmissionStatusUpdatedMessage {
     SubmissionIdMessage id = 1;
     SubmissionStatusMessage status = 2;
+}
+
+message SubmissionFileNameAddedMessage {
+    SubmissionIdMessage id = 1;
+    string fileName = 2;
 }

persistence-model/src/main/scala/hmda/persistence/messages/events/institutions/SubmissionEvents.scala

@@ -7,4 +7,5 @@ object SubmissionEvents {
   trait SubmissionEvent extends Event
   case class SubmissionCreated(submission: Submission) extends SubmissionEvent
   case class SubmissionStatusUpdated(id: SubmissionId, status: SubmissionStatus) extends SubmissionEvent
+  case class SubmissionFileNameAdded(id: SubmissionId, fileName: String) extends Event
 }

persistence-model/src/main/scala/hmda/persistence/serialization/submission/SubmissionProtobufConverter.scala

@@ -1,7 +1,7 @@
 package hmda.persistence.serialization.submission
 
-import hmda.model.fi.{ Submission, SubmissionId, SubmissionStatus, Created, Uploading, Uploaded, Parsing, Parsed, ParsedWithErrors, Validating, ValidatedWithErrors, Validated, Signed, Failed }
-import hmda.persistence.messages.events.institutions.SubmissionEvents.{ SubmissionCreated, SubmissionStatusUpdated }
+import hmda.model.fi.{ Created, Failed, Parsed, ParsedWithErrors, Parsing, Signed, Submission, SubmissionId, SubmissionStatus, Uploaded, Uploading, Validated, ValidatedWithErrors, Validating }
+import hmda.persistence.messages.events.institutions.SubmissionEvents._
 import hmda.persistence.model.serialization.SubmissionEvents._
 
 object SubmissionProtobufConverter {
@@ -32,6 +32,20 @@ object SubmissionProtobufConverter {
     )
   }
 
+  def submissionFileNameAddedToProtobuf(obj: SubmissionFileNameAdded): SubmissionFileNameAddedMessage = {
+    SubmissionFileNameAddedMessage(
+      id = Some(submissionIdToProtobuf(obj.id)),
+      fileName = obj.fileName
+    )
+  }
+
+  def submissionFileNameAddedFromProtobuf(msg: SubmissionFileNameAddedMessage): SubmissionFileNameAdded = {
+    SubmissionFileNameAdded(
+      id = submissionIdFromProtobuf(msg.id.getOrElse(SubmissionIdMessage())),
+      fileName = msg.fileName
+    )
+  }
+
   def submissionToProtobuf(obj: Submission): SubmissionMessage = {
     SubmissionMessage(
       id = Some(submissionIdToProtobuf(obj.id)),

persistence-model/src/main/scala/hmda/persistence/serialization/submission/SubmissionProtobufSerializer.scala

@@ -1,8 +1,8 @@
 package hmda.persistence.serialization.submission
 
 import akka.serialization.SerializerWithStringManifest
-import hmda.persistence.messages.events.institutions.SubmissionEvents.{ SubmissionCreated, SubmissionStatusUpdated }
-import hmda.persistence.model.serialization.SubmissionEvents.{ SubmissionCreatedMessage, SubmissionStatusUpdatedMessage }
+import hmda.persistence.messages.events.institutions.SubmissionEvents._
+import hmda.persistence.model.serialization.SubmissionEvents._
 import hmda.persistence.serialization.submission.SubmissionProtobufConverter._
 
 class SubmissionProtobufSerializer extends SerializerWithStringManifest {
@@ -12,10 +12,12 @@ class SubmissionProtobufSerializer extends SerializerWithStringManifest {
 
   final val SubmissionCreatedManifest = classOf[SubmissionCreated].getName
   final val SubmissionStatusUpdatedManifest = classOf[SubmissionStatusUpdated].getName
+  final val SubmissionFileNameAddedManifest = classOf[SubmissionFileNameAdded].getName
 
   override def toBinary(o: AnyRef): Array[Byte] = o match {
     case evt: SubmissionCreated => submissionCreatedToProtobuf(evt).toByteArray
     case evt: SubmissionStatusUpdated => submissionStatusUpdatedToProtobuf(evt).toByteArray
+    case evt: SubmissionFileNameAdded => submissionFileNameAddedToProtobuf(evt).toByteArray
     case msg: Any => throw new RuntimeException(s"Cannot serialize this message: ${msg.toString}")
   }
 
@@ -24,6 +26,8 @@ class SubmissionProtobufSerializer extends SerializerWithStringManifest {
       submissionCreatedFromProtobuf(SubmissionCreatedMessage.parseFrom(bytes))
     case SubmissionStatusUpdatedManifest =>
       submissionStatusUpdatedFromProtobuf(SubmissionStatusUpdatedMessage.parseFrom(bytes))
+    case SubmissionFileNameAddedManifest =>
+      submissionFileNameAddedFromProtobuf(SubmissionFileNameAddedMessage.parseFrom(bytes))
     case msg: Any => throw new RuntimeException(s"Cannot deserialize this message: ${msg.toString}")
   }
 }

persistence-model/src/test/scala/hmda/persistence/serialization/submission/SubmissionProtobufConverterSpec.scala

@@ -1,11 +1,12 @@
 package hmda.persistence.serialization.submission
 
-import org.scalatest.{ MustMatchers, PropSpec }
+import org.scalatest.{MustMatchers, PropSpec}
 import org.scalatest.prop.PropertyChecks
 import hmda.model.institution.SubmissionGenerators._
-import hmda.persistence.messages.events.institutions.SubmissionEvents.{ SubmissionCreated, SubmissionStatusUpdated }
+import hmda.persistence.messages.events.institutions.SubmissionEvents._
 import hmda.persistence.model.serialization.SubmissionEvents._
 import hmda.persistence.serialization.submission.SubmissionProtobufConverter._
+import org.scalacheck.Gen
 
 class SubmissionProtobufConverterSpec extends PropSpec with PropertyChecks with MustMatchers {
 
@@ -38,6 +39,14 @@ class SubmissionProtobufConverterSpec extends PropSpec with PropertyChecks with
     }
   }
 
+  property("Submission File Name Added must serialize to protobuf and back") {
+    forAll(submissionIdGen, Gen.alphaStr) { (submissionId, fileName) =>
+      val submissionFileNameAdded = SubmissionFileNameAdded(submissionId, fileName)
+      val protobuf = submissionFileNameAddedToProtobuf(submissionFileNameAdded).toByteArray
+      submissionFileNameAddedFromProtobuf(SubmissionFileNameAddedMessage.parseFrom(protobuf)) mustBe submissionFileNameAdded
+    }
+  }
+
   property("Submission Created must serialize to protobuf and back") {
     forAll(submissionGen) { submission =>
       val submissionCreated = SubmissionCreated(submission)

persistence-model/src/test/scala/hmda/persistence/serialization/submission/SubmissionProtobufSerializerSpec.scala

@@ -1,9 +1,10 @@
 package hmda.persistence.serialization.submission
 
-import org.scalatest.{ MustMatchers, PropSpec }
+import org.scalatest.{MustMatchers, PropSpec}
 import org.scalatest.prop.PropertyChecks
 import hmda.model.institution.SubmissionGenerators._
-import hmda.persistence.messages.events.institutions.SubmissionEvents.{ SubmissionCreated, SubmissionStatusUpdated }
+import hmda.persistence.messages.events.institutions.SubmissionEvents._
+import org.scalacheck.Gen
 
 class SubmissionProtobufSerializerSpec extends PropSpec with PropertyChecks with MustMatchers {
   val serializer = new SubmissionProtobufSerializer()
@@ -23,4 +24,12 @@ class SubmissionProtobufSerializerSpec extends PropSpec with PropertyChecks with
       serializer.fromBinary(bytes, serializer.SubmissionStatusUpdatedManifest) mustBe msg
     }
   }
+
+  property("Submission File Name Added messages must be serialized to binary and back") {
+    forAll(submissionIdGen, Gen.alphaStr) { (submissionId, fileName) =>
+      val msg = SubmissionFileNameAdded(submissionId, fileName)
+      val bytes = serializer.toBinary(msg)
+      serializer.fromBinary(bytes, serializer.SubmissionFileNameAddedManifest) mustBe msg
+    }
+  }
 }