test: demo could not generate rln-v2 proof

This commit is contained in:
Roman 2026-03-25 10:30:28 +08:00
parent e629cc8cc0
commit cba2d0cec9
No known key found for this signature in database
GPG Key ID: 583BDF43C238B83E
6 changed files with 210 additions and 32 deletions

View File

@ -14,7 +14,7 @@ def get_env_var(var_name, default=None):
# Configuration constants. Need to be upercase to appear in reports
DEFAULT_NWAKU = "wakuorg/nwaku:wakunode2-v0.37.2-rc.0"
DEFAULT_NWAKU = "wakuorg/nwaku:wakunode2-v0.37.2"
STRESS_ENABLED = False
NODE_1 = get_env_var("NODE_1", DEFAULT_NWAKU)
NODE_2 = get_env_var("NODE_2", DEFAULT_NWAKU)

View File

@ -1,6 +1,7 @@
import os
import re
import time
from collections import deque
from src.libs.custom_logger import get_custom_logger
import random
import threading
@ -48,12 +49,24 @@ class DockerManager:
cli_args_str_for_log = " ".join(cli_args)
logger.debug(f"docker run -i -t {port_bindings_for_log} {image_name} {cli_args_str_for_log}")
container = self._client.containers.run(
image_name, command=cli_args, ports=port_bindings, detach=True, remove=remove_container, auto_remove=remove_container, volumes=volumes
image_name,
command=cli_args,
ports=port_bindings,
detach=True,
auto_remove=False,
volumes=volumes,
)
network = self._client.networks.get(NETWORK_NAME)
logger.debug(f"docker network connect --ip {container_ip} {NETWORK_NAME} {container.id}")
network.connect(container, ipv4_address=container_ip)
try:
network.connect(container, ipv4_address=container_ip)
except APIError as ex:
recent_logs = self.get_container_logs(container, tail=120)
if recent_logs.startswith("<could not fetch container logs"):
recent_logs = self.get_log_file_tail(log_path, tail=120)
logger.error(f"Failed to connect container {container.short_id} to network. Recent container logs:\n{recent_logs}")
raise
logger.debug(f"Container started with ID {container.short_id}. Setting up logs at {log_path}")
log_thread = threading.Thread(target=self._log_container_output, args=(container, log_path))
@ -62,6 +75,27 @@ class DockerManager:
return container
def get_container_logs(self, container, tail=200):
try:
raw = container.logs(tail=tail)
if isinstance(raw, bytes):
return raw.decode("utf-8", errors="ignore")
return str(raw)
except Exception as ex:
return f"<could not fetch container logs: {ex}>"
def get_log_file_tail(self, log_path, tail=200):
try:
if not os.path.exists(log_path):
return f"<log file not found: {log_path}>"
with open(log_path, "r", encoding="utf-8", errors="ignore") as log_file:
lines = deque(log_file, maxlen=tail)
return "".join(lines) if lines else "<log file is empty>"
except Exception as ex:
return f"<could not read log file tail: {ex}>"
def _log_container_output(self, container, log_path):
os.makedirs(os.path.dirname(log_path), exist_ok=True)
retry_count = 0
@ -86,6 +120,10 @@ class DockerManager:
except (APIError, IOError) as e:
retry_count += 1
if retry_count >= 5:
recent_logs = self.get_container_logs(container, tail=120)
if recent_logs.startswith("<could not fetch container logs"):
recent_logs = self.get_log_file_tail(log_path, tail=120)
logger.error(f"Recent container logs for {container.short_id}:\n{recent_logs}")
logger.error(f"Max retries reached for container {container.short_id}. Exiting log stream.")
return
time.sleep(0.2)

View File

@ -37,8 +37,23 @@ def sanitize_docker_flags(input_flags):
@retry(stop=stop_after_delay(180), wait=wait_fixed(0.5), reraise=True)
def rln_credential_store_ready(creds_file_path, single_check=False):
def rln_credential_store_ready(creds_file_path, single_check=False, require_credentials=False):
if os.path.exists(creds_file_path):
if require_credentials:
try:
with open(creds_file_path, "r", encoding="utf-8") as creds_file:
keystore_data = json.load(creds_file)
except (OSError, json.JSONDecodeError) as ex:
if single_check:
return False
raise ValueError(f"Failed to parse RLN keystore at {creds_file_path}: {ex}")
credentials = keystore_data.get("credentials", {}) if isinstance(keystore_data, dict) else {}
if not credentials:
if single_check:
return False
raise ValueError(f"RLN keystore exists but has no credentials yet: {creds_file_path}")
return True
elif not single_check:
raise FileNotFoundError(errno.ENOENT, os.strerror(errno.ENOENT), creds_file_path)
@ -82,6 +97,7 @@ class WakuNode:
self._log_path = os.path.join(DOCKER_LOG_DIR, f"{docker_log_prefix}__{self._image_name.replace('/', '_')}.log")
self._docker_manager = DockerManager(self._image_name)
self._container = None
self.rln_membership_index = None
self.start_args = {}
logger.debug(f"WakuNode instance initialized with log path {self._log_path}")
@ -170,7 +186,7 @@ class WakuNode:
default_args.pop("rln-keystore-prefix", None)
if rln_creds_set:
rln_credential_store_ready(keystore_path)
rln_credential_store_ready(keystore_path, require_credentials=True)
default_args.update(rln_args)
else:
logger.info(f"RLN credentials not set or credential store not available, starting without RLN")
@ -221,13 +237,32 @@ class WakuNode:
logger.debug(f"Waiting for keystore {keystore_path}")
try:
rln_credential_store_ready(keystore_path)
rln_credential_store_ready(keystore_path, require_credentials=True)
self.rln_membership_index = str(self.get_rln_membership_index_from_log())
logger.debug(f"Detected RLN membership index from registration logs: {self.rln_membership_index}")
self.stop()
except Exception as ex:
logger.error(f"File {keystore_path} with RLN credentials did not become available in time {ex}")
raise
else:
logger.warn("RLN credentials not set, no action performed")
return self.rln_membership_index
@retry(stop=stop_after_delay(10), wait=wait_fixed(0.2), reraise=True)
def get_rln_membership_index_from_log(self):
if not os.path.exists(self._log_path):
raise FileNotFoundError(errno.ENOENT, os.strerror(errno.ENOENT), self._log_path)
with open(self._log_path, "r", encoding="utf-8", errors="ignore") as log_file:
log_data = log_file.read()
matches = re.findall(r"membershipIndex=(\d+)", log_data)
if not matches:
raise ValueError("Could not infer RLN membership index from registration logs")
return int(matches[-1])
@retry(stop=stop_after_delay(5), wait=wait_fixed(0.1), reraise=True)
def stop(self):
if self._container:
@ -428,6 +463,21 @@ class WakuNode:
def is_nwaku(self):
return "nwaku" in self.image
def prepare_rln_storage_paths(self, cwd, keystore_prefix, selected_id, reset_existing=False):
keystore_dir = os.path.join(cwd, f"keystore_{keystore_prefix}_{selected_id}")
rln_tree_dir = os.path.join(cwd, f"rln_tree_{keystore_prefix}_{selected_id}")
if reset_existing:
for path, path_name in [(keystore_dir, "keystore"), (rln_tree_dir, "rln tree")]:
if os.path.exists(path):
logger.warning(f"Resetting existing RLN {path_name} directory before registration: {path}")
shutil.rmtree(path, ignore_errors=True)
os.makedirs(keystore_dir, exist_ok=True)
os.makedirs(rln_tree_dir, exist_ok=True)
return keystore_dir, rln_tree_dir
def parse_rln_credentials(self, default_args, is_registration):
rln_args = {}
keystore_path = None
@ -440,6 +490,7 @@ class WakuNode:
return rln_args, False, keystore_path
imported_creds = json.loads(rln_creds_source)
rln_chain_id = str(imported_creds.get("rln-relay-chain-id", "59141"))
if len(imported_creds) < 4 or any(value is None for value in imported_creds.values()):
logger.warn(f"One or more of required RLN credentials were not set properly")
@ -448,6 +499,13 @@ class WakuNode:
eth_private_key = select_private_key(imported_creds, selected_id)
cwd = os.getcwd()
keystore_prefix = default_args.get("rln-keystore-prefix")
if not keystore_prefix:
logger.warn("rln-keystore-prefix is missing, cannot mount RLN state and keystore")
return rln_args, False, keystore_path
keystore_dir, rln_tree_dir = self.prepare_rln_storage_paths(cwd, keystore_prefix, selected_id, reset_existing=is_registration)
if self.is_nwaku():
if is_registration:
@ -470,6 +528,9 @@ class WakuNode:
{
"rln-relay-cred-path": "/keystore/keystore.json",
"rln-relay-cred-password": imported_creds["rln-relay-cred-password"],
"rln-relay-chain-id": rln_chain_id,
"rln-relay-eth-client-address": imported_creds["rln-relay-eth-client-address"],
"rln-relay-eth-contract-address": imported_creds["rln-relay-eth-contract-address"],
}
)
else:
@ -477,18 +538,19 @@ class WakuNode:
{
"rln-relay-cred-path": "/keystore/keystore.json",
"rln-relay-cred-password": imported_creds["rln-relay-cred-password"],
"rln-relay-chain-id": rln_chain_id,
"rln-relay-eth-client-address": imported_creds["rln-relay-eth-client-address"],
"rln-relay-eth-contract-address": imported_creds["rln-relay-eth-contract-address"],
"rln-relay-eth-private-key": imported_creds[eth_private_key],
}
)
keystore_path = cwd + "/keystore_" + default_args["rln-keystore-prefix"] + "_" + selected_id + "/keystore.json"
keystore_path = os.path.join(keystore_dir, "keystore.json")
self._volumes.extend(
[
cwd + "/rln_tree_" + default_args["rln-keystore-prefix"] + "_" + selected_id + ":/etc/rln_tree",
cwd + "/keystore_" + default_args["rln-keystore-prefix"] + "_" + selected_id + ":/keystore",
f"{rln_tree_dir}:/etc/rln_tree",
f"{keystore_dir}:/keystore",
]
)

View File

@ -26,6 +26,7 @@ class StepsRLN(StepsCommon):
multiaddr_list = []
lightpush_nodes = []
keystore_prefixes = []
rln_membership_indexes = []
@allure.step
def generate_keystore_prefixes(self, count=2):
@ -40,13 +41,24 @@ class StepsRLN(StepsCommon):
if count > 0:
logger.debug(111111111111111)
self.keystore_prefixes = self.generate_keystore_prefixes(count)
self.rln_membership_indexes = []
for i, prefix in enumerate(self.keystore_prefixes):
logger.debug(000000000000000000000)
self.register_rln_single_node(prefix=prefix, rln_creds_source=RLN_CREDENTIALS, rln_creds_id=f"{i+1}")
membership_index = self.register_rln_single_node(prefix=prefix, rln_creds_source=RLN_CREDENTIALS, rln_creds_id=f"{i+1}")
self.rln_membership_indexes.append(membership_index)
else:
self.keystore_prefixes = orig_prefixes
# Backward-compatible support for legacy list-based cache values.
if isinstance(orig_prefixes, dict):
self.keystore_prefixes = orig_prefixes.get("keystore_prefixes", [])
self.rln_membership_indexes = orig_prefixes.get("rln_membership_indexes", [])
else:
self.keystore_prefixes = orig_prefixes
self.rln_membership_indexes = []
return self.keystore_prefixes
return {
"keystore_prefixes": self.keystore_prefixes,
"rln_membership_indexes": self.rln_membership_indexes,
}
@allure.step
def setup_main_rln_relay_nodes(self, **kwargs):
@ -60,7 +72,7 @@ class StepsRLN(StepsCommon):
relay="true",
rln_creds_source=RLN_CREDENTIALS,
rln_creds_id="1",
rln_relay_membership_index="1",
rln_relay_membership_index=self.resolve_rln_membership_index(0, **kwargs),
rln_keystore_prefix=self.keystore_prefixes[0],
**kwargs,
)
@ -78,7 +90,7 @@ class StepsRLN(StepsCommon):
discv5_bootstrap_node=self.enr_uri,
rln_creds_source=RLN_CREDENTIALS,
rln_creds_id="2",
rln_relay_membership_index="1",
rln_relay_membership_index=self.resolve_rln_membership_index(1, **kwargs),
rln_keystore_prefix=self.keystore_prefixes[1],
**kwargs,
)
@ -101,7 +113,7 @@ class StepsRLN(StepsCommon):
discv5_bootstrap_node=self.enr_uri,
rln_creds_source=RLN_CREDENTIALS,
rln_creds_id=f"{index + 3}",
rln_relay_membership_index="1",
rln_relay_membership_index=self.resolve_rln_membership_index(index + 2, **kwargs),
rln_keystore_prefix=self.keystore_prefixes[index + 2],
**kwargs,
)
@ -118,7 +130,7 @@ class StepsRLN(StepsCommon):
lightpushnode=self.multiaddr_list[0],
rln_creds_source=RLN_CREDENTIALS,
rln_creds_id="2",
rln_relay_membership_index="1",
rln_relay_membership_index=self.resolve_rln_membership_index(1, **kwargs),
rln_keystore_prefix=self.keystore_prefixes[1],
**kwargs,
)
@ -131,7 +143,23 @@ class StepsRLN(StepsCommon):
def register_rln_single_node(self, prefix="", **kwargs):
logger.debug("Registering RLN credentials for single node")
self.node = WakuNode(DEFAULT_NWAKU, f"node_{gen_step_id()}")
self.node.register_rln(rln_keystore_prefix=prefix, rln_creds_source=kwargs["rln_creds_source"], rln_creds_id=kwargs["rln_creds_id"])
return self.node.register_rln(rln_keystore_prefix=prefix, rln_creds_source=kwargs["rln_creds_source"], rln_creds_id=kwargs["rln_creds_id"])
@allure.step
def resolve_rln_membership_index(self, index, **kwargs):
explicit_index = kwargs.get("rln_relay_membership_index")
if explicit_index is not None:
return str(explicit_index)
if len(self.rln_membership_indexes) > index and self.rln_membership_indexes[index] is not None:
inferred_index = str(self.rln_membership_indexes[index])
logger.debug(f"Using inferred RLN membership index for position {index}: {inferred_index}")
return inferred_index
raise ValueError(
f"RLN membership index for position {index} is not available. "
"Register credentials and persist rln_membership_indexes together with keystore_prefixes before node startup."
)
@allure.step
def check_rln_registration(self, prefix, key_id):

View File

@ -168,7 +168,7 @@ SAMPLE_TIMESTAMPS = [
{"description": "Missing", "value": None, "valid_for": []},
]
PUBSUB_TOPICS_RLN = ["/waku/2/rs/1/0"]
PUBSUB_TOPICS_RLN = [f"/waku/2/rs/{DEFAULT_CLUSTER_ID}/0"]
LOG_ERROR_KEYWORDS = [
"crash",

View File

@ -17,14 +17,18 @@ logger = get_custom_logger(__name__)
class TestRelayRLN(StepsRLN, StepsRelay):
SAMPLE_INPUTS_RLN = SAMPLE_INPUTS + SAMPLE_INPUTS + SAMPLE_INPUTS
def test_single_node_registration(self, pytestconfig):
pytestconfig.cache.set("keystore-prefixes", self.register_rln_relay_nodes(1, []))
@pytest.mark.smoke
def test_valid_payloads_lightpush_at_spam_rate(self, pytestconfig):
message_limit = 1
epoch_sec = 1
pytestconfig.cache.set("keystore-prefixes", self.register_rln_relay_nodes(2, []))
rln_state = self.register_rln_relay_nodes(2, [])
pytestconfig.cache.set(
"keystore-prefixes",
{
"keystore_prefixes": rln_state["keystore_prefixes"],
"rln_membership_indexes": rln_state["rln_membership_indexes"],
},
)
self.setup_first_rln_relay_node(lightpush="true", rln_relay_user_message_limit=message_limit, rln_relay_epoch_sec=epoch_sec)
self.setup_second_rln_lightpush_node(rln_relay_user_message_limit=message_limit, rln_relay_epoch_sec=epoch_sec)
self.subscribe_main_relay_nodes()
@ -43,7 +47,14 @@ class TestRelayRLN(StepsRLN, StepsRelay):
def test_valid_payloads_at_slow_rate(self, pytestconfig):
message_limit = 20
self.register_rln_relay_nodes(0, pytestconfig.cache.get("keystore-prefixes", []))
rln_state = self.register_rln_relay_nodes(2, [])
pytestconfig.cache.set(
"keystore-prefixes",
{
"keystore_prefixes": rln_state["keystore_prefixes"],
"rln_membership_indexes": rln_state["rln_membership_indexes"],
},
)
self.setup_main_rln_relay_nodes(rln_relay_user_message_limit=message_limit, rln_relay_epoch_sec=600)
self.subscribe_main_relay_nodes()
failed_payloads = []
@ -65,7 +76,10 @@ class TestRelayRLN(StepsRLN, StepsRelay):
def test_valid_payloads_at_spam_rate(self, pytestconfig):
message_limit = 20
epoch_sec = 600
self.register_rln_relay_nodes(0, pytestconfig.cache.get("keystore-prefixes", []))
self.register_rln_relay_nodes(
0,
pytestconfig.cache.get("keystore-prefixes", {"keystore_prefixes": [], "rln_membership_indexes": []}),
)
self.setup_main_rln_relay_nodes(rln_relay_user_message_limit=message_limit, rln_relay_epoch_sec=epoch_sec)
self.subscribe_main_relay_nodes()
start = math.trunc(time())
@ -82,7 +96,10 @@ class TestRelayRLN(StepsRLN, StepsRelay):
assert "RLN validation failed" or "NonceLimitReached" in str(e)
def test_valid_payload_at_variable_rate(self, pytestconfig):
self.register_rln_relay_nodes(0, pytestconfig.cache.get("keystore-prefixes", []))
self.register_rln_relay_nodes(
0,
pytestconfig.cache.get("keystore-prefixes", {"keystore_prefixes": [], "rln_membership_indexes": []}),
)
self.setup_main_rln_relay_nodes(rln_relay_user_message_limit=1, rln_relay_epoch_sec=1)
self.subscribe_main_relay_nodes()
payload_desc = SAMPLE_INPUTS[0]["description"]
@ -107,7 +124,10 @@ class TestRelayRLN(StepsRLN, StepsRelay):
def test_valid_payloads_random_epoch_at_slow_rate(self, pytestconfig):
epoch_sec = random.randint(2, 5)
self.register_rln_relay_nodes(0, pytestconfig.cache.get("keystore-prefixes", []))
self.register_rln_relay_nodes(
0,
pytestconfig.cache.get("keystore-prefixes", {"keystore_prefixes": [], "rln_membership_indexes": []}),
)
self.setup_main_rln_relay_nodes(rln_relay_user_message_limit=1, rln_relay_epoch_sec=epoch_sec)
self.subscribe_main_relay_nodes()
failed_payloads = []
@ -124,7 +144,10 @@ class TestRelayRLN(StepsRLN, StepsRelay):
def test_valid_payloads_random_user_message_limit(self, pytestconfig):
user_message_limit = random.randint(2, 4)
self.register_rln_relay_nodes(0, pytestconfig.cache.get("keystore-prefixes", []))
self.register_rln_relay_nodes(
0,
pytestconfig.cache.get("keystore-prefixes", {"keystore_prefixes": [], "rln_membership_indexes": []}),
)
self.setup_main_rln_relay_nodes(rln_relay_user_message_limit=user_message_limit, rln_relay_epoch_sec=1)
self.subscribe_main_relay_nodes()
failed_payloads = []
@ -143,7 +166,14 @@ class TestRelayRLN(StepsRLN, StepsRelay):
def test_valid_payloads_dynamic_at_spam_rate(self, pytestconfig):
message_limit = 100
epoch_sec = 600
pytestconfig.cache.set("keystore-prefixes", self.register_rln_relay_nodes(2, []))
rln_state = self.register_rln_relay_nodes(2, [])
pytestconfig.cache.set(
"keystore-prefixes",
{
"keystore_prefixes": rln_state["keystore_prefixes"],
"rln_membership_indexes": rln_state["rln_membership_indexes"],
},
)
self.setup_main_rln_relay_nodes(
rln_relay_user_message_limit=message_limit,
rln_relay_epoch_sec=epoch_sec,
@ -168,7 +198,14 @@ class TestRelayRLN(StepsRLN, StepsRelay):
@pytest.mark.timeout(600)
def test_valid_payloads_dynamic_at_slow_rate(self, pytestconfig):
message_limit = 100
pytestconfig.cache.set("keystore-prefixes", self.register_rln_relay_nodes(2, []))
rln_state = self.register_rln_relay_nodes(2, [])
pytestconfig.cache.set(
"keystore-prefixes",
{
"keystore_prefixes": rln_state["keystore_prefixes"],
"rln_membership_indexes": rln_state["rln_membership_indexes"],
},
)
self.setup_main_rln_relay_nodes(
rln_relay_user_message_limit=message_limit,
rln_relay_epoch_sec=600,
@ -194,7 +231,10 @@ class TestRelayRLN(StepsRLN, StepsRelay):
def test_valid_payloads_n1_with_rln_n2_without_rln_at_spam_rate(self, pytestconfig):
message_limit = 1
epoch_sec = 1
self.register_rln_relay_nodes(0, pytestconfig.cache.get("keystore-prefixes", []))
self.register_rln_relay_nodes(
0,
pytestconfig.cache.get("keystore-prefixes", {"keystore_prefixes": [], "rln_membership_indexes": []}),
)
self.setup_first_rln_relay_node(rln_relay_user_message_limit=message_limit, rln_relay_epoch_sec=epoch_sec)
self.setup_second_relay_node()
self.subscribe_main_relay_nodes()
@ -211,7 +251,14 @@ class TestRelayRLN(StepsRLN, StepsRelay):
assert "RLN validation failed" or "NonceLimitReached" in str(e)
def test_valid_payloads_with_optional_nodes_at_slow_rate(self, pytestconfig):
pytestconfig.cache.set("keystore-prefixes", self.register_rln_relay_nodes(5, []))
rln_state = self.register_rln_relay_nodes(5, [])
pytestconfig.cache.set(
"keystore-prefixes",
{
"keystore_prefixes": rln_state["keystore_prefixes"],
"rln_membership_indexes": rln_state["rln_membership_indexes"],
},
)
self.setup_main_rln_relay_nodes(rln_relay_user_message_limit=1, rln_relay_epoch_sec=1)
self.setup_optional_rln_relay_nodes(rln_relay_user_message_limit=1, rln_relay_epoch_sec=1)
self.subscribe_main_relay_nodes()
@ -230,7 +277,10 @@ class TestRelayRLN(StepsRLN, StepsRelay):
assert not failed_payloads, f"Payloads failed: {failed_payloads}"
def test_valid_payloads_with_optional_nodes_at_spam_rate(self, pytestconfig):
self.register_rln_relay_nodes(0, pytestconfig.cache.get("keystore-prefixes", []))
self.register_rln_relay_nodes(
0,
pytestconfig.cache.get("keystore-prefixes", {"keystore_prefixes": [], "rln_membership_indexes": []}),
)
self.setup_main_rln_relay_nodes(rln_relay_user_message_limit=1, rln_relay_epoch_sec=1)
self.setup_optional_rln_relay_nodes(rln_relay_user_message_limit=1, rln_relay_epoch_sec=1)
self.subscribe_main_relay_nodes()