From 6958f67af3f477b5dc106aa2f267afb047c26205 Mon Sep 17 00:00:00 2001
From: Etan Kissling <etan@status.im>
Date: Sat, 4 Nov 2023 20:35:41 +0100
Subject: [PATCH] add test runner for v1.4.0-beta.4 Merkle proof tests (#5567)

Create a test runner for validating the new `Merkle proof` Deneb tests
that are added with `v1.4.0-beta.4` specs.
---
 .../consensus_spec_tests_preset.nim           |  1 +
 .../test_fixture_merkle_proof.nim             | 74 +++++++++++++++++++
 2 files changed, 75 insertions(+)
 create mode 100644 tests/consensus_spec/test_fixture_merkle_proof.nim

diff --git a/tests/consensus_spec/consensus_spec_tests_preset.nim b/tests/consensus_spec/consensus_spec_tests_preset.nim
index 24bd8bf01..cc3e3785d 100644
--- a/tests/consensus_spec/consensus_spec_tests_preset.nim
+++ b/tests/consensus_spec/consensus_spec_tests_preset.nim
@@ -20,6 +20,7 @@ import
   ./test_fixture_light_client_single_merkle_proof,
   ./test_fixture_light_client_sync,
   ./test_fixture_light_client_update_ranking,
+  ./test_fixture_merkle_proof,
   ./test_fixture_sanity_blocks,
   ./test_fixture_sanity_slots,
   ./test_fixture_transition
diff --git a/tests/consensus_spec/test_fixture_merkle_proof.nim b/tests/consensus_spec/test_fixture_merkle_proof.nim
new file mode 100644
index 000000000..828a4e048
--- /dev/null
+++ b/tests/consensus_spec/test_fixture_merkle_proof.nim
@@ -0,0 +1,74 @@
+# beacon_chain
+# Copyright (c) 2023 Status Research & Development GmbH
+# Licensed and distributed under either of
+#   * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT).
+#   * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0).
+# at your option. This file may not be copied, modified, or distributed except according to those terms.
+
+{.used.}
+
+import
+  # Standard library
+  std/[sequtils, streams],
+  # Status libraries
+  stew/bitops2,
+  # Third-party
+  yaml,
+  # Beacon chain internals
+  ../../beacon_chain/spec/helpers,
+  # Test utilities
+  ../testutil,
+  ./fixtures_utils, ./os_ops
+
+proc runTest[T](suiteName, path: string, objType: typedesc[T]) =
+  test "Merkle proof - Single merkle proof - " & path.relativePath(SszTestsDir):
+    type
+      TestProof = object
+        leaf: string
+        leaf_index: GeneralizedIndex
+        branch: seq[string]
+
+    let
+      proof = block:
+        let s = openFileStream(path/"proof.yaml")
+        defer: close(s)
+        var res: TestProof
+        yaml.load(s, res)
+        res
+
+      obj = newClone(parseTest(path/"object.ssz_snappy", SSZ, T))
+
+    var computedProof = newSeq[Eth2Digest](log2trunc(proof.leaf_index))
+    build_proof(obj[], proof.leaf_index, computedProof).get
+
+    check:
+      computedProof == proof.branch.mapIt(Eth2Digest.fromHex(it))
+      is_valid_merkle_branch(
+        Eth2Digest.fromHex(proof.leaf),
+        computedProof,
+        log2trunc(proof.leaf_index),
+        get_subtree_index(proof.leaf_index),
+        hash_tree_root(obj[]))
+
+suite "EF - Merkle proof" & preset():
+  const presetPath = SszTestsDir/const_preset
+  for kind, path in walkDir(presetPath, relative = true, checkDir = true):
+    let testsPath = presetPath/path/"merkle_proof"/"single_merkle_proof"
+    if kind != pcDir or not dirExists(testsPath):
+      continue
+    let fork = forkForPathComponent(path).valueOr:
+      test "Merkle proof - Single merkle proof - " & path:
+        skip()
+      continue
+    for kind, path in walkDir(testsPath, relative = true, checkDir = true):
+      let suitePath = testsPath/path
+      if kind != pcDir or not dirExists(suitePath):
+        continue
+      let objName = path
+      withConsensusFork(fork):
+        for kind, path in walkDir(suitePath, relative = true, checkDir = true):
+          case objName
+          of "BeaconBlockBody":
+            runTest(suiteName, suitePath/path, consensusFork.BeaconBlockBody)
+          else:
+            raiseAssert "Unknown test object: " & suitePath/path