Restore coverage CI workflow job but using grcov (#1259)

Adds 'coverage' makefile rule to generate coverage reports using grcov.
Adds coverage and editor temp file patterns to .gitingore.

---------
Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>

Author: dcookspi

.github/workflows/coverage.yml

@@ -0,0 +1,84 @@
+on:
+  pull_request:
+    paths:
+      # Only run coverage report if the sources have changed
+      - "src/**.rs"
+      - "crates/**.rs"
+  push:
+    branches:
+      - main
+    paths:
+      # Only run coverage report if the sources have changed
+      - "src/**.rs"
+      - "crates/**.rs"
+
+name: Code Coverage
+jobs:
+  codecov:
+    runs-on: ubuntu-latest
+    container:
+      image: rust:slim-bookworm
+      options: --security-opt seccomp=unconfined --privileged
+    env:
+      SPFS_SUPPRESS_OVERLAYFS_PARAMS_WARNING: "1"
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.11.0
+      - name: Setup spfs repos
+        run: |
+          mkdir /spfs
+          mkdir -p /tmp/spfs-repos/local
+          mkdir -p /tmp/spfs-repos/origin
+          cat >/etc/spfs.conf << EOF
+          [storage]
+          root = /tmp/spfs-repos/local
+
+          [remote.origin]
+          address = file:///tmp/spfs-repos/origin?create=true
+          EOF
+      - name: Install prerequisites
+        run: |
+          apt-get update
+          apt-get install --yes build-essential libcap2-bin sudo cmake tcsh rsync protobuf-compiler fuse libfuse-dev curl unzip pkg-config libssl-dev git
+          # spfs-fuse requires this option enabled
+          echo user_allow_other >> /etc/fuse.conf
+          FB_REL=https://github.com/google/flatbuffers/releases/
+          curl --proto '=https' --tlsv1.2 -sSfL ${FB_REL}/download/v23.5.26/Linux.flatc.binary.g++-10.zip | funzip > /usr/bin/flatc
+          chmod +x /usr/bin/flatc
+      - uses: actions/checkout@v3
+      - name: Install ast-grep
+        run: cargo install --locked --force ast-grep
+      - name: Install llvm-tools and grcov
+        run: |
+          # set up the profiling requirements
+          rustup component add llvm-tools
+          cargo install grcov
+      - name: Configure cargo
+        run: |
+          mkdir -p .cargo
+          cat << EOF > .cargo/config.toml
+          [build]
+          # Disable incremental compilation to lower disk usage, and sccache
+          # can't cache incremental compiles.
+          incremental = false
+
+          [profile.dev]
+          # Disable debug information to lower disk usage.
+          debug = false
+          EOF
+      - name: Install spfs
+        run: |
+          make install-debug-spfs FEATURES=server,spfs/server
+          cargo clean
+      - name: Generate code coverage
+        run: |
+          # Originally used tarpaulin but it used too much space to generate
+          make coverage FEATURES=server,spfs/server,spfs/protobuf-src,spk/migration-to-components,sentry,statsd,fuse-backend,spfs-vfs/protobuf-src
+      - name: Upload to codecov.io
+        uses: codecov/codecov-action@v3
+      - name: Code coverage summary report in logs
+        uses: irongut/CodeCoverageSummary@v1.3.0
+        with:
+          output: both
+          format: markdown
+          filename: target/debug/coverage/cobertura.xml

.gitignore

@@ -3,6 +3,7 @@ coverage.xml
 .benchmarks
 .coverage
 .coverage.*
+profraw
 
 # spdev
 /build/
@@ -16,6 +17,7 @@ dist/
 # editors
 .idea/
 .vscode/
+*~
 .nfs*
 .secrets
 # GENERATED FOR spdev:Shell

Makefile

@@ -126,3 +126,20 @@ rpm-buildenv:
 		--cache-from build_env \
 		-f rpmbuild.Dockerfile \
 		--tag build_env
+
+.PHONY: coverage
+coverage: FEATURES?=server,spfs/server,spfs/protobuf-src,spk/migration-to-components,sentry,statsd,fuse-backend,spfs-vfs/protobuf-src
+coverage:
+	# Generate a coverage reports (html, lcov) using grcov, requires:
+	# - cargo install grcov
+	# - rustup component add llvm-tools
+	# The html report can be viewed from: target/debug/coverage/index.html
+	echo "coverage started, about to make dir 1"
+	mkdir -p profraw
+	echo "coverage made dir 1, about to make dir 2"
+	mkdir -p target/debug/coverage
+	echo "coverage made dir 2, about to run cargo test"
+	RUSTFLAGS='-C instrument-coverage' LLVM_PROFILE_FILE='profraw/spk-%p-%m.profraw' spfs run - -- cargo test --workspace --features ${FEATURES} 2>&1
+	echo "coverage cargo test run, about to run grcov"
+	grcov . -s . --binary-path ./target/debug/ --branch --ignore-not-existing --keep-only 'crates/*' -t lcov,cobertura -o ./target/debug/coverage/
+	echo "coverage finished"

crates/spk-cli/common/src/flags.rs

@@ -96,12 +96,13 @@ impl Runtime {
         self.edit
     }
 
-    /// Unless `--no-runtime` is present, relaunch the current process inside
-    /// a new spfs runtime.
+    /// Unless `--no-runtime` is present, relaunch the current process
+    /// inside a new spfs runtime.
     ///
-    /// The caller is expected to pass in a list of subcommand aliases that can
-    /// be used to find an appropriate place on the command line to insert a
-    /// `--no-runtime` argument, to avoid recursively creating a runtime.
+    /// The caller is expected to pass in a list of subcommand aliases
+    /// that can be used to find an appropriate place on the command
+    /// line to insert a `--no-runtime` argument, to avoid recursively
+    /// creating a runtime.
     pub async fn ensure_active_runtime(
         &self,
         sub_command_aliases: &[&str],

cspell.json

@@ -91,6 +91,7 @@
     "cmpt",
     "cmpts",
     "cnproc",
+    "cobertura",
     "codegen",
     "colour",
     "compat",
@@ -139,6 +140,7 @@
     "derserializer",
     "deserializing",
     "DESTDIR",
+    "devcontainer",
     "devel",
     "DEVNULL",
     "devs",
@@ -283,6 +285,7 @@
     "gnupress",
     "goldmark",
     "gperf",
+    "grcov",
     "Grav",
     "Gritz",
     "GVTA",
@@ -530,6 +533,7 @@
     "perror",
     "persistable",
     "pids",
+    "Pipenv",
     "Pinnable",
     "pixbuf",
     "PJDUUENJYFFDKZWRKHDUXK4FGGZ7FHDYMZ7P4CXORUG6TUMDJ7A",
@@ -554,6 +558,7 @@
     "printenv",
     "privs",
     "PROCESSENTRY",
+    "profraw",
     "projecs",
     "proptest",
     "prost",