/
DefaultForkConfiguration.java
374 lines (327 loc) · 12.2 KB
/
DefaultForkConfiguration.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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
package org.apache.maven.plugin.surefire.booterclient;
/*
* 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 org.apache.maven.plugin.surefire.JdkAttributes;
import org.apache.maven.plugin.surefire.booterclient.lazytestprovider.Commandline;
import org.apache.maven.plugin.surefire.log.api.ConsoleLogger;
import org.apache.maven.surefire.booter.AbstractPathConfiguration;
import org.apache.maven.surefire.booter.Classpath;
import org.apache.maven.surefire.booter.StartupConfiguration;
import org.apache.maven.surefire.booter.SurefireBooterForkException;
import org.apache.maven.surefire.extensions.ForkNodeFactory;
import org.apache.maven.surefire.api.util.internal.ImmutableMap;
import org.apache.maven.surefire.shared.utils.cli.CommandLineException;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.File;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import static org.apache.maven.plugin.surefire.SurefireHelper.replaceForkThreadsInPath;
import static org.apache.maven.plugin.surefire.util.Relocator.relocate;
import static org.apache.maven.plugin.surefire.SurefireHelper.replaceThreadNumberPlaceholders;
import static org.apache.maven.surefire.booter.Classpath.join;
/**
* Basic framework which constructs CLI.
*
* @author <a href="mailto:tibordigana@apache.org">Tibor Digana (tibor17)</a>
* @since 2.21.0.Jigsaw
*/
public abstract class DefaultForkConfiguration
extends ForkConfiguration
{
@Nonnull private final Classpath booterClasspath;
@Nonnull private final File tempDirectory;
@Nullable
private final String debugLine;
@Nonnull private final File workingDirectory;
@Nonnull private final Properties modelProperties;
@Nullable private final String argLine;
@Nonnull private final Map<String, String> environmentVariables;
@Nonnull private final String[] excludedEnvironmentVariables;
private final boolean debug;
private final int forkCount;
private final boolean reuseForks;
@Nonnull private final Platform pluginPlatform;
@Nonnull private final ConsoleLogger log;
@Nonnull private final ForkNodeFactory forkNodeFactory;
@SuppressWarnings( "checkstyle:parameternumber" )
protected DefaultForkConfiguration( @Nonnull Classpath booterClasspath,
@Nonnull File tempDirectory,
@Nullable String debugLine,
@Nonnull File workingDirectory,
@Nonnull Properties modelProperties,
@Nullable String argLine,
@Nonnull Map<String, String> environmentVariables,
@Nonnull String[] excludedEnvironmentVariables,
boolean debug,
int forkCount,
boolean reuseForks,
@Nonnull Platform pluginPlatform,
@Nonnull ConsoleLogger log,
@Nonnull ForkNodeFactory forkNodeFactory )
{
this.booterClasspath = booterClasspath;
this.tempDirectory = tempDirectory;
this.debugLine = debugLine;
this.workingDirectory = workingDirectory;
this.modelProperties = modelProperties;
this.argLine = argLine;
this.environmentVariables = toImmutable( environmentVariables );
this.excludedEnvironmentVariables = excludedEnvironmentVariables;
this.debug = debug;
this.forkCount = forkCount;
this.reuseForks = reuseForks;
this.pluginPlatform = pluginPlatform;
this.log = log;
this.forkNodeFactory = forkNodeFactory;
}
protected abstract void resolveClasspath( @Nonnull Commandline cli,
@Nonnull String booterThatHasMainMethod,
@Nonnull StartupConfiguration config,
@Nonnull File dumpLogDirectory )
throws SurefireBooterForkException;
@Nonnull
protected String extendJvmArgLine( @Nonnull String jvmArgLine )
{
return jvmArgLine;
}
@Nonnull
@Override
public final ForkNodeFactory getForkNodeFactory()
{
return forkNodeFactory;
}
/**
* @param config The startup configuration
* @param forkNumber index of forked JVM, to be the replacement in the argLine
* @param dumpLogDirectory directory for dump log file
* @return CommandLine able to flush entire command going to be sent to forked JVM
* @throws org.apache.maven.surefire.booter.SurefireBooterForkException when unable to perform the fork
*/
@Nonnull
@Override
public Commandline createCommandLine( @Nonnull StartupConfiguration config,
int forkNumber,
@Nonnull File dumpLogDirectory )
throws SurefireBooterForkException
{
try
{
Commandline cli =
new Commandline( getExcludedEnvironmentVariables() );
cli.setWorkingDirectory( getWorkingDirectory( forkNumber ).getAbsolutePath() );
for ( Entry<String, String> entry : getEnvironmentVariables().entrySet() )
{
String value = entry.getValue();
cli.addEnvironment( entry.getKey(), value == null ? "" : value );
}
cli.setExecutable( getJdkForTests().getJvmExecutable().getAbsolutePath() );
String jvmArgLine = newJvmArgLine( forkNumber );
if ( !jvmArgLine.isEmpty() )
{
cli.createArg()
.setLine( jvmArgLine );
}
if ( getDebugLine() != null && !getDebugLine().isEmpty() )
{
cli.createArg()
.setLine( getDebugLine() );
}
resolveClasspath( cli, findStartClass( config ), config, dumpLogDirectory );
return cli;
}
catch ( CommandLineException e )
{
throw new SurefireBooterForkException( e.getLocalizedMessage(), e );
}
}
protected ConsoleLogger getLogger()
{
return log;
}
@Nonnull
protected List<String> toCompleteClasspath( @Nonnull StartupConfiguration conf ) throws SurefireBooterForkException
{
AbstractPathConfiguration pathConfig = conf.getClasspathConfiguration();
if ( pathConfig.isClassPathConfig() == pathConfig.isModularPathConfig() )
{
throw new SurefireBooterForkException( "Could not find class-path config nor modular class-path either." );
}
Classpath bootClasspath = getBooterClasspath();
Classpath testClasspath = pathConfig.getTestClasspath();
Classpath providerClasspath = pathConfig.getProviderClasspath();
Classpath completeClasspath = join( join( bootClasspath, testClasspath ), providerClasspath );
getLogger().debug( completeClasspath.getLogMessage( "boot classpath:" ) );
getLogger().debug( completeClasspath.getCompactLogMessage( "boot(compact) classpath:" ) );
return completeClasspath.getClassPath();
}
@Nonnull
private File getWorkingDirectory( int forkNumber )
throws SurefireBooterForkException
{
File cwd = replaceForkThreadsInPath( getWorkingDirectory(), forkNumber );
if ( !cwd.exists() && !cwd.mkdirs() )
{
throw new SurefireBooterForkException( "Cannot create workingDirectory " + cwd.getAbsolutePath() );
}
if ( !cwd.isDirectory() )
{
throw new SurefireBooterForkException(
"WorkingDirectory " + cwd.getAbsolutePath() + " exists and is not a directory" );
}
return cwd;
}
/**
* Replaces expressions <pre>@{property-name}</pre> with the corresponding properties
* from the model. This allows late evaluation of property values when the plugin is executed (as compared
* to evaluation when the pom is parsed as is done with <pre>${property-name}</pre> expressions).
*
* This allows other plugins to modify or set properties with the changes getting picked up by surefire.
*/
@Nonnull
private String interpolateArgLineWithPropertyExpressions()
{
if ( getArgLine() == null )
{
return "";
}
String resolvedArgLine = getArgLine().trim();
if ( resolvedArgLine.isEmpty() )
{
return "";
}
for ( final String key : getModelProperties().stringPropertyNames() )
{
String field = "@{" + key + "}";
if ( getArgLine().contains( field ) )
{
resolvedArgLine = resolvedArgLine.replace( field, getModelProperties().getProperty( key, "" ) );
}
}
return resolvedArgLine;
}
@Nonnull
private static String stripWhitespace( @Nonnull String argLine )
{
return argLine.replaceAll( "\\s", " " );
}
/**
* Immutable map.
*
* @param map immutable map copies elements from <code>map</code>
* @param <K> key type
* @param <V> value type
* @return never returns null
*/
@Nonnull
private static <K, V> Map<K, V> toImmutable( @Nullable Map<K, V> map )
{
return map == null ? Collections.<K, V>emptyMap() : new ImmutableMap<>( map );
}
@Override
@Nonnull
public File getTempDirectory()
{
return tempDirectory;
}
@Override
@Nullable
protected String getDebugLine()
{
return debugLine;
}
@Override
@Nonnull
protected File getWorkingDirectory()
{
return workingDirectory;
}
@Override
@Nonnull
protected Properties getModelProperties()
{
return modelProperties;
}
@Override
@Nullable
protected String getArgLine()
{
return argLine;
}
@Override
@Nonnull
protected Map<String, String> getEnvironmentVariables()
{
return environmentVariables;
}
@Nonnull
@Override
protected String[] getExcludedEnvironmentVariables()
{
return excludedEnvironmentVariables;
}
@Override
protected boolean isDebug()
{
return debug;
}
@Override
protected int getForkCount()
{
return forkCount;
}
@Override
protected boolean isReuseForks()
{
return reuseForks;
}
@Override
@Nonnull
protected Platform getPluginPlatform()
{
return pluginPlatform;
}
@Override
@Nonnull
protected JdkAttributes getJdkForTests()
{
return getPluginPlatform().getJdkExecAttributesForTests();
}
@Override
@Nonnull
protected Classpath getBooterClasspath()
{
return booterClasspath;
}
@Nonnull
private String newJvmArgLine( int forks )
{
String interpolatedArgs = stripWhitespace( interpolateArgLineWithPropertyExpressions() );
String argsWithReplacedForkNumbers = replaceThreadNumberPlaceholders( interpolatedArgs, forks );
return extendJvmArgLine( argsWithReplacedForkNumbers );
}
@Nonnull
private static String findStartClass( StartupConfiguration config )
{
return config.isShadefire() ? relocate( DEFAULT_PROVIDER_CLASS ) : DEFAULT_PROVIDER_CLASS;
}
}