add codecoverage

.

.

.

.

.

.

Author: vladimir-popov

.github/workflows/ci.yml

@@ -11,9 +11,35 @@ on:
 
 jobs:
   test:
+    name: Build, Test and Check coverage
     runs-on: ubuntu-latest
-    name: Build and Test
     steps:
-      - uses: actions/checkout@v3
-      - uses: mlugg/setup-zig@v1
-      - run: zig build test --summary all
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+
+      - name: Install zig
+        uses: mlugg/setup-zig@v2
+
+      - name: Zig build test
+        run: |
+          zig build test --summary all
+          ls zig-out/bin
+
+      - name: get kcov version
+        uses: sudo-bot/action-kcov@latest
+        with:
+            cli-args: "--version"
+
+      - name: Run test with kcov coverage
+        uses: sudo-bot/action-kcov@latest
+        with:
+          cli-args: "--dump-summary ./coverage ./zig-out/bin/test"
+
+      - name: Upload results to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          directory: ./coverage/
+          fail_ci_if_error: true

.gitignore

@@ -1,2 +1,4 @@
 .zig-cache/
 zig-out/
+kcov-output/
+coverage/

build.zig

@@ -37,15 +37,32 @@ pub fn build(b: *std.Build) void {
     ) orelse &[0][]const u8{};
 
     const parcom_tests = b.addTest(.{
-        .root_source_file = b.path("src/parcom.zig"),
-        .target = target,
-        .optimize = optimize,
+        .root_module = parcom,
         .filters = test_filters,
     });
 
+    // -Dtest-coverage
+    const coverage = b.option(
+        bool,
+        "test-coverage",
+        "Generate test coverage",
+    ) orelse false;
+
+    if (coverage) {
+        parcom_tests.setExecCmd(&[_]?[]const u8{
+            "kcov",
+            "--include-path=src/parcom.zig",
+            "--dump-summary",
+            "./coverage",
+            null, // to get zig to use the --test-cmd-bin flag
+        });
+    }
+
     const run_parcom_tests = b.addRunArtifact(parcom_tests);
+    const install_tests_bin = b.addInstallArtifact(parcom_tests, .{});
 
     const test_step = b.step("test", "Run unit tests");
+    test_step.dependOn(&install_tests_bin.step);
     test_step.dependOn(&run_parcom_tests.step);
 
     // ----- Examples -----