Merge bitcoin/bitcoin#32881: test: Turn rpcauth.py test into functional test

fa4d68cf97 Turn rpcauth.py test into functional test (MarcoFalke)

Pull request description:

  Currently the `rpcauth-test.py` is problematic, because:

  * The boilerplate for the test runner is duplicate or inconsistent with the other (functional) tests. Specifically `ConfigParser`.
  * The cmake/ci behavior is brittle and can silently fail, as explained in https://github.com/bitcoin/bitcoin/issues/31476.
  * Outside of ctest, this single test has to be run manually and separately, which is easy to forget.
  * If the test is manually called, it runs single threaded, when it could just run in parallel with the other functional tests.
  * It is also the only "unit" test written in Python, but not called by the functional test runner.

  Fix all issues by turning it into a functional test.

ACKs for top commit:
  l0rinc:
    ACK fa4d68cf97
  janb84:
    LGTM ACK fa4d68cf97
  w0xlt:
    ACK fa4d68cf97

Tree-SHA512: a3b2b03be31c33288dee23c544b33ec43295e796c2047777597ceb86acce9f697478e32d891aa986c1d7d5749d62eded65eeb858e9d7479bda7a400eb1167040
This commit is contained in:
merge-script
2025-07-10 10:00:30 +01:00
7 changed files with 30 additions and 34 deletions

View File

@@ -353,6 +353,7 @@ BASE_SCRIPTS = [
'rpc_getdescriptorinfo.py',
'rpc_mempool_info.py',
'rpc_help.py',
'tool_rpcauth.py',
'p2p_handshake.py',
'p2p_handshake.py --v2transport',
'feature_dirsymlinks.py',

57
test/functional/tool_rpcauth.py Executable file
View File

@@ -0,0 +1,57 @@
#!/usr/bin/env python3
# Copyright (c) 2015-present The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
"""Test share/rpcauth/rpcauth.py
"""
import hmac
import importlib
import os
import re
import sys
from test_framework.test_framework import BitcoinTestFramework
from test_framework.util import assert_equal
class RpcAuthTest(BitcoinTestFramework):
def set_test_params(self):
self.num_nodes = 0 # No node/datadir needed
def setup_network(self):
pass
def setUp(self):
sys.path.insert(0, os.path.dirname(self.config["environment"]["RPCAUTH"]))
self.rpcauth = importlib.import_module('rpcauth')
def run_test(self):
self.setUp()
self.test_generate_salt()
self.test_generate_password()
self.test_check_password_hmac()
def test_generate_salt(self):
for i in range(16, 32 + 1):
assert_equal(len(self.rpcauth.generate_salt(i)), i * 2)
def test_generate_password(self):
"""Test that generated passwords only consist of urlsafe characters."""
r = re.compile(r"[0-9a-zA-Z_-]*")
password = self.rpcauth.generate_password()
assert r.fullmatch(password)
def test_check_password_hmac(self):
salt = self.rpcauth.generate_salt(16)
password = self.rpcauth.generate_password()
password_hmac = self.rpcauth.password_to_hmac(salt, password)
m = hmac.new(salt.encode('utf-8'), password.encode('utf-8'), 'SHA256')
expected_password_hmac = m.hexdigest()
assert_equal(expected_password_hmac, password_hmac)
if __name__ == '__main__':
RpcAuthTest(__file__).main()