Refactor: benchmark, readme, and unit tests (#33)

* Update benchmark and README info.

Signed-off-by: txaty <[email protected]>

* Fix unit test issues.

Signed-off-by: txaty <[email protected]>

---------

Signed-off-by: txaty <[email protected]>

Author: txaty

README.md

@@ -4,6 +4,7 @@
 [![Go Report Card](https://goreportcard.com/badge/github.com/txaty/go-merkletree)](https://goreportcard.com/report/github.com/txaty/go-merkletree)
 [![codecov](https://codecov.io/gh/txaty/go-merkletree/branch/main/graph/badge.svg?token=M02CIBSXFR)](https://codecov.io/gh/txaty/go-merkletree)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/3a9bb5ff5cb64dcf83903ca998a9144d)](https://app.codacy.com/gh/txaty/go-merkletree/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
 
 High performance Golang Merkle Tree, supporting parallelization and OpenZeppelin sibling-sorting.
 
@@ -167,9 +168,9 @@ handleError(err)
 
 Setup:
 
-|      CPU       | Memory |      OS      | Hash Function |
-|:--------------:|:------:|:------------:|:-------------:|
-| Intel i7-9750H |  16GB  | Ubuntu 20.04 |    SHA256     |
+|  AWS EC2   |   CPU   | Memory |        OS        | Hash Function | Go Version |
+|:----------:|:-------:|:------:|:----------------:|:-------------:|:----------:|
+| c5.4xlarge | 16 Core |  32GB  | Ubuntu 22.04 LTS |    SHA256     |   1.21.4   |
 
 Benchmark tasks:
 
@@ -180,7 +181,7 @@ Benchmark tasks:
 <tbody>
 <tr><td>
 
-![Proof Generation](asset/proof_gen.png)
+![Proof Generation All](asset/proof_gen_all.png)
 
 </td><td>
 
@@ -201,12 +202,11 @@ Benchmark implementation can be found in [txaty/merkle-tree-bench](https://githu
 
 This project requires the following dependencies:
 
-- [gool](https://github.com/txaty/gool) - a generics goroutine pool. Before running the code, make sure that your Golang
-  version supports generics.
+- [golang.org/x/sync](golang.org/x/sync) - `errgroup` in this package is used to handle errors from goroutines.
 - [gomonkey](https://github.com/agiledragon/gomonkey) - a Go library that allows you to monkey patch in unit tests.
   Please note that this library may have permission-denied issues on Apple Silicon MacBooks. However, this will not
   affect the use of the Merkle Tree library.
 
 ## License
 
-MIT License
+Released under the [MIT License](https://github.com/txaty/go-merkletree/blob/master/LICENSE).

asset/proof_gen.png

@@ -34,7 +34,7 @@ import (
 func mockDataBlocks(num int) []DataBlock {
 	blocks := make([]DataBlock, num)
 	for i := 0; i < num; i++ {
-		byteLen := rand.Intn(1 << 15)
+		byteLen := max(32, rand.Intn(1<<15))
 		block := &mock.DataBlock{
 			Data: make([]byte, byteLen),
 		}

asset/proof_gen_all.png

@@ -26,6 +26,7 @@ import (
 	"crypto/sha256"
 	"fmt"
 	"reflect"
+	"sync/atomic"
 	"testing"
 )
 
@@ -147,6 +148,7 @@ func TestMerkleTreeNew_modeProofGenAndTreeBuild(t *testing.T) {
 }
 
 func TestMerkleTreeNew_modeProofGenAndTreeBuildParallel(t *testing.T) {
+	var hashFuncCounter atomic.Uint32
 	type args struct {
 		blocks []DataBlock
 		config *Config
@@ -221,12 +223,13 @@ func TestMerkleTreeNew_modeProofGenAndTreeBuildParallel(t *testing.T) {
 		{
 			name: "test_tree_build_hash_func_error",
 			args: args{
-				blocks: mockDataBlocks(100),
+				blocks: mockDataBlocks(5),
 				config: &Config{
 					HashFunc: func(block []byte) ([]byte, error) {
-						if len(block) == 64 {
+						if hashFuncCounter.Load() >= 5 {
 							return nil, fmt.Errorf("hash func error")
 						}
+						hashFuncCounter.Add(1)
 						sha256Func := sha256.New()
 						sha256Func.Write(block)
 						return sha256Func.Sum(nil), nil

asset/proof_verification.png

@@ -276,6 +276,24 @@ func TestMerkleTreeNew_modeTreeBuildParallel(t *testing.T) {
 			},
 			wantErr: true,
 		},
+		{
+			name: "test_hash_func_error_when_computing_nodes_parallel",
+			args: args{
+				blocks: mockDataBlocks(4),
+				config: &Config{
+					HashFunc: func(block []byte) ([]byte, error) {
+						if hashFuncCounter.Load() == 5 {
+							return nil, fmt.Errorf("hash func error")
+						}
+						hashFuncCounter.Add(1)
+						sha256Func := sha256.New()
+						sha256Func.Write(block)
+						return sha256Func.Sum(nil), nil
+					},
+				},
+			},
+			wantErr: true,
+		},
 		{
 			name: "test_hash_func_error_when_computing_root_parallel",
 			args: args{
@@ -299,6 +317,7 @@ func TestMerkleTreeNew_modeTreeBuildParallel(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
+			hashFuncCounter.Store(0)
 			m, err := New(tt.args.config, tt.args.blocks)
 			if (err != nil) != tt.wantErr {
 				t.Errorf("Build() error = %v, wantErr %v", err, tt.wantErr)