Skip to content

Better CodeSource.location for Groovy loaded from JARs #668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Better CodeSource.location for Groovy loaded from JARs #668

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4390bf5
Better `CodeSource.location` for Groovy loaded from JARs
jglick Mar 3, 2023
c8354fc
Neglected to close the `InputStream`
jglick Mar 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions plugin/src/main/java/org/jenkinsci/plugins/workflow/cps/CpsGroovyShell.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@
import java.util.logging.Logger;
import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URLClassLoader;
import java.security.CodeSource;
import org.codehaus.groovy.control.CompilationFailedException;
import org.codehaus.groovy.control.CompilationUnit;
import org.codehaus.groovy.control.CompilerConfiguration;
Expand Down Expand Up @@ -76,6 +80,32 @@ private static final class CleanGroovyClassLoader extends GroovyClassLoader {
return new CleanClassCollector(unit, su);
}

/**
* The default implementation handles JAR entries poorly, setting the {@link CodeSource#getLocation} to {@code file:/groovy/script}.
* When called from {@link #recompile} the actual URL is in fact known.
* (This implementation yields {@code jar:file:/x.jar!/pkg/Clazz.groovy}
* which is not the same as {@link URLClassLoader}’s {@code file:/x.jar} or {@code jar:file:/x.jar!/}
* but the only way to set {@link GroovyCodeSource#getURL} is to have it load the text itself.)
*/
@SuppressWarnings("rawtypes")
@Deprecated
@Override public Class parseClass(InputStream in, String fileName) throws CompilationFailedException {
try {
in.close();
} catch (IOException x) {
LOGGER.log(Level.WARNING, "failed to close input stream for " + fileName, x);
}
LOGGER.finer(() -> "processing " + fileName);
if (fileName.startsWith("jar:file:")) {
try {
return parseClass(new GroovyCodeSource(new URL(fileName)));
} catch (MalformedURLException x) {
LOGGER.log(Level.WARNING, null, x);
}
}
return super.parseClass(in, fileName);
}

private final class CleanClassCollector extends ClassCollector {

CleanClassCollector(CompilationUnit unit, SourceUnit su) {
Expand Down