條件測試

JUnit5支援條件註解,根據布林值判斷是否執行測試。

自定義條件

@EnabledIf@DisabledIf註解用來設定自定義條件,示例:

@Test
@EnabledIf("customCondition")
void enabled() {
// ...
} @Test
@DisabledIf("customCondition")
void disabled() {
// ...
} boolean customCondition() {
return true;
}

其中customCondition()方法用來返回布林值,它可以接受一個ExtensionContext型別的引數。如果定義在測試類外部,那麼需要是static方法。

內建條件

JUnit5的org.junit.jupiter.api.condition包中內建了一些條件註解。

作業系統條件

@EnabledOnOsDisabledOnOs,示例:

@Test
@EnabledOnOs(MAC)
void onlyOnMacOs() {
// ...
} @TestOnMac
void testOnMac() {
// ...
} @Test
@EnabledOnOs({ LINUX, MAC })
void onLinuxOrMac() {
// ...
} @Test
@DisabledOnOs(WINDOWS)
void notOnWindows() {
// ...
} @Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Test
@EnabledOnOs(MAC)
@interface TestOnMac {
}

JRE條件

@EnabledOnJre@DisabledOnJre用於指定版本,@EnabledForJreRange@DisabledForJreRange用於指定版本範圍,示例:

@Test
@EnabledOnJre(JAVA_8)
void onlyOnJava8() {
// ...
} @Test
@EnabledOnJre({ JAVA_9, JAVA_10 })
void onJava9Or10() {
// ...
} @Test
@EnabledForJreRange(min = JAVA_9, max = JAVA_11)
void fromJava9to11() {
// ...
} @Test
@EnabledForJreRange(min = JAVA_9)
void fromJava9toCurrentJavaFeatureNumber() {
// ...
} @Test
@EnabledForJreRange(max = JAVA_11)
void fromJava8To11() {
// ...
} @Test
@DisabledOnJre(JAVA_9)
void notOnJava9() {
// ...
} @Test
@DisabledForJreRange(min = JAVA_9, max = JAVA_11)
void notFromJava9to11() {
// ...
} @Test
@DisabledForJreRange(min = JAVA_9)
void notFromJava9toCurrentJavaFeatureNumber() {
// ...
} @Test
@DisabledForJreRange(max = JAVA_11)
void notFromJava8to11() {
// ...
}

JVM系統屬性條件

@EnabledIfSystemProperty@DisabledIfSystemProperty,示例:

@Test
@EnabledIfSystemProperty(named = "os.arch", matches = ".*64.*")
void onlyOn64BitArchitectures() {
// ...
} @Test
@DisabledIfSystemProperty(named = "ci-server", matches = "true")
void notOnCiServer() {
// ...
}

環境變數條件

@EnabledIfEnvironmentVariable@DisabledIfEnvironmentVariable,示例:

@Test
@EnabledIfEnvironmentVariable(named = "ENV", matches = "staging-server")
void onlyOnStagingServer() {
// ...
} @Test
@DisabledIfEnvironmentVariable(named = "ENV", matches = ".*development.*")
void notOnDeveloperWorkstation() {
// ...
}

巢狀測試

巢狀測試可以幫助我們對測試結構進行分層。藉助於Java巢狀類的語法,JUnit5可以通過@Nested註解,實現巢狀測試,示例:

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue; import java.util.EmptyStackException;
import java.util.Stack; import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test; @DisplayName("A stack")
class TestingAStackDemo { Stack<Object> stack; @Test
@DisplayName("is instantiated with new Stack()")
void isInstantiatedWithNew() {
new Stack<>();
} @Nested
@DisplayName("when new")
class WhenNew { @BeforeEach
void createNewStack() {
stack = new Stack<>();
} @Test
@DisplayName("is empty")
void isEmpty() {
assertTrue(stack.isEmpty());
} @Test
@DisplayName("throws EmptyStackException when popped")
void throwsExceptionWhenPopped() {
assertThrows(EmptyStackException.class, stack::pop);
} @Test
@DisplayName("throws EmptyStackException when peeked")
void throwsExceptionWhenPeeked() {
assertThrows(EmptyStackException.class, stack::peek);
} @Nested
@DisplayName("after pushing an element")
class AfterPushing { String anElement = "an element"; @BeforeEach
void pushAnElement() {
stack.push(anElement);
} @Test
@DisplayName("it is no longer empty")
void isNotEmpty() {
assertFalse(stack.isEmpty());
} @Test
@DisplayName("returns the element when popped and is empty")
void returnElementWhenPopped() {
assertEquals(anElement, stack.pop());
assertTrue(stack.isEmpty());
} @Test
@DisplayName("returns the element when peeked but remains not empty")
void returnElementWhenPeeked() {
assertEquals(anElement, stack.peek());
assertFalse(stack.isEmpty());
}
}
}
}

外部測試類通過@BeforeEach向內部測試類傳遞變數。

執行後結果:

重複測試

@RepeatedTest註解能控制測試方法的重複執行次數,示例:

import static org.junit.jupiter.api.Assertions.assertEquals;

import java.util.logging.Logger;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.RepeatedTest;
import org.junit.jupiter.api.RepetitionInfo;
import org.junit.jupiter.api.TestInfo; class RepeatedTestsDemo { private Logger logger = // ... @BeforeEach
void beforeEach(TestInfo testInfo, RepetitionInfo repetitionInfo) {
int currentRepetition = repetitionInfo.getCurrentRepetition();
int totalRepetitions = repetitionInfo.getTotalRepetitions();
String methodName = testInfo.getTestMethod().get().getName();
logger.info(String.format("About to execute repetition %d of %d for %s", //
currentRepetition, totalRepetitions, methodName));
} @RepeatedTest(10)
void repeatedTest() {
// ...
} @RepeatedTest(5)
void repeatedTestWithRepetitionInfo(RepetitionInfo repetitionInfo) {
assertEquals(5, repetitionInfo.getTotalRepetitions());
} @RepeatedTest(value = 1, name = "{displayName} {currentRepetition}/{totalRepetitions}")
@DisplayName("Repeat!")
void customDisplayName(TestInfo testInfo) {
assertEquals("Repeat! 1/1", testInfo.getDisplayName());
} @RepeatedTest(value = 1, name = RepeatedTest.LONG_DISPLAY_NAME)
@DisplayName("Details...")
void customDisplayNameWithLongPattern(TestInfo testInfo) {
assertEquals("Details... :: repetition 1 of 1", testInfo.getDisplayName());
} @RepeatedTest(value = 5, name = "Wiederholung {currentRepetition} von {totalRepetitions}")
void repeatedTestInGerman() {
// ...
} }

其中name可以用來自定義重複測試的顯示名字,{currentRepetition}{totalRepetitions}是當前次數和總共次數的變數。

執行結果:

├─ RepeatedTestsDemo
│ ├─ repeatedTest()
│ │ ├─ repetition 1 of 10
│ │ ├─ repetition 2 of 10
│ │ ├─ repetition 3 of 10
│ │ ├─ repetition 4 of 10
│ │ ├─ repetition 5 of 10
│ │ ├─ repetition 6 of 10
│ │ ├─ repetition 7 of 10
│ │ ├─ repetition 8 of 10
│ │ ├─ repetition 9 of 10
│ │ └─ repetition 10 of 10
│ ├─ repeatedTestWithRepetitionInfo(RepetitionInfo)
│ │ ├─ repetition 1 of 5
│ │ ├─ repetition 2 of 5
│ │ ├─ repetition 3 of 5
│ │ ├─ repetition 4 of 5
│ │ └─ repetition 5 of 5
│ ├─ Repeat!
│ │ └─ Repeat! 1/1
│ ├─ Details...
│ │ └─ Details... :: repetition 1 of 1
│ └─ repeatedTestInGerman()
│ ├─ Wiederholung 1 von 5
│ ├─ Wiederholung 2 von 5
│ ├─ Wiederholung 3 von 5
│ ├─ Wiederholung 4 von 5
│ └─ Wiederholung 5 von 5

小結

本文分別對JUnit5的條件測試、巢狀測試、重複測試進行了介紹,它們可以使得測試更加靈活和富有層次。除了這些,JUnit5還支援另一個重要且常見的測試:引數化測試。

參考資料:

https://junit.org/junit5/docs/current/user-guide/#writing-tests-conditional-execution

https://junit.org/junit5/docs/current/user-guide/#writing-tests-nested

https://junit.org/junit5/docs/current/user-guide/#writing-tests-repeated-tests