8308475: Make the thread dump files generated by jcmd Thread.dump_to_file jtreg failure handler action easily accessible

Reviewed-by: lmesnik

Author: jaikiran

test/failure_handler/src/share/classes/jdk/test/failurehandler/HtmlSection.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2023, 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
@@ -150,6 +150,17 @@ public void link(HtmlSection section, String child, String name) {
                 path, name);
     }
 
+    /**
+     * Creates a {@code <a href></a>} link with {@code targetAddress} being the value for {@code href}
+     * and the {@code linkText} being the text for the link.
+     *
+     * @param targetAddress the target address
+     * @param linkText      the text for the link
+     */
+    public void createLink(String targetAddress, String linkText) {
+        pw.printf("<a href=\"%1$s\">%2$s</a>%n", targetAddress, linkText);
+    }
+
     public HtmlSection createChildren(String[] sections) {
         int i = 0;
         int n = sections.length;

test/failure_handler/src/share/classes/jdk/test/failurehandler/action/ActionHelper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2023, 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
@@ -47,6 +47,7 @@
 import java.util.Date;
 import java.util.List;
 import java.util.Properties;
+import java.util.StringTokenizer;
 import java.util.Timer;
 import java.util.TimerTask;
 import java.util.concurrent.TimeUnit;
@@ -76,9 +77,10 @@ public ActionHelper(Path workDir, String prefix, Properties properties,
     public List<Long> getChildren(HtmlSection section, long pid) {
         String pidStr = "" + pid;
         ProcessBuilder pb = getChildren.prepareProcess(section, this, pidStr);
-        PrintWriter log = getChildren.getSection(section).getWriter();
+        HtmlSection childrenSection = getChildren.getSection(section);
+        PrintWriter log = childrenSection.getWriter();
         CharArrayWriter writer = new CharArrayWriter();
-        ExitCode code = run(log, writer, pb, getChildren.getParameters());
+        ExitCode code = run(childrenSection, log, writer, pb, getChildren.getParameters());
         Reader output = new CharArrayReader(writer.toCharArray());
 
         if (!ExitCode.OK.equals(code)) {
@@ -154,8 +156,8 @@ private void addJdks(Path[] jdkPaths) {
         }
     }
 
-    private ExitCode run(PrintWriter log, Writer out, ProcessBuilder pb,
-                    ActionParameters params) {
+    private ExitCode run(HtmlSection section, PrintWriter log, Writer out, ProcessBuilder pb,
+                         ActionParameters params) {
         char[] lineChars = new char[40];
         Arrays.fill(lineChars, '-');
         String line = new String(lineChars);
@@ -199,6 +201,19 @@ private ExitCode run(PrintWriter log, Writer out, ProcessBuilder pb,
         log.printf("%s%n[%tF %<tT] exit code: %d time: %d ms%n%1$s%n",
                 line, new Date(), result.value,
                 TimeUnit.NANOSECONDS.toMillis(stopwatch.getElapsedTimeNs()));
+        // upon successful completion of the action, generate links to any successArtifacts
+        // that have been declared for this action
+        if (ExitCode.OK.equals(result) && params.successArtifacts != null) {
+            final StringTokenizer t = new StringTokenizer(params.successArtifacts, ",");
+            while (t.hasMoreTokens()) {
+                final String artifactPath = t.nextToken().trim();
+                if (artifactPath.isEmpty()) {
+                    continue;
+                }
+                // create a link to the artifact
+                section.createLink(artifactPath, artifactPath);
+            }
+        }
         return result;
     }
 
@@ -286,11 +301,21 @@ private void exec(HtmlSection section, ProcessBuilder process,
         }
         PrintWriter sectionWriter = section.getWriter();
         if (params.repeat > 1) {
+            // hold on to the original command and successArtifacts values which potentially
+            // contain the %iterCount token, since we need to replace it with different value
+            // on each iteration
+            String originalSuccessArtifacts = params.successArtifacts;
+            List<String> originalCommand = process.command();
             for (int i = 0, n = params.repeat; i < n; ++i) {
                 HtmlSection iteration = section.createChildren(
                         String.format("iteration_%d", i));
                 PrintWriter writer = iteration.getWriter();
-                ExitCode exitCode = run(writer, writer, process, params);
+                // use the original values with the token (if any)
+                params.successArtifacts = originalSuccessArtifacts;
+                process.command(originalCommand);
+                // replace the %iterCount token (if any)
+                prepareIteration(i, process, params);
+                ExitCode exitCode = run(section, writer, writer, process, params);
                 if (params.stopOnError && !ExitCode.OK.equals(exitCode)) {
                     sectionWriter.printf(
                             "ERROR: non zero exit code[%d] -- break.",
@@ -309,7 +334,26 @@ private void exec(HtmlSection section, ProcessBuilder process,
                 }
             }
         } else {
-            run(section.getWriter(), section.getWriter(), process, params);
+            prepareIteration(0, process, params);
+            run(section, section.getWriter(), section.getWriter(), process, params);
+        }
+    }
+
+    // replaces the occurrences of %iterCount from the process builder command/arguments
+    // and the action params' "successArtifacts" paths, with the iteration count
+    private void prepareIteration(int iterationCount, ProcessBuilder pb,
+                                  ActionParameters actionParams) {
+        List<String> command = new ArrayList<>();
+        for (String arg : pb.command()) {
+            arg = arg.replaceAll("%iterCount", String.valueOf(iterationCount)) ;
+            command.add(arg);
+        }
+        pb.command(command);
+
+        String successArtifacts = actionParams.successArtifacts;
+        if (successArtifacts != null) {
+            actionParams.successArtifacts = successArtifacts.replaceAll("%iterCount",
+                    String.valueOf(iterationCount));
         }
     }
 

test/failure_handler/src/share/classes/jdk/test/failurehandler/action/ActionParameters.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2023, 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
@@ -43,5 +43,9 @@ public class ActionParameters {
     @DefaultValue (value = "" + 20_000L)
     public long timeout = -1L;
 
+    @Value (name = "successArtifacts")
+    @DefaultValue (value = "")
+    public String successArtifacts = "";
+
     public ActionParameters() { }
 }

test/failure_handler/src/share/classes/jdk/test/failurehandler/action/PatternAction.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2023, 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
@@ -62,6 +62,11 @@ public ProcessBuilder prepareProcess(HtmlSection section,
         for (int i = 0, n = args.length; i < n; ++i) {
             args[i] = args[i].replace("%java", helper.findApp("java").getAbsolutePath());
         }
+        // replace occurrences of the pattern in the "successArtifacts" param
+        String successArtifacts = action.getParameters().successArtifacts;
+        if (successArtifacts != null) {
+            action.getParameters().successArtifacts = successArtifacts.replaceAll(pattern, value);
+        }
         return action.prepareProcess(section.getWriter(), helper);
     }
 

test/failure_handler/src/share/conf/common.properties

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015, 2022, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2015, 2023, 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
@@ -57,7 +57,9 @@ jcmd.gc.class_histogram.args=%p GC.class_histogram
 jcmd.gc.finalizer_info.args=%p GC.finalizer_info
 jcmd.gc.heap_info.args=%p GC.heap_info
 
-jcmd.thread.dump_to_file.args=%p Thread.dump_to_file JavaThread.dump.%p
+jcmd.thread.dump_to_file.args=%p Thread.dump_to_file -format=json JavaThread.dump.%p.%iterCount
+jcmd.thread.dump_to_file.params.repeat=6
+jcmd.thread.dump_to_file.params.successArtifacts=JavaThread.dump.%p.%iterCount
 
 jstack.app=jstack
 jstack.args=-e -l %p