JUnit 5 –动态测试

在定义测试时,JUnit 4有一个很大的弱点:它必须在编译时发生。 现在,JUnit 5将解决此问题! Milestone 1 刚刚发布 ,并带有全新的动态测试,该动态测试允许在运行时创建测试。

总览

本系列中有关JUnit 5的其他文章:

本系列基于预发行版本Milestone 1 ,当然可以随时更改。 发布新的里程碑或一般可用性版本时,帖子将更新。


您将在此处阅读的大部分内容和更多内容都可以在新兴的JUnit 5用户指南中找到 (该链接已链接到Milestone 1版本–您可以在此处找到最新版本)。 我在这里显示的代码示例可以在GitHub上找到

静态测试

JUnit 3通过解析方法名称并检查它们是否以测试开头来识别测试。 JUnit 4利用了(后来的)注解,并引入了@Test,这给了我们更多的自由。 这两种技术共享相同的方法:测试是在编译时定义的。

但是,事实证明这是非常有限的。 例如,考虑一种常见情况,即应该对多种输入数据执行相同的测试,在这种情况下,应针对许多不同点:

void testDistanceComputation(Point p1, Point p2, double distance) {
	assertEquals(distance, p1.distanceTo(p2));
}

我们有什么选择? 最直接的方法是创建许多有趣的点,然后在循环中调用我们的测试方法:

@Test
void testDistanceComputations() {
	List<PointPointDistance> testData = createTestData();
	for (PointPointDistance datum : testData) {
		testDistanceComputation(
			datum.point1(), datum.point2(), datum.distance());
	}
}

但是,如果这样做,JUnit会将循环视为单个测试。 这意味着仅在第一个失败之前执行测试,报告将受到影响,并且工具支持通常低于标准。

有几个JUnit 4功能和扩展可解决此问题。 它们或多或少都可以工作,但通常仅限于特定的用例( Theories ), 难以使用Parameterized ),并且通常需要运行程序(如值得称赞的JUnitParams )。 原因是它们都受到相同的限制:JUnit 4确实不支持在运行时创建测试。

使用lambda创建测试也是如此。 有些人想定义这样的测试:

class PointTest {
 
	"Distance To Origin" -> {
		Point origin = Point.create(0,0);
		Point p = Point.create(3,4);
		assertEquals(5, origin.distanceTo(p));
	}
 
}

当然,这只是一个理想选择-它甚至无法在Java中进行编译。 尽管如此,看到我们能达到多近还是很有趣的。 las,也无法静态标识各个lambda,因此此处也有相同的限制。

但是,如果JUnit 5没有提出解决方案,我不会写所有这些内容:进行动态测试以解决问题!
JUnit 5 –动态测试

动态测试

从最近开始,JUnit 5代码库就采用了一种新类型和一种新注释,它们共同解决了我们的问题。

首先,有DynamicTest ,它是测试的简单包装。 它有一个名称,并保存构成测试主体的代码。 后者以Executable的形式发生,就像Runnable但是可以抛出任何Throwable (可格式化的命名)。 它是使用静态工厂方法创建的:

public static DynamicTest dynamicTest(String name, Executable test);

然后是@TestFactory ,可以注释方法。 这些方法必须返回动态测试的IteratorIterableStream (这当然不能在编译时强制执行,因此,如果我们返回其他内容,JUnit将在运行时发出barf。)

很容易看出他们是如何合作的:

  1. 当寻找@Test方法时,JUnit还将发现@TestFactory方法。
  2. 在构建测试树时,它将执行这些方法并将生成的测试添加到树中。
  3. 最终,将执行测试。

因此,我们能够在运行时动态创建测试:

@TestFactory
List<DynamicTest> createPointTests() {
	return Arrays.asList(
		DynamicTest.dynamicTest(
			"A Great Test For Point",
			() -> {
				// test code
			}),
		DynamicTest.dynamicTest(
			"Another Great Test For Point",
			() -> {
				// test code
			})
	);
}

让我们看看如何使用它来解决我们上面描述的问题。

要创建参数化测试,我们执行与之前非常相似的操作:

@TestFactory
Stream<DynamicTest> testDistanceComputations() {
	List<PointPointDistance> testData = createTestData();
	return testData.stream()
		.map(datum -> DynamicTest.dynamicTest(
			"Testing " + datum,
			() -> testDistanceComputation(
				datum.point1(), datum.point2(), datum.distance()
		)));
}

与上面所做的操作的关键区别在于,我们不再直接执行testDistanceComputation 取而代之的是,我们为每个数据创建一个动态测试,这意味着JUnit将知道这些测试很多,而不仅仅是一个。

在这种情况下,我们可能会使用其他方法来生成动态测试:

@TestFactory
Stream<DynamicTest> testDistanceComputations() {
	return DynamicTest.stream(
		createTestData().iterator(),
		datum -> "Testing " + datum,
		datum -> testDistanceComputation(
				datum.point1(), datum.point2(), datum.distance()));
}

在这里,我们将测试数据stream ,然后告诉它如何从中创建名称和测试。

所以你怎么看? 也许符合“ JUnit 5将这些作为单独的测试来对待,但是从语法上来看仍然很麻烦”的思路吗? 好吧,至少我是这样认为的。 该功能很好,但有点笨拙。

但这只是里程碑1,因此有足够的时间进行改进。 也许扩展可以提供一种更舒适的方式来创建动态测试,但是我不太清楚如何。 我想, 新的扩展点会有所帮助。

Lambda测试

好的,让我们看看我们距离备受期待的lambda测试有多近。 现在,没有为此明确创建动态测试,因此我们必须进行一些修改。 (这种修补是错误的,受Jens Schauder 关于JUnit 5演示之一“启发”。谢谢Jens!)

动态测试需要一个名称和一个可执行文件,用lambda创建后者听起来很合理。 为了能够做到这一点,我们需要一个目标,即lambda被分配给的目标。 想到一个方法参数...

但是该方法会做什么? 显然,它应该创建一个动态测试,然后呢? 也许我们可以将该测试转储到某个地方,然后让JUnit进行测试?

public class LambdaTest {
 
	private final List<DynamicTest> tests = new ArrayList<>();
 
	// use lambda to create the 'Executable'
	public void registerTest(String name, Executable test) {
		tests.add(DynamicTest.dynamicTest(name, test));
	}
 
	@TestFactory
	void List<DynamicTest> tests() {
		return tests;
	}
 
}

好的,这看起来很有希望。 但是,我们从哪里获得LambdaTest的实例? 对于我们的测试类,最简单的解决方案是简单地对其进行扩展,然后重复调用registerTest 如果这样做的话,我们可能更愿意使用一个较短的名称。 我们还可以使其受到保护:

// don't do this at home!
protected void λ(String name, Executable test) {
	tests.add(DynamicTest.dynamicTest(name, test));
}

看来我们要到达那里。 剩下的就是调用λ ,并且唯一明显的方法是从测试类的构造函数内部进行:

class PointTest extends LambdaTest {
 
	public PointTest() {
		λ("A Great Test For Point", () -> {
			// test code
		})
	}
 
}

我们已经完成修补工作。 为了进一步发展,我们必须开始黑客攻击。 有没有听说过双括号初始化 这是一个有点奇怪的功能,它创建一个匿名子类并在新类的构造函数中执行给定的代码。 有了它,我们可以走得更远:

class PointTest extends LambdaTest {{
 
	λ("A Great Test For Point", () -> {
		// test code
	});
 
}}

如果我们真的很渴望,我们可以删除另外两个符号。 有了这个怪异的技巧 (我们现在受到Benji Weber的启发),我们可以通过反射来确定lambda的参数名称,并将其用作测试的名称。 要利用这一点,我们需要一个新的接口,并且必须稍微更改LambdaTest ::λ:

@FunctionalInterface
// the interface we are extending here allows us
// to retrieve the parameter name via 'prettyName()'
// (the black magic is hidden inside that method;
//  look at 'MethodFinder' and 'NamedValue' in Benji's post)
public interface NamedTest extends ParameterNameFinder {
	void execute(String name);
}
 
protected void λ(NamedTest namedTest) {
	String name = namedTest.prettyName();
	Executable test = () -> namedTest.execute(name);
	tests.add(DynamicTest.dynamicTest(name, test));
}

综上所述,我们可以创建如下测试:

class PointTest extends LambdaTest {{
 
	λ(A_Great_Test_For_Point -> {
		// test code
	});
 
}}

你怎么看? 所有这些黑客值得吗? 老实说,我不介意让我的IDE生成测试方法样板,所以我的回答是“否”。 但这是一个有趣的实验。 :)

生命周期

动态测试的当前实现是故意的。 这种显示方式之一是它们没有集成到生命周期中。 从用户指南中:

这意味着对于动态测试,不会执行@BeforeEach和@AfterEach方法及其对应的扩展回调。 换句话说,如果您在lambda表达式中访问来自测试实例的字段以进行动态测试,则这些字段将不会由回调方法或由同一@TestFactory方法生成的动态测试在执行之间的扩展名进行重置。

不过,已经有一个问题可以解决

反射

那我们看到了什么? 到目前为止,JUnit只知道在编译时声明的测试。 JUnit 5具有动态测试的概念,动态测试是在运行时创建的,由名称和保存测试代码的可执行文件组成。 到此为止,我们已经看到了如何创建参数化测试以及如何使用lambda来以更现代的风格定义测试。

你怎么看? 渴望尝试吗?

翻译自: https://www.javacodegeeks.com/2016/07/junit-5-dynamic-tests.html