unit tests for feat comment on task (BE) (#60)

Author: hilu03

backend/test/controllers/CommentControllerSpec.scala

@@ -0,0 +1,201 @@
+package controllers
+
+import dto.request.comment.{CreateUpdateCommentRequest, TextChunk}
+import dto.request.project.CreateProjectRequest
+import dto.request.task.CreateTaskRequest
+import dto.request.workspace.CreateWorkspaceRequest
+import exception.AppException
+import org.scalatest.BeforeAndAfterAll
+import org.scalatest.concurrent.ScalaFutures
+import org.scalatestplus.play._
+import org.scalatestplus.play.guice.GuiceOneAppPerSuite
+import play.api.inject.guice.GuiceApplicationBuilder
+import play.api.libs.json.Json
+import play.api.mvc.Cookie
+import play.api.test.Helpers._
+import play.api.test._
+import play.api.{Application, Configuration}
+import services._
+
+class CommentControllerSpec
+    extends PlaySpec
+    with GuiceOneAppPerSuite
+    with Injecting
+    with ScalaFutures
+    with BeforeAndAfterAll {
+
+  override implicit def fakeApplication(): Application = {
+    new GuiceApplicationBuilder()
+      .configure(
+        "config.resource" -> "application.test.conf",
+        "slick.dbs.default.db.url" -> s"jdbc:h2:mem:comment_test;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE;MODE=PostgreSQL;DATABASE_TO_UPPER=false"
+      )
+      .build()
+  }
+
+  // config & token
+  lazy val config: Configuration = app.configuration
+  lazy val defaultAdminEmail: String =
+    config.getOptional[String]("admin.email").getOrElse("admin@mail.com")
+  lazy val defaultAdminName: String =
+    config.getOptional[String]("admin.name").getOrElse("Administrator")
+  lazy val cookieName: String =
+    config.getOptional[String]("cookie.name").getOrElse("auth_token")
+
+  def fakeToken: String = {
+    val jwtService = inject[JwtService]
+    jwtService
+      .generateToken(UserToken(1, defaultAdminName, defaultAdminEmail))
+      .getOrElse(throw new RuntimeException("JWT token not generated"))
+  }
+
+  override def beforeAll(): Unit = {
+    val workspaceService = inject[WorkspaceService]
+    val projectService = inject[ProjectService]
+    val taskService = inject[TaskService]
+
+    await(
+      workspaceService.createWorkspace(
+        CreateWorkspaceRequest("Workspace test"),
+        1
+      )
+    )
+
+    await(
+      // create project with default columns
+      projectService.createProject(
+        CreateProjectRequest("Project test"),
+        1,
+        1
+      )
+    )
+
+    await(
+      // create tasks in column
+      taskService.createNewTask(
+        CreateTaskRequest("Project test", 1),
+        1,
+        1
+      )
+    )
+  }
+
+  "CommentController" should {
+
+    "create comment successfully" in {
+      val commentChunk = TextChunk("test comment")
+      val body = Json.toJson(CreateUpdateCommentRequest(
+        Seq(commentChunk)
+      ))
+      val request = FakeRequest(POST, "/api/tasks/1/comments")
+        .withCookies(Cookie(cookieName, fakeToken))
+        .withBody(body)
+
+      val result = route(app, request).get
+
+      status(result) mustBe CREATED
+      (contentAsJson(result) \ "message").as[String] must include(
+        "Comment created successfully"
+      )
+    }
+
+    "fail when creating comment with unexisting task id" in {
+      val commentChunk = TextChunk("test comment")
+      val body = Json.toJson(CreateUpdateCommentRequest(
+        Seq(commentChunk)
+      ))
+      val request = FakeRequest(POST, "/api/tasks/2/comments")
+        .withCookies(Cookie(cookieName, fakeToken))
+        .withBody(body)
+
+      val ex = intercept[AppException] {
+        await(route(app, request).get)
+      }
+      ex.statusCode mustBe NOT_FOUND
+      ex.message must include(
+        "Task with ID 2 does not exist or you do not have access"
+      )
+    }
+
+    "update comment successfully" in {
+      val commentChunk = TextChunk("updated comment")
+      val body = Json.toJson(CreateUpdateCommentRequest(
+        Seq(commentChunk)
+      ))
+      val request = FakeRequest(PUT, "/api/comments/1")
+        .withCookies(Cookie(cookieName, fakeToken))
+        .withBody(body)
+        .withHeaders(CONTENT_TYPE -> "application/json")
+
+      val result = route(app, request).get
+
+      status(result) mustBe OK
+      (contentAsJson(result) \ "message")
+        .as[String] mustBe "Comment updated successfully"
+    }
+
+    "fail when updating comment with unexist comment id" in {
+      val commentChunk = TextChunk("error comment")
+      val body = Json.toJson(CreateUpdateCommentRequest(
+        Seq(commentChunk)
+      ))
+      val request = FakeRequest(PUT, "/api/comments/0")
+        .withCookies(Cookie(cookieName, fakeToken))
+        .withBody(body)
+        .withHeaders(CONTENT_TYPE -> "application/json")
+
+      val ex = intercept[AppException] {
+        await(route(app, request).get)
+      }
+
+      ex.statusCode mustBe NOT_FOUND
+      ex.message must include("Comment with ID 0 does not exist")
+    }
+
+    "get comments in task by task id successfully" in {
+      val request = FakeRequest(GET, "/api/tasks/1/comments")
+        .withCookies(Cookie(cookieName, fakeToken))
+      val result = route(app, request).get
+
+      status(result) mustBe OK
+      (contentAsJson(result) \ "message")
+        .as[String] mustBe "Comments retrieved successfully for task ID: 1"
+    }
+
+    "fail when getting comments in a task with unexist task id" in {
+      val request = FakeRequest(GET, "/api/tasks/0/comments")
+        .withCookies(Cookie(cookieName, fakeToken))
+
+      val ex = intercept[AppException] {
+        await(route(app, request).get)
+      }
+
+      ex.statusCode mustBe NOT_FOUND
+      ex.message must include("Task with ID 0 does not exist or you do not have access.")
+    }
+
+    "delete comment successfully" in {
+      val request = FakeRequest(DELETE, "/api/comments/1")
+        .withCookies(Cookie(cookieName, fakeToken))
+      val result = route(app, request).get
+
+      status(result) mustBe OK
+      (contentAsJson(result) \ "message")
+        .as[String] mustBe "Comment deleted successfully"
+    }
+
+    "fail when deleting comment with unexist id" in {
+      val request = FakeRequest(DELETE, "/api/comments/0")
+        .withCookies(Cookie(cookieName, fakeToken))
+      val result = route(app, request).get
+
+      val ex = intercept[AppException] {
+        await(result)
+      }
+      ex.statusCode mustBe NOT_FOUND
+      ex.message must include("Comment with ID 0 does not exist.")
+    }
+
+
+  }
+}