Тестирование проектов Kotlin с помощью Maven

Создание тестов с помощью JUnit

JUnit — стандартный фреймворк для тестирования серверных приложений на Kotlin. Хотя Kotlin поддерживает несколько версий JUnit, в большинстве современных проектов следует использовать JUnit 6.

Чтобы создать тест на Kotlin с помощью JUnit, используйте аннотацию @Test из пакета kotlin.test или JUnit.

<dependencies>
    <dependency>
        <groupId>org.jetbrains.kotlin</groupId>
        <artifactId>kotlin-test-junit5</artifactId>
        <version>2.4.20</version>
        <scope>test</scope>
    </dependency>
</dependencies>

<!-- pom.xml -->
<dependencies>
    <dependency>
        <groupId>org.jetbrains.kotlin</groupId>
        <artifactId>kotlin-test-junit</artifactId>
        <version>2.4.20</version>
        <scope>test</scope>
    </dependency>
</dependencies>

import kotlin.test.Test
import kotlin.test.assertEquals

class OrderServiceTest {
    @Test
    fun `calculate total should sum item prices`() {
        val service = OrderService()
        val result = service.calculateTotal(listOf(10.0, 25.0))
        assertEquals(35.0, result)
    }
}

import kotlin.test.Test
import kotlin.test.assertNotNull

class UserRepositoryIT {
    @Test
    fun saveFindUser() {
        // Example integration with a database or service
        val repository = UserRepository()
        repository.save(User("KotlinUser"))
        
        val user = repository.findByName("KotlinUser")
        assertNotNull(user)
    }
}

Запуск тестов

В проектах Maven выполнение тестов обычно разделено между двумя плагинами — Surefire и Failsafe, что обеспечивает четкий жизненный цикл сборки.

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>3.5.5</version>
</plugin>

mvn test

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-failsafe-plugin</artifactId>
    <version>3.5.5</version>
    <executions>
        <execution>
            <goals>
                <goal>integration-test</goal>
                <goal>verify</goal>
            </goals>
        </execution>
    </executions>
</plugin>

mvn verify

Подробные сообщения об ошибках

Плагин компилятора Power-assert для Kotlin формирует подробные сообщения об ошибках, показывающие промежуточные значения в проверках. Благодаря этому в выводе консоли отображаются полные диаграммы.

1. Чтобы включить Power-assert, добавьте следующую конфигурацию в файл pom.xml проекта:

   <properties> <kotlin.version>2.4.20</kotlin.version> <kotlin.compiler.jdkRelease>17</kotlin.compiler.jdkRelease> </properties> <dependencies> <dependency> <groupId>org.jetbrains.kotlin</groupId> <artifactId>kotlin-test-junit5</artifactId> <version>${kotlin.version}</version> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.jetbrains.kotlin</groupId> <artifactId>kotlin-maven-plugin</artifactId> <version>${kotlin.version}</version> <extensions>true</extensions> <executions> <execution> <id>compile</id> <phase>process-sources</phase> <goals> <goal>compile</goal> </goals> </execution> <execution> <id>test-compile</id> <phase>process-test-sources</phase> <goals> <goal>test-compile</goal> </goals> </execution> </executions> <configuration> <!-- Specify the Power-assert plugin --> <compilerPlugins> <plugin>power-assert</plugin> </compilerPlugins> <!-- Specify the functions to transform --> <pluginOptions> <option>power-assert:function=kotlin.test.assertEquals</option> <option>power-assert:function=kotlin.test.assertTrue</option> </pluginOptions> </configuration> <!-- Add the Power-assert plugin dependency --> <dependencies> <dependency> <groupId>org.jetbrains.kotlin</groupId> <artifactId>kotlin-maven-power-assert</artifactId> <version>${kotlin.version}</version> </dependency> </dependencies> </plugin> </plugins> </build>

   • В разделе <properties> укажите версию Kotlin и целевую версию JDK, например JDK 17.

   • В разделе <dependencies> добавьте kotlin-test-junit5 для запуска тестов.

   • В разделе <build><plugins> настройте kotlin-maven-plugin с помощью плагина компилятора power-assert. Перечислите функции проверки, которые нужно преобразовать, в разделе <pluginOptions> и добавьте зависимость плагина Power-assert.

2. Создайте файл теста UserProfileBackendTest.kt в каталоге src/test/kotlin:

   import kotlin.test.Test
   import kotlin.test.assertEquals
   
   class UserProfileBackendTest {
   
       data class UserProfile(val id: Long, val email: String)
   
       @Test
       fun `verify backend entity mapping matches`() {
           // Define expected object state
           val expectedRecord = UserProfile(id = 451L, email = "admin-dev@company.internal")
   
           // Simulate a mismatched backend response 
           val actualRecord = UserProfile(id = 451L, email = "admin-prod@company.com")
   
           // Use a standard kotlin.test assertion
           assertEquals(expectedRecord, actualRecord, "Profile configurations out of sync")
       }
   }
   

3. Запустите тест и проверьте вывод:

   mvn test
   

В консоли отображается полная диаграмма Power-assert, показывающая разницу между ожидаемыми и фактическими значениями в каждой точке выражения:

Profile configurations out of sync
assertEquals(expectedRecord, actualRecord, "Profile configurations out of sync")
             |               |
             |               UserProfile(id=451, email=admin-prod@company.com)
             UserProfile(id=451, email=admin-dev@company.internal)

Другие фреймворки для тестирования

Помимо JUnit, вы можете использовать другие популярные фреймворки, чтобы сделать тесты на Kotlin более идиоматичными и удобочитаемыми:

Что дальше

• Изучите возможности библиотеки kotlin.test.

• Подробнее узнайте о плагине компилятора Power-assert.