chore: Integrate coveralls.io

Enable test coverage for unit and integration tests in GHA.

Signed-off-by: Marcus Brandenburger <bur@zurich.ibm.com>

Author: mbrandenburger

.github/workflows/tests.yml

@@ -31,7 +31,14 @@ jobs:
           cache-dependency-path: "**/*.sum"
       - run: make install-tools
       - run: make install-fabric-bins
-      - run: make unit-tests
+      - name: unit-tests
+        env:
+          GO_TEST_PARAMS: "-race -coverprofile=coverage.profile"
+        run: make unit-tests
+      - uses: coverallsapp/github-action@v2
+        with:
+          flag-name: utest
+          parallel: true
 
   utest-postgres:
     needs:
@@ -45,18 +52,31 @@ jobs:
           cache-dependency-path: "**/*.sum"
       - run: make install-tools
       - run: make testing-docker-images
-      - run: make unit-tests-postgres
+      - name: unit-tests-postgres
+        env:
+          GO_TEST_PARAMS: "-race -coverprofile=coverage.profile"
+        run: make unit-tests-postgres
+      - uses: coverallsapp/github-action@v2
+        with:
+          flag-name: utest-postgres
+          parallel: true
 
   itest-list:
     runs-on: ubuntu-latest
     outputs:
       tests: ${{ steps.set-itest-tests.outputs.tests }}
+      all-tests: ${{ steps.set-all-tests.outputs.all-tests }}
     steps:
       - uses: actions/checkout@v5
       - name: list itest targets
         id: set-itest-tests
         run: |
           echo "tests=$(make list-integration-tests | jq -R . | jq -s -c .)" >> $GITHUB_OUTPUT
+      - name: build carryforward string
+        id: set-all-tests
+        run: |
+          itests=$(make list-integration-tests | sed 's/^/itest-/' | paste -sd "," -)
+          echo "all-tests=utest,utest-postgres,$itests" >> $GITHUB_OUTPUT
 
   itest:
     needs:
@@ -97,4 +117,26 @@ jobs:
           make install-softhsm
           ./ci/scripts/setup_softhsm.sh
 
-      - run: make integration-tests-${{ matrix.tests }}
+      - name: Run the integration test
+      - run: |
+          mkdir -p covdata
+          GOCOVERDIR=covdata \
+            make integration-tests-${{ matrix.tests }}
+          go tool covdata textfmt -i=covdata -o coverage.profile
+
+      - uses: coverallsapp/github-action@v2
+        with:
+          flag-name: itest-${{ matrix.tests }}
+          parallel: true
+
+  finish:
+    needs:
+      - utest
+      - utest-postgres
+      - itest
+    runs-on: ubuntu-latest
+    steps:
+      - uses: coverallsapp/github-action@v2
+        with:
+          parallel-finished: true
+          carryforward: ${{ needs.itest-list.outputs.all-tests }}

docs/development.md

@@ -87,10 +87,17 @@ make lint
 
 ### Unit Tests
 
-Run all unit tests (with and without race detection):
+Run all unit tests:
 ```bash
 make unit-tests
-make unit-tests-race
+make unit-tests-postgres
+make unit-tests-sdk
+```
+
+For coverage analysis:
+```bash
+GO_TEST_PARAMS="-coverprofile=cov.out" make unit-tests
+go tool cover -func=cov.out
 ```
 
 ### Integration Tests
@@ -117,6 +124,13 @@ export FSCNODE_PROFILER=true
 make integration-tests-fabric-iou
 ```
 
+Enable coverage profiling:
+```bash
+mkdir -p covdata
+GOCOVERDIR=covdata make integration-tests
+go tool covdata textfmt -i=covdata -o profile.txt
+```
+
 ## Write your own integration test
 
 Creating a new integration test is straightforward.

integration/integration.go

@@ -85,7 +85,16 @@ func New(startPort int, path string, topologies ...api.Topology) (*Infrastructur
 		}
 	}
 
-	buildServer := common.NewBuildServer("-tags", "pkcs11")
+	// build parameter
+	var params []string
+	params = append(params, "-tags", "pkcs11")
+
+	// build with coverage profiling, more details: https://go.dev/doc/build-cover
+	if _, ok := os.LookupEnv("GOCOVERDIR"); ok {
+		params = append(params, "-cover")
+	}
+
+	buildServer := common.NewBuildServer(params...)
 	buildServer.Serve()
 	builder := buildServer.Client()