Skip to content

Commit 60da98b

Browse files
slawekjaranowskislawekjaranowski
committed
[MSHARED-1359] Allow reuse the same classloader for multiple script executions
1 parent cc3d6cd commit 60da98b

14 files changed

+345
-176
lines changed

‎pom.xml

+25
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,32 @@
109109
<artifactId>junit-jupiter-api</artifactId>
110110
<scope>test</scope>
111111
</dependency>
112+
<dependency>
113+
<groupId>org.junit.jupiter</groupId>
114+
<artifactId>junit-jupiter-params</artifactId>
115+
<scope>test</scope>
116+
</dependency>
112117

113118
</dependencies>
114119

120+
<build>
121+
<plugins>
122+
<plugin>
123+
<groupId>org.apache.maven.plugins</groupId>
124+
<artifactId>maven-dependency-plugin</artifactId>
125+
<executions>
126+
<execution>
127+
<goals>
128+
<goal>copy-dependencies</goal>
129+
</goals>
130+
<phase>generate-test-resources</phase>
131+
<configuration>
132+
<includeGroupIds>org.slf4j</includeGroupIds>
133+
<stripVersion>true</stripVersion>
134+
</configuration>
135+
</execution>
136+
</executions>
137+
</plugin>
138+
</plugins>
139+
</build>
115140
</project>

‎src/main/java/org/apache/maven/shared/scriptinterpreter/BeanShellScriptInterpreter.java

+34-15
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
import java.io.File;
2222
import java.io.IOException;
2323
import java.io.PrintStream;
24+
import java.io.UncheckedIOException;
25+
import java.net.MalformedURLException;
26+
import java.net.URL;
27+
import java.net.URLClassLoader;
2428
import java.util.List;
2529
import java.util.Map;
2630

@@ -36,13 +40,28 @@
3640
*/
3741
class BeanShellScriptInterpreter implements ScriptInterpreter {
3842

39-
/** {@inheritDoc} */
43+
private URLClassLoader classLoader;
44+
4045
@Override
41-
public Object evaluateScript(
42-
String script,
43-
List<String> classPath,
44-
Map<String, ? extends Object> globalVariables,
45-
PrintStream scriptOutput)
46+
public void setClassPath(List<String> classPath) {
47+
if (classPath == null || classPath.isEmpty()) {
48+
return;
49+
}
50+
51+
URL[] urls = classPath.stream().map(this::toUrl).toArray(URL[]::new);
52+
classLoader = new URLClassLoader(urls, Thread.currentThread().getContextClassLoader());
53+
}
54+
55+
private URL toUrl(String path) {
56+
try {
57+
return new File(path).toURI().toURL();
58+
} catch (MalformedURLException e) {
59+
throw new UncheckedIOException(e);
60+
}
61+
}
62+
63+
@Override
64+
public Object evaluateScript(String script, Map<String, ?> globalVariables, PrintStream scriptOutput)
4665
throws ScriptEvaluationException {
4766
PrintStream origOut = System.out;
4867
PrintStream origErr = System.err;
@@ -67,15 +86,8 @@ public Object evaluateScript(
6786
}
6887
}
6988

70-
if (classPath != null && !classPath.isEmpty()) {
71-
for (String path : classPath) {
72-
try {
73-
engine.getClassManager()
74-
.addClassPath(new File(path).toURI().toURL());
75-
} catch (IOException e) {
76-
throw new RuntimeException("bad class path: " + path, e);
77-
}
78-
}
89+
if (classLoader != null) {
90+
engine.setClassLoader(classLoader);
7991
}
8092

8193
if (globalVariables != null) {
@@ -102,4 +114,11 @@ public Object evaluateScript(
102114
System.setOut(origOut);
103115
}
104116
}
117+
118+
@Override
119+
public void close() throws IOException {
120+
if (classLoader != null) {
121+
classLoader.close();
122+
}
123+
}
105124
}

‎src/main/java/org/apache/maven/shared/scriptinterpreter/FileLogger.java

+14-5
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,13 @@
1919
package org.apache.maven.shared.scriptinterpreter;
2020

2121
import java.io.File;
22-
import java.io.FileOutputStream;
2322
import java.io.IOException;
2423
import java.io.OutputStream;
2524
import java.io.PrintStream;
25+
import java.nio.file.Files;
2626

2727
/**
2828
* <p>FileLogger class.</p>
29-
*
3029
*/
3130
public class FileLogger implements ExecutionLogger, AutoCloseable {
3231

@@ -53,7 +52,7 @@ public FileLogger(File outputFile) throws IOException {
5352
/**
5453
* Creates a new logger that writes to the specified file and optionally mirrors messages.
5554
*
56-
* @param outputFile The path to the output file, if null all message will be discarded.
55+
* @param outputFile The path to the output file, if null all message will be discarded.
5756
* @param mirrorHandler The class which handle mirrored message, can be <code>null</code>.
5857
* @throws java.io.IOException If the output file could not be created.
5958
*/
@@ -64,7 +63,7 @@ public FileLogger(File outputFile, FileLoggerMirrorHandler mirrorHandler) throws
6463

6564
if (outputFile != null) {
6665
outputFile.getParentFile().mkdirs();
67-
outputStream = new FileOutputStream(outputFile);
66+
outputStream = Files.newOutputStream(outputFile.toPath());
6867
} else {
6968
outputStream = new NullOutputStream();
7069
}
@@ -119,7 +118,8 @@ public void close() {
119118
}
120119

121120
private static class MirrorStreamWrapper extends OutputStream {
122-
private final OutputStream out;
121+
private OutputStream out;
122+
123123
private final FileLoggerMirrorHandler mirrorHandler;
124124

125125
private StringBuilder lineBuffer;
@@ -163,6 +163,15 @@ public void flush() throws IOException {
163163
// clear buffer
164164
lineBuffer = new StringBuilder();
165165
}
166+
167+
@Override
168+
public void close() throws IOException {
169+
flush();
170+
if (out != null) {
171+
out.close();
172+
out = null;
173+
}
174+
}
166175
}
167176

168177
private static class NullOutputStream extends OutputStream {

‎src/main/java/org/apache/maven/shared/scriptinterpreter/GroovyScriptInterpreter.java

+33-14
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@
1919
package org.apache.maven.shared.scriptinterpreter;
2020

2121
import java.io.File;
22+
import java.io.IOException;
2223
import java.io.PrintStream;
24+
import java.io.UncheckedIOException;
25+
import java.net.MalformedURLException;
2326
import java.net.URL;
2427
import java.util.List;
2528
import java.util.Map;
@@ -36,31 +39,42 @@
3639
*/
3740
class GroovyScriptInterpreter implements ScriptInterpreter {
3841

39-
/** {@inheritDoc} */
42+
private final RootLoader childFirstLoader =
43+
new RootLoader(new URL[] {}, Thread.currentThread().getContextClassLoader());
44+
45+
@Override
46+
public void setClassPath(List<String> classPath) {
47+
if (classPath == null || classPath.isEmpty()) {
48+
return;
49+
}
50+
51+
classPath.stream().map(this::toUrl).forEach(childFirstLoader::addURL);
52+
}
53+
54+
private URL toUrl(String path) {
55+
try {
56+
return new File(path).toURI().toURL();
57+
} catch (MalformedURLException e) {
58+
throw new UncheckedIOException(e);
59+
}
60+
}
61+
62+
/**
63+
* {@inheritDoc}
64+
*/
4065
@Override
41-
public Object evaluateScript(
42-
String script,
43-
List<String> classPath,
44-
Map<String, ? extends Object> globalVariables,
45-
PrintStream scriptOutput)
66+
public Object evaluateScript(String script, Map<String, ?> globalVariables, PrintStream scriptOutput)
4667
throws ScriptEvaluationException {
4768
PrintStream origOut = System.out;
4869
PrintStream origErr = System.err;
4970

50-
try (RootLoader childFirstLoader =
51-
new RootLoader(new URL[] {}, getClass().getClassLoader())) {
71+
try {
5272

5373
if (scriptOutput != null) {
5474
System.setErr(scriptOutput);
5575
System.setOut(scriptOutput);
5676
}
5777

58-
if (classPath != null && !classPath.isEmpty()) {
59-
for (String path : classPath) {
60-
childFirstLoader.addURL(new File(path).toURI().toURL());
61-
}
62-
}
63-
6478
GroovyShell interpreter = new GroovyShell(
6579
childFirstLoader,
6680
new Binding(globalVariables),
@@ -74,4 +88,9 @@ public Object evaluateScript(
7488
System.setOut(origOut);
7589
}
7690
}
91+
92+
@Override
93+
public void close() throws IOException {
94+
childFirstLoader.close();
95+
}
7796
}

‎src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptInterpreter.java

+17-13
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
*/
1919
package org.apache.maven.shared.scriptinterpreter;
2020

21+
import java.io.Closeable;
2122
import java.io.PrintStream;
2223
import java.util.List;
2324
import java.util.Map;
@@ -28,26 +29,29 @@
2829
*
2930
* @author Benjamin Bentmann
3031
*/
31-
public interface ScriptInterpreter {
32+
public interface ScriptInterpreter extends Closeable {
3233

3334
/**
34-
* Evaluates the specified script.
35+
* Set class path used by interpreted.
3536
*
36-
* @param script The script contents to evaluate, must not be <code>null</code>.
3737
* @param classPath The additional class path for the script interpreter, may be <code>null</code> or empty if only
38-
* the plugin realm should be used for the script evaluation. If specified, this class path will precede
39-
* the artifacts from the plugin class path.
38+
* the plugin realm should be used for the script evaluation. If specified, this class path will
39+
* precede
40+
* the artifacts from the plugin class path.
41+
*/
42+
void setClassPath(List<String> classPath);
43+
44+
/**
45+
* Evaluates the specified script.
46+
*
47+
* @param script The script contents to evaluate, must not be <code>null</code>.
4048
* @param globalVariables The global variables (as a mapping from variable name to value) to define for the script,
41-
* may be <code>null</code> if not used.
42-
* @param scriptOutput A print stream to redirect any output from the script to, may be <code>null</code> to use
43-
* stdout/stderr.
49+
* may be <code>null</code> if not used.
50+
* @param scriptOutput A print stream to redirect any output from the script to, may be <code>null</code> to use
51+
* stdout/stderr.
4452
* @return The return value from the script, can be <code>null</code>
4553
* @throws ScriptEvaluationException If the script evaluation produced an error.
4654
*/
47-
Object evaluateScript(
48-
String script,
49-
List<String> classPath,
50-
Map<String, ? extends Object> globalVariables,
51-
PrintStream scriptOutput)
55+
Object evaluateScript(String script, Map<String, ?> globalVariables, PrintStream scriptOutput)
5256
throws ScriptEvaluationException;
5357
}

‎src/main/java/org/apache/maven/shared/scriptinterpreter/ScriptRunner.java

+17-2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
*/
1919
package org.apache.maven.shared.scriptinterpreter;
2020

21+
import java.io.Closeable;
2122
import java.io.File;
2223
import java.io.IOException;
2324
import java.io.PrintStream;
@@ -38,7 +39,7 @@
3839
*
3940
* @author Benjamin Bentmann
4041
*/
41-
public class ScriptRunner {
42+
public class ScriptRunner implements Closeable {
4243

4344
private static final Logger LOG = LoggerFactory.getLogger(ScriptRunner.class);
4445

@@ -220,7 +221,8 @@ private void executeRun(
220221
scriptVariables.put("basedir", scriptFile.getParentFile());
221222
scriptVariables.put("context", context);
222223

223-
result = interpreter.evaluateScript(script, classPath, scriptVariables, out);
224+
interpreter.setClassPath(classPath);
225+
result = interpreter.evaluateScript(script, scriptVariables, out);
224226
if (logger != null) {
225227
logger.consumeLine("Finished " + scriptDescription + ": " + scriptFile);
226228
}
@@ -273,4 +275,17 @@ private ScriptInterpreter getInterpreter(File scriptFile) {
273275
}
274276
return interpreter;
275277
}
278+
279+
/**
280+
* Closes this script interpreter and releases any system resources associated with it.
281+
*
282+
* @throws IOException if an I/O error occurs.
283+
*/
284+
@Override
285+
public void close() throws IOException {
286+
for (ScriptInterpreter scriptInterpreter : scriptInterpreters.values()) {
287+
scriptInterpreter.close();
288+
}
289+
scriptInterpreters.clear();
290+
}
276291
}

0 commit comments

Comments
 (0)