Тестирование мультиплатформенного приложения − руководство

Создание проекта

1. В кратком руководстве выполните инструкции по настройке среды для разработки Kotlin Multiplatform.

2. В IntelliJ IDEA выберите Файл | Создать | Проект.

3. На панели слева выберите Kotlin Multiplatform.

4. В окне Новый проект укажите следующие значения:

   • Имя: KMP testing

   • Идентификатор проекта: kmp.project.testing

5. Выберите целевую платформу Android. Если вы используете Mac, выберите также iOS. Обязательно выберите параметр Не делиться пользовательским интерфейсом.

6. Снимите флажок Добавить тесты и нажмите Создать.

   

Написание кода

В каталоге sharedLogic/src/commonMain/kotlin создайте пакет common.example.search. В этом пакете создайте файл Kotlin Grep.kt со следующей функцией:

fun grep(lines: List<String>, pattern: String, action: (String) -> Unit) {
    val regex = pattern.toRegex()
    lines.filter(regex::containsMatchIn)
        .forEach(action)
}

Эта функция имитирует команду grep в UNIX. Функция принимает строки текста, шаблон в виде регулярного выражения и функцию, которая вызывается при каждом совпадении строки с шаблоном.

Добавление тестов

Теперь протестируем общий код. Важную роль в этом играет набор исходного кода для общих тестов, у которого в качестве зависимости подключена библиотека API kotlin.test.

1. Убедитесь, что в файле sharedLogic/build.gradle.kts есть зависимость от библиотеки kotlin.test:

   sourceSets {
      //...
      commonTest.dependencies {
          implementation(libs.kotlin.test)
      }
   }
   

2. В наборе исходного кода commonTest хранятся все общие тесты. Создайте в проекте каталог с таким же именем:

   1. Щёлкните правой кнопкой мыши каталог sharedLogic/src и выберите Создать | Каталог. В IDE появится список вариантов.

   2. Начните вводить путь commonTest/kotlin, чтобы сузить список вариантов, а затем выберите его:

   

3. В каталоге commonTest/kotlin создайте пакет common.example.search.

4. В этом пакете создайте файл Grep.kt и добавьте в него следующий модульный тест:

   import kotlin.test.Test
   import kotlin.test.assertContains
   import kotlin.test.assertEquals
   
   class GrepTest {
       companion object {
           val sampleData = listOf(
               "123 abc",
               "abc 123",
               "123 ABC",
               "ABC 123"
           )
       }
   
       @Test
       fun shouldFindMatches() {
           val results = mutableListOf<String>()
           grep(sampleData, "[a-z]+") {
               results.add(it)
           }
   
           assertEquals(2, results.size)
           for (result in results) {
               assertContains(result, "abc")
           }
       }
   }
   

Как видите, импортируемые аннотации и проверки не зависят ни от платформы, ни от фреймворка. При запуске этого теста платформозависимый фреймворк предоставит средство запуска тестов.

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

Запустить тест можно следующими способами:

• Запустить тестовую функцию shouldFindMatches() с помощью значка Запустить на полосе рядом с кодом.

• Запустить файл теста через его контекстное меню.

• Запустить тестовый класс GrepTest с помощью значка Запустить на полосе рядом с кодом.

Также можно воспользоваться сочетанием клавиш ⌃ ⇧ F10/Ctrl+Shift+F10. Независимо от выбранного способа, вы увидите список целевых платформ для запуска теста:

Для варианта android тесты запускаются с помощью JUnit 4. Для варианта iosSimulatorArm64 компилятор Kotlin обнаруживает аннотации для тестирования и создаёт тестовый бинарный файл, который запускается собственным средством запуска тестов Kotlin/Native.

Пример вывода после успешного запуска теста:

Написание тестов для общего кода

Вы уже создали тест для общего кода с помощью функции grep(). Теперь рассмотрим более сложный тест общего кода с классом CurrentRuntime. Этот класс содержит сведения о платформе, на которой выполняется код. Например, при локальном запуске модульных тестов Android на JVM в нём могут быть значения «OpenJDK» и «17.0».

Экземпляр CurrentRuntime нужно создать, указав название платформы и её версию в виде строк; версия является необязательной. Если версия указана, достаточно привести начальное число строки, если оно есть.

1. В каталоге commonMain/kotlin создайте пакет org.kmp.testing.

2. В этом пакете создайте файл CurrentRuntime.kt и добавьте в него следующую реализацию:

   class CurrentRuntime(val name: String, rawVersion: String?) {
       companion object {
           val versionRegex = Regex("^[0-9]+(\\.[0-9]+)?")
       }
   
       val version = parseVersion(rawVersion)
   
       override fun toString() = "$name version $version"
   
       private fun parseVersion(rawVersion: String?): String {
           val result = rawVersion?.let { versionRegex.find(it) }
           return result?.value ?: "unknown"
       }
   }
   

3. В каталоге commonTest/kotlin создайте пакет org.kmp.testing.

4. В этом пакете создайте файл CurrentRuntimeTest.kt и добавьте в него следующий тест, не зависящий от платформы и фреймворка:

   import kotlin.test.Test
   import kotlin.test.assertEquals
   
   class CurrentRuntimeTest {
       @Test
       fun shouldDisplayDetails() {
           val runtime = CurrentRuntime("MyRuntime", "1.1")
           assertEquals("MyRuntime version 1.1", runtime.toString())
       }
   
       @Test
       fun shouldHandleNullVersion() {
           val runtime = CurrentRuntime("MyRuntime", null)
           assertEquals("MyRuntime version unknown", runtime.toString())
       }
   
       @Test
       fun shouldParseNumberFromVersionString() {
           val runtime = CurrentRuntime("MyRuntime", "1.2 Alpha Experimental")
           assertEquals("MyRuntime version 1.2", runtime.toString())
       }
   
       @Test
       fun shouldHandleMissingVersion() {
           val runtime = CurrentRuntime("MyRuntime", "Alpha Experimental")
           assertEquals("MyRuntime version unknown", runtime.toString())
       }
   }
   

Этот тест можно запустить любым из доступных в IDE способов.

Добавление платформозависимых тестов

Теперь, когда вы научились писать тесты для общего кода, рассмотрим написание платформозависимых тестов для Android и iOS.

Чтобы создать экземпляр CurrentRuntime, объявите функцию в общем файле CurrentRuntime.kt следующим образом:

expect fun determineCurrentRuntime(): CurrentRuntime

Для каждой поддерживаемой платформы нужно предоставить отдельную реализацию функции. В противном случае сборка завершится с ошибкой. Помимо реализации этой функции на каждой платформе, следует добавить тесты. Давайте создадим их для Android и iOS.

Запуск нескольких тестов и анализ отчётов

Теперь у вас есть код для общего кода, реализаций Android и iOS, а также соответствующие тесты. Структура каталогов проекта должна выглядеть примерно так:

Отдельные тесты можно запускать из контекстного меню или с помощью сочетания клавиш. Ещё один способ — использовать задачи Gradle. Например, если запустить задачу Gradle allTests, все тесты проекта будут выполнены соответствующими средствами запуска:

При запуске тестов, помимо вывода в IDE, создаются HTML-отчёты. Их можно найти в каталоге sharedLogic/build/reports/tests:

Запустите задачу allTests и изучите созданные отчёты:

• Файл allTests/index.html содержит объединённые отчёты об общих тестах и тестах iOS (тесты iOS зависят от общих тестов и выполняются после них).

• Папки testDebugUnitTest и testReleaseUnitTest содержат отчёты для обоих вариантов сборки Android по умолчанию. (В настоящее время отчёты о тестах Android не объединяются автоматически с отчётом allTests.)