Merge pull request #4433 from ghubstan/5-add-remote-debug-option

Allow remote debugging of background Bisq apps
bisq-network · Aug 31, 2020 · 8c6b525 · 8c6b525
2 parents 51d1441 + 4d12b8f
commit 8c6b525
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 18 deletions.
diff --git a/apitest/src/main/java/bisq/apitest/config/ApiTestConfig.java b/apitest/src/main/java/bisq/apitest/config/ApiTestConfig.java
@@ -69,6 +69,7 @@ public class ApiTestConfig {
     static final String SKIP_TESTS = "skipTests";
     static final String SHUTDOWN_AFTER_TESTS = "shutdownAfterTests";
     static final String SUPPORTING_APPS = "supportingApps";
+    static final String ENABLE_BISQ_DEBUGGING = "enableBisqDebugging";
 
     // Default values for certain options
     static final String DEFAULT_CONFIG_FILE_NAME = "apitest.properties";
@@ -99,6 +100,7 @@ public class ApiTestConfig {
     public final boolean skipTests;
     public final boolean shutdownAfterTests;
     public final List<String> supportingApps;
+    public final boolean enableBisqDebugging;
 
     // Immutable system configurations set in the constructor.
     public final String bitcoinDatadir;
@@ -224,6 +226,12 @@ public ApiTestConfig(String... args) {
                         .ofType(String.class)
                         .defaultsTo("bitcoind,seednode,arbdaemon,alicedaemon,bobdaemon");
 
+        ArgumentAcceptingOptionSpec<Boolean> enableBisqDebuggingOpt =
+                parser.accepts(ENABLE_BISQ_DEBUGGING,
+                        "Start Bisq apps with remote debug options")
+                        .withRequiredArg()
+                        .ofType(Boolean.class)
+                        .defaultsTo(false);
         try {
             CompositeOptionSet options = new CompositeOptionSet();
 
@@ -279,6 +287,7 @@ public ApiTestConfig(String... args) {
             this.skipTests = options.valueOf(skipTestsOpt);
             this.shutdownAfterTests = options.valueOf(shutdownAfterTestsOpt);
             this.supportingApps = asList(options.valueOf(supportingAppsOpt).split(","));
+            this.enableBisqDebugging = options.valueOf(enableBisqDebuggingOpt);
 
             // Assign values to special-case static fields.
             BASH_PATH_VALUE = bashPath;

diff --git a/apitest/src/main/java/bisq/apitest/config/BisqAppConfig.java b/apitest/src/main/java/bisq/apitest/config/BisqAppConfig.java
@@ -30,58 +30,64 @@
  @see <a href="https://github.com/bisq-network/bisq/blob/master/docs/dev-setup.md">dev-setup.md</a>
  @see <a href="https://github.com/bisq-network/bisq/blob/master/docs/dao-setup.md">dao-setup.md</a>
  */
-@SuppressWarnings("unused")
 public enum BisqAppConfig {
 
     seednode("bisq-BTC_REGTEST_Seed_2002",
             "bisq-seednode",
-            "\"-XX:MaxRAM=2g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml\"",
+            "-XX:MaxRAM=2g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml",
             SeedNodeMain.class.getName(),
             2002,
             5120,
-            -1),
+            -1,
+            49996),
     arbdaemon("bisq-BTC_REGTEST_Arb_dao",
             "bisq-daemon",
-            "\"-XX:MaxRAM=2g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml\"",
+            "-XX:MaxRAM=2g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml",
             BisqDaemonMain.class.getName(),
             4444,
             5121,
-            9997),
+            9997,
+            49997),
     arbdesktop("bisq-BTC_REGTEST_Arb_dao",
             "bisq-desktop",
-            "\"-XX:MaxRAM=3g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml\"",
+            "-XX:MaxRAM=3g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml",
             BisqAppMain.class.getName(),
             4444,
             5121,
-            -1),
+            -1,
+            49997),
     alicedaemon("bisq-BTC_REGTEST_Alice_dao",
             "bisq-daemon",
-            "\"-XX:MaxRAM=2g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml\"",
+            "-XX:MaxRAM=2g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml",
             BisqDaemonMain.class.getName(),
             7777,
             5122,
-            9998),
+            9998,
+            49998),
     alicedesktop("bisq-BTC_REGTEST_Alice_dao",
             "bisq-desktop",
-            "\"-XX:MaxRAM=4g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml\"",
+            "-XX:MaxRAM=4g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml",
             BisqAppMain.class.getName(),
             7777,
             5122,
-            -1),
+            -1,
+            49998),
     bobdaemon("bisq-BTC_REGTEST_Bob_dao",
             "bisq-daemon",
-            "\"-XX:MaxRAM=2g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml\"",
+            "-XX:MaxRAM=2g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml",
             BisqDaemonMain.class.getName(),
             8888,
             5123,
-            9999),
+            9999,
+            49999),
     bobdesktop("bisq-BTC_REGTEST_Bob_dao",
             "bisq-desktop",
-            "\"-XX:MaxRAM=4g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml\"",
+            "-XX:MaxRAM=4g -Dlogback.configurationFile=apitest/build/resources/main/logback.xml",
             BisqAppMain.class.getName(),
             8888,
             5123,
-            -1);
+            -1,
+            49999);
 
     public final String appName;
     public final String startupScript;
@@ -91,21 +97,24 @@ public enum BisqAppConfig {
     public final int rpcBlockNotificationPort;
     // Daemons can use a global gRPC password, but each needs a unique apiPort.
     public final int apiPort;
+    public final int remoteDebugPort;
 
     BisqAppConfig(String appName,
                   String startupScript,
                   String javaOpts,
                   String mainClassName,
                   int nodePort,
                   int rpcBlockNotificationPort,
-                  int apiPort) {
+                  int apiPort,
+                  int remoteDebugPort) {
         this.appName = appName;
         this.startupScript = startupScript;
         this.javaOpts = javaOpts;
         this.mainClassName = mainClassName;
         this.nodePort = nodePort;
         this.rpcBlockNotificationPort = rpcBlockNotificationPort;
         this.apiPort = apiPort;
+        this.remoteDebugPort = remoteDebugPort;
     }
 
     @Override
@@ -118,6 +127,7 @@ public String toString() {
                 ", nodePort=" + nodePort + "\n" +
                 ", rpcBlockNotificationPort=" + rpcBlockNotificationPort + "\n" +
                 ", apiPort=" + apiPort + "\n" +
+                ", remoteDebugPort=" + remoteDebugPort + "\n" +
                 '}';
     }
 }
diff --git a/apitest/src/main/java/bisq/apitest/linux/BisqApp.java b/apitest/src/main/java/bisq/apitest/linux/BisqApp.java
@@ -53,6 +53,7 @@ public class BisqApp extends AbstractLinuxProcess implements LinuxProcess {
     private final boolean useLocalhostForP2P;
     public final boolean useDevPrivilegeKeys;
     private final String findBisqPidScript;
+    private final String debugOpts;
 
     public BisqApp(BisqAppConfig bisqAppConfig, ApiTestConfig config) {
         super(bisqAppConfig.appName, config);
@@ -67,6 +68,9 @@ public BisqApp(BisqAppConfig bisqAppConfig, ApiTestConfig config) {
         this.useDevPrivilegeKeys = true;
         this.findBisqPidScript = (config.isRunningTest ? "." : "./apitest")
                 + "/scripts/get-bisq-pid.sh";
+        this.debugOpts = config.enableBisqDebugging
+                ? " -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:" + bisqAppConfig.remoteDebugPort
+                : "";
     }
 
     @Override
@@ -112,7 +116,6 @@ public void shutdown() {
 
             if (isAlive(pid)) {
                 this.shutdownExceptions.add(new IllegalStateException(format("%s shutdown did not work", bisqAppConfig.appName)));
-                return;
             }
 
         } catch (Exception e) {
@@ -209,7 +212,7 @@ private long findBisqAppPid() throws IOException, InterruptedException {
     }
 
     private String getJavaOptsSpec() {
-        return "export JAVA_OPTS=" + bisqAppConfig.javaOpts + "; ";
+        return "export JAVA_OPTS=\"" + bisqAppConfig.javaOpts + debugOpts + "\"; ";
     }
 
     private List<String> getOptsList() {