8358600: Template-Framework Library: Template for TestFramework test class #25643

eme64 · 2025-06-04T15:50:17Z

We might want to write many IR/TestFramework tests, and so I would like to integrate a Template that generates the class, and the user has to only generate a list of tests.

This is a first extension for #24217. I had already prototyped it earlier and plan to use it in multiple tests #23418 (see IRTestClass.java).

jdk/test/hotspot/jtreg/compiler/lib/template_framework/library/TestFrameworkClass.java

Lines 36 to 45 in dc640cb

    
            * This class provides a {@link #render} method that can be used to simplify generating 
        
            * source code when using the {@link TestFramework} (also known as IR Framework) to run 
        
            * a list of tests. 
        
            * 
        
            * <p> 
        
            * The idea is that the user only has to generate the code for the individual tests, 
        
            * and can then pass the corresponding list of {@link TemplateToken}s to this 
        
            * provided {@link #render} method which generates the surrounding class and the main 
        
            * method that invokes the {@link TestFramework}, so that all the generated tests 
        
            * are run.

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-8358600: Template-Framework Library: Template for TestFramework test class (Sub-task - P4)

Reviewers

Manuel Hässig (@mhaessig - Author) Review applies to 256d922c
Christian Hagedorn (@chhagedorn - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25643

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

Using diff file

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

Using Webrev

Link to Webrev Comment

bridgekeeper · 2025-06-04T15:51:03Z

👋 Welcome back epeter! 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 · 2025-06-04T15:51:31Z

@eme64 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:

8358600: Template-Framework Library: Template for TestFramework test class

Reviewed-by: chagedorn, mhaessig

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 97 new commits pushed to the master branch:

3f0fef2: 8359135: New test TestCPUTimeSampleThrottling fails intermittently
3e0ef83: 8359083: Test jdkCheckHtml.java should report SkippedException rather than report fails when miss tidy
7b7136b: 8359181: Error messages generated by configure --help after 8301197
... and 94 more: https://git.openjdk.org/jdk/compare/248341d372ba9c1031729a65eb10d8def52de641...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.

openjdk · 2025-06-04T15:52:02Z

@eme64 The following label will be automatically applied to this pull request:

hotspot-compiler

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

mlbridge · 2025-06-04T16:02:11Z

Webrevs

mhaessig

Thank you for your continued work on the Template Framework. This seems like good start to the template library. While it already looks good, I have a few small questions :)

.../hotspot/jtreg/testlibrary_tests/template_framework/examples/TestWithTestFrameworkClass.java

mhaessig · 2025-06-05T11:13:17Z

.../hotspot/jtreg/testlibrary_tests/template_framework/examples/TestWithTestFrameworkClass.java

+            "p.xyz", "InnerTest",
+            // List of imports. Duplicates are permitted.
+            List.of("compiler.lib.generators.*",
+                    "compiler.lib.ir_framework.*",


Suggested change

"compiler.lib.ir_framework.*",

This should not be needed since its imported by default in TestFrameworkClass. Or is this a deliberate duplication?

Yes, it was deliberate. But I'll just remove it.

mhaessig · 2025-06-05T11:15:47Z

test/hotspot/jtreg/compiler/lib/template_framework/library/TestFrameworkClass.java

+     */
+    public static String render(final String packageName,
+                                final String className,
+                                final List<String> imports,


To eliminate duplicate imports this could also be a Set.

Sure, I'll make it a Set.

mhaessig

Thank you for your continued work on the Template Framework. This seems like good start to the template library. While it already looks good, I have a few small questions :)

eme64 · 2025-06-05T11:58:39Z

@mhaessig Thanks for reviewing! I applied you suggestions :)

mhaessig

Thank you for addressing my comments. Looks good to me!

eme64 · 2025-06-05T12:09:23Z

@mhaessig Thank you 😊

chhagedorn

Otherwise, looks good!

chhagedorn · 2025-06-12T07:17:20Z

test/hotspot/jtreg/compiler/lib/template_framework/library/TestFrameworkClass.java

+            public class #className {
+            // --- CLASS_HOOK insertions start ---
+            """,
+            Hooks.CLASS_HOOK.anchor(


Ah, so I can insert here from my testTemplateTokens right? Do you also want to show an example in TestWithTestFrameworkClass that this is possible? Maybe we can also add something in the description above since I only got aware of that now when seeing this anchor().

eme64 · 2025-06-12T09:14:24Z

@chhagedorn I added a comment and example with the hook insertion :)

chhagedorn

Thanks for adding the hint!

eme64 · 2025-06-12T14:11:13Z

@mhaessig @chhagedorn Thanks for reviewing and for all the helpful suggestions 😊

eme64 · 2025-06-12T14:11:35Z

/integrate

openjdk · 2025-06-12T14:12:15Z

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

e18277b: 8352075: Perf regression accessing fields
e5ce5c5: 8357959: (bf) ByteBuffer.allocateDirect initialization can result in large TTSP spikes
91fdd72: 8355726: LinkedBlockingDeque fixes and improvements
... and 99 more: https://git.openjdk.org/jdk/compare/248341d372ba9c1031729a65eb10d8def52de641...master

Your commit was automatically rebased without conflicts.

openjdk · 2025-06-12T14:12:22Z

@eme64 Pushed as commit b85fe02.

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

JDK-8358600

11d55dc

openjdk bot changed the title ~~JDK-8358600~~ 8358600: Template-Framework Library: Template for TestFramework test class Jun 4, 2025

openjdk bot added the hotspot-compiler label Jun 4, 2025

eme64 marked this pull request as ready for review June 4, 2025 15:55

openjdk bot added the rfr label Jun 4, 2025

streamline API to a single render method

dc640cb

mhaessig reviewed Jun 5, 2025

View reviewed changes

review suggestions

256d922

mhaessig approved these changes Jun 5, 2025

View reviewed changes

chhagedorn approved these changes Jun 12, 2025

View reviewed changes

openjdk bot added the ready label Jun 12, 2025

add hook example and comment for christian

55c6b22

openjdk bot removed the ready label Jun 12, 2025

chhagedorn approved these changes Jun 12, 2025

View reviewed changes

openjdk bot added the ready label Jun 12, 2025

openjdk bot added the integrated label Jun 12, 2025

openjdk bot closed this Jun 12, 2025

openjdk bot removed ready rfr labels Jun 12, 2025

	* This class provides a {@link #render} method that can be used to simplify generating
	* source code when using the {@link TestFramework} (also known as IR Framework) to run
	* a list of tests.
	*
	* <p>
	* The idea is that the user only has to generate the code for the individual tests,
	* and can then pass the corresponding list of {@link TemplateToken}s to this
	* provided {@link #render} method which generates the surrounding class and the main
	* method that invokes the {@link TestFramework}, so that all the generated tests
	* are run.

8358600: Template-Framework Library: Template for TestFramework test class #25643

8358600: Template-Framework Library: Template for TestFramework test class #25643

Uh oh!

Conversation

eme64 commented Jun 4, 2025 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Jun 4, 2025

Uh oh!

openjdk bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk bot commented Jun 4, 2025

Uh oh!

mlbridge bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

mhaessig left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mhaessig Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

eme64 Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

mhaessig Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

eme64 Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mhaessig left a comment

Choose a reason for hiding this comment

Uh oh!

eme64 commented Jun 5, 2025

Uh oh!

mhaessig left a comment

Choose a reason for hiding this comment

Uh oh!

eme64 commented Jun 5, 2025

Uh oh!

chhagedorn left a comment

Choose a reason for hiding this comment

Uh oh!

chhagedorn Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

eme64 commented Jun 12, 2025

Uh oh!

chhagedorn left a comment

Choose a reason for hiding this comment

Uh oh!

eme64 commented Jun 12, 2025

Uh oh!

eme64 commented Jun 12, 2025

Uh oh!

openjdk bot commented Jun 12, 2025

Uh oh!

openjdk bot commented Jun 12, 2025

Uh oh!

Uh oh!

eme64 commented Jun 4, 2025 •

edited by openjdk bot

Loading

openjdk bot commented Jun 4, 2025 •

edited

Loading

mlbridge bot commented Jun 4, 2025 •

edited

Loading

eme64 Jun 5, 2025 •

edited

Loading