8242522: Minor LingeredApp improvements

Reviewed-by: lmesnik, cjplummer

Author: Alex Menkov

test/hotspot/jtreg/serviceability/attach/AttachNegativePidTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2020, 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
@@ -40,15 +40,20 @@
 public class AttachNegativePidTest {
 
     public static void main(String... args) throws Exception {
-        LingeredApp app = LingeredApp.startApp();
-        String strPID = Long.toString(-1 * app.getPid());
+        LingeredApp app = null;
         try {
-            VirtualMachine.attach(strPID);
-        } catch (AttachNotSupportedException anse) {
-            // Passed
-            return;
+            app = LingeredApp.startApp();
+            String strPID = Long.toString(-1 * app.getPid());
+            try {
+                VirtualMachine.attach(strPID);
+            } catch (AttachNotSupportedException anse) {
+                // Passed
+                return;
+            }
+            throw new RuntimeException("There is no expected AttachNotSupportedException for " + strPID);
+        } finally {
+            LingeredApp.stopApp(app);
         }
-        throw new RuntimeException("There is no expected AttachNotSupportedException for " + strPID);
     }
 
 }

test/jdk/sun/tools/jhsdb/heapconfig/TmtoolTestScenario.java

@@ -66,14 +66,14 @@ public List<String> getToolOutput() {
      * @return STDOUT of test app
      */
     public List<String> getAppOutput() {
-        return theApp.getAppOutput();
+        return theApp.getOutput().getStdoutAsList();
     }
 
     /**
      * @return Value of the app output with -XX:+PrintFlagsFinal as a map.
      */
-    public Map<String, String>  parseFlagsFinal() {
-        List<String> astr = theApp.getAppOutput();
+    public Map<String, String> parseFlagsFinal() {
+        List<String> astr = getAppOutput();
         Map<String, String> vmMap = new HashMap<String, String>();
 
         for (String line : astr) {

test/jdk/sun/tools/jinfo/JInfoTest.java

@@ -68,8 +68,12 @@ private static void setFlag() throws Exception {
             output.shouldHaveExitValue(0);
             documentMatch(output.getStdout(), ".*MinHeapFreeRatio=1.*MinHeapFreeRatio=1.*");
         } finally {
-            JInfoTestLingeredApp.stopApp(app1);
-            JInfoTestLingeredApp.stopApp(app2);
+            // LingeredApp.stopApp can throw an exception
+            try {
+                JInfoTestLingeredApp.stopApp(app1);
+            } finally {
+                JInfoTestLingeredApp.stopApp(app2);
+            }
         }
     }
 
@@ -92,8 +96,12 @@ private static void classNameMatch() throws Exception {
             // "Runtime Environment" written once per proc
             documentMatch(output.getStdout(), ".*Runtime Environment.*Runtime Environment.*");
         } finally {
-            JInfoTestLingeredApp.stopApp(app1);
-            JInfoTestLingeredApp.stopApp(app2);
+            // LingeredApp.stopApp can throw an exception
+            try {
+                JInfoTestLingeredApp.stopApp(app1);
+            } finally {
+                JInfoTestLingeredApp.stopApp(app2);
+            }
         }
     }
 

test/lib/jdk/test/lib/apps/LingeredApp.java

@@ -23,10 +23,8 @@
 
 package jdk.test.lib.apps;
 
-import java.io.BufferedReader;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
-import java.io.StringReader;
 import java.nio.file.Files;
 import java.nio.file.NoSuchFileException;
 import java.nio.file.Path;
@@ -40,6 +38,8 @@
 import java.util.Map;
 import java.util.stream.Collectors;
 import java.util.UUID;
+
+import jdk.test.lib.JDKToolFinder;
 import jdk.test.lib.Utils;
 import jdk.test.lib.process.OutputBuffer;
 import jdk.test.lib.process.StreamPumper;
@@ -49,9 +49,18 @@
  * to make further attach actions reliable across supported platforms
 
  * Caller example:
- *   SmartTestApp a = SmartTestApp.startApp(cmd);
+ *
+ *   LingeredApp a = LingeredApp.startApp(cmd);
+ *     // do something.
+ *     // a.getPid(). a.getProcess(), a.getProcessStdout() are available.
+ *   LingeredApp.stopApp(a);
+ *
+ *   for use custom LingeredApp (class SmartTestApp extends LingeredApp):
+ *
+ *   SmartTestApp = new SmartTestApp();
+ *   LingeredApp.startApp(a, cmd);
  *     // do something
- *   a.stopApp();
+ *   a.stopApp();   // LingeredApp.stopApp(a) can be used as well
  *
  *   or fine grained control
  *
@@ -63,10 +72,9 @@
  *   a.deleteLock();
  *   a.waitAppTerminate();
  *
- *  Then you can work with app output and process object
+ *  After app termination (stopApp/waitAppTermination) its output is available
  *
  *   output = a.getAppOutput();
- *   process = a.getProcess();
  *
  */
 public class LingeredApp {
@@ -144,7 +152,7 @@ public OutputBuffer getOutput() {
             throw new RuntimeException("Process is still alive. Can't get its output.");
         }
         if (output == null) {
-            output = OutputBuffer.of(stdoutBuffer.toString(), stderrBuffer.toString());
+            output = OutputBuffer.of(stdoutBuffer.toString(), stderrBuffer.toString(), appProcess.exitValue());
         }
         return output;
     }
@@ -168,18 +176,6 @@ private void startOutputPumpers() {
         errPumperThread.start();
     }
 
-    /**
-     *
-     * @return application output as List. Empty List if application produced no output
-     */
-    public List<String> getAppOutput() {
-        if (appProcess.isAlive()) {
-            throw new RuntimeException("Process is still alive. Can't get its output.");
-        }
-        BufferedReader bufReader = new BufferedReader(new StringReader(output.getStdout()));
-        return bufReader.lines().collect(Collectors.toList());
-    }
-
     /* Make sure all part of the app use the same method to get dates,
      as different methods could produce different results
      */
@@ -241,14 +237,16 @@ public void waitAppTerminate() {
      * The app touches the lock file when it's started
      * wait while it happens. Caller have to delete lock on wait error.
      *
-     * @param timeout
+     * @param timeout timeout in seconds
      * @throws java.io.IOException
      */
     public void waitAppReady(long timeout) throws IOException {
+        // adjust timeout for timeout_factor and convert to ms
+        timeout = Utils.adjustTimeout(timeout) * 1000;
         long here = epoch();
         while (true) {
             long epoch = epoch();
-            if (epoch - here > (timeout * 1000)) {
+            if (epoch - here > timeout) {
                 throw new IOException("App waiting timeout");
             }
 
@@ -271,30 +269,20 @@ public void waitAppReady(long timeout) throws IOException {
         }
     }
 
+    /**
+     * Waits the application to start with the default timeout.
+     */
+    public void waitAppReady() throws IOException {
+        waitAppReady(appWaitTime);
+    }
+
     /**
      * Analyze an environment and prepare a command line to
      * run the app, app name should be added explicitly
      */
     private List<String> runAppPrepare(String[] vmArguments) {
-        // We should always use testjava or throw an exception,
-        // so we can't use JDKToolFinder.getJDKTool("java");
-        // that falls back to compile java on error
-        String jdkPath = System.getProperty("test.jdk");
-        if (jdkPath == null) {
-            // we are not under jtreg, try env
-            Map<String, String> env = System.getenv();
-            jdkPath = env.get("TESTJAVA");
-        }
-
-        if (jdkPath == null) {
-            throw new RuntimeException("Can't determine jdk path neither test.jdk property no TESTJAVA env are set");
-        }
-
-        String osname = System.getProperty("os.name");
-        String javapath = jdkPath + ((osname.startsWith("window")) ? "/bin/java.exe" : "/bin/java");
-
-        List<String> cmd = new ArrayList<String>();
-        cmd.add(javapath);
+        List<String> cmd = new ArrayList<>();
+        cmd.add(JDKToolFinder.getTestJDKTool("java"));
         Collections.addAll(cmd, vmArguments);
 
         // Make sure we set correct classpath to run the app
@@ -318,12 +306,9 @@ protected void runAddAppName(List<String> cmd) {
      */
     public void printCommandLine(List<String> cmd) {
         // A bit of verbosity
-        StringBuilder cmdLine = new StringBuilder();
-        for (String strCmd : cmd) {
-            cmdLine.append("'").append(strCmd).append("' ");
-        }
-
-        System.err.println("Command line: [" + cmdLine.toString() + "]");
+        System.out.println(cmd.stream()
+                .map(s -> "'" + s + "'")
+                .collect(Collectors.joining(" ", "Command line: [", "]")));
     }
 
     /**
@@ -357,7 +342,7 @@ private void finishApp() {
                     " LingeredApp stderr: [" + output.getStderr() + "]\n" +
                     " LingeredApp exitValue = " + appProcess.exitValue();
 
-            System.err.println(msg);
+            System.out.println(msg);
         }
     }
 
@@ -398,7 +383,7 @@ public static void startAppExactJvmOpts(LingeredApp theApp, String... jvmOpts) t
         theApp.createLock();
         try {
             theApp.runAppExactJvmOpts(jvmOpts);
-            theApp.waitAppReady(appWaitTime);
+            theApp.waitAppReady();
         } catch (Exception ex) {
             theApp.deleteLock();
             throw ex;
@@ -428,7 +413,7 @@ public static LingeredApp startApp(String... additionalJvmOpts) throws IOExcepti
         try {
             startApp(a, additionalJvmOpts);
         } catch (Exception ex) {
-            System.err.println("LingeredApp failed to start: " + ex);
+            System.out.println("LingeredApp failed to start: " + ex);
             a.finishApp();
             throw ex;
         }

test/lib/jdk/test/lib/process/OutputBuffer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2020, 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
@@ -23,13 +23,17 @@
 
 package jdk.test.lib.process;
 
+import java.io.BufferedReader;
 import java.io.ByteArrayOutputStream;
 import java.io.InputStream;
+import java.io.StringReader;
 import java.nio.charset.Charset;
 import java.time.Instant;
+import java.util.List;
 import java.util.concurrent.CancellationException;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Future;
+import java.util.stream.Collectors;
 
 public interface OutputBuffer {
   public static class OutputBufferException extends RuntimeException {
@@ -46,6 +50,17 @@ public OutputBufferException(Throwable cause) {
    * @return stdout result
    */
   public String getStdout();
+
+  /**
+   * Returns the stdout as a list.
+   * Empty List if application produced no output.
+   */
+  default public List<String> getStdoutAsList() {
+    return new BufferedReader(new StringReader(getStdout()))
+            .lines()
+            .collect(Collectors.toList());
+  }
+
   /**
    * Returns the stderr result
    *