Merge pull request #3066 from etan-status/lc-prooftest

Allow extending LC merkle proof tests

tests/core/pyspec/eth2spec/gen_helpers/gen_from_tests/gen.py

@@ -49,7 +49,7 @@ def generate_from_tests(runner_name: str, handler_name: str, src: Any,
             preset_name=preset_name,
             runner_name=runner_name,
             handler_name=handler_name,
-            suite_name='pyspec_tests',
+            suite_name=getattr(tfn, 'suite_name', 'pyspec_tests'),
             case_name=case_name,
             # TODO: with_all_phases and other per-phase tooling, should be replaced with per-fork equivalent.
             case_fn=lambda: tfn(generator_mode=True, phase=phase, preset=preset_name, bls_active=bls_active)

tests/core/pyspec/eth2spec/test/altair/light_client/test_single_merkle_proof.py

@@ -1,14 +1,17 @@
 from eth2spec.test.context import (
     spec_state_test,
     with_altair_and_later,
+    with_test_suite_name,
 )
 
 
+@with_test_suite_name("BeaconState")
 @with_altair_and_later
 @spec_state_test
 def test_current_sync_committee_merkle_proof(spec, state):
-    yield "state", state
+    yield "object", state
-    current_sync_committee_branch = spec.compute_merkle_proof_for_state(state, spec.CURRENT_SYNC_COMMITTEE_INDEX)
+    current_sync_committee_branch = \
+        spec.compute_merkle_proof_for_state(state, spec.CURRENT_SYNC_COMMITTEE_INDEX)
     yield "proof", {
         "leaf": "0x" + state.current_sync_committee.hash_tree_root().hex(),
         "leaf_index": spec.CURRENT_SYNC_COMMITTEE_INDEX,
@@ -23,11 +26,13 @@ def test_current_sync_committee_merkle_proof(spec, state):
     )
 
 
+@with_test_suite_name("BeaconState")
 @with_altair_and_later
 @spec_state_test
 def test_next_sync_committee_merkle_proof(spec, state):
-    yield "state", state
+    yield "object", state
-    next_sync_committee_branch = spec.compute_merkle_proof_for_state(state, spec.NEXT_SYNC_COMMITTEE_INDEX)
+    next_sync_committee_branch = \
+        spec.compute_merkle_proof_for_state(state, spec.NEXT_SYNC_COMMITTEE_INDEX)
     yield "proof", {
         "leaf": "0x" + state.next_sync_committee.hash_tree_root().hex(),
         "leaf_index": spec.NEXT_SYNC_COMMITTEE_INDEX,
@@ -42,11 +47,13 @@ def test_next_sync_committee_merkle_proof(spec, state):
     )
 
 
+@with_test_suite_name("BeaconState")
 @with_altair_and_later
 @spec_state_test
 def test_finality_root_merkle_proof(spec, state):
-    yield "state", state
+    yield "object", state
-    finality_branch = spec.compute_merkle_proof_for_state(state, spec.FINALIZED_ROOT_INDEX)
+    finality_branch = \
+        spec.compute_merkle_proof_for_state(state, spec.FINALIZED_ROOT_INDEX)
     yield "proof", {
         "leaf": "0x" + state.finalized_checkpoint.root.hex(),
         "leaf_index": spec.FINALIZED_ROOT_INDEX,

tests/core/pyspec/eth2spec/test/context.py

@@ -614,6 +614,13 @@ def only_generator(reason):
     return _decorator
 
 
+def with_test_suite_name(suite_name: str):
+    def _decorator(inner):
+        inner.suite_name = suite_name
+        return inner
+    return _decorator
+
+
 #
 # Fork transition state tests
 #

tests/formats/light_client/single_merkle_proof.md

@@ -5,13 +5,15 @@ generation and verification of merkle proofs based on static data.
 
 ## Test case format
 
-### `state.ssz_snappy`
+Tests for each individual SSZ type are grouped into a `suite` indicating the SSZ type name.
 
-An SSZ-snappy encoded `BeaconState` object from which other data is generated.
+### `object.yaml`
+
+A SSZ-snappy encoded object from which other data is generated. The SSZ type can be determined from the test `suite` name.
 
 ### `proof.yaml`
 
-A proof of the leaf value (a merkle root) at generalized-index `leaf_index` in the given `state`.
+A proof of the leaf value (a merkle root) at generalized-index `leaf_index` in the given `object`.
 
 ```yaml
 leaf: Bytes32            # string, hex encoded, with 0x prefix
@@ -23,6 +25,6 @@ branch: list of Bytes32  # list, each element is a string, hex encoded, with 0x
 
 A test-runner can implement the following assertions:
 - Check that `is_valid_merkle_branch` confirms `leaf` at `leaf_index` to verify
-  against `has_tree_root(state)` and `proof`.
+  against `hash_tree_root(object)` and `branch`.
 - If the implementation supports generating merkle proofs, check that the
-  self-generated proof matches the `proof` provided with the test.
+  self-generated proof matches the `branch` provided with the test.