chore: add test coverage to CI GHA (+badge)

.github/workflows/ci.yaml

@@ -15,9 +15,11 @@ jobs:
           toolchain: stable
           components: rustfmt, clippy
       - uses: Swatinem/rust-cache@v2
-      - name: clippy
+      - id: clippy
+        name: clippy
         run: cargo clippy --all --all-targets
-      - name: format
+      - id: format
+        name: format
         run: cargo fmt --all -- --check
   test: # ----------------------------------------------------------------------
     strategy:
@@ -34,7 +36,15 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
-          components: rustfmt, clippy
       - uses: Swatinem/rust-cache@v2
-      - name: test
-        run: cargo test --all
+      - id: build
+        name: build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build # required for end-to-end tests in main.rs
+      - id: test
+        name: test
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --no-fail-fast

.github/workflows/coverage.yaml

@@ -0,0 +1,50 @@
+on:
+  push:
+    branches:
+      - main
+jobs:
+  coverage: # ------------------------------------------------------------------
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+      - id: install-llvm-tools-preview-and-grcov
+        name: install llvm-tools-preview and grcov
+        run: |
+          rustup component add llvm-tools-preview
+          cargo install grcov
+      - uses: Swatinem/rust-cache@v2
+      - id: build
+        name: build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build # required for end-to-end tests in main.rs
+        env:
+          CARGO_INCREMENTAL: '0'
+          RUSTFLAGS: -Cinstrument-coverage
+          RUSTDOCFLAGS: -Cinstrument-coverage
+          LLVM_PROFILE_FILE: cargo-test-%p-%m.profraw
+      - id: test
+        name: test
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --no-fail-fast
+        env:
+          CARGO_INCREMENTAL: '0'
+          RUSTFLAGS: -Cinstrument-coverage
+          RUSTDOCFLAGS: -Cinstrument-coverage
+          LLVM_PROFILE_FILE: cargo-test-%p-%m.profraw
+      - id: coverage
+        name: coverage
+        run: |
+          mkdir -p target/coverage/
+          grcov . --binary-path ./target/debug/deps/ -s . -t lcov --branch --ignore-not-existing --ignore '../*' --ignore "/*" -o target/coverage/tests.lcov
+      - id: coverage-report
+        name: coverage-report
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: target/coverage/tests.lcov

README.md

@@ -1,10 +1,13 @@
 <!-- markdownlint-disable MD013 MD033 MD041 -->
 <div>
   <a href="https://github.com/marccarre/ssh-to-ansible/actions">
-    <img src="https://github.com/marccarre/ssh-to-ansible/actions/workflows/ci.yaml/badge.svg" alt="build status">
+    <img src="https://github.com/marccarre/ssh-to-ansible/actions/workflows/ci.yaml/badge.svg" alt="build status" />
   </a>
   <a href="https://github.com/marccarre/ssh-to-ansible/releases">
-    <img src="https://img.shields.io/github/downloads/marccarre/ssh-to-ansible/total.svg" alt="downloads">
+    <img src="https://img.shields.io/github/downloads/marccarre/ssh-to-ansible/total.svg" alt="downloads" />
+  </a>
+  <a href='https://coveralls.io/github/marccarre/ssh-to-ansible?branch=main'>
+    <img src='https://coveralls.io/repos/github/marccarre/ssh-to-ansible/badge.svg?branch=main' alt='Coverage Status' />
   </a>
 </div>
 <!-- markdownlint-enable MD013 MD033 MD041 -->