JDK-8310380: Handle problems in core-related tests on macOS when codesign tool does not work #14562

MBaesken · 2023-06-20T13:23:16Z

Currently, a number of tests fail on macOS because they miss the core file (e.g. serviceability/sa/TestJmapCore.java).
The reason is that configure detects on some setups that codesign does not work ("checking if debug mode codesign is possible... no) .
So adding the needed entitlement to generate cores is not done in the build. This is currently not checked later in the tests.
But without the entitlement, a core is not generated.

Progress

Change must be properly reviewed (1 review required, with at least 1 Reviewer)
Change must not contain extraneous whitespace
Commit message must refer to an issue

Issue

JDK-8310380: Handle problems in core-related tests on macOS when codesign tool does not work (Bug - P4)

Reviewers

Lutz Schmidt (@RealLucy - Reviewer) ⚠️ Review applies to 0d8c68c2
Christoph Langer (@RealCLanger - Reviewer) ⚠️ Review applies to 619b3578
Chris Plummer (@plummercj - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/14562/head:pull/14562
$ git checkout pull/14562

Update a local copy of the PR:
$ git checkout pull/14562
$ git pull https://git.openjdk.org/jdk.git pull/14562/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 14562

View PR using the GUI difftool:
$ git pr show -t 14562

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/14562.diff

Webrev

Link to Webrev Comment

bridgekeeper · 2023-06-20T13:24:39Z

👋 Welcome back mbaesken! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2023-06-20T13:27:07Z

@MBaesken The following labels will be automatically applied to this pull request:

core-libs
hotspot-runtime
serviceability

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

mlbridge · 2023-06-20T13:30:58Z

Webrevs

RealLucy

LGTM.
Thanks for enhancing test analysis.

openjdk · 2023-06-21T15:21:26Z

@MBaesken This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8310380: Handle problems in core-related tests on macOS when codesign tool does not work

Reviewed-by: lucy, clanger, cjplummer

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 100 new commits pushed to the master branch:

315242b: 8310975: java.util.FormatItemModifier should not be protected
d6dd0dc: 8308452: Extend internal Architecture enum with byte order and address size
fb283df: 8310828: java.sql java.sql.rowset packages have no @since info
ec45bd6: 8310182: DateTimeFormatter date formats (ISO_LOCAL_DATE) separated with hyphen, not dash
2bd4136: 8310849: Pattern matching for instanceof and arrayType cleanup in j.l.invoke and j.l.reflect
7ce967a: 8281455: Change JVM options with small ranges from 64 to 32 bits, for gc_globals.hpp
f6133ed: 8310890: Normalize identifier names
58bb655: 8222329: Readable read(CharBuffer) does not specify that 0 is returned when there is no remaining space in buffer
05e9c41: 8310731: Configure a javax.net.ssl.SNIMatcher for the HTTP/1.1 test servers in java/net/httpclient tests
1587836: 8310425: [JVMCI] compiler/runtime/TestConstantDynamic: lookupConstant returned an object of incorrect type: null
... and 90 more: https://git.openjdk.org/jdk/compare/4ca548fe74419dc9e110489e3d2d3adf695ef37f...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

RealCLanger

I made a few review suggestions. Does the symptom happen on both, arm64 and x64?

RealCLanger · 2023-06-21T15:19:31Z

test/lib/jdk/test/lib/util/CoreUtils.java

@@ -148,6 +150,11 @@ public static String getCoreFileLocation(String crashOutputString, long pid) thr
                    // We can't generate cores files with hardened binaries on OSX 10.15 and later.
                    throw new SkippedException("Cannot produce core file with hardened binary on OSX 10.15 and later");
                }
+            } else {


Maybe you could do just one case here:
else if (!Platform.hasPlistEntriesOSX()) {...

RealCLanger · 2023-06-21T15:22:07Z

test/lib/jdk/test/lib/Platform.java

+    public static boolean hasPlistEntriesOSX() throws IOException {
+        // Find the path to the java binary.
+        String jdkPath = System.getProperty("java.home");
+        Path javaPath = Paths.get(jdkPath + "/bin/java");


You could do it more concisely:

Path javaPath = Paths.get(System.getProperty("java.home") + "/bin/java");
if (Files.notExists(javaPath)) {
throw new FileNotFoundException("Could not find file " + javaPath.toAbsolutePath().toString());

RealCLanger · 2023-06-21T15:22:39Z

test/lib/jdk/test/lib/Platform.java

+        }
+
+        // Run codesign on the java binary.
+        ProcessBuilder pb = new ProcessBuilder("codesign", "--display", "--verbose", javaFileName);


And then here 'ProcessBuilder pb = new ProcessBuilder("codesign", "--display", "--verbose", javaPath.toAbsolutePath().toString());`

RealCLanger · 2023-06-21T15:23:35Z

test/lib/jdk/test/lib/Platform.java

+        ProcessBuilder pb = new ProcessBuilder("codesign", "--display", "--verbose", javaFileName);
+        pb.redirectErrorStream(true); // redirect stderr to stdout
+        Process codesignProcess = pb.start();
+        BufferedReader is = new BufferedReader(new InputStreamReader(codesignProcess.getInputStream()));


Maybe do the BufferedReader stuff in a try-with-resources and then return false instead of potentially throwing an IOException?

RealCLanger · 2023-06-21T15:25:15Z

test/lib/jdk/test/lib/Platform.java

+        BufferedReader is = new BufferedReader(new InputStreamReader(codesignProcess.getInputStream()));
+        String line;
+        while ((line = is.readLine()) != null) {
+            System.out.println("STDOUT: " + line);


This output is for every line seems too much. Maybe just print the lines where you find "Info.plist=not bound" or "Info.plist entries="?

I found the output useful when analyzing the issue (and it is just a few lines).

plummercj

Copyrights need updating.

plummercj · 2023-06-21T19:29:56Z

test/lib/jdk/test/lib/Platform.java

+                return true;
+            }
+        }
+        return false;


Probably would be good to log that no Info.plist entry was found.

plummercj · 2023-06-21T19:32:23Z

test/lib/jdk/test/lib/util/CoreUtils.java

@@ -127,6 +127,8 @@ public static String getCoreFileLocation(String crashOutputString, long pid) thr
            }

            return coreFileLocation; // success!
+        } else {
+            System.out.println("Core file not found, try to find a reason for this");


Suggested change

System.out.println("Core file not found, try to find a reason for this");

System.out.println("Core file not found. Trying to find a reason why...");

I changed the message.

plummercj · 2023-06-21T19:44:31Z

test/lib/jdk/test/lib/Platform.java

@@ -260,6 +260,34 @@ public static boolean hasSA() {
        return true;
    }

+
+    public static boolean hasPlistEntriesOSX() throws IOException {


Almost all of this is replicated from isHardenedOSX(). I wonder if there is a way to do some sharing while still maintaining separate APIs. Combining them into one API might make it harder to understand the code. Maybe a launchCodesign() API that returns the BufferedReader would help.

plummercj

Copyrights need updating.

plummercj · 2023-06-21T20:51:53Z

jdk/test/lib/TestMutuallyExclusivePlatformPredicates.java is failing due to the new API in Platform.java.

MBaesken · 2023-06-22T09:47:27Z

I adjusted COPYRIGHT info, adjusted TestMutuallyExclusivePlatformPredicates.java .
Also simplified the coding in Platform.java a bit.

RealCLanger

Looks a bit better. But I think instead of adding a Utils.javaPath() method, you can do all this path handling in Platform.launchCodesignOnJavaBinary(). Then even more code would be shared.

RealCLanger · 2023-06-22T10:52:09Z

test/lib/jdk/test/lib/Platform.java

@@ -260,6 +260,36 @@ public static boolean hasSA() {
        return true;
    }

+    private static codesignProcess launchCodesignOnJavaBinary(String javaFileName) {


That can't work... should be private static Process 😉

MBaesken · 2023-06-22T11:46:19Z

Yes it must be 'private static Process' . And I moved the javaPath method into the caller ,

MBaesken · 2023-06-22T12:06:02Z

Looks a bit better. But I think instead of adding a Utils.javaPath() method, you can do all this path handling in Platform.launchCodesignOnJavaBinary(). Then even more code would be shared.

Okay, I had the idea to later use the method javaPath at some more places, but let's do this separately.

RealCLanger

Looks good to me now.

MBaesken · 2023-06-23T08:37:16Z

Hi Christoph, thanks for the review !
Chris are you okay with the latest rev. of this change?

plummercj · 2023-06-26T05:11:24Z

Chris are you okay with the latest rev. of this change?

Sorry, I've been on vacation the past few days. I will have a look at it tomorrow.

plummercj · 2023-06-26T17:25:01Z

test/lib/jdk/test/lib/Platform.java

+        return codesignProcess;
+    }
+
+    public static boolean hasPlistEntriesOSX() throws IOException {


Although I understand why you chose this API name (it mimics the form used for isHardenedOSX), I don't think it is a good choice. isHardenedOSX is short for "is this a hardened OSX system". That mapping does not work with hasPlistEntriesOSX, which is more like "does this OSX system have plist entries". I would suggest hasOSXPlistEntries.

plummercj · 2023-06-26T17:26:30Z

test/lib/jdk/test/lib/util/CoreUtils.java

@@ -148,6 +150,11 @@ public static String getCoreFileLocation(String crashOutputString, long pid) thr
                    // We can't generate cores files with hardened binaries on OSX 10.15 and later.
                    throw new SkippedException("Cannot produce core file with hardened binary on OSX 10.15 and later");
                }
+            } else {
+                // codesign has to add entitlements using the plist, if this is not present we might not generate a core file


Suggested change

// codesign has to add entitlements using the plist, if this is not present we might not generate a core file

// codesign has to add entitlements using the plist. If this is not present we might not generate a core file.

MBaesken · 2023-06-27T13:40:30Z

Hi Chris, I renamed the method and adjusted the comment.

MBaesken · 2023-06-28T06:49:49Z

Thanks for the review !

/integrate

openjdk · 2023-06-28T06:51:10Z

Going to push as commit 39c104d.
Since your change was applied there have been 110 commits pushed to the master branch:

526dba1: 8310130: C2: assert(false) failed: scalar_input is neither phi nor a matchin reduction
48e61c1: 8310728: Enable Zc:inline flag in Visual Studio build
56a73a6: 8309591: Socket.setOption(TCP_QUICKACK) uses wrong level
afdaa2a: 8309109: AArch64: [TESTBUG] compiler/intrinsics/sha/cli/TestUseSHA3IntrinsicsOptionOnSupportedCPU.java fails on Neoverse N2 and V1
7f09435: 8310982: jdk/internal/util/ArchTest.java fails after JDK-8308452 failed with Method isARM()
f07e396: 8310914: Remove 2 malformed java/foreign ProblemList entries
a97f98f: 8310585: GetThreadState spec mentions undefined JVMTI_THREAD_STATE_MONITOR_WAITING
2cf5c2f: 8310238: [test bug] javax/swing/JTableHeader/6889007/bug6889007.java fails
269852b: 8294316: SA core file support is broken on macosx-x64 starting with macOS 12.x
4bce38c: 8310830: typo in the parameter name in @throws of ClassDesc::ofDescriptor
... and 100 more: https://git.openjdk.org/jdk/compare/4ca548fe74419dc9e110489e3d2d3adf695ef37f...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-06-28T06:51:21Z

@MBaesken Pushed as commit 39c104d.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

JDK-8310380

0d8c68c

openjdk bot added the rfr Pull request is ready for review label Jun 20, 2023

openjdk bot added serviceability serviceability-dev@openjdk.org hotspot-runtime hotspot-runtime-dev@openjdk.org core-libs core-libs-dev@openjdk.org labels Jun 20, 2023

RealLucy approved these changes Jun 21, 2023

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jun 21, 2023

RealCLanger reviewed Jun 21, 2023

View reviewed changes

plummercj reviewed Jun 21, 2023

View reviewed changes

plummercj suggested changes Jun 21, 2023

View reviewed changes

Some adjustments

1b604db

RealCLanger suggested changes Jun 22, 2023

View reviewed changes

move javaPath into caller

619b357

RealCLanger approved these changes Jun 22, 2023

View reviewed changes

plummercj suggested changes Jun 26, 2023

View reviewed changes

small adjustments

09eb93c

plummercj approved these changes Jun 27, 2023

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label Jun 28, 2023

openjdk bot closed this Jun 28, 2023

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jun 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JDK-8310380: Handle problems in core-related tests on macOS when codesign tool does not work #14562

JDK-8310380: Handle problems in core-related tests on macOS when codesign tool does not work #14562

MBaesken commented Jun 20, 2023 •

edited by openjdk bot

Loading

bridgekeeper bot commented Jun 20, 2023

openjdk bot commented Jun 20, 2023

mlbridge bot commented Jun 20, 2023 •

edited

Loading

RealLucy left a comment

openjdk bot commented Jun 21, 2023 •

edited

Loading

RealCLanger left a comment

RealCLanger Jun 21, 2023

RealCLanger Jun 21, 2023 •

edited

Loading

RealCLanger Jun 21, 2023

RealCLanger Jun 21, 2023

RealCLanger Jun 21, 2023

MBaesken Jun 22, 2023

plummercj left a comment

plummercj Jun 21, 2023

plummercj Jun 21, 2023

MBaesken Jun 22, 2023

plummercj Jun 21, 2023

plummercj left a comment

plummercj commented Jun 21, 2023

MBaesken commented Jun 22, 2023

RealCLanger left a comment

RealCLanger Jun 22, 2023

MBaesken commented Jun 22, 2023

MBaesken commented Jun 22, 2023 •

edited

Loading

RealCLanger left a comment

MBaesken commented Jun 23, 2023

plummercj commented Jun 26, 2023

plummercj Jun 26, 2023

plummercj Jun 26, 2023

MBaesken commented Jun 27, 2023

MBaesken commented Jun 28, 2023

openjdk bot commented Jun 28, 2023

openjdk bot commented Jun 28, 2023

	System.out.println("Core file not found, try to find a reason for this");
	System.out.println("Core file not found. Trying to find a reason why...");

	// codesign has to add entitlements using the plist, if this is not present we might not generate a core file
	// codesign has to add entitlements using the plist. If this is not present we might not generate a core file.

JDK-8310380: Handle problems in core-related tests on macOS when codesign tool does not work #14562

JDK-8310380: Handle problems in core-related tests on macOS when codesign tool does not work #14562

Conversation

MBaesken commented Jun 20, 2023 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

Webrev

bridgekeeper bot commented Jun 20, 2023

openjdk bot commented Jun 20, 2023

mlbridge bot commented Jun 20, 2023 • edited Loading

Webrevs

RealLucy left a comment

Choose a reason for hiding this comment

openjdk bot commented Jun 21, 2023 • edited Loading

RealCLanger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RealCLanger Jun 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

plummercj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

plummercj left a comment

Choose a reason for hiding this comment

plummercj commented Jun 21, 2023

MBaesken commented Jun 22, 2023

RealCLanger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MBaesken commented Jun 22, 2023

MBaesken commented Jun 22, 2023 • edited Loading

RealCLanger left a comment

Choose a reason for hiding this comment

MBaesken commented Jun 23, 2023

plummercj commented Jun 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MBaesken commented Jun 27, 2023

MBaesken commented Jun 28, 2023

openjdk bot commented Jun 28, 2023

openjdk bot commented Jun 28, 2023

MBaesken commented Jun 20, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Jun 20, 2023 •

edited

Loading

openjdk bot commented Jun 21, 2023 •

edited

Loading

RealCLanger Jun 21, 2023 •

edited

Loading

MBaesken commented Jun 22, 2023 •

edited

Loading