test: observe fork observer

Author: pinheadmz

.github/workflows/test.yml

@@ -61,6 +61,7 @@ jobs:
           - dag_connection_test.py
           - logging_test.py
           - rpc_test.py
+          - services_test.py
           - scenarios_test.py
     steps:
       - uses: actions/checkout@v4

test/data/services/network.yaml

@@ -0,0 +1,35 @@
+nodes:
+  - name: john
+    config: |
+      dns=1
+      debug=rpc
+      rpcauth=forkobserver:1418183465eecbd407010cf60811c6a0$d4e5f0647a63429c218da1302d7f19fe627302aeb0a71a74de55346a25d8057c
+      rpcwhitelist=forkobserver:getchaintips,getblockheader,getblockhash,getblock,getnetworkinfo
+      rpcwhitelistdefault=0
+    connect:
+      - paul
+  - name: paul
+    config: |
+      dns=1
+      debug=rpc
+      rpcauth=forkobserver:1418183465eecbd407010cf60811c6a0$d4e5f0647a63429c218da1302d7f19fe627302aeb0a71a74de55346a25d8057c
+      rpcwhitelist=forkobserver:getchaintips,getblockheader,getblockhash,getblock,getnetworkinfo
+      rpcwhitelistdefault=0
+  - name: george
+    config: |
+      dns=1
+      debug=rpc
+      rpcauth=forkobserver:1418183465eecbd407010cf60811c6a0$d4e5f0647a63429c218da1302d7f19fe627302aeb0a71a74de55346a25d8057c
+      rpcwhitelist=forkobserver:getchaintips,getblockheader,getblockhash,getblock,getnetworkinfo
+      rpcwhitelistdefault=0
+    connect:
+      - ringo
+  - name: ringo
+    config: |
+      dns=1
+      debug=rpc
+      rpcauth=forkobserver:1418183465eecbd407010cf60811c6a0$d4e5f0647a63429c218da1302d7f19fe627302aeb0a71a74de55346a25d8057c
+      rpcwhitelist=forkobserver:getchaintips,getblockheader,getblockhash,getblock,getnetworkinfo
+      rpcwhitelistdefault=0
+fork_observer:
+  enabled: true

test/data/services/node-defaults.yaml

@@ -0,0 +1,4 @@
+image:
+  repository: bitcoindevproject/bitcoin
+  pullPolicy: IfNotPresent
+  tag: "27.0"

test/services_test.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+
+import os
+from pathlib import Path
+from subprocess import PIPE, Popen
+
+import requests
+from test_base import TestBase
+
+
+class ServicesTest(TestBase):
+    def __init__(self):
+        super().__init__()
+        self.network_dir = Path(os.path.dirname(__file__)) / "data" / "services"
+
+    def run_test(self):
+        try:
+            self.setup_network()
+            self.check_fork_observer()
+        finally:
+            self.stop_server()
+
+    def setup_network(self):
+        self.log.info("Setting up network")
+        self.log.info(self.warnet(f"deploy {self.network_dir}"))
+        self.wait_for_all_tanks_status(target="running")
+        self.wait_for_all_edges()
+
+    def check_fork_observer(self):
+        self.log.info("Creating chain split")
+        self.warnet("bitcoin rpc john createwallet miner")
+        self.warnet("bitcoin rpc john -generate 1")
+        self.log.info("Forwarding port 2323...")
+        # Stays alive in background
+        self.fo_port_fwd_process = Popen(
+            ["kubectl", "port-forward", "fork-observer", "2323"],
+            stdout=PIPE,
+            stderr=PIPE,
+            bufsize=1,
+            universal_newlines=True,
+        )
+
+        def call_fo_api():
+            try:
+                fo_res = requests.get("http://localhost:2323/api/networks.json")
+                network_id = fo_res.json()["networks"][0]["id"]
+                fo_data = requests.get(f"http://localhost:2323/api/{network_id}/data.json")
+                # fork observed!
+                return len(fo_data.json()["header_infos"]) == 2
+            except Exception as e:
+                self.log.info(f"Fork Observer API error: {e}")
+            self.log.info("No Fork observed yet")
+            return False
+
+        self.wait_for_predicate(call_fo_api)
+        self.log.info("Fork observed!")
+        self.fo_port_fwd_process.terminate()
+
+
+if __name__ == "__main__":
+    test = ServicesTest()
+    test.run_test()