Lincheck в проектах Kotlin Multiplatform

Настройка проекта

1. Создайте новый проект Kotlin Multiplatform в IntelliJ IDEA. При создании проекта убедитесь, что:

   • Установлен флажок Include tests.

   • В проекте есть цель на базе JVM (серверная, настольная или Android). Проверить, что код компилируется для JVM, можно, просмотрев файл shared/build.gradle.kts или core/build.gradle.kts:

     kotlin { 
         // ...
     
         jvm()
     
         // ...
     
         // If you have an Android target, the use of JVM is
         // configured in the `androidLibrary` section
         androidLibrary {
             // ...
     
             compilerOptions {
                 jvmTarget = JvmTarget.JVM_11
             }
     
         // ...
     
         }
     }
     

2. Настройте папку для тестов и зависимость Lincheck в соответствии с целевыми платформами проекта:

   • Desktop/Android + iOS

   • Server + iOS, Server + Desktop, Server + Desktop + iOS

    // shared/build.gradle.kts
    kotlin {
        sourceSets {
            commonTest.dependencies {
                implementation(libs.kotlin.test)
            }
            jvmTest {
                implementation("org.jetbrains.lincheck:lincheck:3.7")
            }
        }
    }
    

    // shared/build.gradle.kts
    kotlin {
        sourceSets {
            commonTest.dependencies {
                implementation(libs.kotlin.test)
            }
            getByName("androidHostTest").dependencies {
                implementation("org.jetbrains.lincheck:lincheck:3.7")
            }
        }
    }
    

Создание общих классов

Создайте классы, реализующие структуры данных-счетчики, общие для всех платформ:

1. Создайте файл UnsafeCounter.kt в каталоге core/src/commonMain или shared/src/commonMain:

   class UnsafeCounter {
       private var value: Int = 0
   
       fun inc() = value++
   
       fun get(): Int = value
   }
   

2. Создайте файл SafeCounter.kt в том же каталоге:

   import kotlin.concurrent.atomics.AtomicInt
   import kotlin.concurrent.atomics.ExperimentalAtomicApi
   
   @OptIn(ExperimentalAtomicApi::class)
   class SafeCounter {
       private var value = AtomicInt(0)
   
       fun inc() = value.addAndFetch(1)
   
       fun get(): Int = value.load()
   }

Написание общих тестов

Напишите тесты, которые запускаются для всех платформ:

1. Создайте файл UnsafeCounterTest.kt в каталоге core/src/commonTest или shared/src/commonTest:

   import kotlin.test.Test
   import kotlin.test.assertEquals
   
   class UnsafeCounterTest {
       @Test
       fun testIncrement() {
           val counter = UnsafeCounter()
           assertEquals(0, counter.get(), "Initial value should be 0")
           counter.inc()
           assertEquals(1, counter.get(), "Value after one increment should be 1")
       }
   }

2. Создайте файл SafeCounterTest.kt в том же каталоге:

   import kotlin.test.Test
   import kotlin.test.assertEquals
   
   class SafeCounterTest {
       @Test
       fun testIncrement() {
           val counter = SafeCounter()
           assertEquals(0, counter.get(), "Initial value should be 0")
           counter.inc()
           assertEquals(1, counter.get(), "Value after one increment should be 1")
       }
   }

Написание тестов для JVM

Напишите тесты, которые запускаются только на платформах, предназначенных для JVM:

1. Создайте файл UnsafeCounterConcurrentTest.kt в каталоге тестов для тестов, предназначенных только для JVM:

   • Android + iOS — shared/src/androidHostTest/kotlin

   • Desktop + iOS — shared/src/jvmTest/kotlin

   • Любой проект с серверной целью — core/src/jvmTest/kotlin

   import org.jetbrains.lincheck.datastructures.ModelCheckingOptions
   import org.jetbrains.lincheck.datastructures.Operation
   import kotlin.test.Test
   
   class UnsafeCounterConcurrentTest {
       private val c = UnsafeCounter()
   
       @Operation
       fun inc() = c.inc()
   
       @Operation
       fun get() = c.get()
   
       @Test
       fun modelCheckingTest() {
           ModelCheckingOptions().check(this::class)
       }
   }

2. Создайте файл SafeCounterConcurrentTest.kt в том же каталоге:

   import org.jetbrains.lincheck.datastructures.ModelCheckingOptions
   import org.jetbrains.lincheck.datastructures.Operation
   import kotlin.test.Test
   
   class SafeCounterConcurrentTest {
       private val c = SafeCounter()
   
       @Operation
       fun inc() = c.inc()
   
       @Operation
       fun get() = c.get()
   
       @Test
       fun modelCheckingTest() {
           ModelCheckingOptions().check(this::class)
       }
   }

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

На этом этапе в проекте должны быть общая реализация структур данных-счетчиков, общие тесты и тесты счетчиков, предназначенные только для JVM. Структура каталогов проекта должна выглядеть так:

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

Например, тесты, предназначенные только для JVM, выполняются с помощью средства запуска тестов JVM:

Поддержка платформ, отличных от JVM

Маловероятно, что в будущем Lincheck будет поддерживать другие платформы.

Lincheck в значительной степени полагается на JVM для манипуляций с байт-кодом, что затрудняет реализацию модельной проверки на других платформах. Кроме того, одновременное применение модельной проверки для нескольких платформ не дает существенных преимуществ, поскольку Lincheck тестирует код в детерминированной изолированной среде, и результаты тестов не зависят от платформы.

См. также

• Узнайте больше о Kotlin Multiplatform

• Ознакомьтесь с документацией Lincheck