單元測試是每個程序員必備的技能，而Runner是每個單元測試類必有屬性。本文通過解讀Junit源碼，介紹junit中每個執行器的使用方法，讓讀者在單元測試時，可以靈活的使用Runner執行器。
一、背景
在今年的敏捷團隊建設中，京東物流通過Suite執行器實現了一鍵自動化單元測試。Juint除了Suite執行器還有哪些執行器呢？由此京東物流的Runner探索之旅開始了！
二、RunWith
RunWith的註釋是當一個類用@RunWith註釋或擴展一個用@RunWith註釋的類時，JUnit將調用它引用的類來運行該類中的測試，而不是內置到JUnit中的運行器，就是測試類根據指定運行方式進行運行。
代碼如下：
public @interface RunWith {
Class<? extends Runner> value();
}
其中：Runner 就是指定的運行方式。
三、Runner
Runner的作用是告訴Junit如何運行一個測試類，它是一個抽象類。通過RunWith 指定具體的實現類，如果不指定默認使用BlockJUnit4ClassRunner，Runner的代碼如下：
public abstract class Runner implements Describable {
public abstract Description getDescription();
public abstract void run(RunNotifier notifier);
public int testCount() {
return getDescription().testCount();
}
}
3.1 ParentRunner
ParentRunner是一個抽象類，提供了大多數特定於運行器的功能，是經常使用運行器的父節點。實現了Filterable,Sortable接口，可以過濾和排序子對象。
提供了3個抽象方法：
protected abstract List<T> getChildren();
protected abstract Description describeChild(T child);
protected abstract void runChild(T child, RunNotifier notifier);
3.1.1 BlockJUnit4ClassRunner
BlockJUnit4ClassRunner是Juint4默認的運行器，具有與舊的測試類運行器(JUnit4ClassRunner)完全相同的行爲。
ParentRunner3個抽象方法的實現如下：
@Override
protected void runChild(final FrameworkMethod method, RunNotifier notifier) {
Description description = describeChild(method);
if (isIgnored(method)) {
notifier.fireTestIgnored(description);
} else {
runLeaf(methodBlock(method), description, notifier);
}
}
@Override
protected Description describeChild(FrameworkMethod method) {
Description description = methodDescriptions.get(method);
if (description == null) {
description = Description.createTestDescription(getTestClass().getJavaClass(),
testName(method), method.getAnnotations());
methodDescriptions.putIfAbsent(method, description);
}
return description;
}
@Override
protected List<FrameworkMethod> getChildren() {
return computeTestMethods();
}
runChild() :
-
調用describeChild()
-
判斷方法是否包含@Ignore註解，有就觸發TestIgnored事件通知
-
構造Statement回調，通過methodBlock()構造並裝飾測試方法
-
執行測試方法調用statement.evaluate()
describeChild() : 對測試方法創建Description並進行緩存
getChildren():返回運行測試的方法。 默認實現返回該類和超類上所有用@Test標註的未重寫的方法
3.1.2 BlockJUnit4ClassRunnerWithParameters
BlockJUnit4ClassRunnerWithParameters是一個支持參數的BlockJUnit4ClassRunner。參數可以通過構造函數注入或注入到帶註釋的字段中。參數包含名稱、測試類和一組參數。
private final Object[] parameters;
private final String name;
public BlockJUnit4ClassRunnerWithParameters(TestWithParameters test)
throws InitializationError {
super(test.getTestClass().getJavaClass());
parameters = test.getParameters().toArray(
new Object[test.getParameters().size()]);
name = test.getName();
}
參數代碼如下：
public class TestWithParameters {
private final String name;
private final TestClass testClass;
private final List<Object> parameters;
public TestWithParameters(String name, TestClass testClass,
List<Object> parameters) {
notNull(name, "The name is missing.");
notNull(testClass, "The test class is missing.");
notNull(parameters, "The parameters are missing.");
this.name = name;
this.testClass = testClass;
this.parameters = unmodifiableList(new ArrayList<Object>(parameters));
}
BlockJUnit4ClassRunnerWithParameters一般結合Parameterized使用
3.1.3 Theories
Theories允許對無限數據點集的子集測試某種功能。提供一組參數的排列組合值作爲待測方法的輸入參數。同時注意到在使用Theories這個Runner的時候，待測方法可以擁有輸入參數，可以使您的測試更加靈活。
測試代碼如下：
@RunWith(Theories.class)
public class TheoriesTest {
@DataPoints
public static String[] tables = {"方桌子", "圓桌子"};
@DataPoints
public static int[] counts = {4,6,8};
@Theory
public void testMethod(String table, int count){
System.out.println(String.format("一套桌椅有一個%s和%d個椅子", table, count));
}
}
運行結果：
圖2 Theories測試代碼的執行結果
3.1.4 JUnit4
JUnit4是Junit4默認執行器的別名，想要顯式地將一個類標記爲JUnit4類,應該使用@RunWith(JUnit4.class)，而不是，使用@RunWith(BlockJUnit4ClassRunner.class)
3.1.5 Suite
Suite允許您手動構建包含來自許多類的測試的套件.通過Suite.SuiteClasses定義要執行的測試類，一鍵執行所有的測試類。
測試代碼如下：
@RunWith(Suite.class)
@Suite.SuiteClasses({Suite_test_a.class,Suite_test_b.class,Suite_test_c.class })
public class Suite_main {
}
public class Suite_test_a {
@Test
public void testRun(){
System.out.println("Suite_test_a_running");
}
}
public class Suite_test_b {
@Test
public void testRun(){
System.out.println("Suite_test_b_running");
}
}
public class Suite_test_c {
@Test
public void testRun(){
System.out.println("Suite_test_c_running");
}
}
執行結果：
圖3 Suite測試代碼的執行結果
如結果所示：執行MainSuit時依次執行了Suite_test_a，Suite_test_b,Suite_test_c 的方法，實現了一鍵執行。
3.1.6 Categories
Categories在給定的一組測試類中，只運行用帶有@ inclecategory標註的類別或該類別的子類型標註的類和方法。通過ExcludeCategory過濾類型。
測試代碼如下：
public interface BlackCategory {}
public interface WhiteCategory {}
public class Categories_test_a {
@Test
@Category(BlackCategory.class)
public void testFirst(){
System.out.println("Categories_test_a_testFirst_running");
}
@Test
@Category(WhiteCategory.class)
public void testSecond(){
System.out.println("Categories_test_a_testSecond_running");
}
}
public class Categories_test_b {
@Test
@Category(WhiteCategory.class)
public void testFirst(){
System.out.println("Categories_test_b_testFirst_running");
}
@Test
@Category(BlackCategory.class)
public void testSecond(){
System.out.println("Categories_test_b_testSecond_running");
}
}
執行帶WhiteCategory的方法
@RunWith(Categories.class)
@Categories.IncludeCategory(WhiteCategory.class)
@Categories.ExcludeCategory(BlackCategory.class)
@Suite.SuiteClasses( { Categories_test_a.class, Categories_test_b.class })
public class Categories_main {
}
運行結果:
圖4 Categories測試代碼WhiteCategory分組執行結果
執行帶BlackCategory的方法
@RunWith(Categories.class)
@Categories.IncludeCategory(BlackCategory.class)
@Categories.ExcludeCategory(WhiteCategory.class)
@Suite.SuiteClasses( { Categories_test_a.class, Categories_test_b.class })
public class Categories_main {
}
運行結果：
圖5 Categories測試代碼BlackCategory分組執行結果
如運行結果所示，通過IncludeCategory，ExcludeCategory可以靈活的運行具體的測試類和方法。
3.1.7 Enclosed
Enclosed使用Enclosed運行外部類，內部類中的測試將被運行。 您可以將測試放在內部類中，以便對它們進行分組或共享常量。
測試代碼：
public class EnclosedTest {
@Test
public void runOutMethou(){
System.out.println("EnclosedTest_runOutMethou_running");
}
public static class EnclosedInnerTest {
@Test
public void runInMethou(){
System.out.println("EnclosedInnerTest_runInMethou_running");
}
}
}
運行結果：沒有執行內部類的測試方法。
圖6 Enclosed測試代碼的執行結果
使用Enclosed執行器：
@RunWith(Enclosed.class)
public class EnclosedTest {
@Test
public void runOutMethou(){
System.out.println("EnclosedTest_runOutMethou_running");
}
public static class EnclosedInnerTest {
@Test
public void runInMethou(){
System.out.println("EnclosedInnerTest_runInMethou_running");
}
}
}
執行結果：執行了內部類的測試方法。
圖7 Enclosed測試代碼的執行結果
3.1.8 Parameterized
Parameterized實現參數化測試。 運行參數化的測試類時，會爲測試方法和測試數據元素的交叉乘積創建實例。
Parameterized包含一個提供數據的方法，這個方法必須增加Parameters註解，並且這個方法必
須是靜態static的，並且返回一個集合Collection，Collection中的值長度必須相等。
測試代碼：
@RunWith(Parameterized.class)
public class ParameterizedTest {
@Parameterized.Parameters
public static Collection<Object[]> initData(){
return Arrays.asList(new Object[][]{
{"小白",1,"雞腿"},{"小黑",2,"麪包"},{"小紅",1,"蘋果"}
});
}
private String name;
private int count;
private String food;
public ParameterizedTest(String name, int count, String food) {
this.name = name;
this.count = count;
this.food = food;
}
@Test
public void eated(){
System.out.println(String.format("%s中午吃了%d個%s",name,count,food));
}
}
運行結果：
圖8 Parameterized測試代碼的執行結果
3.2 JUnit38ClassRunner
JUnit38ClassRunner及其子類是Junit4的內部運行器，有一個內部類OldTestClassAdaptingListener
實現了TestListener接口。
3.3 ErrorReportingRunner
ErrorReportingRunner也是Junit4運行錯誤時拋出的異常，代碼如下：
private final List<Throwable> causes;
public ErrorReportingRunner(Class<?> testClass, Throwable cause) {
if (testClass == null) {
throw new NullPointerException("Test class cannot be null");
}
this.testClass = testClass;
causes = getCauses(cause);
}
private List<Throwable> getCauses(Throwable cause) {
if (cause instanceof InvocationTargetException) {
return getCauses(cause.getCause());
}
if (cause instanceof InitializationError) {
return ((InitializationError) cause).getCauses();
}
if (cause instanceof org.junit.internal.runners.InitializationError) {
return ((org.junit.internal.runners.InitializationError) cause)
.getCauses();
}
return Arrays.asList(cause);
}
當junit運行錯誤時，會拋出ErrorReportingRunner，例如：
public Runner getRunner() {
try {
Runner runner = request.getRunner();
fFilter.apply(runner);
return runner;
} catch (NoTestsRemainException e) {
return new ErrorReportingRunner(Filter.class, new Exception(String
.format("No tests found matching %s from %s", fFilter
.describe(), request.toString())));
}
}
3.4 IgnoredClassRunner
IgnoredClassRunner是當測試的方法包含Ignore註解時，會忽略該方法。
public class IgnoredClassRunner extends Runner {
private final Class<?> clazz;
public IgnoredClassRunner(Class<?> testClass) {
clazz = testClass;
}
@Override
public void run(RunNotifier notifier) {
notifier.fireTestIgnored(getDescription());
}
@Override
public Description getDescription() {
return Description.createSuiteDescription(clazz);
}
}
IgnoredClassRunner的使用
public class IgnoredBuilder extends RunnerBuilder {
@Override
public Runner runnerForClass(Class<?> testClass) {
if (testClass.getAnnotation(Ignore.class) != null) {
return new IgnoredClassRunner(testClass);
}
return null;
}
}
當測試時想忽略某些方法時，可以通過繼承IgnoredClassRunner增加特定註解實現。
四、小結
Runner探索之旅結束了，可是單元測試之路纔剛剛開始。不同的Runner組合，讓單元測試更加靈活，測試場景更加豐富，更好的實現了測試驅動開發，讓系統更加牢固可靠。
作者：京東物流 陳昌浩
來源：京東雲開發者社區