Merge #422: feature_fedpeg.py bitcoind parent2 uses rpc cookie auth

f6528e9 feature_fedpeg.py parent2 uses rpc cookie auth (Gregory Sanders)
f349e17 allow start_node to create/take cookie files (Gregory Sanders)

Author: instagibbs

qa/rpc-tests/feature_fedpeg.py

@@ -39,33 +39,41 @@ def add_options(self, parser):
     def setup_network(self, split=False):
         if self.options.parent_bitcoin and self.options.parent_binpath == "":
             raise Exception("Can't run with --parent_bitcoin without specifying --parent_binpath")
-
         self.nodes = []
         self.extra_args = []
         # Parent chain args
         for n in range(2):
+            # We want to test the rpc cookie method so we force the use of a
+            # dummy conf file to avoid loading rpcuser/rpcpassword lines
+            use_cookie_auth = n==1
+            rpc_u, rpc_p = rpc_auth_pair(n)
             if self.options.parent_bitcoin:
                 self.parent_chain = 'regtest'
-                rpc_u, rpc_p = rpc_auth_pair(n)
                 self.extra_args.append([
+                    "-conf=dummy",
                     "-printtoconsole=0",
-                    "-port="+str(p2p_port(n)),
-                    "-rpcuser="+rpc_u,
-                    "-rpcpassword="+rpc_p,
-                    "-rpcport="+str(rpc_port(n)),
                     "-addresstype=legacy", # To make sure bitcoind gives back p2pkh no matter version
                     "-deprecatedrpc=validateaddress",
+                    "-port="+str(p2p_port(n)),
+                    "-rpcport="+str(rpc_port(n))
                 ])
             else:
                 self.parent_chain = 'parent'
                 self.extra_args.append([
+                    "-conf=dummy",
                     "-printtoconsole=0",
                     '-validatepegin=0',
                     '-anyonecanspendaremine',
                     '-initialfreecoins=2100000000000000',
+                    "-port="+str(p2p_port(n)),
+                    "-rpcport="+str(rpc_port(n))
                 ])
+            # Only first parent uses name/password, the 2nd uses cookie auth
+            if not use_cookie_auth:
+                self.extra_args[n].extend(["-rpcuser="+rpc_u, "-rpcpassword="+rpc_p])
+
             self.binary = self.options.parent_binpath if self.options.parent_binpath != "" else None
-            self.nodes.append(start_node(n, self.options.tmpdir, self.extra_args[n], binary=self.binary, chain=self.parent_chain))
+            self.nodes.append(start_node(n, self.options.tmpdir, self.extra_args[n], binary=self.binary, chain=self.parent_chain, cookie_auth=use_cookie_auth))
 
         connect_nodes_bi(self.nodes, 0, 1)
         self.parentgenesisblockhash = self.nodes[0].getblockhash(0)
@@ -77,6 +85,7 @@ def setup_network(self, split=False):
         self.fedpeg_script = "512103dff4923d778550cc13ce0d887d737553b4b58f4e8e886507fc39f5e447b2186451ae"
         parent_chain_signblockscript = '51'
         for n in range(2):
+            used_cookie_auth = n==1
             rpc_u, rpc_p = rpc_auth_pair(n)
             args = [
                 "-printtoconsole=0",
@@ -88,8 +97,6 @@ def setup_network(self, split=False):
                 '-peginconfirmationdepth=10',
                 '-mainchainrpchost=127.0.0.1',
                 '-mainchainrpcport=%s' % rpc_port(n),
-                '-mainchainrpcuser=%s' % rpc_u,
-                '-mainchainrpcpassword=%s' % rpc_p,
             ]
             if not self.options.parent_bitcoin:
                 args.extend([
@@ -98,9 +105,21 @@ def setup_network(self, split=False):
                     '-con_parent_chain_signblockscript=%s' % parent_chain_signblockscript,
                     '-con_parent_pegged_asset=%s' % parent_pegged_asset,
                 ])
+
+            if used_cookie_auth:
+                # Need to specify where to find parent cookie file
+                datadir = os.path.join(self.options.tmpdir, "node"+str(n))
+                args.append('-mainchainrpccookiefile='+datadir+"/" + self.parent_chain + "/.cookie")
+            else:
+                args.extend([
+                    '-mainchainrpcuser=%s' % rpc_u,
+                    '-mainchainrpcpassword=%s' % rpc_p,
+                ])
+
             self.extra_args.append(args)
             self.nodes.append(start_node(n + 2, self.options.tmpdir, self.extra_args[n + 2], chain='sidechain'))
 
+        # We only connect the same-chain nodes, so sync_all works correctly
         connect_nodes_bi(self.nodes, 2, 3)
         self.is_network_split = True
         self.sync_all()
@@ -297,7 +316,7 @@ def run_test(self):
         assert(sidechain.getblockcount() != sidechain2.getblockcount())
 
         print("Restarting parent2")
-        self.nodes[1] = start_node(1, self.options.tmpdir, self.extra_args[1], binary=self.binary, chain=self.parent_chain)
+        self.nodes[1] = start_node(1, self.options.tmpdir, self.extra_args[1], binary=self.binary, chain=self.parent_chain, cookie_auth=True)
         parent2 = self.nodes[1]
         connect_nodes_bi(self.nodes, 0, 1)
         time.sleep(5)

qa/rpc-tests/test_framework/util.py

@@ -22,6 +22,7 @@
 import time
 import re
 import errno
+from pathlib import Path
 
 from . import coverage
 from .authproxy import AuthServiceProxy, JSONRPCException
@@ -198,8 +199,13 @@ def initialize_datadir(dirname, n):
 def rpc_auth_pair(n):
     return 'rpcuser💻' + str(n), 'rpcpass🔑' + str(n)
 
-def rpc_url(i, rpchost=None):
-    rpc_u, rpc_p = rpc_auth_pair(i)
+def rpc_url(i, rpchost=None, cookie_file=None):
+    if cookie_file:
+        with open(cookie_file, 'r') as f:
+            rpc_auth = f.readline()
+    else:
+        rpc_u, rpc_p = rpc_auth_pair(i)
+        rpc_auth = rpc_u+":"+rpc_p
     host = '127.0.0.1'
     port = rpc_port(i)
     if rpchost:
@@ -208,7 +214,7 @@ def rpc_url(i, rpchost=None):
             host, port = parts
         else:
             host = rpchost
-    return "http://%s:%s@%s:%d" % (rpc_u, rpc_p, host, int(port))
+    return "http://%s@%s:%d" % (rpc_auth, host, int(port))
 
 def wait_for_bitcoind_start(process, url, i):
     '''
@@ -333,11 +339,12 @@ def _rpchost_to_args(rpchost):
         rv += ['-rpcport=' + rpcport]
     return rv
 
-def start_node(i, dirname, extra_args=None, rpchost=None, timewait=None, binary=None, chain='elementsregtest'):
+def start_node(i, dirname, extra_args=None, rpchost=None, timewait=None, binary=None, chain='elementsregtest', cookie_auth=False):
     """
     Start a bitcoind and return RPC connection to it
     """
     datadir = os.path.join(dirname, "node"+str(i))
+    cookie_file = datadir+"/"+chain+"/.cookie"
     if binary is None:
         binary = os.getenv("ELEMENTSD", "elementsd")
     args = [ binary, "-datadir="+datadir, "-server", "-keypool=1", "-discover=0", "-rest", "-mocktime="+str(get_mocktime()) ]
@@ -346,7 +353,15 @@ def start_node(i, dirname, extra_args=None, rpchost=None, timewait=None, binary=
     bitcoind_processes[i] = subprocess.Popen(args)
     if os.getenv("PYTHON_DEBUG", ""):
         print("start_node: bitcoind started, waiting for RPC to come up")
-    url = rpc_url(i, rpchost)
+
+    # We need to make sure the cookie auth file is created before reading it
+    wait_for_cookie_time = 10
+    cookie_file_handle = Path(cookie_file)
+    while cookie_auth and wait_for_cookie_time > 0 and not cookie_file_handle.is_file():
+        wait_for_cookie_time -= 1
+        time.sleep(1)
+
+    url = rpc_url(i, rpchost, cookie_file if cookie_auth else None)
     wait_for_bitcoind_start(bitcoind_processes[i], url, i)
     if os.getenv("PYTHON_DEBUG", ""):
         print("start_node: RPC successfully started")