使用 Lincheck 编写你的第一个测试

本教程演示了如何编写你的第一个 Lincheck 测试，设置 Lincheck 框架，并使用其基本 API。你将创建一个新的 IntelliJ IDEA 项目，其中包含一个不正确的并发计数器实现，并为其编写一个测试，之后找出并分析该 bug。

创建项目

在 IntelliJ IDEA 中打开一个现有的 Kotlin 项目，或者创建一个新项目。创建项目时，请使用 Gradle 构建系统。

添加所需依赖项

1. 打开 build.gradle(.kts) 文件，确保 mavenCentral() 已添加到版本库列表。

2. 将以下依赖项添加到 Gradle 配置中：

   KotlinGroovy

   repositories {
       mavenCentral()
   }
   
   dependencies {
       // Lincheck 依赖项
       testImplementation("org.jetbrains.lincheck:lincheck:3.0")
       // 此依赖项允许你使用 kotlin.test 和 JUnit：
       testImplementation("junit:junit:4.13")
   }

   repositories {
       mavenCentral()
   }
   
   dependencies {
       // Lincheck 依赖项
       testImplementation "org.jetbrains.lincheck:lincheck:3.0"
       // 此依赖项允许你使用 kotlin.test 和 JUnit：
       testImplementation "junit:junit:4.13"
   }

编写并发计数器并运行测试

1. 在 src/test/kotlin 目录中，创建一个 BasicCounterTest.kt 文件，并添加以下包含有 bug 的并发计数器及其 Lincheck 测试的代码：

   import org.jetbrains.lincheck.*
   import org.jetbrains.lincheck.datastructures.*
   import org.junit.*
   
   class Counter {
       @Volatile
       private var value = 0
   
       fun inc(): Int = ++value
       fun get() = value
   }
   
   class BasicCounterTest {
       private val c = Counter() // 初始状态
   
       // 对 Counter 的操作
       @Operation
       fun inc() = c.inc()
   
       @Operation
       fun get() = c.get()
   
       @Test // JUnit
       fun stressTest() = StressOptions().check(this::class) // 神奇按钮
   }

   此 Lincheck 测试会自动：

   • 生成多个随机并发场景，其中包含指定的 inc() 和 get() 操作。
   • 对每个生成的场景执行大量调用。
   • 验证每个调用结果的正确性。

2. 运行上述测试，你会看到以下错误：

   = Invalid execution results =
   | ------------------- |
   | Thread 1 | Thread 2 |
   | ------------------- |
   | inc(): 1 | inc(): 1 |
   | ------------------- |

   这里，Lincheck 发现了一个违反计数器原子性的执行——两个并发增量操作最终结果都为 1。这意味着一个增量操作丢失了，并且计数器的行为不正确。

跟踪无效执行

除了显示无效的执行结果，Lincheck 还可以提供导致该错误的交错执行顺序。此特性可通过模型检测测试策略访问，该策略会检查大量具有有限次数上下文切换的执行。

1. 要切换测试策略，将 options 类型从 StressOptions() 替换为 ModelCheckingOptions()。更新后的 BasicCounterTest 类将如下所示：

   import org.jetbrains.lincheck.*
   import org.jetbrains.lincheck.datastructures.*
   import org.junit.*
   
   class Counter {
       @Volatile
       private var value = 0
   
       fun inc(): Int = ++value
       fun get() = value
   }
   
   class BasicCounterTest {
       private val c = Counter()
   
       @Operation
       fun inc() = c.inc()
   
       @Operation
       fun get() = c.get()
   
       @Test
       fun modelCheckingTest() = ModelCheckingOptions().check(this::class)
   }

2. 再次运行测试。你将获得导致不正确结果的执行跟踪：

   = Invalid execution results =
   | ------------------- |
   | Thread 1 | Thread 2 |
   | ------------------- |
   | inc(): 1 | inc(): 1 |
   | ------------------- |
   
   The following interleaving leads to the error:
   | --------------------------------------------------------------------- |
   | Thread 1 |                          Thread  2                         |
   | --------------------------------------------------------------------- |
   |          | inc()                                                      |
   |          |   inc(): 1 at BasicCounterTest.inc(BasicCounterTest.kt:18) |
   |          |     value.READ: 0 at Counter.inc(BasicCounterTest.kt:10)   |
   |          |     switch                                                 |
   | inc(): 1 |                                                            |
   |          |     value.WRITE(1) at Counter.inc(BasicCounterTest.kt:10)  |
   |          |     value.READ: 1 at Counter.inc(BasicCounterTest.kt:10)   |
   |          |   result: 1                                                |
   | --------------------------------------------------------------------- |

   根据跟踪信息，发生了以下事件：

   • T2：第二个线程开始 inc() 操作，读取当前的计数器值 (value.READ: 0) 并暂停。
   • T1：第一个线程执行 inc()，返回 1，并结束。
   • T2：第二个线程恢复执行并递增之前获取的计数器值，错误地将计数器更新为 1。

获取完整代码。

测试 Java 标准库

现在，让我们找出 Java 标准库中的 ConcurrentLinkedDeque 类中的一个 bug。下面的 Lincheck 测试发现了一个在 Deque 头部移除和添加元素之间的竞态条件：

import java.util.concurrent.*
import org.jetbrains.lincheck.*
import org.jetbrains.lincheck.datastructures.*
import org.junit.*

class ConcurrentDequeTest {
    private val deque = ConcurrentLinkedDeque<Int>()

    @Operation
    fun addFirst(e: Int) = deque.addFirst(e)

    @Operation
    fun addLast(e: Int) = deque.addLast(e)

    @Operation
    fun pollFirst() = deque.pollFirst()

    @Operation
    fun pollLast() = deque.pollLast()

    @Operation
    fun peekFirst() = deque.peekFirst()

    @Operation
    fun peekLast() = deque.peekLast()

    @Test
    fun modelCheckingTest() = ModelCheckingOptions().check(this::class)
}

运行 modelCheckingTest()。测试将失败并输出以下内容：

= Invalid execution results =
| ---------------------------------------- |
|      Thread 1     |       Thread 2       |
| ---------------------------------------- |
| addLast(22): void |                      |
| ---------------------------------------- |
| pollFirst(): 22   | addFirst(8): void    |
|                   | peekLast(): 22 [-,1] |
| ---------------------------------------- |

---
All operations above the horizontal line | ----- | happen before those below the line
---
Values in "[..]" brackets indicate the number of completed operations
in each of the parallel threads seen at the beginning of the current operation
---

The following interleaving leads to the error:
| --------------------------------------------------------------------------------------------------------------------------------- |
|                                                Thread 1                                                    |       Thread 2       |
| --------------------------------------------------------------------------------------------------------------------------------- |
| pollFirst()                                                                                                |                      |
|   pollFirst(): 22 at ConcurrentDequeTest.pollFirst(ConcurrentDequeTest.kt:17)                              |                      |
|     first(): Node@1 at ConcurrentLinkedDeque.pollFirst(ConcurrentLinkedDeque.java:915)                     |                      |
|     item.READ: null at ConcurrentLinkedDeque.pollFirst(ConcurrentLinkedDeque.java:917)                     |                      |
|     next.READ: Node@2 at ConcurrentLinkedDeque.pollFirst(ConcurrentLinkedDeque.java:925)                   |                      |
|     item.READ: 22 at ConcurrentLinkedDeque.pollFirst(ConcurrentLinkedDeque.java:917)                       |                      |
|     prev.READ: null at ConcurrentLinkedDeque.pollFirst(ConcurrentLinkedDeque.java:919)                     |                      |
|     switch                                                                                                 |                      |
|                                                                                                            | addFirst(8): void    |
|                                                                                                            | peekLast(): 22       |
|     compareAndSet(Node@2,22,null): true at ConcurrentLinkedDeque.pollFirst(ConcurrentLinkedDeque.java:920) |                      |
|     unlink(Node@2) at ConcurrentLinkedDeque.pollFirst(ConcurrentLinkedDeque.java:921)                      |                      |
|   result: 22                                                                                               |                      |
| --------------------------------------------------------------------------------------------------------------------------------- |

获取完整代码。

下一步

选择你的测试策略并配置测试执行。

另请参见

• 如何生成操作实参
• 常见算法约束
• 检测非阻塞进度保证
• 定义算法的顺序规范