Standardize test function names for clarity and consistency (#7709)

Author: eddyashton

tests/README.md

@@ -0,0 +1,55 @@
+# End-to-End Tests
+
+## Test hierarchy
+
+```
+CTest entry          ctest -R e2e_logging
+└── Entry-point      tests/e2e_logging.py
+    └── Runner       cr.add("cpp", run_cpp, ...)
+        └── Group    run_cpp(args) — creates and owns a network
+            └── Case test_historical_query(network, args) — single test
+```
+
+## Naming conventions
+
+### CTest entries
+
+Registered in CMakeLists.txt via `add_e2e_test(NAME ...)`. Names should be
+unique and not be substrings of each other, so that `ctest -R <name>` matches
+exactly one test. For example, `recovery_test` and `recovery_test_suite` are
+problematic because `-R recovery_test` matches both.
+
+### Entry-points
+
+Python scripts (e.g. `schema.py`, `e2e_logging.py`) that use `ConcurrentRunner`
+to run one or more groups in parallel. A single entry-point may bin-pack
+unrelated groups for efficient CI run-time.
+
+### Runners (ConcurrentRunner threads)
+
+The first argument to `cr.add("name", ...)`. This name appears in every log
+line from that thread, so it should be short and descriptive (e.g. `"cpp"`,
+`"operations"`, `"recovery"`).
+
+### Groups — `run_` prefix
+
+Top-level functions that create and own a network, then call test cases on it.
+
+- Should take `(args)` or `(const_args)`.
+- Should create their own network via `with infra.network.network(...)`.
+- Should not return `network`.
+- `const_args` signals the function will `copy.deepcopy` before mutating.
+
+### Test cases — `test_` prefix
+
+Individual test functions that operate on an existing network.
+
+- Should take `(network, args)` and return `network` (enables chaining).
+- Should have a `@reqs.description("...")` decorator.
+- Should not create their own network.
+
+### Other helpers
+
+Functions that don't fit either pattern (e.g. shared test groups that operate
+on an existing network but aren't individual tests) should avoid the `test_`
+and `run_` prefixes.

tests/e2e_logging.py

@@ -2200,7 +2200,7 @@ def additional_interfaces(local_node_id):
     ) as network:
         network.start_and_open(args)
 
-        run_main_tests(network, args)
+        do_main_tests(network, args)
 
 
 def run_app_space_js(args):
@@ -2256,7 +2256,7 @@ def run_app_space_js(args):
             )
             assert r.status_code == http.HTTPStatus.OK.value, r.status_code
 
-        run_main_tests(network, args)
+        do_main_tests(network, args)
 
 
 def test_cose_config(network, args):
@@ -2276,7 +2276,7 @@ def test_cose_config(network, args):
     return network
 
 
-def run_main_tests(network, args):
+def do_main_tests(network, args):
     test_basic_constraints(network, args)
     test(network, args)
     test_remove(network, args)

tests/e2e_operations.py

@@ -2582,7 +2582,7 @@ def run_read_ledger_on_testdata(args):
                     )
 
 
-def test_merkle_verification_level(args):
+def run_merkle_verification_level(args):
     """Test MERKLE verification level on isolated chunks and full ledgers"""
     LOG.info("Testing MERKLE verification level")
 
@@ -2746,7 +2746,7 @@ def test_merkle_verification_level(args):
         temp_dir.cleanup()
 
 
-def test_error_message_on_failure_to_read_aci_sec_context(args):
+def run_error_message_on_failure_to_read_aci_sec_context(args):
     with infra.network.network(
         args.nodes,
         args.binary_dir,
@@ -2796,7 +2796,7 @@ def test_error_message_on_failure_to_read_aci_sec_context(args):
         ), f"Did not find expected log messages: {expected_log_messages}"
 
 
-def test_error_message_on_failure_to_fetch_snapshot(const_args):
+def run_error_message_on_failure_to_fetch_snapshot(const_args):
     args = copy.deepcopy(const_args)
     args.nodes = infra.e2e_args.min_nodes(args, 0)
     with infra.network.network(
@@ -2909,7 +2909,7 @@ def run_snp_tests(args):
     )
     run_recovery_local_unsealing(args, recovery_f=1, suffix="_unsealing_with_f_equal_1")
     run_recovery_unsealing_validate_audit(args)
-    test_error_message_on_failure_to_read_aci_sec_context(args)
+    run_error_message_on_failure_to_read_aci_sec_context(args)
     run_recovery_decision_protocol(args)
     run_recovery_decision_protocol_timeout_path(args)
     run_recovery_decision_protocol_multiple_timeout(args)
@@ -2930,5 +2930,5 @@ def run(args):
     run_late_mounted_ledger_check(args)
     run_empty_ledger_dir_check(args)
     run_read_ledger_on_testdata(args)
-    test_merkle_verification_level(args)
+    run_merkle_verification_level(args)
     run_propose_request_vote(args)

tests/npm_tests.py

@@ -154,7 +154,7 @@ def generate_and_verify_jwk(client):
         assert body["pem"] == pub_pem
 
 
-def test_apply_writes(c):
+def check_apply_writes(c):
     ### Default behaviour
     # Writes are applied for 2xx response codes
     r = c.post("/app/rpc/apply_writes", {"val": "aaa", "statusCode": 200})
@@ -695,7 +695,7 @@ def test_npm_app(network, args):
         v3 = r.body.json()["version"]
         assert v3 == v1
 
-        test_apply_writes(c)
+        check_apply_writes(c)
 
         priv_key_pem, _ = infra.crypto.generate_rsa_keypair(2048)
         pem = infra.crypto.generate_cert(priv_key_pem)

tests/recovery.py

@@ -591,7 +591,7 @@ def test_trusted_keys_vs_endorsements(network, args):
 
 
 @reqs.description("Recover a service from local files")
-def test_recover_service_from_files(
+def run_recover_service_from_files(
     args,
     directory,
     expected_recovery_count,
@@ -1202,7 +1202,7 @@ def run(args):
 
 
 def run_recovery_from_files(args):
-    test_recover_service_from_files(
+    run_recover_service_from_files(
         args,
         directory=args.directory,
         expected_recovery_count=args.expected_recovery_count,