[KLC-1667] Fix code coverage workflow (#17)

* update code coverage workflow with coverage summary and results

* fix parsers tests

* fix p2p test failing due to invalid pbk size

* update executors tests to handle klever-blockchain client

* fix mock address mismatch during tests

* add grace.pem file for tests usage

* add error handling in executors transaction creation

* improve code-coverage workflow results in fail cases

Author: RomuloSiebra

.github/workflows/code-coverage.yml

@@ -9,30 +9,62 @@ on:
 
 jobs:
   build:
-    strategy:
-      matrix:
-        runs-on: [ ubuntu-latest ]
-    runs-on: ${{ matrix.runs-on }}
+    runs-on: ubuntu-latest
     name: Build
     steps:
-      - name: Set up Go 1.x
-        uses: actions/setup-go@v3
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v4
+
+      - name: Go Setup
+        uses: ./.github/actions/go-setup-action
         with:
-          go-version: 1.20.7
-        id: go
+          go-version: ${{vars.GO_VERSION }}
+          go-private: ${{vars.GO_PRIVATE_REPO }}
+          git-user: ${{ secrets.GIT_USER }}
+          git-pass: ${{ secrets.GIT_PASS }}
 
-      - name: Check out code into the Go module directory
-        uses: actions/checkout@v3
+      - name: Run unit tests
+        id: run-tests
+        run: |
+          set +e
+          make test-coverage
+          echo "test_exit_code=$?" >> "$GITHUB_OUTPUT"
+          # Always succeed so that the next step can evaluate the results
+          exit 0
 
-      - name: Get dependencies
+      - name: Process test results
+        if: always()
+        id: coverage
         run: |
-          go get -v -t -d ./...
-          if [ -f Gopkg.toml ]; then
-              curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
-              dep ensure
+          # Generate coverage summary
+          if [ -f coverage.out ]; then
+            go tool cover -func=coverage.out > coverage-summary.txt
+            COVERAGE=$(grep "total:" coverage-summary.txt | awk '{print $3}')
+            echo "total=$COVERAGE" >> $GITHUB_OUTPUT
+          else
+            echo "No coverage data generated" > coverage-summary.txt
+            echo "total=0.0%" >> $GITHUB_OUTPUT
           fi
-      - name: Run unit tests
-        run: make test-coverage
 
-      - name: Upload coverage
-        run: bash <(curl -s https://codecov.io/bash) -f coverage.txt -y codecov.yml
+          # Create test summary and check for failures
+          echo "### Test Results 🧪" >> $GITHUB_STEP_SUMMARY
+          if [ "${{ steps.run-tests.outputs.test_exit_code }}" == "0" ]; then
+            echo "✅ All tests passed successfully" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "❌ Some tests failed" >> $GITHUB_STEP_SUMMARY
+            echo "::error::🔴 Test failures detected!"
+            
+            if [ -f test-output.json ]; then
+              echo "#### Failed Tests" >> $GITHUB_STEP_SUMMARY
+              echo '```' >> $GITHUB_STEP_SUMMARY
+              jq -r 'select(.Action=="fail") | "- \(.Package) - \(.Test)"' test-output.json | tee -a $GITHUB_STEP_SUMMARY
+              echo '```' >> $GITHUB_STEP_SUMMARY
+              
+              # Output failures as GitHub annotations
+              jq -r 'select(.Action=="fail") | "::error file=\(.Package)::❌ \(.Test): \(.Action)"' test-output.json
+            fi
+            
+            exit 1
+          fi
+          
+          echo "Coverage: $COVERAGE" >> $GITHUB_STEP_SUMMARY

Makefile

@@ -15,7 +15,7 @@ test: clean-test
 
 test-coverage:
 	@echo "Running unit tests"
-	CURRENT_DIRECTORY=$(CURRENT_DIRECTORY) go test -cover -coverprofile=coverage.txt -covermode=atomic -v ${TESTS_TO_RUN}
+	CURRENT_DIRECTORY=$(CURRENT_DIRECTORY) go test -cover -coverprofile=coverage.out -covermode=atomic -v ${TESTS_TO_RUN} -json > test-output.json
 
 slow-tests: clean-test
 	@docker compose -f docker/docker-compose.yml build

config/config.go

@@ -194,8 +194,8 @@ type PendingOperationsFilterConfig struct {
 type ScCallsModuleConfig struct {
 	ScProxyBech32Address            string
 	ExtraGasToExecute               uint64
-	MaxGasLimitToUse                uint64
-	GasLimitForOutOfGasTransactions uint64
+	MaxGasLimitToUse                int64
+	GasLimitForOutOfGasTransactions int64
 	NetworkAddress                  string
 	ProxyMaxNoncesDelta             int
 	ProxyFinalityCheck              bool

executors/kleverBlockchain/module/testdata/grace.pem

@@ -0,0 +1,5 @@
+-----BEGIN PRIVATE KEY for klv17la0vdplk320zvy9s7qps5j69ff2yl3dn0drmhyuw57dnhe23g5schkvag-----
+MWE0YTIwNGYxMDYzZTUxN2VjMWI0YjU2NjUyYzY2YThkYzNmM2UwNTUxNDIyODEw
+ZDYyMWQxZmI1NTNmNmFjNWY3ZmFmNjM0M2ZiNDU0ZjEzMDg1ODc4MDE4NTI1YTJh
+NTJhMjdlMmQ5YmRhM2RkYzljNzUzY2Q5ZGYyYThhMjk=
+-----END PRIVATE KEY for klv17la0vdplk320zvy9s7qps5j69ff2yl3dn0drmhyuw57dnhe23g5schkvag-----

executors/kleverBlockchain/scCallsExecutor.go

@@ -39,8 +39,8 @@ type ArgsScCallExecutor struct {
 	Filter                          ScCallsExecuteFilter
 	Log                             logger.Logger
 	ExtraGasToExecute               uint64
-	MaxGasLimitToUse                uint64
-	GasLimitForOutOfGasTransactions uint64
+	MaxGasLimitToUse                int64
+	GasLimitForOutOfGasTransactions int64
 	NonceTxHandler                  NonceTransactionsHandler
 	PrivateKey                      crypto.PrivateKey
 	SingleSigner                    crypto.SingleSigner
@@ -55,8 +55,8 @@ type scCallExecutor struct {
 	filter                          ScCallsExecuteFilter
 	log                             logger.Logger
 	extraGasToExecute               uint64
-	maxGasLimitToUse                uint64
-	gasLimitForOutOfGasTransactions uint64
+	maxGasLimitToUse                int64
+	gasLimitForOutOfGasTransactions int64
 	nonceTxHandler                  NonceTransactionsHandler
 	privateKey                      crypto.PrivateKey
 	singleSigner                    crypto.SingleSigner
@@ -281,30 +281,29 @@ func (executor *scCallExecutor) executeOperation(
 		return err
 	}
 
-	tx := transaction.NewBaseTransaction(executor.senderAddress.Bytes(), 0, nil, 0, 0)
+	tx := transaction.NewBaseTransaction(executor.senderAddress.Bytes(), 0, [][]byte{dataBytes}, 0, 0)
 	err = tx.SetChainID([]byte(networkConfig.ChainID))
 	if err != nil {
 		return err
 	}
 
-	contractRequest := transaction.SmartContract{
+	contractRequest := &transaction.SmartContract{
+		Type:    transaction.SmartContract_SCInvoke,
 		Address: receiverAddr.Bytes(),
 	}
 
-	txArgs := transaction.TXArgs{
-		Type:     uint32(transaction.SmartContract_SCInvoke),
-		Sender:   executor.senderAddress.Bytes(),
-		Contract: json.RawMessage(contractRequest.String()),
-		Data:     [][]byte{dataBytes},
+	err = tx.PushContract(transaction.TXContract_SmartContractType, contractRequest)
+	if err != nil {
+		return err
 	}
 
-	err = tx.AddTransaction(txArgs)
+	err = executor.nonceTxHandler.ApplyNonceAndGasPrice(ctx, executor.senderAddress, tx)
 	if err != nil {
 		return err
 	}
 
 	to := callData.To.Bech32()
-	if tx.GasLimit > contractMaxGasLimit {
+	if tx.GetBandwidthFee() > contractMaxGasLimit {
 		// the contract will refund this transaction, so we will use less gas to preserve funds
 		executor.log.Warn("setting a lower gas limit for this transaction because it will be refunded",
 			"computed gas limit", tx.GasLimit,
@@ -316,10 +315,10 @@ func (executor *scCallExecutor) executeOperation(
 			"amount", callData.Amount,
 			"nonce", callData.Nonce,
 		)
-		tx.GasLimit = executor.gasLimitForOutOfGasTransactions
+		tx.RawData.BandwidthFee = executor.gasLimitForOutOfGasTransactions
 	}
 
-	if tx.GasLimit > executor.maxGasLimitToUse {
+	if tx.GetBandwidthFee() > executor.maxGasLimitToUse {
 		executor.log.Warn("can not execute transaction because the provided gas limit on the SC call exceeds "+
 			"the maximum gas limit allowance for this executor, WILL SKIP the execution",
 			"computed gas limit", tx.GasLimit,
@@ -335,11 +334,6 @@ func (executor *scCallExecutor) executeOperation(
 		return nil
 	}
 
-	err = executor.nonceTxHandler.ApplyNonceAndGasPrice(ctx, executor.senderAddress, tx)
-	if err != nil {
-		return err
-	}
-
 	err = executor.signTransactionWithPrivateKey(tx)
 	if err != nil {
 		return err
@@ -425,7 +419,7 @@ func (executor *scCallExecutor) checkResults(ctx context.Context, hash string) (
 		return nil, true
 	}
 
-	executor.logFullTransaction(ctx, hash)
+	executor.logFullTransaction(ctx, txResult)
 	return fmt.Errorf("%w for tx hash %s", errTransactionFailed, hash), true
 }
 
@@ -447,20 +441,14 @@ func (executor *scCallExecutor) handleError(ctx context.Context, err error) {
 	}()
 }
 
-func (executor *scCallExecutor) logFullTransaction(ctx context.Context, hash string) {
-	txData, err := executor.proxy.GetTransactionInfoWithResults(ctx, hash)
-	if err != nil {
-		executor.log.Error("error getting the transaction for display", "error", err)
-		return
-	}
-
+func (executor *scCallExecutor) logFullTransaction(ctx context.Context, txData *models.TransactionData) {
 	txDataString, err := json.MarshalIndent(txData, "", "  ")
 	if err != nil {
 		executor.log.Error("error preparing transaction for display", "error", err)
 		return
 	}
 
-	executor.log.Error("transaction failed", "hash", hash, "full transaction details", string(txDataString))
+	executor.log.Error("transaction failed", "hash", txData.Hash, "full transaction details", string(txDataString))
 }
 
 func (executor *scCallExecutor) waitForExtraDelay(ctx context.Context, err error) {