Feat/31 integration test (#44)

* chore: add docker into devcontainer

* chore: add live-server into devcontainer

* chore: add mysql version test

* feat: add /test controller

* chore: add container singleton init test

* test: add TestContainer and Test it runs

* chore: fix mysql conf foler path for Testcontainer

* test: add gradle tasks integrationTest

* chore: delete \r line (for execute)

* test: move RepositoryTest into Integration-Test with testcontainer

* chore: remove unused dependency

* test: fix repository test for using testcontainer

---------

Co-authored-by: ParkJeongseop <[email protected]>

Author: junha-ahn

.devcontainer/devcontainer.json

@@ -11,6 +11,13 @@
 			"gradleVersion": "latest",
 			"mavenVersion": "latest",
 			"antVersion": "latest"
+		},
+		"ghcr.io/devcontainers/features/docker-in-docker:2": {
+			"moby": true,
+			"azureDnsAutoDetection": true,
+			"installDockerBuildx": true,
+			"version": "20.10",
+			"dockerDashComposeVersion": "v1"
 		}
 	},
 
@@ -31,7 +38,8 @@
 			"extensions": [
 				"mathiasfrohlich.Kotlin",
 				"GitHub.copilot",
-				"vscjava.vscode-gradle"
+				"vscjava.vscode-gradle",
+				"ritwickdey.LiveServer"
 			]
 		}
 	}

.github/workflows/gradle-build-test-lint.yml

@@ -50,6 +50,24 @@ jobs:
         if: always()
         with:
           arguments: test -x jacocoTestReport
+
+  integrationTest:
+    runs-on: ubuntu-latest
+    needs: set-up
+    if: always()
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: integrationTest
+        uses: gradle/gradle-build-action@749f47bda3e44aa060e82d7b3ef7e40d953bd629
+        if: always()
+        with:
+          arguments: integrationTest
 
   coverage:
     runs-on: ubuntu-latest

build.gradle.kts

@@ -23,6 +23,31 @@ repositories {
     mavenCentral()
 }
 
+sourceSets {
+    create("integrationTest") {
+        compileClasspath += sourceSets.main.get().output
+        runtimeClasspath += sourceSets.main.get().output
+    }
+}
+
+val integrationTestImplementation by configurations.getting {
+    extendsFrom(configurations.implementation.get())
+}
+
+configurations["integrationTestRuntimeOnly"].extendsFrom(configurations.runtimeOnly.get())
+configurations["integrationTestImplementation"].extendsFrom(configurations.testImplementation.get())
+
+val integrationTest = task<Test>("integrationTest") {
+    description = "Runs integration tests."
+    group = "verification"
+
+    testClassesDirs = sourceSets["integrationTest"].output.classesDirs
+    classpath = sourceSets["integrationTest"].runtimeClasspath
+    shouldRunAfter("test")
+}
+
+tasks.check { dependsOn(integrationTest) }
+
 dependencies {
     implementation("org.springframework.boot:spring-boot-starter-data-jpa")
     implementation("org.springframework.boot:spring-boot-starter-web")
@@ -32,8 +57,11 @@ dependencies {
     developmentOnly("org.springframework.boot:spring-boot-devtools")
     runtimeOnly("com.mysql:mysql-connector-j")
     testImplementation("org.springframework.boot:spring-boot-starter-test")
-    testImplementation("com.h2database:h2")
     implementation("org.modelmapper:modelmapper:2.4.2")
+    integrationTestImplementation("org.springframework.boot:spring-boot-testcontainers")
+    integrationTestImplementation("org.testcontainers:junit-jupiter")
+    integrationTestImplementation("org.testcontainers:mysql")
+    implementation("com.ninja-squad:springmockk:4.0.2")
 }
 
 tasks.withType<KotlinCompile> {
@@ -92,7 +120,7 @@ tasks.jacocoTestReport {
 
 tasks.jacocoTestCoverageVerification {
 
-    var Qdomains = mutableListOf<String>()
+    val Qdomains = mutableListOf<String>()
 
     for (qPattern in 'A'..'Z') {
         Qdomains.add("*.Q$qPattern*")

docker-compose.yml

@@ -0,0 +1,45 @@
+version: "3"
+
+services:
+  db:
+    container_name: mysqldb
+    image: mysql:8.0.33
+    restart: "no"
+    environment:
+      MYSQL_ROOT_PASSWORD: test
+    ports:
+      - 3306:3306
+    volumes:
+      - ./src/intTest/resources/db/mysql/conf.d:/etc/mysql/conf.d
+      - ./src/intTest/resources/db/mysql/initdb.d:/docker-entrypoint-initdb.d
+    healthcheck:
+      test: ['CMD-SHELL', 'mysqladmin ping -h 127.0.0.1 -u root --password=$$MYSQL_ROOT_PASSWORD']
+      interval: 10s
+      timeout: 2s
+      retries: 100
+
+    networks:
+      - spring-network
+      
+  api:
+    container_name: api
+    build:
+      context: .
+      dockerfile: Dockerfile
+    restart: "no"
+    ports:
+      - 8080:8080
+    environment:
+      MYSQL_HOST: mysqldb
+      MYSQL_PORT: 3306
+      MYSQL_USERNAME: root
+      MYSQL_PASSWORD: test
+      MYSQL_SCHEMA: test
+    depends_on:
+      db:
+        condition: service_healthy
+    networks:
+      - spring-network
+
+networks:
+  spring-network:

gradlew

@@ -242,4 +242,4 @@ eval "set -- $(
         tr '\n' ' '
     )" '"$@"'
 
-exec "$JAVACMD" "$@"
+exec "$JAVACMD" "$@"

src/integrationTest/kotlin/com/group4/ticketingservice/AbstractIntegrationTest.kt

@@ -0,0 +1,27 @@
+package com.group4.ticketingservice
+
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.test.context.DynamicPropertyRegistry
+import org.springframework.test.context.DynamicPropertySource
+import org.testcontainers.containers.MySQLContainer
+import org.testcontainers.junit.jupiter.Container
+import org.testcontainers.junit.jupiter.Testcontainers
+
+@SpringBootTest
+@Testcontainers
+abstract class AbstractIntegrationTest {
+
+    companion object {
+        @Container
+        val mysqlContainer = MySQLContainer("mysql:8.0.33")
+            .withConfigurationOverride("./db/mysql/conf.d")
+
+        @JvmStatic
+        @DynamicPropertySource
+        fun datasourceConfig(registry: DynamicPropertyRegistry) {
+            registry.add("spring.datasource.url", mysqlContainer::getJdbcUrl)
+            registry.add("spring.datasource.username", mysqlContainer::getUsername)
+            registry.add("spring.datasource.password", mysqlContainer::getPassword)
+        }
+    }
+}

src/test/kotlin/com/group4/ticketingservice/bookmark/BookmarkRepositoryTest.kt renamed to src/integrationTest/kotlin/com/group4/ticketingservice/Bookmark/BookmarkRepositoryTest.kt

@@ -1,18 +1,16 @@
-package com.group4.ticketingservice.bookmark
+package com.group4.ticketingservice
 
 import com.group4.ticketingservice.entity.Bookmark
 import com.group4.ticketingservice.repository.BookmarkRepository
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.Assertions.assertInstanceOf
 import org.junit.jupiter.api.Test
 import org.springframework.beans.factory.annotation.Autowired
-import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest
 import org.springframework.data.repository.findByIdOrNull
 
-@DataJpaTest
 class BookmarkRepositoryTest(
     @Autowired val bookmarkRepository: BookmarkRepository
-) {
+) : AbstractIntegrationTest() {
 
     @Test
     fun `bookmarkRepository_save should return savedBookmark`() {
@@ -43,7 +41,7 @@ class BookmarkRepositoryTest(
         val foundBookmark = bookmarkRepository.findByIdOrNull(savedBookmark.id?.toLong())
 
         // then
-        assertThat(foundBookmark).isEqualTo(savedBookmark)
+        assert(savedBookmark.id == foundBookmark?.id)
     }
 
     @Test

src/integrationTest/kotlin/com/group4/ticketingservice/TestControllerTest.kt

@@ -0,0 +1,23 @@
+package com.group4.ticketingservice
+
+import org.junit.jupiter.api.Test
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc
+import org.springframework.test.web.servlet.MockMvc
+import org.springframework.test.web.servlet.request.MockMvcRequestBuilders
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status
+
+@AutoConfigureMockMvc
+class TestControllerTest : AbstractIntegrationTest() {
+    @Autowired private lateinit var mockMvc: MockMvc
+
+    @Test
+    fun contextLoads() {
+    }
+
+    @Test
+    fun `E2E test`() {
+        mockMvc.perform(MockMvcRequestBuilders.get("/bookmarks"))
+            .andExpect(status().isOk)
+    }
+}

src/integrationTest/resources/application.properties

@@ -0,0 +1 @@
+spring.jpa.hibernate.ddl-auto=create

src/integrationTest/resources/db/mysql/conf.d/my.cnf

@@ -0,0 +1,10 @@
+[client]
+default-character-set = utf8mb4
+
+[mysql]
+default-character-set = utf8mb4
+
+[mysqld]
+character-set-client-handshake = FALSE
+character-set-server           = utf8mb4
+collation-server               = utf8mb4_unicode_ci

src/integrationTest/resources/db/mysql/initdb.d/init-db.sql

@@ -0,0 +1 @@
+-- use ddl-auto