Add API test harness for Linux & OSX

apitest/src/main/java/bisq/apitest/JUnitHelper.java

@@ -0,0 +1,51 @@
+package bisq.apitest;
+
+import lombok.extern.slf4j.Slf4j;
+
+import org.junit.runner.Description;
+import org.junit.runner.JUnitCore;
+import org.junit.runner.Result;
+import org.junit.runner.notification.Failure;
+import org.junit.runner.notification.RunListener;
+
+import static java.lang.String.format;
+
+@Slf4j
+public class JUnitHelper {
+
+    public static void runTests(Class... testClasses) {
+        JUnitCore jUnitCore = new JUnitCore();
+        jUnitCore.addListener(new RunListener() {
+            public void testStarted(Description description) {
+                log.info("{}", description);
+            }
+
+            public void testIgnored(Description description) {
+                log.info("Ignored {}", description);
+            }
+
+            public void testFailure(Failure failure) {
+                log.error("Failed {}", failure.getTrace());
+            }
+        });
+        Result result = jUnitCore.run(testClasses);
+        printTestResults(result);
+    }
+
+    public static void printTestResults(Result result) {
+        log.info("Total tests: {},  Failed: {},  Ignored: {}",
+                result.getRunCount(),
+                result.getFailureCount(),
+                result.getIgnoreCount());
+
+        if (result.wasSuccessful()) {
+            log.info("All {} tests passed", result.getRunCount());
+        } else if (result.getFailureCount() > 0) {
+            log.error("{} test(s) failed", result.getFailureCount());
+            result.getFailures().iterator().forEachRemaining(f -> log.error(format("%s.%s()%n\t%s",
+                    f.getDescription().getTestClass().getName(),
+                    f.getDescription().getMethodName(),
+                    f.getTrace())));
+        }
+    }
+}

apitest/src/main/java/bisq/apitest/method/BitcoinCliHelper.java

@@ -20,6 +20,7 @@
 import java.io.IOException;
 
 import static java.lang.String.format;
+import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.fail;
 
 
@@ -39,7 +40,9 @@ public BitcoinCliHelper(ApiTestConfig config) {
 
     public String getNewBtcAddress() {
         try {
-            return new BitcoinCli(config, "getnewaddress").run().getOutput();
+            String newAddress = new BitcoinCli(config, "getnewaddress").run().getOutput();
+            assertNotNull(newAddress);
+            return newAddress;
         } catch (IOException | InterruptedException ex) {
             fail(ex.getMessage());
             return null;
@@ -50,8 +53,9 @@ public String[] generateToAddress(int blocks, String address) {
         try {
             String generateToAddressCmd = format("generatetoaddress %d \"%s\"", blocks, address);
             BitcoinCli generateToAddress = new BitcoinCli(config, generateToAddressCmd).run();
-            // Return an array of transaction ids.
-            return generateToAddress.getOutputValueAsStringArray();
+            String[] txids = generateToAddress.getOutputValueAsStringArray();
+            assertNotNull(txids);
+            return txids;
         } catch (IOException | InterruptedException ex) {
             fail(ex.getMessage());
             return null;
@@ -61,4 +65,22 @@ public String[] generateToAddress(int blocks, String address) {
     public void generateBlocks(int blocks) {
         generateToAddress(blocks, getNewBtcAddress());
     }
+
+    public String sendToAddress(String address, double amount) {
+        // sendtoaddress "address" amount \
+        //              ( "comment" "comment_to" subtractfeefromamount \
+        //                          replaceable conf_target "estimate_mode" )
+        // returns a transaction id
+        try {
+            String sendToAddressCmd = format("sendtoaddress \"%s\" %s \"\" \"\" true",
+                    address, amount);
+            BitcoinCli sendToAddress = new BitcoinCli(config, sendToAddressCmd).run();
+            String txid = sendToAddress.getOutput();
+            assertNotNull(txid);
+            return txid;
+        } catch (IOException | InterruptedException ex) {
+            fail(ex.getMessage());
+            return null;
+        }
+    }
 }

apitest/src/main/java/bisq/apitest/method/MethodTest.java

@@ -18,6 +18,7 @@
 package bisq.apitest.method;
 
 import bisq.proto.grpc.GetBalanceRequest;
+import bisq.proto.grpc.GetFundingAddressesRequest;
 import bisq.proto.grpc.LockWalletRequest;
 import bisq.proto.grpc.RemoveWalletPasswordRequest;
 import bisq.proto.grpc.SetWalletPasswordRequest;
@@ -55,17 +56,34 @@ protected final LockWalletRequest createLockWalletRequest() {
         return LockWalletRequest.newBuilder().build();
     }
 
+    protected final GetFundingAddressesRequest createGetFundingAddressesRequest() {
+        return GetFundingAddressesRequest.newBuilder().build();
+    }
+
     // Convenience methods for calling frequently used & thoroughly tested gRPC services.
 
     protected final long getBalance() {
         return grpcStubs.walletsService.getBalance(createBalanceRequest()).getBalance();
     }
 
     protected final void unlockWallet(String password, long timeout) {
+        //noinspection ResultOfMethodCallIgnored
         grpcStubs.walletsService.unlockWallet(createUnlockWalletRequest(password, timeout));
     }
 
     protected final void lockWallet() {
+        //noinspection ResultOfMethodCallIgnored
         grpcStubs.walletsService.lockWallet(createLockWalletRequest());
     }
+
+    protected final String getUnusedBtcAddress() {
+        return grpcStubs.walletsService.getFundingAddresses(createGetFundingAddressesRequest())
+                .getAddressBalanceInfoList()
+                .stream()
+                .filter(a -> a.getBalance() == 0 && a.getNumConfirmations() == 0)
+                .findFirst()
+                .get()
+                .getAddress();
+
+    }
 }

apitest/src/main/java/bisq/apitest/method/MethodTestMain.java

@@ -2,19 +2,13 @@
 
 import lombok.extern.slf4j.Slf4j;
 
-import org.junit.runner.Description;
-import org.junit.runner.JUnitCore;
-import org.junit.runner.Result;
-import org.junit.runner.notification.Failure;
-import org.junit.runner.notification.RunListener;
-
-import static java.lang.String.format;
+import static bisq.apitest.JUnitHelper.runTests;
 
 /**
  * Driver for running API method tests.
  *
  * This may not seem necessary, but test cases are contained in the apitest sub
- * project's main sources, not its test sources.  An IDE will not automatically configure
+ * project's main sources, not its test sources.  An IDE may not automatically configure
  * JUnit test launchers, and a gradle build will not automatically run the test cases.
  *
  * However, it is easy to manually configure an IDE launcher to run all, some or one
@@ -24,40 +18,6 @@
 public class MethodTestMain {
 
     public static void main(String[] args) {
-        JUnitCore jUnitCore = new JUnitCore();
-        jUnitCore.addListener(new RunListener() {
-            public void testStarted(Description description) {
-                log.info("{}", description);
-            }
-
-            public void testIgnored(Description description) {
-                log.info("Ignored {}", description);
-            }
-
-            public void testFailure(Failure failure) {
-                log.error("Failed {}", failure.getTrace());
-            }
-        });
-        Result result = jUnitCore.run(GetVersionTest.class, GetBalanceTest.class, WalletProtectionTest.class);
-        ResultUtil.printResult(result);
-    }
-
-    private static class ResultUtil {
-        public static void printResult(Result result) {
-            log.info("Total tests: {},  Failed: {},  Ignored: {}",
-                    result.getRunCount(),
-                    result.getFailureCount(),
-                    result.getIgnoreCount());
-
-            if (result.wasSuccessful()) {
-                log.info("All tests passed");
-            } else if (result.getFailureCount() > 0) {
-                log.error("{} test(s) failed", result.getFailureCount());
-                result.getFailures().iterator().forEachRemaining(f -> log.error(format("%s.%s()%n\t%s",
-                        f.getDescription().getTestClass().getName(),
-                        f.getDescription().getMethodName(),
-                        f.getTrace())));
-            }
-        }
+        runTests(GetVersionTest.class, GetBalanceTest.class, WalletProtectionTest.class);
     }
 }

apitest/src/main/java/bisq/apitest/scenario/FundWalletScenarioTest.java

@@ -0,0 +1,78 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq 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 Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package bisq.apitest.scenario;
+
+import lombok.extern.slf4j.Slf4j;
+
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import static java.lang.Double.parseDouble;
+import static java.util.concurrent.TimeUnit.MILLISECONDS;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.fail;
+
+
+
+import bisq.apitest.OrderedRunner;
+import bisq.apitest.annotation.Order;
+
+@Slf4j
+@RunWith(OrderedRunner.class)
+public class FundWalletScenarioTest extends ScenarioTest {
+
+    @BeforeClass
+    public static void setUp() {
+        try {
+            setUpScaffold("bitcoind,seednode,alicedaemon");
+            bitcoinCli.generateBlocks(1);
+            MILLISECONDS.sleep(1500);
+        } catch (InterruptedException ex) {
+            fail(ex.getMessage());
+        }
+    }
+
+    @Test
+    @Order(1)
+    public void testFundWallet() {
+        long balance = getBalance();  // bisq wallet was initialized with 10 btc
+        assertEquals(1000000000, balance);
+
+        String unusedAddress = getUnusedBtcAddress();
+
+        // Given the default tx fee rate, we want to send 2.5 + the fee,
+        // so the new wallet balance will be exactly 12.5 btc.
+        // We should calculate the fee based on the fee rate and tx size
+        // instead of hard coding the fee amount.
+        double btc = parseDouble("2.5") + parseDouble("0.0000336");
+        bitcoinCli.sendToAddress(unusedAddress, btc);
+
+        bitcoinCli.generateBlocks(1);
+        sleep(1500);
+
+        balance = getBalance();
+        assertEquals(1250000000L, balance); // new balance is 12.5 btc
+    }
+
+    @AfterClass
+    public static void tearDown() {
+        tearDownScaffold();
+    }
+}

apitest/src/main/java/bisq/apitest/scenario/ScenarioTest.java

@@ -1,6 +1,28 @@
+/*
+ * This file is part of Bisq.
+ *
+ * Bisq is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at
+ * your option) any later version.
+ *
+ * Bisq 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 Affero General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Bisq. If not, see <http://www.gnu.org/licenses/>.
+ */
+
 package bisq.apitest.scenario;
 
+import lombok.extern.slf4j.Slf4j;
+
+
+
 import bisq.apitest.method.MethodTest;
 
+@Slf4j
 public class ScenarioTest extends MethodTest {
 }

apitest/src/main/java/bisq/apitest/scenario/ScenarioTestMain.java

@@ -0,0 +1,23 @@
+package bisq.apitest.scenario;
+
+import lombok.extern.slf4j.Slf4j;
+
+import static bisq.apitest.JUnitHelper.runTests;
+
+/**
+ * Driver for running API scenario tests.
+ *
+ * This may not seem necessary, but test cases are contained in the apitest sub
+ * project's main sources, not its test sources.  An IDE may not automatically configure
+ * JUnit test launchers, and a gradle build will not automatically run the test cases.
+ *
+ * However, it is easy to manually configure an IDE launcher to run all, some or one
+ * JUnit test, and new gradle tasks should be provided to run all, some, or one test.
+ */
+@Slf4j
+public class ScenarioTestMain {
+
+    public static void main(String[] args) {
+        runTests(FundWalletScenarioTest.class);
+    }
+}