/
JUnitPlatformProvider.java
317 lines (287 loc) · 11.6 KB
/
JUnitPlatformProvider.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
package org.apache.maven.surefire.junitplatform;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import static java.util.Arrays.stream;
import static java.util.Collections.emptyMap;
import static java.util.Optional.empty;
import static java.util.Optional.of;
import static java.util.logging.Level.WARNING;
import static java.util.stream.Collectors.toList;
import static org.apache.maven.surefire.api.booter.ProviderParameterNames.EXCLUDE_JUNIT5_ENGINES_PROP;
import static org.apache.maven.surefire.api.booter.ProviderParameterNames.INCLUDE_JUNIT5_ENGINES_PROP;
import static org.apache.maven.surefire.api.booter.ProviderParameterNames.TESTNG_EXCLUDEDGROUPS_PROP;
import static org.apache.maven.surefire.api.booter.ProviderParameterNames.TESTNG_GROUPS_PROP;
import static org.apache.maven.surefire.api.report.ConsoleOutputCapture.startCapture;
import static org.apache.maven.surefire.api.util.TestsToRun.fromClass;
import static org.apache.maven.surefire.shared.utils.StringUtils.isBlank;
import static org.junit.platform.engine.discovery.DiscoverySelectors.selectClass;
import static org.junit.platform.engine.discovery.DiscoverySelectors.selectUniqueId;
import static org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder.request;
import java.io.IOException;
import java.io.StringReader;
import java.io.UncheckedIOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Properties;
import java.util.logging.Logger;
import org.apache.maven.surefire.api.provider.AbstractProvider;
import org.apache.maven.surefire.api.provider.ProviderParameters;
import org.apache.maven.surefire.api.report.ConsoleOutputReceiver;
import org.apache.maven.surefire.api.report.ReporterException;
import org.apache.maven.surefire.api.report.ReporterFactory;
import org.apache.maven.surefire.api.report.RunListener;
import org.apache.maven.surefire.api.suite.RunResult;
import org.apache.maven.surefire.api.testset.TestListResolver;
import org.apache.maven.surefire.api.testset.TestSetFailedException;
import org.apache.maven.surefire.api.util.ScanResult;
import org.apache.maven.surefire.api.util.SurefireReflectionException;
import org.apache.maven.surefire.api.util.TestsToRun;
import org.apache.maven.surefire.shared.utils.StringUtils;
import org.junit.platform.engine.DiscoverySelector;
import org.junit.platform.engine.Filter;
import org.junit.platform.launcher.EngineFilter;
import org.junit.platform.launcher.Launcher;
import org.junit.platform.launcher.LauncherDiscoveryRequest;
import org.junit.platform.launcher.TagFilter;
import org.junit.platform.launcher.TestIdentifier;
import org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder;
/**
* JUnit 5 Platform Provider.
*
* @since 2.22.0
*/
public class JUnitPlatformProvider
extends AbstractProvider
{
static final String CONFIGURATION_PARAMETERS = "configurationParameters";
private final ProviderParameters parameters;
private final Launcher launcher;
private final Filter<?>[] filters;
private final Map<String, String> configurationParameters;
public JUnitPlatformProvider( ProviderParameters parameters )
{
this( parameters, new LazyLauncher() );
}
JUnitPlatformProvider( ProviderParameters parameters, Launcher launcher )
{
this.parameters = parameters;
this.launcher = launcher;
filters = newFilters();
configurationParameters = newConfigurationParameters();
Logger.getLogger( "org.junit" ).setLevel( WARNING );
}
@Override
public Iterable<Class<?>> getSuites()
{
try
{
return scanClasspath();
}
finally
{
if ( launcher instanceof AutoCloseable )
{
try
{
( (AutoCloseable) launcher ).close();
}
catch ( Exception e )
{
throw new SurefireReflectionException( e );
}
}
}
}
@Override
public RunResult invoke( Object forkTestSet )
throws TestSetFailedException, ReporterException
{
ReporterFactory reporterFactory = parameters.getReporterFactory();
final RunResult runResult;
try
{
RunListener runListener = reporterFactory.createReporter();
startCapture( ( ConsoleOutputReceiver ) runListener );
if ( forkTestSet instanceof TestsToRun )
{
invokeAllTests( (TestsToRun) forkTestSet, runListener );
}
else if ( forkTestSet instanceof Class )
{
invokeAllTests( fromClass( ( Class<?> ) forkTestSet ), runListener );
}
else if ( forkTestSet == null )
{
invokeAllTests( scanClasspath(), runListener );
}
else
{
throw new IllegalArgumentException(
"Unexpected value of forkTestSet: " + forkTestSet );
}
}
finally
{
runResult = reporterFactory.close();
if ( launcher instanceof AutoCloseable )
{
try
{
( (AutoCloseable) launcher ).close();
}
catch ( Exception e )
{
throw new SurefireReflectionException( e );
}
}
}
return runResult;
}
private TestsToRun scanClasspath()
{
TestPlanScannerFilter filter = new TestPlanScannerFilter( launcher, filters );
ScanResult scanResult = parameters.getScanResult();
TestsToRun scannedClasses = scanResult.applyFilter( filter, parameters.getTestClassLoader() );
return parameters.getRunOrderCalculator().orderTestClasses( scannedClasses );
}
private void invokeAllTests( TestsToRun testsToRun, RunListener runListener )
{
RunListenerAdapter adapter = new RunListenerAdapter( runListener );
execute( testsToRun, adapter );
// Rerun failing tests if requested
int count = parameters.getTestRequest().getRerunFailingTestsCount();
if ( count > 0 && adapter.hasFailingTests() )
{
for ( int i = 0; i < count; i++ )
{
// Replace the "discoveryRequest" so that it only specifies the failing tests
LauncherDiscoveryRequest discoveryRequest = buildLauncherDiscoveryRequestForRerunFailures( adapter );
// Reset adapter's recorded failures and invoke the failed tests again
adapter.reset();
launcher.execute( discoveryRequest, adapter );
// If no tests fail in the rerun, we're done
if ( !adapter.hasFailingTests() )
{
break;
}
}
}
}
private void execute( TestsToRun testsToRun, RunListenerAdapter adapter )
{
if ( testsToRun.allowEagerReading() )
{
List<DiscoverySelector> selectors = new ArrayList<>();
testsToRun.iterator()
.forEachRemaining( c -> selectors.add( selectClass( c.getName() ) ) );
LauncherDiscoveryRequestBuilder builder = request()
.filters( filters )
.configurationParameters( configurationParameters )
.selectors( selectors );
launcher.execute( builder.build(), adapter );
}
else
{
testsToRun.iterator()
.forEachRemaining( c ->
{
LauncherDiscoveryRequestBuilder builder = request()
.filters( filters )
.configurationParameters( configurationParameters )
.selectors( selectClass( c.getName() ) );
launcher.execute( builder.build(), adapter );
} );
}
}
private LauncherDiscoveryRequest buildLauncherDiscoveryRequestForRerunFailures( RunListenerAdapter adapter )
{
LauncherDiscoveryRequestBuilder builder = request().filters( filters ).configurationParameters(
configurationParameters );
// Iterate over recorded failures
for ( TestIdentifier identifier : new LinkedHashSet<>( adapter.getFailures().keySet() ) )
{
builder.selectors( selectUniqueId( identifier.getUniqueId() ) );
}
return builder.build();
}
private Filter<?>[] newFilters()
{
List<Filter<?>> filters = new ArrayList<>();
getPropertiesList( TESTNG_GROUPS_PROP )
.map( TagFilter::includeTags )
.ifPresent( filters::add );
getPropertiesList( TESTNG_EXCLUDEDGROUPS_PROP )
.map( TagFilter::excludeTags )
.ifPresent( filters::add );
TestListResolver testListResolver = parameters.getTestRequest().getTestListResolver();
if ( !testListResolver.isEmpty() )
{
filters.add( new TestMethodFilter( testListResolver ) );
}
getPropertiesList( INCLUDE_JUNIT5_ENGINES_PROP )
.map( EngineFilter::includeEngines )
.ifPresent( filters::add );
getPropertiesList( EXCLUDE_JUNIT5_ENGINES_PROP )
.map( EngineFilter::excludeEngines )
.ifPresent( filters::add );
return filters.toArray( new Filter<?>[ filters.size() ] );
}
Filter<?>[] getFilters()
{
return filters;
}
private Map<String, String> newConfigurationParameters()
{
String content = parameters.getProviderProperties().get( CONFIGURATION_PARAMETERS );
if ( content == null )
{
return emptyMap();
}
try ( StringReader reader = new StringReader( content ) )
{
Map<String, String> result = new HashMap<>();
Properties props = new Properties();
props.load( reader );
props.stringPropertyNames()
.forEach( key -> result.put( key, props.getProperty( key ) ) );
return result;
}
catch ( IOException e )
{
throw new UncheckedIOException( "Error reading " + CONFIGURATION_PARAMETERS, e );
}
}
Map<String, String> getConfigurationParameters()
{
return configurationParameters;
}
private Optional<List<String>> getPropertiesList( String key )
{
String property = parameters.getProviderProperties().get( key );
return isBlank( property ) ? empty()
: of( stream( property.split( "[,]+" ) )
.filter( StringUtils::isNotBlank )
.map( String::trim )
.collect( toList() ) );
}
}