Merge pull request #5 from TheMeinerLP/feature/unit-tests

Add unit tests

Author: TheMeinerLP

.github/workflows/pull_requests.yml

@@ -0,0 +1,39 @@
+name: Check if code still running
+
+on: pull_request
+
+concurrency:
+  group: pr-${{ github.base_ref }}-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  detekt:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+      - name: Run Tests
+        run:  gradle test
+      - name: Publish Unit Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v1
+        if: always()
+        with:
+          check_name: 'unit test results'
+          files: build/test-results/**/*.xml
+  ktlint:
+    name: ktlint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Clone repo
+        uses: actions/checkout@master
+        with:
+          fetch-depth: 1
+      - name: ktlint
+        uses: ScaCap/action-ktlint@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-pr-review

build.gradle.kts

@@ -8,6 +8,7 @@ plugins {
     id("org.openapi.generator") version "5.3.0"
     id("org.hidetake.swagger.generator") version "2.18.2"
     id("org.jetbrains.changelog") version "1.3.1"
+    id("io.gitlab.arturbosch.detekt") version "1.17.1"
 
 
     kotlin("jvm") version "1.5.31"
@@ -61,8 +62,15 @@ dependencies {
 
     swaggerUI("org.webjars:swagger-ui:3.52.5")
     swaggerCodegen("io.swagger.codegen.v3:swagger-codegen-cli:3.0.28")
-    //testImplementation("org.springframework.boot:spring-boot-starter-test")
-    //testImplementation("io.projectreactor:reactor-test")
+
+    // Unit Testing
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+
+    // Test Containers
+    testImplementation("org.testcontainers:testcontainers-bom:1.16.2")
+    testImplementation("org.testcontainers:junit-jupiter:1.16.2")
+    testApi("org.testcontainers:mongodb:1.16.2")
+
 }
 
 
@@ -75,10 +83,6 @@ tasks {
             jvmTarget = "1.8"
         }
     }
-
-    test {
-        useJUnitPlatform()
-    }
     bootBuildImage {
         imageName = if (System.getenv("repository") != null) {
             "ghcr.io/${System.getenv("repository").toLowerCase()}/${project.name.toLowerCase()}:${project.version}"
@@ -95,6 +99,9 @@ tasks {
         }
         isPublish = true
     }
+    test {
+        useJUnitPlatform()
+    }
 }
 
 changelog {

src/main/kotlin/dev/themeinerlp/skinserver/SkinServerApplication.kt

@@ -8,6 +8,10 @@ import org.springframework.boot.autoconfigure.SpringBootApplication
 import org.springframework.boot.context.properties.ConfigurationPropertiesScan
 import org.springframework.boot.context.properties.EnableConfigurationProperties
 import org.springframework.boot.runApplication
+import org.springframework.context.annotation.Bean
+import org.springframework.data.mongodb.MongoDatabaseFactory
+import org.springframework.data.mongodb.MongoTransactionManager
+
 
 @OpenAPIDefinition(
     info = Info(
@@ -25,7 +29,13 @@ import org.springframework.boot.runApplication
 )
 @ConfigurationPropertiesScan
 @EnableConfigurationProperties(value = [SkinServerProperties::class])
-class SkinServerApplication
+class SkinServerApplication {
+
+    @Bean
+    fun transactionManager(dbFactory: MongoDatabaseFactory): MongoTransactionManager {
+        return MongoTransactionManager(dbFactory)
+    }
+}
 
 fun main(args: Array<String>) {
     runApplication<SkinServerApplication>(*args)

src/main/kotlin/dev/themeinerlp/skinserver/handler/render/RenderHandlerImpl.kt

@@ -9,8 +9,8 @@ import org.springframework.http.HttpStatus
 import org.springframework.http.MediaType
 import org.springframework.http.ResponseEntity
 import org.springframework.stereotype.Component
-import org.springframework.web.multipart.MultipartFile
 import org.springframework.web.server.ResponseStatusException
+import javax.servlet.http.Part
 
 @Component
 class RenderHandlerImpl(
@@ -19,19 +19,18 @@ class RenderHandlerImpl(
 ) : RenderDatabaseHandler {
 
     override fun renderHead(
-        skin: MultipartFile?,
+        skin: Part?,
         size: Int?,
         rotation: HeadView?,
         layer: Boolean?
     ): ResponseEntity<Any> {
         size ?: throw ResponseStatusException(HttpStatus.NOT_FOUND, "Size is empty")
         skin ?: throw ResponseStatusException(HttpStatus.NOT_FOUND, "Skin is empty")
-        rotation ?: throw ResponseStatusException(HttpStatus.NOT_FOUND, "Rotation is empty")
         if (size < skinServerProperties.minSize || size > skinServerProperties.maxSize) {
             throw ResponseStatusException(HttpStatus.BAD_REQUEST, "Size are to small or to big")
         }
         val content = skin.inputStream.use {
-            this.renderService.renderHeadFromByteArray(size, rotation, it.readBytes(), layer ?: true)
+            this.renderService.renderHeadFromByteArray(size, rotation ?: HeadView.Front, it.readBytes(), layer ?: true)
         }
         return ResponseEntity.ok().contentType(MediaType.IMAGE_PNG).body(InputStreamResource(content.inputStream()))
     }

src/main/kotlin/dev/themeinerlp/skinserver/spec/dao/skin/Skin.kt

@@ -6,7 +6,7 @@ import org.springframework.data.mongodb.core.mapping.Document
 
 @Document
 data class Skin(
-    @Id val uuid: UUID? = null,
+    @Id val uuid: UUID? = UUID.randomUUID(),
     val skinUrl: String? = null,
     val texture: String? = null,
     val username: String? = null

src/main/kotlin/dev/themeinerlp/skinserver/spec/handler/render/RenderHandler.kt

@@ -9,11 +9,11 @@ import io.swagger.v3.oas.annotations.responses.ApiResponses
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.http.MediaType
 import org.springframework.http.ResponseEntity
+import javax.servlet.http.Part
 import org.springframework.web.bind.annotation.*
-import org.springframework.web.multipart.MultipartFile
 
 interface RenderDatabaseHandler {
-    fun renderHead(skin: MultipartFile?, size: Int?, rotation: HeadView?, layer: Boolean?): ResponseEntity<Any>
+    fun renderHead(skin: Part?, size: Int?, rotation: HeadView?, layer: Boolean?): ResponseEntity<Any>
 }
 
 @RestController
@@ -47,11 +47,6 @@ class RenderHandler {
                 responseCode = "404",
                 content = []
             ),
-            ApiResponse(
-                description = "view is empty",
-                responseCode = "404",
-                content = []
-            ),
             ApiResponse(
                 description = "Size are to small or to big",
                 responseCode = "500",
@@ -72,7 +67,7 @@ class RenderHandler {
             required = true,
         )
         @RequestPart(required = true)
-        skin: MultipartFile?,
+        skin: Part?,
         @Parameter(
             description = "Head scale, default is 64",
             required = true,

src/main/kotlin/dev/themeinerlp/skinserver/spec/repository/skin/SkinRepository.kt

@@ -4,7 +4,7 @@ import dev.themeinerlp.skinserver.spec.dao.skin.Skin
 import java.util.UUID
 import org.springframework.data.mongodb.repository.MongoRepository
 
-interface SkinRepository : MongoRepository<Skin, String> {
+interface SkinRepository : MongoRepository<Skin, UUID> {
 
     fun findByUuid(uuid: UUID): Skin?
     fun findByUsernameIgnoreCase(username: String): Skin?

src/test/kotlin/dev/themeinerlp/skinserver/TestBase.kt

@@ -0,0 +1,28 @@
+package dev.themeinerlp.skinserver
+
+import dev.themeinerlp.skinserver.service.testcontainer.TestContainer
+import dev.themeinerlp.skinserver.utils.TestUtilsImplementation
+import org.junit.jupiter.api.extension.ExtendWith
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.test.context.ActiveProfiles
+import org.springframework.test.context.ContextConfiguration
+import org.springframework.test.context.junit.jupiter.SpringExtension
+import org.springframework.test.web.servlet.MockMvc
+
+
+@ExtendWith(SpringExtension::class)
+@SpringBootTest(classes = [SkinServerApplication::class])
+@AutoConfigureMockMvc
+@ActiveProfiles("test")
+@ContextConfiguration(initializers = [TestContainer::class])
+abstract class TestBase {
+
+    @Autowired
+    lateinit var mockMvc: MockMvc
+
+    @Autowired
+    lateinit var testUtilsImplementation: TestUtilsImplementation
+
+}

src/test/kotlin/dev/themeinerlp/skinserver/handler/head/integration/HeadHandlerTest.kt

@@ -0,0 +1,92 @@
+package dev.themeinerlp.skinserver.handler.head.integration
+
+import dev.themeinerlp.skinserver.TestBase
+import dev.themeinerlp.skinserver.spec.dao.skin.Skin
+import dev.themeinerlp.skinserver.spec.repository.skin.SkinRepository
+import dev.themeinerlp.skinserver.utils.HeadView
+import java.nio.file.Files
+import java.util.Base64
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.EnumSource
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.core.io.ResourceLoader
+import org.springframework.http.MediaType
+import org.springframework.test.web.servlet.get
+import org.springframework.transaction.annotation.Transactional
+
+@Transactional
+class HeadHandlerTest : TestBase() {
+
+    @Autowired
+    lateinit var skinRepository: SkinRepository
+
+    @Autowired
+    lateinit var resourceLoader: ResourceLoader
+
+    fun createTestData(): Skin {
+        return skinRepository.save(
+            Skin(
+                username = "fakeuser",
+                skinUrl = "fakeurl",
+                texture = Base64.getEncoder()
+                    .encodeToString(Files.readAllBytes(resourceLoader.getResource("classpath:fakeuser.png").file.toPath()))
+            )
+        )
+    }
+
+    @Test
+    fun `get Skin by Username`() {
+        createTestData()
+        mockMvc.get("/head/username/64/fakeuser/") {
+            accept(MediaType.IMAGE_PNG)
+            contentType = MediaType.IMAGE_PNG
+        }.andExpect {
+            status {
+                isOk()
+            }
+        }
+    }
+
+    @Test
+    fun `get Skin by UUID`() {
+        val uuid = createTestData().uuid
+        mockMvc.get("/head/uuid/64/$uuid/") {
+            accept(MediaType.IMAGE_PNG)
+            contentType = MediaType.IMAGE_PNG
+        }.andExpect {
+            status {
+                isOk()
+            }
+        }
+    }
+
+    @ParameterizedTest
+    @EnumSource(HeadView::class)
+    fun `get Skin by UUID different rotations`(rotation: HeadView) {
+        val uuid = createTestData().uuid
+        mockMvc.get("/head/uuid/64/$uuid/$rotation/") {
+            accept(MediaType.IMAGE_PNG)
+            contentType = MediaType.IMAGE_PNG
+        }.andExpect {
+            status {
+                isOk()
+            }
+        }
+    }
+
+    @ParameterizedTest
+    @EnumSource(HeadView::class)
+    fun `get Skin by Username different rotations`(rotation: HeadView) {
+        createTestData()
+        mockMvc.get("/head/username/64/fakeuser/$rotation/") {
+            accept(MediaType.IMAGE_PNG)
+            contentType = MediaType.IMAGE_PNG
+        }.andExpect {
+            status {
+                isOk()
+            }
+        }
+    }
+
+}