charts: only use conf file sections prior to v0.17

Author: pinheadmz

.github/workflows/test.yml

@@ -30,6 +30,7 @@ jobs:
     strategy:
       matrix:
         test:
+          - conf_test.py
           - dag_connection_test.py
           - logging_test.py
           - rpc_test.py

resources/charts/bitcoincore/templates/_helpers.tpl

@@ -55,3 +55,15 @@ Create the name of the service account to use
 {{- default "default" .Values.serviceAccount.name }}
 {{- end }}
 {{- end }}
+
+
+{{/*
+Add network section heading in bitcoin.conf after v0.17.0
+*/}}
+{{- define "bitcoincore.check_semver.regtest" -}}
+{{- $tag := .Values.image.tag | trimPrefix "v" -}}
+{{- $version := semverCompare ">=0.17.0" $tag -}}
+{{- if $version -}}
+[regtest]
+{{- end -}}
+{{- end -}}

resources/charts/bitcoincore/templates/configmap.yaml

@@ -7,6 +7,9 @@ metadata:
 data:
   bitcoin.conf: |
     {{- if eq .Values.chain "regtest" }}
+    regtest=1
+
+    {{ template "bitcoincore.check_semver.regtest" . }}
       {{- tpl .Values.regtestConfig . | nindent 4 }}
     {{- end }}
     {{- .Values.baseConfig | nindent 4 }}

resources/charts/bitcoincore/values.yaml

@@ -111,9 +111,6 @@ metricsExport: false
 prometheusMetricsPort: 9332
 
 regtestConfig: |
-  regtest=1
-
-  [regtest]
   rpcuser=user
   rpcpassword=password
   rpcport=18443

test/conf_test.py

@@ -0,0 +1,58 @@
+#!/usr/bin/env python3
+
+import json
+import os
+import re
+from pathlib import Path
+
+from test_base import TestBase
+
+from warnet.k8s import get_mission
+
+
+class ConfTest(TestBase):
+    def __init__(self):
+        super().__init__()
+        self.network_dir = Path(os.path.dirname(__file__)) / "data" / "bitcoin_conf"
+
+    def run_test(self):
+        try:
+            self.setup_network()
+            self.check_uacomment()
+        finally:
+            self.stop_server()
+
+    def setup_network(self):
+        self.log.info("Setting up network")
+        self.log.info(self.warcli(f"deploy {self.network_dir}"))
+        self.wait_for_all_tanks_status(target="running")
+
+    def check_uacomment(self):
+        tanks = get_mission("tank")
+
+        def get_uacomment():
+            for tank in tanks[::-1]:
+                try:
+                    name = tank.metadata.name
+                    info = json.loads(self.warcli(f"bitcoin rpc {name} getnetworkinfo"))
+                    subver = info["subversion"]
+
+                    # Regex pattern to match the uacomment inside parentheses
+                    # e.g. /Satoshi:27.0.0(tank-0027)/
+                    pattern = r"\(([^)]+)\)"
+                    match = re.search(pattern, subver)
+                    if match:
+                        uacomment = match.group(1)
+                        assert uacomment == name
+                    else:
+                        return False
+                except Exception:
+                    return False
+            return True
+
+        self.wait_for_predicate(get_uacomment)
+
+
+if __name__ == "__main__":
+    test = ConfTest()
+    test.run_test()

test/data/bitcoin_conf/network.yaml

@@ -0,0 +1,64 @@
+nodes:
+  - name: tank-0016
+    image:
+      tag: "v0.16.1"
+    connect:
+      - tank-0017
+    config:
+      uacomment=tank-0016
+  - name: tank-0017
+    image:
+      tag: "v0.17.0"
+    connect:
+      - tank-0019
+    config:
+      uacomment=tank-0017
+  - name: tank-0019
+    image:
+      tag: "v0.19.2"
+    connect:
+      - tank-0020
+    config:
+      uacomment=tank-0019
+  - name: tank-0020
+    image:
+      tag: "v0.20.0"
+    connect:
+      - tank-0021
+    config:
+      uacomment=tank-0020
+  - name: tank-0021
+    image:
+      tag: "v0.21.1"
+    connect:
+      - tank-0024
+    config:
+      uacomment=tank-0021
+  - name: tank-0024
+    image:
+      tag: "24.2"
+    connect:
+      - tank-0025
+    config:
+      uacomment=tank-0024
+  - name: tank-0025
+    image:
+      tag: "25.1"
+    connect:
+      - tank-0026
+    config:
+      uacomment=tank-0025
+  - name: tank-0026
+    image:
+      tag: "26.0"
+    connect:
+      - tank-0027
+    config:
+      uacomment=tank-0026
+  - name: tank-0027
+    image:
+      tag: "27.0"
+    connect:
+      - tank-0016
+    config:
+      uacomment=tank-0027

test/data/bitcoin_conf/node-defaults.yaml

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