Merge pull request #667 from viccuad/add-coverage

ci: Add codecov support

Author: flavio

.github/workflows/ci.yml

@@ -84,3 +84,39 @@ jobs:
         with:
           command: clippy
           args: -- -D warnings
+
+  coverage:
+    name: coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
+      - uses: actions-rs/toolchain@16499b5e05bf2e26879000db0c1d13f7e13fa3af # v1.0.7
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - uses: taiki-e/install-action@5794068c211bc8f5f4514b7c3f03d6adbe66f1b7 # v2.26.18
+        with:
+          tool: cargo-tarpaulin
+      - name: Generate unit-tests coverage
+        run: make coverage-unit-tests
+      - name: Upload unit-tests coverage to Codecov
+        uses: codecov/codecov-action@e0b68c6749509c5f83f984dd99a76a1c1a231044 # v4.0.1
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_ORG_TOKEN }}
+        with:
+          name: unit-tests
+          directory: coverage/unit-tests
+          flags: unit-tests
+          verbose: true
+      - name: Generate integration-tests coverage
+        run: make coverage-integration-tests
+      - name: Upload unit-tests coverage to Codecov
+        uses: codecov/codecov-action@e0b68c6749509c5f83f984dd99a76a1c1a231044 # v4.0.1
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_ORG_TOKEN }}
+        with:
+          name: integration-tests
+          directory: coverage/integration-tests
+          flags: integration-tests
+          verbose: true

.gitignore

@@ -2,3 +2,6 @@
 bom-cargo.json
 /bin
 /registry
+
+# coverage instrumentation:
+*.profraw

Makefile

@@ -31,6 +31,23 @@ unit-tests: fmt lint
 integration-tests: fmt lint
 	cargo test --test '*'
 
+.PHONY: coverage
+coverage: coverage-unit-tests coverage-integration-tests
+	
+.PHONY: coverage-unit-tests
+coverage-unit-tests:
+	# integration-tests with llvm need +nightly. Hence, enable +nightly on
+	# unit-tests, and use --skip-clean to not recompile on CI if not needed
+	cargo tarpaulin --verbose --skip-clean --engine=llvm \
+		--all-features --lib --bin --follow-exec \
+		--out xml --out html --output-dir coverage/unit-tests
+	
+.PHONY: coverage-integration-tests
+coverage-integration-tests:
+	cargo tarpaulin --verbose --skip-clean --engine=llvm \
+		--all-features --test integration_test --follow-exec \
+		--out xml --out html --output-dir coverage/integration-tests
+
 .PHONY: clean
 clean:
 	cargo clean

coverage/integration-tests/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

coverage/unit-tests/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore