test: rename base.py -> tests.py

test/tests.py

@@ -0,0 +1,193 @@
+is_interactive = "is_interactive" in vars()
+
+
+def succeed(*cmds):
+    """Returns the concatenated output of all cmds"""
+    return machine.succeed(*cmds)
+
+
+def assert_matches(cmd, regexp):
+    out = succeed(cmd)
+    if not re.search(regexp, out):
+        raise Exception(f"Pattern '{regexp}' not found in '{out}'")
+
+
+def assert_full_match(cmd, regexp):
+    out = succeed(cmd)
+    if not re.fullmatch(regexp, out):
+        raise Exception(f"Pattern '{regexp}' doesn't match '{out}'")
+
+
+def log_has_string(unit, str):
+    return f"journalctl -b --output=cat -u {unit} --grep='{str}'"
+
+
+def assert_no_failure(unit):
+    """Unit should not have failed since the system is running"""
+    machine.fail(log_has_string(unit, "Failed with result"))
+
+
+def assert_running(unit):
+    machine.wait_for_unit(unit)
+    assert_no_failure(unit)
+
+
+def run_tests(extra_tests):
+    """
+    :param extra_tests: Test functions that hook into the testing code below
+    :type extra_tests: Dict[str, Callable[]]
+    """
+    # Don't execute the following test suite when this script is running in interactive mode
+    if is_interactive:
+        raise Exception()
+
+    test_security()
+
+    assert_running("bitcoind")
+    machine.wait_until_succeeds("bitcoin-cli getnetworkinfo")
+    assert_matches("su operator -c 'bitcoin-cli getnetworkinfo' | jq", '"version"')
+    # RPC access for user 'public' should be restricted
+    machine.fail(
+        "bitcoin-cli -rpcuser=public -rpcpassword=$(cat /secrets/bitcoin-rpcpassword-public) stop"
+    )
+    machine.wait_until_succeeds(
+        log_has_string("bitcoind", "RPC User public not allowed to call method stop")
+    )
+
+    assert_running("electrs")
+    extra_tests.pop("electrs")()
+    # Check RPC connection to bitcoind
+    machine.wait_until_succeeds(log_has_string("electrs", "NetworkInfo"))
+    # Stop electrs from spamming the test log with 'wait for bitcoind sync' messages
+    succeed("systemctl stop electrs")
+
+    assert_running("liquidd")
+    machine.wait_until_succeeds("elements-cli getnetworkinfo")
+    assert_matches("su operator -c 'elements-cli getnetworkinfo' | jq", '"version"')
+    succeed("su operator -c 'liquidswap-cli --help'")
+
+    assert_running("clightning")
+    assert_matches("su operator -c 'lightning-cli getinfo' | jq", '"id"')
+
+    assert_running("lnd")
+    assert_matches("su operator -c 'lncli getinfo' | jq", '"version"')
+    assert_no_failure("lnd")
+
+    assert_running("lightning-loop")
+    assert_matches("su operator -c 'loop --version'", "version")
+    # Check that lightning-loop fails with the right error, making sure
+    # lightning-loop can connect to lnd
+    machine.wait_until_succeeds(
+        log_has_string(
+            "lightning-loop",
+            "Waiting for lnd to be fully synced to its chain backend, this might take a while",
+        )
+    )
+
+    assert_running("nbxplorer")
+    machine.wait_until_succeeds(log_has_string("nbxplorer", "BTC: RPC connection successful"))
+    extra_tests.pop("nbxplorer")()
+    assert_running("btcpayserver")
+    machine.wait_until_succeeds(log_has_string("btcpayserver", "Listening on"))
+    extra_tests.pop("btcpayserver")()
+
+    assert_running("spark-wallet")
+    extra_tests.pop("spark-wallet")()
+
+    assert_running("lightning-charge")
+    extra_tests.pop("lightning-charge")()
+
+    assert_running("nanopos")
+    extra_tests.pop("nanopos")()
+
+    assert_running("onion-chef")
+
+    assert_running("joinmarket")
+    machine.wait_until_succeeds(
+        log_has_string("joinmarket", "P2EPDaemonServerProtocolFactory starting on 27184")
+    )
+    machine.wait_until_succeeds(
+        log_has_string("joinmarket-yieldgenerator", "Failure to get blockheight",)
+    )
+
+    # FIXME: use 'wait_for_unit' because 'create-web-index' always fails during startup due
+    # to incomplete unit dependencies.
+    # 'create-web-index' implicitly tests 'nodeinfo'.
+    machine.wait_for_unit("create-web-index")
+    assert_running("nginx")
+    extra_tests.pop("web-index")()
+
+    machine.wait_until_succeeds(log_has_string("bitcoind-import-banlist", "Importing node banlist"))
+    assert_no_failure("bitcoind-import-banlist")
+
+    ### Additional tests
+
+    # Current time in µs
+    pre_restart = succeed("date +%s.%6N").rstrip()
+
+    # Sanity-check system by restarting all services
+    succeed(
+        "systemctl restart bitcoind clightning lnd lightning-loop spark-wallet lightning-charge nanopos liquidd"
+    )
+
+    # Now that the bitcoind restart triggered a banlist import restart, check that
+    # re-importing already banned addresses works
+    machine.wait_until_succeeds(
+        log_has_string(f"bitcoind-import-banlist --since=@{pre_restart}", "Importing node banlist")
+    )
+    assert_no_failure("bitcoind-import-banlist")
+
+    extra_tests.pop("prestop")()
+
+    ### Test duplicity
+
+    succeed("systemctl stop bitcoind")
+    succeed("systemctl start duplicity")
+    machine.wait_until_succeeds(log_has_string("duplicity", "duplicity.service: Succeeded."))
+    # Make sure files in duplicity backup and /var/lib are identical
+    assert_matches(
+        "export $(cat /secrets/backup-encryption-env); duplicity verify '--archive-dir' '/var/lib/duplicity' 'file:///var/lib/localBackups' '/var/lib'",
+        "0 differences found",
+    )
+    # Make sure duplicity backup includes important files
+    assert_matches(
+        "export $(cat /secrets/backup-encryption-env); duplicity list-current-files 'file:///var/lib/localBackups'",
+        "var/lib/clightning/bitcoin/hsm_secret",
+    )
+    assert_matches(
+        "export $(cat /secrets/backup-encryption-env); duplicity list-current-files 'file:///var/lib/localBackups'",
+        "secrets/lnd-seed-mnemonic",
+    )
+    assert_matches(
+        "export $(cat /secrets/backup-encryption-env); duplicity list-current-files 'file:///var/lib/localBackups'",
+        "secrets/jm-wallet-seed",
+    )
+    assert_matches(
+        "export $(cat /secrets/backup-encryption-env); duplicity list-current-files 'file:///var/lib/localBackups'",
+        "var/lib/bitcoind/wallet.dat",
+    )
+    assert_matches(
+        "export $(cat /secrets/backup-encryption-env); duplicity list-current-files 'file:///var/lib/localBackups'",
+        "var/backup/postgresql/btcpaydb.sql.gz",
+    )
+
+    ### Check that all extra_tests have been run
+    assert len(extra_tests) == 0
+
+
+def test_security():
+    assert_running("setup-secrets")
+    # Unused secrets should be inaccessible
+    succeed('[[ $(stat -c "%U:%G %a" /secrets/dummy) = "root:root 440" ]]')
+
+    # Access to '/proc' should be restricted
+    machine.succeed("grep -Fq hidepid=2 /proc/mounts")
+
+    machine.wait_for_unit("bitcoind")
+    # `systemctl status` run by unprivileged users shouldn't leak cgroup info
+    assert_matches(
+        "sudo -u electrs systemctl status bitcoind 2>&1 >/dev/null",
+        "Failed to dump process list for 'bitcoind.service', ignoring: Access denied",
+    )
+    # The 'operator' with group 'proc' has full access
+    assert_full_match("sudo -u operator systemctl status bitcoind 2>&1 >/dev/null", "")