Skip to content

Commit 598bc79

Browse files
committed
Revise Launcher API examples in User Guide
1 parent faf0212 commit 598bc79

File tree

3 files changed

+24
-17
lines changed

3 files changed

+24
-17
lines changed

documentation/src/test/java/example/UsingTheLauncherDemo.java

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@
3636
import org.junit.platform.launcher.TestPlan;
3737
import org.junit.platform.launcher.core.LauncherConfig;
3838
import org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder;
39-
import org.junit.platform.launcher.core.LauncherExecutionRequestBuilder;
4039
import org.junit.platform.launcher.core.LauncherFactory;
4140
import org.junit.platform.launcher.listeners.SummaryGeneratingListener;
4241
import org.junit.platform.launcher.listeners.TestExecutionSummary;
@@ -70,14 +69,14 @@ void execution() {
7069

7170
try (LauncherSession session = LauncherFactory.openSession()) {
7271
Launcher launcher = session.getLauncher();
73-
// Register a listener of your choice
72+
// Register one ore more listeners of your choice.
7473
launcher.registerTestExecutionListeners(listener);
75-
// Discover tests and build a test plan
74+
// Discover tests and build a test plan.
7675
TestPlan testPlan = launcher.discover(discoveryRequest);
77-
// Execute test plan
78-
launcher.execute(LauncherExecutionRequestBuilder.request(testPlan).build());
79-
// Alternatively, execute the discoveryRequest request directly
80-
launcher.execute(LauncherExecutionRequestBuilder.request(discoveryRequest).build());
76+
// Execute the test plan.
77+
launcher.execute(testPlan);
78+
// Alternatively, execute the discovery request directly.
79+
launcher.execute(discoveryRequest);
8180
}
8281

8382
TestExecutionSummary summary = listener.getSummary();
@@ -107,13 +106,12 @@ void launcherConfig() {
107106
.addTestExecutionListeners(new CustomTestExecutionListener())
108107
.build();
109108

110-
LauncherExecutionRequest request = LauncherDiscoveryRequestBuilder.request()
109+
LauncherDiscoveryRequest discoveryRequest = LauncherDiscoveryRequestBuilder.request()
111110
.selectors(selectPackage("com.example.mytests"))
112-
.forExecution()
113111
.build();
114112

115113
try (LauncherSession session = LauncherFactory.openSession(launcherConfig)) {
116-
session.getLauncher().execute(request);
114+
session.getLauncher().execute(discoveryRequest);
117115
}
118116
// end::launcherConfig[]
119117
// @formatter:on

documentation/src/test/java/example/UsingTheLauncherForDiscoveryDemo.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@
1414
import static org.junit.platform.engine.discovery.ClassNameFilter.includeClassNamePatterns;
1515
import static org.junit.platform.engine.discovery.DiscoverySelectors.selectClass;
1616
import static org.junit.platform.engine.discovery.DiscoverySelectors.selectPackage;
17+
import static org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder.discoveryRequest;
1718

1819
import org.junit.platform.launcher.LauncherDiscoveryRequest;
1920
import org.junit.platform.launcher.LauncherSession;
2021
import org.junit.platform.launcher.TestPlan;
21-
import org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder;
2222
import org.junit.platform.launcher.core.LauncherFactory;
2323
// end::imports[]
2424

@@ -32,7 +32,7 @@ class UsingTheLauncherForDiscoveryDemo {
3232
void discovery() {
3333
// @formatter:off
3434
// tag::discovery[]
35-
LauncherDiscoveryRequest request = LauncherDiscoveryRequestBuilder.request()
35+
LauncherDiscoveryRequest discoveryRequest = discoveryRequest()
3636
.selectors(
3737
selectPackage("com.example.mytests"),
3838
selectClass(MyTestClass.class)
@@ -43,7 +43,7 @@ void discovery() {
4343
.build();
4444

4545
try (LauncherSession session = LauncherFactory.openSession()) {
46-
TestPlan testPlan = session.getLauncher().discover(request);
46+
TestPlan testPlan = session.getLauncher().discover(discoveryRequest);
4747

4848
// ... discover additional test plans or execute tests
4949
}

documentation/src/test/java/example/sharedresources/SharedResourceDemo.java

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@
1212

1313
import static org.junit.jupiter.api.Assertions.assertSame;
1414
import static org.junit.jupiter.api.Assertions.assertTrue;
15-
import static org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder.request;
15+
import static org.junit.platform.engine.discovery.DiscoverySelectors.selectPackage;
16+
import static org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder.discoveryRequest;
1617

1718
import example.FirstCustomEngine;
1819
import example.SecondCustomEngine;
1920

2021
import org.junit.jupiter.api.Test;
2122
import org.junit.platform.launcher.Launcher;
23+
import org.junit.platform.launcher.LauncherDiscoveryRequest;
2224
import org.junit.platform.launcher.core.LauncherConfig;
2325
import org.junit.platform.launcher.core.LauncherFactory;
2426

@@ -31,15 +33,22 @@ void runBothCustomEnginesTest() {
3133
FirstCustomEngine firstCustomEngine = new FirstCustomEngine();
3234
SecondCustomEngine secondCustomEngine = new SecondCustomEngine();
3335

34-
Launcher launcher = LauncherFactory.create(LauncherConfig.builder()
36+
LauncherConfig launcherConfig = LauncherConfig.builder()
3537
// tag::custom_line_break[]
3638
.addTestEngines(firstCustomEngine, secondCustomEngine)
3739
// tag::custom_line_break[]
3840
.enableTestEngineAutoRegistration(false)
3941
// tag::custom_line_break[]
40-
.build());
42+
.build();
4143

42-
launcher.execute(request().forExecution().build());
44+
LauncherDiscoveryRequest discoveryRequest = discoveryRequest()
45+
// tag::custom_line_break[]
46+
.selectors(selectPackage("com.example.mytests"))
47+
// tag::custom_line_break[]
48+
.build();
49+
50+
Launcher launcher = LauncherFactory.create(launcherConfig);
51+
launcher.execute(discoveryRequest);
4352

4453
assertSame(firstCustomEngine.getSocket(), secondCustomEngine.getSocket());
4554
assertTrue(firstCustomEngine.getSocket().isClosed(), "socket should be closed");

0 commit comments

Comments
 (0)