Add more test coverage for pkg/merkle

[fbac]

Implement test coverage for hash functions, proofs, and tree operations in pkg/merkle package

• Adds test suite for hash functions in hash_test.go covering Hash, HashNode, HashLeaf, and HashEmptyLeaf functions
• Creates internal test coverage for MultiProof functionality in proof_internal_test.go testing proof verification process
• Extends proof_test.go with additional test cases for MultiProof.GetLeafCount and error handling in Verify function
• Introduces internal tests for MerkleTree implementation in tree_internal_test.go covering tree construction and manipulation

📍Where to Start

Start with the basic hash function tests in hash_test.go as these functions are fundamental to the merkle tree operations and are used by the other components being tested.

---

Macroscope summarized 1ab9bdf.

Summary by CodeRabbit

• Tests
  • Added comprehensive unit tests for Merkle tree hashing functions, multi-proof logic, and tree construction, including error handling and edge cases.
  • Enhanced verification tests for multi-proofs, covering both successful and failure scenarios.
  • Improved test coverage for internal tree and proof operations to ensure correctness and robustness.

[coderabbitai]

Walkthrough

This pull request introduces comprehensive unit tests for the Merkle tree implementation, focusing on hashing functions, proof validation, and tree construction. New test files are added to cover the core hash functions, internal proof logic, and tree-building routines, ensuring correctness, error handling, and domain separation. Additional tests are included for public proof verification methods, especially for error and edge cases. The tests use assertions to validate expected outputs, error conditions, and internal state, significantly increasing test coverage for the Merkle package.

Changes

File(s)	Change Summary
pkg/merkle/hash_test.go	Adds unit tests for hashing functions (Hash, HashNode, HashLeaf, HashEmptyLeaf) and domain separation in the Merkle package.
pkg/merkle/proof_internal_test.go	Introduces tests for internal multi-proof logic, including validation, node queue construction, index handling, and root computation.
pkg/merkle/proof_test.go	Adds tests for GetLeafCount and error/edge cases in Verify, covering various proof verification scenarios.
pkg/merkle/tree_internal_test.go	Provides tests for internal tree-building functions and methods, including node creation, leaf balancing, and error cases.

Sequence Diagram(s)

sequenceDiagram
    participant Test
    participant Hash
    participant HashNode
    participant HashLeaf
    participant HashEmptyLeaf

    Test->>Hash: Call with input data
    Hash-->>Test: Return hash

    Test->>HashNode: Call with left, right
    HashNode-->>Test: Return node hash

    Test->>HashLeaf: Call with leaf data
    HashLeaf-->>Test: Return leaf hash

    Test->>HashEmptyLeaf: Call
    HashEmptyLeaf-->>Test: Return empty leaf hash

Loading

sequenceDiagram
    participant Test
    participant MultiProof
    participant MerkleTree

    Test->>MultiProof: Validate proof (various scenarios)
    MultiProof-->>Test: Return validation result/error

    Test->>MultiProof: getNextProof
    MultiProof-->>Test: Return next proof node/error

    Test->>MerkleTree: Leaves(), makeNodes(), makeLeaves(), makeTree()
    MerkleTree-->>Test: Return leaves/nodes/tree/error

Loading

Possibly related PRs

• Add pkg merkle #712: Adds the hashing functions that are now being tested in this PR, making it directly related to the new test coverage.

Suggested reviewers

• neekolas
• mkysel

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (1.64.8)

Error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2
Failed executing command with error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 35cb124 and b0784df.

📒 Files selected for processing (4)

• pkg/merkle/hash_test.go (1 hunks)
• pkg/merkle/proof_internal_test.go (1 hunks)
• pkg/merkle/proof_test.go (1 hunks)
• pkg/merkle/tree_internal_test.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (4)

• pkg/merkle/proof_internal_test.go
• pkg/merkle/proof_test.go
• pkg/merkle/hash_test.go
• pkg/merkle/tree_internal_test.go

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: Push Docker Images to GitHub Packages (xmtpd-cli)
• GitHub Check: Push Docker Images to GitHub Packages (xmtpd)
• GitHub Check: Test (Node)
• GitHub Check: Upgrade Tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[macroscopeapp]

Expand test coverage for pkg/merkle package's hash functions, proofs, and tree operations

Adds test coverage across the merkle package through new test files:

• hash_test.go tests Hash, HashNode, HashLeaf, and HashEmptyLeaf functions with various inputs
• proof_internal_test.go tests internal MultiProof functionality including validation, proof generation, and node operations
• proof_test.go adds tests for MultiProof.GetLeafCount and error handling in proof verification
• tree_internal_test.go tests internal MerkleTree operations like node creation and tree building

📍Where to Start

Start with the basic hash function tests in hash_test.go as these functions are fundamental to the merkle tree operations tested in the other files.

---

Macroscope summarized b0784df.