-
Notifications
You must be signed in to change notification settings - Fork 6.3k
8347007: --strip-debug removes parameter names included with -parameters #27566
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.
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
Open
slowhog
wants to merge
3
commits into
openjdk:master
Choose a base branch
from
slowhog:JDK-8347007
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+294
−7
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
228 changes: 228 additions & 0 deletions
228
test/jdk/tools/jlink/plugins/StripParameterNamesTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,228 @@ | ||
| /* | ||
| * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved. | ||
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | ||
| * | ||
| * This code is free software; you can redistribute it and/or modify it | ||
| * under the terms of the GNU General Public License version 2 only, as | ||
| * published by the Free Software Foundation. | ||
| * | ||
| * This code is distributed in the hope that it will be useful, but WITHOUT | ||
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | ||
| * version 2 for more details (a copy is included in the LICENSE file that | ||
| * accompanied this code). | ||
| * | ||
| * You should have received a copy of the GNU General Public License version | ||
| * 2 along with this work; if not, write to the Free Software Foundation, | ||
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | ||
| * | ||
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | ||
| * or visit www.oracle.com if you need additional information or have any | ||
| * questions. | ||
| */ | ||
|
|
||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.BeforeAll; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.params.ParameterizedTest; | ||
| import org.junit.jupiter.params.provider.FieldSource; | ||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.File; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.nio.file.Paths; | ||
| import java.util.ArrayList; | ||
| import java.util.Comparator; | ||
| import java.util.List; | ||
| import java.util.stream.Stream; | ||
| import java.util.spi.ToolProvider; | ||
|
|
||
| import tests.JImageGenerator; | ||
| import tests.JImageGenerator.InMemorySourceFile; | ||
| import tests.Result; | ||
|
|
||
| /* | ||
| * @test | ||
| * @summary Test jlink strip debug plugins handle method parameter names. | ||
| * @bug 8347007 | ||
| * @library ../../lib | ||
| * @modules java.base/jdk.internal.jimage | ||
| * jdk.jlink/jdk.tools.jlink.internal | ||
| * jdk.jlink/jdk.tools.jlink.plugin | ||
| * jdk.jlink/jdk.tools.jmod | ||
| * jdk.jlink/jdk.tools.jimage | ||
| * jdk.compiler | ||
| * @build tests.* | ||
| * @run junit/othervm StripParameterNamesTest | ||
| */ | ||
| public class StripParameterNamesTest { | ||
| private static final ToolProvider JAVAC_TOOL = ToolProvider.findFirst("javac") | ||
| .orElseThrow(() -> new RuntimeException("javac tool not found")); | ||
|
|
||
| private static Path src = Paths.get("src").toAbsolutePath(); | ||
| private static List<Jmod> testJmods = new ArrayList<>(); | ||
|
|
||
| record Jmod(Path moduleDir, boolean withDebugInfo, boolean withParameterNames) {} | ||
|
|
||
| @BeforeAll | ||
| public static void setup() throws IOException { | ||
| Files.createDirectory(src); | ||
| var mainClassSource = new InMemorySourceFile("test", "InspectParameterNames", """ | ||
| package test; | ||
|
|
||
| public class InspectParameterNames { | ||
| int add(int a, int b) { | ||
| return a + b; | ||
| } | ||
|
|
||
| public static boolean hasParameterNames() throws NoSuchMethodException { | ||
| // Get add method in the class | ||
| var method = InspectParameterNames.class.getDeclaredMethod("add", int.class, int.class); | ||
|
|
||
| // Get method parameters | ||
| var parameters = method.getParameters(); | ||
|
|
||
| // validate parameter names | ||
| return parameters[0].getName().equals("a") && parameters[1].getName().equals("b"); | ||
| } | ||
|
|
||
| public static void main(String[] args) throws NoSuchMethodException { | ||
| System.out.println(hasParameterNames()); | ||
| } | ||
| } | ||
| """); | ||
| var moduleDir = JImageGenerator.generateSources(src, "bug8347007x", List.of(mainClassSource)); | ||
| JImageGenerator.generateModuleInfo(moduleDir, List.of("test")); | ||
| testJmods.add(buildJmod(true, true)); | ||
| testJmods.add(buildJmod(true, false)); | ||
| testJmods.add(buildJmod(false, true)); | ||
| testJmods.add(buildJmod(false, false)); | ||
| } | ||
|
|
||
| @AfterEach | ||
| public void cleanup() throws IOException { | ||
| rmdir(Paths.get("img")); | ||
| } | ||
|
|
||
| static void report(String command, List<String> args) { | ||
| System.out.println(command + " " + String.join(" ", args)); | ||
| } | ||
|
|
||
| static void javac(List<String> args) { | ||
| report("javac", args); | ||
| JAVAC_TOOL.run(System.out, System.err, args.toArray(new String[0])); | ||
| } | ||
| /** | ||
| * Recursively remove a Directory | ||
| * | ||
| * @param dir Directory to delete | ||
| * @throws IOException If an error occurs | ||
| */ | ||
| static void rmdir(Path dir) throws IOException { | ||
| // Nothing to do if the file does not exist | ||
| if (!Files.exists(dir)) { | ||
| return; | ||
| } | ||
| try (Stream<Path> walk = Files.walk(dir)) { | ||
| walk.sorted(Comparator.reverseOrder()) | ||
| .map(Path::toFile) | ||
| .forEach(File::delete); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Build jmods from the module source path | ||
| */ | ||
| static Jmod buildJmod(boolean withDebugInfo, boolean withParameterNames) { | ||
| String dirName = "jmods"; | ||
| List<String> options = new ArrayList<>(); | ||
|
|
||
| if (withDebugInfo) { | ||
| options.add("-g"); | ||
| dirName += "g"; | ||
| } | ||
|
|
||
| if (withParameterNames) { | ||
| options.add("-parameters"); | ||
| dirName += "p"; | ||
| } | ||
|
|
||
| Path moduleDir = Paths.get(dirName).toAbsolutePath(); | ||
|
|
||
| options.add("-d"); | ||
| options.add(moduleDir.toString()); | ||
| options.add("--module-source-path"); | ||
| options.add(src.toString()); | ||
| options.add("--module"); | ||
| options.add("bug8347007x"); | ||
|
|
||
| javac(options); | ||
| return new Jmod(moduleDir, withDebugInfo, withParameterNames); | ||
| } | ||
|
|
||
| Result buildImage(Path modulePath, Path imageDir, String... options) { | ||
| var jlinkTask = JImageGenerator.getJLinkTask() | ||
| .modulePath(modulePath.toString()) | ||
| .output(imageDir); | ||
|
|
||
| for (var option: options) { | ||
| jlinkTask.option(option); | ||
| } | ||
|
|
||
| return jlinkTask.addMods("bug8347007x") | ||
| .call(); | ||
| } | ||
|
|
||
| void assertHasParameterNames(Path imageDir, boolean expected) throws IOException, InterruptedException { | ||
| Path binDir = imageDir.resolve("bin").toAbsolutePath(); | ||
| Path bin = binDir.resolve("java"); | ||
|
|
||
| ProcessBuilder processBuilder = new ProcessBuilder(bin.toString(), | ||
| "-XX:+UnlockDiagnosticVMOptions", | ||
| "-XX:+BytecodeVerificationLocal", | ||
| "-m", "bug8347007x/test.InspectParameterNames"); | ||
| processBuilder.directory(binDir.toFile()); | ||
| Process process = processBuilder.start(); | ||
| int exitCode = process.waitFor(); | ||
| var output = process.inputReader().readLine(); | ||
| System.out.println(output); | ||
| assertEquals(expected, Boolean.parseBoolean(output)); | ||
| } | ||
|
|
||
| Stream<Jmod> provideTestJmods() { | ||
| return testJmods.stream(); | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @FieldSource("testJmods") | ||
| public void testDefaultBehavior(Jmod jmod) throws Exception { | ||
| var imageDir = Paths.get("img"); | ||
| buildImage(jmod.moduleDir(), imageDir) | ||
| .assertSuccess(); | ||
| var hasParameter = jmod.withParameterNames(); | ||
| assertHasParameterNames(imageDir, hasParameter); | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @FieldSource("testJmods") | ||
| public void testStripDebug(Jmod jmod) throws Exception { | ||
| var imageDir = Paths.get("img"); | ||
| buildImage(jmod.moduleDir(), imageDir, | ||
| "--strip-debug") | ||
| .assertSuccess(); | ||
| var hasParameter = jmod.withParameterNames(); | ||
| assertHasParameterNames(imageDir, hasParameter); | ||
| } | ||
|
|
||
| @Test | ||
| public void testWithoutStripParameterName() throws Exception { | ||
| var imageDir = Paths.get("img"); | ||
| var jmod = testJmods.get(0); | ||
| buildImage(jmod.moduleDir(), imageDir, | ||
| "--strip-debug", "--strip-java-debug-attributes") | ||
| .assertSuccess(); | ||
| assertHasParameterNames(imageDir, jmod.withParameterNames()); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This method name specifically implies enabling. Maybe "setEnabled..."?