Add coverage reports using coveralls (#71)

#### Type of change

- Test update

#### Description

- Add test coverage reports using coveralls

#### Related issues

- resolves #70

Signed-off-by: Liran Funaro <liran.funaro@gmail.com>

Author: liran-funaro

.github/workflows/ci.yml

@@ -48,4 +48,8 @@ jobs:
         with:
           go-version-file: go.mod
       - run: scripts/install-dev-dependencies.sh
-      - run: make test
+      - run: make test-cover
+      - name: Send coverage
+        uses: shogo82148/actions-goveralls@v1
+        with:
+          path-to-profile: coverage.profile

.gitignore

@@ -25,3 +25,4 @@ TESTS*.xml
 .tox/
 .vagrant/
 .vscode
+*coverage.profile

Makefile

@@ -58,6 +58,14 @@ GO_TEST_FMT_FLAGS := -hide empty-packages
 test: FORCE
 	@$(go_test) ./... | gotestfmt ${GO_TEST_FMT_FLAGS}
 
+# Runs test with coverage analysis.
+test-cover: FORCE
+	@$(go_test) -coverprofile=coverage.profile -coverpkg=./... ./... | gotestfmt ${GO_TEST_FMT_FLAGS}
+	@scripts/test-coverage-filter-files.sh
+
+cover-report: FORCE
+	$(go_cmd) tool cover -html=coverage.profile
+
 .PHONY: $(TOOLS_EXES)
 ## Builds a native binary
 $(TOOLS_EXES): %: $(BUILD_DIR)/%

README.md

@@ -5,6 +5,8 @@ SPDX-License-Identifier: Apache-2.0
 -->
 # Fabric-X Common
 
+[![Coverage Status](https://coveralls.io/repos/github/hyperledger/fabric-x-common/badge.svg?branch=main)](https://coveralls.io/github/hyperledger/fabric-x-common?branch=main)
+
 This library encapsulates some common code across Fabric-X ecosystem.
 This code have been taken from [Hyperledger Fabric](https://github.com/hyperledger/fabric) v3.0.0-rc1.
 

common/deliverclient/orderers/connection.go

@@ -57,6 +57,10 @@ type OrdererOrg struct {
 	RootCerts [][]byte
 }
 
+func (o *OrdererOrg) String() string {
+	return fmt.Sprintf("Addresses: %v", o.Addresses)
+}
+
 func NewConnectionSource(logger *flogging.FabricLogger, overrides map[string]*Endpoint, selfEndpoint string) *ConnectionSource {
 	return &ConnectionSource{
 		orgToEndpointsHash: map[string][]byte{},

common/errors/errors.go

@@ -0,0 +1,24 @@
+#!/bin/bash
+#
+# Copyright IBM Corp. All Rights Reserved.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+# We filter some of the files for test coverage reporting.
+sed -i -E -f - coverage.profile <<EOF
+# The main file cannot be covered by tests as it may call os.Exit(1).
+/main\.go/d
+# Generated files (e.g., mocks, protobuf) may contain unused methods.
+/\.pb(\.gw)?\.go/d
+/\/mocks?\//d
+/\/fakes?\//d
+# Test files that are included in non-test files.
+/test_exports?\.go/d
+/\/test\//d
+/configtest\//d
+/testtools\//d
+/testprotos\//d
+/testutil\//d
+/configtest\//d
+EOF