Unit test Etherman (#28)

* test setup

* etherman test created with the exception of a few cases

* ethclient_mock completed

* typo fixed

* SignTx not used arguments added back cause otherwise we arent compatible with the defined etherman interface

* TxMock moved to mocks folder (will move the others with a different PR)

* TestGetRevertMessage extended by one test case

* ineffectual assignment of 'err' removed

* 'mocks' added to exclusion rule of sonarqube

* Exclude mocks folder from coverage analysis

* Exclude cmd/main.go

* part of the requested changes applied to the PR

---------

Co-authored-by: Stefan Negovanović <[email protected]>

.gitignore

@@ -1,3 +1,4 @@
 dist
 docker/data
+.idea
 coverage.out

cmd/main.go

@@ -10,19 +10,20 @@ import (
 	"os/signal"
 	"time"
 
-	beethoven "github.com/0xPolygon/beethoven"
 	"github.com/0xPolygon/cdk-data-availability/dummyinterfaces"
 	dbConf "github.com/0xPolygon/cdk-validium-node/db"
 	"github.com/0xPolygon/cdk-validium-node/ethtxmanager"
 	"github.com/0xPolygon/cdk-validium-node/jsonrpc"
 	"github.com/0xPolygon/cdk-validium-node/log"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/crypto"
+	"github.com/ethereum/go-ethereum/ethclient"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"github.com/urfave/cli/v2"
 	"go.opentelemetry.io/otel/exporters/prometheus"
 	"go.opentelemetry.io/otel/sdk/metric"
 
+	beethoven "github.com/0xPolygon/beethoven"
 	"github.com/0xPolygon/beethoven/config"
 	"github.com/0xPolygon/beethoven/db"
 	"github.com/0xPolygon/beethoven/etherman"
@@ -93,7 +94,19 @@ func start(cliCtx *cli.Context) error {
 	if err != nil {
 		log.Fatal(err)
 	}
-	ethMan, err := etherman.New(cliCtx.Context, c.L1.NodeURL, *auth)
+
+	// Connect to ethereum node
+	ethClient, err := ethclient.DialContext(cliCtx.Context, c.L1.NodeURL)
+	if err != nil {
+		log.Fatal("error connecting to %s: %+v", c.L1.NodeURL, err)
+	}
+
+	// Make sure the connection is okay
+	if _, err = ethClient.ChainID(cliCtx.Context); err != nil {
+		log.Fatal("error getting chain ID from l1 with address: %+v", err)
+	}
+
+	ethMan, err := etherman.New(ethClient, *auth)
 	if err != nil {
 		log.Fatal(err)
 	}

etherman/etherman.go

@@ -3,6 +3,7 @@ package etherman
 import (
 	"context"
 	"errors"
+	"github.com/jackc/pgx/v4"
 	"math/big"
 	"time"
 
@@ -15,29 +16,14 @@ import (
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
-	"github.com/ethereum/go-ethereum/ethclient"
-	"github.com/jackc/pgx/v4"
 )
 
 type Etherman struct {
 	ethClient EthereumClient
 	auth      bind.TransactOpts
 }
 
-func New(ctx context.Context, url string, auth bind.TransactOpts) (Etherman, error) {
-	// Connect to ethereum node
-	ethClient, err := ethclient.DialContext(ctx, url)
-	if err != nil {
-		log.Errorf("error connecting to %s: %+v", url, err)
-		return Etherman{}, err
-	}
-
-	// Make sure the connection is okay
-	if _, err = ethClient.ChainID(ctx); err != nil {
-		log.Errorf("error getting chain ID from l1 with %s address: %+v", url, err)
-		return Etherman{}, err
-	}
-
+func New(ethClient EthereumClient, auth bind.TransactOpts) (Etherman, error) {
 	return Etherman{
 		ethClient: ethClient,
 		auth:      auth,
@@ -49,6 +35,7 @@ func (e *Etherman) GetSequencerAddr(l1Contract common.Address) (common.Address,
 	if err != nil {
 		return common.Address{}, err
 	}
+
 	return contract.TrustedSequencer(&bind.CallOpts{Pending: false})
 }
 
@@ -69,6 +56,7 @@ func (e *Etherman) BuildTrustedVerifyBatchesTxData(lastVerifiedBatch, newVerifie
 		log.Errorf("error geting ABI: %v, Proof: %s", err)
 		return nil, err
 	}
+
 	return abi.Pack(
 		"verifyBatchesTrustedAggregator",
 		pendStateNum,
@@ -177,6 +165,7 @@ func (e *Etherman) GetRevertMessage(ctx context.Context, tx *types.Transaction)
 
 	if receipt.Status == types.ReceiptStatusFailed {
 		revertMessage, err := operations.RevertReason(ctx, e.ethClient, tx, receipt.BlockNumber)
+
 		if err != nil {
 			return "", err
 		}