ISSUE-133 Adding COMPRESS command

Author: quantranhong1999

README.adoc

@@ -44,6 +44,7 @@ For now only the following commands are supported:
  - UID EXPUNGE
  - UID MOVE
  - UID STORE
+ - COMPRESS (link:https://datatracker.ietf.org/doc/html/rfc4978[RFC-4978])
 
 == Supported checks
 

src/it/scala-2.12/com/linagora/gatling/imap/scenario/it/ImapAuthenticationScenarioIT.scala

@@ -2,7 +2,7 @@ package com.linagora.gatling.imap.scenario.it
 
 import com.linagora.gatling.imap.Fixture.bart
 import com.linagora.gatling.imap.PreDef.imap
-import com.linagora.gatling.imap.scenario.{ImapAuthenticationScenario, ImapCapabilityScenario, ImapCheckScenario, ImapCloseScenario, ImapCopyMessageScenario, ImapCreateFolderScenario, ImapDeleteFolderScenario, ImapEnableScenario, ImapExamineFolderScenario, ImapExpungeScenario, ImapGetAclScenario, ImapGetQuotaRootScenario, ImapGetQuotaScenario, ImapIdleScenario, ImapLogoutScenario, ImapLsubScenario, ImapMoveMessageScenario, ImapMyRightsScenario, ImapNamespaceScenario, ImapNoopScenario, ImapRenameFolderScenario, ImapSearchScenario, ImapSimpleScenario, ImapStatusScenario, ImapSubscribeScenario, ImapUIDFetchScenario, ImapUidCopyMessageScenario, ImapUidExpungeMessageScenario, ImapUidMoveMessageScenario, ImapUidStoreScenario, ImapUnselectScenario, ImapUnsubscribeScenario}
+import com.linagora.gatling.imap.scenario.{ImapAuthenticationScenario, ImapCapabilityScenario, ImapCheckScenario, ImapCloseScenario, ImapCompressScenario, ImapCopyMessageScenario, ImapCreateFolderScenario, ImapDeleteFolderScenario, ImapEnableScenario, ImapExamineFolderScenario, ImapExpungeScenario, ImapGetAclScenario, ImapGetQuotaRootScenario, ImapGetQuotaScenario, ImapIdleScenario, ImapLogoutScenario, ImapLsubScenario, ImapMoveMessageScenario, ImapMyRightsScenario, ImapNamespaceScenario, ImapNoopScenario, ImapRenameFolderScenario, ImapSearchScenario, ImapSimpleScenario, ImapStatusScenario, ImapSubscribeScenario, ImapUIDFetchScenario, ImapUidCopyMessageScenario, ImapUidExpungeMessageScenario, ImapUidMoveMessageScenario, ImapUidStoreScenario, ImapUnselectScenario, ImapUnsubscribeScenario}
 import com.linagora.gatling.imap.{CyrusServer, Fixture, JamesServer, RunningServer}
 import io.gatling.core.feeder.FeederBuilder
 import io.gatling.core.funspec.GatlingFunSpec
@@ -91,6 +91,10 @@ class ImapGetQuotaScenarioJamesIT extends BaseIt(JamesServer.start()) {
   scenario(ImapGetQuotaScenario(_))
 }
 
+class ImapCompressScenarioJamesIT extends BaseIt(JamesServer.start()) {
+  scenario(ImapCompressScenario(_))
+}
+
 class ImapIdleScenarioJamesIT extends BaseIt(JamesServer.start()) {
   scenario(ImapIdleScenario(_))
 }

src/main/scala-2.12/com/linagora/gatling/imap/action/CompressAction.scala

@@ -0,0 +1,27 @@
+package com.linagora.gatling.imap.action
+
+import akka.actor.Props
+import com.linagora.gatling.imap.check.ImapCheck
+import com.linagora.gatling.imap.protocol.{Command, UserId}
+import io.gatling.commons.validation.Validation
+import io.gatling.core.action.ValidatedActionActor
+import io.gatling.core.session._
+
+import scala.collection.immutable.Seq
+
+object CompressAction {
+  def props(imapContext: ImapActionContext, requestname: String, checks: Seq[ImapCheck]) =
+    Props(new CompressAction(imapContext, requestname, checks))
+}
+
+class CompressAction(val imapContext: ImapActionContext, val requestName: String, override val checks: Seq[ImapCheck]) extends ValidatedActionActor with ImapActionActor {
+
+  override protected def executeOrFail(session: Session): Validation[_] = {
+    Validation.unit
+      .map(_ => {
+        val id: Long = session.userId
+        val handler = handleResponse(session, imapContext.clock.nowMillis)
+        sessions.tell(Command.Compress(UserId(id)), handler)
+      })
+  }
+}

src/main/scala-2.12/com/linagora/gatling/imap/action/ImapActionBuilder.scala

@@ -94,6 +94,9 @@ class ImapActionBuilder(requestName: String) {
   def setQuota(quotaRootAndResourceLimits: Expression[String]): ImapSetQuotaActionBuilder =
     ImapSetQuotaActionBuilder(requestName, quotaRootAndResourceLimits, Seq.empty)
 
+  def compress(): ImapCompressActionBuilder =
+    ImapCompressActionBuilder(requestName, Seq.empty)
+
   def getAcl(mailbox: Expression[String]): ImapGetAclActionBuilder =
     ImapGetAclActionBuilder(requestName, mailbox, Seq.empty)
 
@@ -402,6 +405,15 @@ case class ImapSetQuotaActionBuilder(requestName: String, capability: Expression
   override val actionName: String = "set-quota-action"
 }
 
+case class ImapCompressActionBuilder(requestName: String, private val checks: Seq[ImapCheck]) extends ImapCommandActionBuilder {
+  def check(checks: ImapCheck*): ImapCompressActionBuilder = copy(checks = this.checks ++ checks)
+
+  override def props(ctx: ImapActionContext): Props =
+    CompressAction.props(ctx, requestName, checks)
+
+  override val actionName: String = "compress-action"
+}
+
 case class ImapGetAclActionBuilder(requestName: String, capability: Expression[String], private val checks: Seq[ImapCheck]) extends ImapCommandActionBuilder {
   def check(checks: ImapCheck*): ImapGetAclActionBuilder = copy(checks = this.checks ++ checks)
 

src/main/scala-2.12/com/linagora/gatling/imap/protocol/ImapSessions.scala

@@ -123,6 +123,9 @@ private class ImapSession(client: => ImapAsyncClient, protocol: ImapProtocol) ex
     case cmd@Command.SetQuota(_, _) =>
       val handler = context.actorOf(SetQuotaHandler.props(session), genName("setQuota"))
       handler forward cmd
+    case cmd@Command.Compress(_) =>
+      val handler = context.actorOf(CompressHandler.props(session), genName("compress"))
+      handler forward cmd
     case cmd@Command.Idle(_) =>
       val handler = context.actorOf(IdleHandler.props(session), genName("idle"))
       handler forward cmd

src/main/scala-2.12/com/linagora/gatling/imap/protocol/command/CompressHandler.scala

@@ -0,0 +1,48 @@
+package com.linagora.gatling.imap.protocol.command
+
+import java.util.function.Consumer
+
+import akka.actor.{ActorRef, Props}
+import com.linagora.gatling.imap.protocol._
+import com.yahoo.imapnio.async.client.ImapAsyncSession
+import com.yahoo.imapnio.async.response.ImapAsyncResponse
+import io.gatling.core.akka.BaseActor
+
+import scala.collection.immutable.Seq
+
+object CompressHandler {
+  def props(session: ImapAsyncSession) = Props(new CompressHandler(session))
+}
+
+class CompressHandler(session: ImapAsyncSession) extends BaseActor {
+  override def receive: Receive = {
+    case Command.Compress(userId) =>
+      logger.trace(s"CompressHandler for user : ${userId.value}, on actor ${self.path} responding to ${sender.path}")
+      context.become(waitCallback(sender()))
+
+      val responseCallback: Consumer[ImapAsyncResponse] = responses => {
+        import collection.JavaConverters._
+
+        val responsesList = ImapResponses(responses.getResponseLines.asScala.to[Seq])
+        logger.trace(s"On response for $userId :\n ${responsesList.mkString("\n")}")
+        self !  Response.CompressResponse(responsesList)
+      }
+      val errorCallback: Consumer[Exception] = e => {
+        logger.trace(s"${getClass.getSimpleName} command failed", e)
+        logger.error(s"${getClass.getSimpleName} command failed")
+        sender ! e
+        context.stop(self)
+      }
+
+      val future = session.startCompression()
+      future.setDoneCallback(responseCallback)
+      future.setExceptionCallback(errorCallback)
+  }
+
+  def waitCallback(sender: ActorRef): Receive = {
+    case msg@Response.CompressResponse(_) =>
+      logger.trace(s"CompressHandler respond to ${sender.path} with $msg")
+      sender ! msg
+      context.stop(self)
+  }
+}

src/main/scala-2.12/com/linagora/gatling/imap/protocol/package.scala

@@ -83,6 +83,8 @@ package object protocol {
 
     case class SetQuota(userId: UserId, quotaRootAndResourcesLimits: String) extends Command
 
+    case class Compress(userId: UserId) extends Command
+
     case class GetAcl(userId: UserId, mailbox: String) extends Command
 
     case class MyRights(userId: UserId, mailbox: String) extends Command
@@ -173,6 +175,8 @@ package object protocol {
 
     case class SetQuotaResponse(responses: ImapResponses) extends Response
 
+    case class CompressResponse(responses: ImapResponses) extends Response
+
     case class AclResponse(responses: ImapResponses) extends Response
 
     case class MyRightsResponse(responses: ImapResponses) extends Response

src/main/scala-2.12/com/linagora/gatling/imap/scenario/ImapCompressScenario.scala

@@ -0,0 +1,15 @@
+package com.linagora.gatling.imap.scenario
+
+import com.linagora.gatling.imap.PreDef._
+import io.gatling.core.Predef._
+import io.gatling.core.feeder.FeederBuilder
+import io.gatling.core.structure.ScenarioBuilder
+
+object ImapCompressScenario {
+  def apply(feeder: FeederBuilder): ScenarioBuilder =
+    scenario("Imap")
+      .feed(feeder)
+      .exec(imap("Connect").connect()).exitHereIfFailed
+      .exec(imap("compress").compress().check(ok))
+      .exec(imap("noop").noop().check(ok))
+}