作为库的一部分提供测试

Question

假设一个接口像：

public interface Fooer {
  void foo();
  boolean isFooed();
}

这是我正在编写的 Java 库的一部分。这个库的用户应该实现这个接口并将对象传递到我的库中。

我想为用户提供一种方法来测试他们的实现以保持我的库代码假设的不变量。

按照上面的例子：

Fooer f = getUsersFooer();
f.foo();
// f.isFooed() MUST return true now

是否有可能提供此类测试作为库的一部分，如果可以，是否可行甚至可以接受？

（我不知道这些是否会被视为单元测试或集成测试......他们使用 getter 方法或非常原始的非变异方法测试由单个方法所做的修改）

当然，我可以编写类似的类

public class TestFooer {
  public static boolean test(Fooer f) {
    // ...
  }
}

但是有没有一种“标准方式”，使用通常的测试框架（JUnit，...）？

Answer 1

这是一种常见的模式，用于检查某些规范实现的合规性。这称为 TCK，Technology Compatibility Kit。很多TCK的代码我没看过，但是经常看到他们用TestNG。

最近在 JUnit 5.8.0-M1 中添加了一个允许定义可用于此目的的测试套件。

您的 TCK 对您的 API 和 org.junit.jupiter:junit-jupiter（至少 5.8.0-M1）加上 org.junit.platform:junit-platform-suite（至少 1.8.0-M1）有一个非测试依赖。测试不在src/test/java，而是src/main/java。然后向 TCK 添加一个套件类，例如：

package org.example;

import org.junit.platform.suite.api.SelectPackages;
import org.junit.platform.suite.api.Suite;

@Suite
@SelectPackages("org.example")
public abstract class TestCompatibilityKitSuite {}

请注意，这个类不必是抽象的，我只是认为它使预期的用途更加清晰。

然后，该实现依赖于api 和一个test 依赖于tck。要运行测试，请添加如下类：

package test;

import org.example.TestCompatibilityKitSuite;

class TckTest extends TestCompatibilityKitSuite {}

TCK 必须加载实现。一个好方法是使用java.util.ServiceLoader。有关完整示例，请查看 here。