Merge pull request #314 from korpling/local-merge-request-checks

Add script for local merge request checks

Author: thomaskrause

.github/workflows/static_code_analysis.yml

@@ -1,4 +1,4 @@
-name: Code Coverage
+name: Verify
 
 on:
   push:
@@ -7,13 +7,17 @@ on:
   pull_request:
 
 jobs:
-  coverage:
-    name: Execute tests with code coverage
+  merge-request-checks:
+    name: Run
     runs-on: ubuntu-latest
-    env:
-      CARGO_TERM_COLOR: always
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install diff-cover
+        uses: threeal/pipx-install-action@v1.0.0
+        with:
+          packages: diff_cover
       - uses: actions-rust-lang/setup-rust-toolchain@v1.4.4
         with:
           toolchain: stable
@@ -42,21 +46,24 @@ jobs:
         run: ./target/release/annis data --cmd 'import relannis/subtok.demo'
       - name: Install cargo-llvm-cov
         uses: taiki-e/install-action@cargo-llvm-cov
-      - name: Remove old code coverage artifacts
-        run: cargo llvm-cov clean --workspace
-      - name: Run tests code coverage (standard tests)
-        run: cargo llvm-cov --no-report --release
-        env:
-          RUSTFLAGS: "-C link-dead-code"
-      - name: Run tests code coverage (ignored tests)
-        run: cargo llvm-cov --no-report --release --tests -- --ignored
+      - name: Run verify.sh
+        run: ./verify.sh
+      - name: Generate code coverage comment
+        id: pr
+        run: |
+          {
+            echo 'COVERAGE_INFO<<EOF'
+            diff-cover target/llvm-cov/tests.lcov
+            echo EOF
+          } >> "$GITHUB_ENV"
         env:
-          RUSTFLAGS: "-C link-dead-code"
-      - name: Merge code coverage reports
-        run: cargo llvm-cov report --ignore-filename-regex '(tests?\.rs)|(capi/.*)' --release --codecov --output-path codecov.json
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMMENT_OUTPUT: TRUE
+      - uses: mshick/add-pr-comment@v2
         with:
-          token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
-          files: codecov.json
-          fail_ci_if_error: true
+          message: |
+            Commit ${{ github.event.pull_request.head.sha }}
+            ```
+            ${{env.COVERAGE_INFO}}
+            ```
+      

.github/workflows/code_coverage.yml .github/workflows/verify.yml.github/workflows/code_coverage.yml renamed to .github/workflows/verify.yml

@@ -24,19 +24,29 @@ Notable differences/enhancements compared to the thesis are:
 You need to install Rust to compile the project.
 We recommend installing the following Cargo subcommands for developing annis-web:
 
+- [cargo-llvm-cov](https://crates.io/crates/cargo-llvm-cov) for determining the code coverage
 - [cargo-release](https://crates.io/crates/cargo-release) for creating releases
 - [cargo-about](https://crates.io/crates/cargo-about) for re-generating the
   third party license file
-- [cargo-llvm-cov](https://crates.io/crates/cargo-llvm-cov) for determining the code coverage
 - [cargo-dist](https://crates.io/crates/cargo-dist) for configuring the GitHub actions that create the release binaries.
 
+Also install the [`diff-cover`](https://github.com/Bachmann1234/diff_cover) command line tool to run merge the merge request checks locally.
+
 ### Execute tests
 
 You can run the tests with the default `cargo test` command.
-To calculate the code coverage, you can use `cargo-llvm-cov`:
+
+To run all checks that have to pass for a merge requests locally, first make sure you have the `diff-cover` and `cargo-llvm-cov` tools installed.
+
+```bash
+cargo install cargo-llvm-cov
+pipx install diff_cover
+```
+
+Then, run the following command to run all checks including code coverage:
 
 ```bash
-cargo llvm-cov --open --all-features --ignore-filename-regex '(tests?\.rs)|(capi/.*)'
+./verify.sh
 ```
 
 

README.md

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# Stop the script if any command exits with a non-zero return code
+set -e
+
+# Run static code checks
+cargo fmt --check
+cargo clippy
+
+# Execute tests and calculate the code coverage both as lcov and HTML report
+cargo llvm-cov clean --workspace
+cargo llvm-cov --no-report --release
+cargo llvm-cov --no-report --release --tests -- --ignored
+mkdir -p target/llvm-cov/
+cargo llvm-cov report --ignore-filename-regex '(tests?\.rs)|(capi/.*)' --release --lcov --output-path target/llvm-cov/tests.lcov
+
+# Use diff-cover (https://github.com/Bachmann1234/diff_cover) and output code coverage compared to main branch
+mkdir -p target/llvm-cov/html/
+OUTPUT="$(diff-cover target/llvm-cov/tests.lcov --html-report target/llvm-cov/html/patch.html)"
+echo "$OUTPUT"
+if [ -z "${CI}" ]; then
+    echo "HTML report available at $PWD/target/llvm-cov/html/patch.html"
+fi
+
+# Extract the code coverage percentage and exit with error code if threshold is not reached
+PERC_REGEX='.*Coverage: ([0-9]+)(\.[0-9]*)?\%.*'
+if [[ $OUTPUT =~ $PERC_REGEX ]]; then
+    PERCENTAGE="$((${BASH_REMATCH[1]}))"
+    if [[ $PERCENTAGE -lt 80 ]]
+        then
+            >&2 echo "Code coverage threshold not reached"
+            exit 3
+        fi
+fi
+exit 0