nim-codex/tests/codex/merkletree/testcodextree.nim

import std/unittest
import std/sequtils
import std/tables

import pkg/chronos
import pkg/questionable/results
import pkg/stew/byteutils
import pkg/nimcrypto/sha2
import pkg/libp2p

import pkg/codex/codextypes
import pkg/codex/merkletree
import pkg/codex/utils/digest

import ./helpers
import ./generictreetests

# TODO: Generalize to other hashes

const
  data =
    @[
      "00000000000000000000000000000001".toBytes,
      "00000000000000000000000000000002".toBytes,
      "00000000000000000000000000000003".toBytes,
      "00000000000000000000000000000004".toBytes,
      "00000000000000000000000000000005".toBytes,
      "00000000000000000000000000000006".toBytes,
      "00000000000000000000000000000007".toBytes,
      "00000000000000000000000000000008".toBytes,
      "00000000000000000000000000000009".toBytes,
      "00000000000000000000000000000010".toBytes,
    ]
  sha256 = Sha256HashCodec

suite "Test CodexTree":
  proc CodexTreeInit(leaves: seq[MultiHash]): ?!CodexTree =
    waitFor CodexTree.init(leaves)

  proc CodexTreeInit(leaves: seq[Cid]): ?!CodexTree =
    waitFor CodexTree.init(leaves)

  proc CodexTreeInit(mcodec: MultiCodec, leaves: seq[ByteHash]): ?!CodexTree =
    waitFor CodexTree.init(mcodec, leaves)

  test "Cannot init tree without any multihash leaves":
    check:
      CodexTreeInit(leaves = newSeq[MultiHash]()).isErr

  test "Cannot init tree without any cid leaves":
    check:
      CodexTreeInit(leaves = newSeq[Cid]()).isErr

  test "Cannot init tree without any byte leaves":
    check:
      CodexTreeInit(sha256, leaves =  newSeq[ByteHash]()).isErr

  test "Should build tree from multihash leaves":
    var
      expectedLeaves = data.mapIt(  MultiHash.digest($sha256, it).tryGet() )

    var tree = CodexTreeInit(leaves = expectedLeaves)
    check:
      tree.isOk
      tree.get().leaves == expectedLeaves.mapIt( it.digestBytes )
      tree.get().mcodec == sha256

  test "Should build tree from cid leaves":
    var
      expectedLeaves = data.mapIt(
        Cid.init(
          CidVersion.CIDv1,
          BlockCodec,
          MultiHash.digest($sha256, it).tryGet
      ).tryGet )

    let
      tree = CodexTreeInit(leaves = expectedLeaves)

    check:
      tree.isOk
      tree.get().leaves == expectedLeaves.mapIt( it.mhash.tryGet.digestBytes )
      tree.get().mcodec == sha256

  test "Should build from raw digestbytes (should not hash leaves)":
    let
      tree = CodexTreeInit(sha256, leaves = data).tryGet

    check:
      tree.mcodec == sha256
      tree.leaves == data

  test "Should build from nodes":
    let
      tree = CodexTreeInit(sha256, leaves = data).tryGet
      fromNodes = CodexTree.fromNodes(
        nodes = toSeq(tree.nodes),
        nleaves = tree.leavesCount).tryGet

    check:
      tree.mcodec == sha256
      tree == fromNodes

let
  mhash = sha256.mhash().tryGet
  zero: seq[byte] = newSeq[byte](mhash.size)
  compress = proc(x, y: seq[byte], key: ByteTreeKey): seq[byte] =
    compress(x, y, key, mhash).tryGet

  makeTree = proc(data: seq[seq[byte]]): CodexTree =
    (waitFor CodexTree.init(sha256, leaves = data)).tryGet

testGenericTree(
  "CodexTree",
  @data,
  zero,
  compress,
  makeTree)