--- /dev/null 2018-10-22 16:32:33.000000000 -0700 +++ new/test/jdk/com/sun/jdi/lib/jdb/Debuggee.java 2018-10-22 16:32:30.450637300 -0700 @@ -0,0 +1,191 @@ +/* + * Copyright (c) 2018, 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. + */ + +package lib.jdb; + +import jdk.test.lib.Utils; +import jdk.test.lib.process.ProcessTools; + +import java.io.Closeable; +import java.io.IOException; +import java.util.LinkedList; +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; + +/** + * Helper class to run java debuggee and parse agent listening transport/address. + * Usage: + * 1) + * Debugee debugee = Debuggee.launcher("MyClass").setTransport("dt_shmem").launch(); + * try { + * String transport = debuggee.getTransport(); + * String addr = debuggee.getAddress(); + * } finally { + * debuggee.shutdown(); + * } + * 2) (using try-with-resource) + * try (Debugee debugee = Debuggee.launcher("MyClass").launch()) { + * String transport = debuggee.getTransport(); + * String addr = debuggee.getAddress(); + * } + * 3) + * ProcessBuilder pb = Debuggee.launcher("MyClass").setSuspended(false).prepare(); + * ProcessTools.executeProcess(pb); + */ +public class Debuggee implements Closeable { + + public static Launcher launcher(String mainClass) { + return new Launcher(mainClass); + } + + public static class Launcher { + private final String mainClass; + private final List options = new LinkedList<>(); + private String transport = "dt_socket"; + private String address = null; + private boolean suspended = true; + private boolean addTestVmAndJavaOptions = true; + + private Launcher(String mainClass) { + this.mainClass = mainClass; + } + public Launcher addOption(String option) { + options.add(option); + return this; + } + public Launcher addOptions(List options) { + this.options.addAll(options); + return this; + } + // default is "dt_socket" + public Launcher setTransport(String value) { + transport = value; + return this; + } + // default is "null" (auto-generate) + public Launcher setAddress(String value) { + address = value; + return this; + } + // default is "true" + public Launcher setSuspended(boolean value) { + suspended = value; + return this; + } + // default is "true" + public Launcher addTestVmAndJavaOptions(boolean value) { + addTestVmAndJavaOptions = value; + return this; + } + + public ProcessBuilder prepare() { + List debuggeeArgs = new LinkedList<>(); + debuggeeArgs.add("-agentlib:jdwp=transport=" + transport + + (address == null ? "" : ",address=" + address) + + ",server=y,suspend=" + (suspended ? "y" : "n")); + debuggeeArgs.addAll(options); + debuggeeArgs.add(mainClass); + return ProcessTools.createJavaProcessBuilder(addTestVmAndJavaOptions, + debuggeeArgs.toArray(new String[0])); + } + + public Debuggee launch(String name) { + return new Debuggee(prepare(), name); + } + public Debuggee launch() { + return launch("debuggee"); + } + } + + // starts the process, waits for "Listening for transport" output and detects transport/address + private Debuggee(ProcessBuilder pb, String name) { + // debuggeeListen[0] - transport, debuggeeListen[1] - address + String[] debuggeeListen = new String[2]; + Pattern listenRegexp = Pattern.compile("Listening for transport \\b(.+)\\b at address: \\b(.+)\\b"); + try { + p = ProcessTools.startProcess(name, pb, + s -> output.add(s), // output consumer + s -> { // warm-up predicate + Matcher m = listenRegexp.matcher(s); + if (!m.matches()) { + return false; + } + debuggeeListen[0] = m.group(1); + debuggeeListen[1] = m.group(2); + return true; + }, + 30, TimeUnit.SECONDS); + transport = debuggeeListen[0]; + address = debuggeeListen[1]; + } catch (IOException | InterruptedException | TimeoutException ex) { + throw new RuntimeException("failed to launch debuggee", ex); + } + } + + private final Process p; + private final List output = new LinkedList<>(); + private final String transport; + private final String address; + + public void shutdown() { + try { + close(); + } catch (IOException ex) { + // ignore + } + } + + // waits until the process shutdown or crash + public boolean waitFor(long timeout, TimeUnit unit) { + try { + return p.waitFor(Utils.adjustTimeout(timeout), unit); + } catch (InterruptedException e) { + return false; + } + } + + // returns the whole debuggee output as a string + public String getOutput() { + return output.stream().collect(Collectors.joining(Utils.NEW_LINE)); + } + + String getTransport() { + return transport; + } + + public String getAddress() { + return address; + } + + @Override + public void close() throws IOException { + if (p.isAlive()) { + p.destroy(); + } + } + +}