mirror of
https://github.com/ankitects/anki.git
synced 2026-09-10 12:18:22 -04:00
a7f3ffb63a
## Linked issue Closes #4995 ## Summary / motivation Bedges available: [](https://sonarcloud.io/summary/new_code?id=ankitects_anki) [](https://sonarcloud.io/summary/new_code?id=ankitects_anki) [](https://sonarcloud.io/summary/new_code?id=ankitects_anki) [](https://sonarcloud.io/summary/new_code?id=ankitects_anki) [](https://sonarcloud.io/summary/new_code?id=ankitects_anki) [](https://sonarcloud.io/summary/new_code?id=ankitects_anki) [](https://sonarcloud.io/summary/new_code?id=ankitects_anki) **[SONAR DASHBOARD](https://sonarcloud.io/project/overview?id=ankitects_anki)** Integrates SonarCloud into the CI pipeline as a proof of concept to evaluate whether it surfaces actionable quality and security insights for this codebase. Changes: - Added `sonar-project.properties` configuring sources (`pylib`, `qt`, `ts`, `rslib`) and coverage report paths - Extended `tools/coverage/coverage-py` (and `.bat`) to emit `coverage.xml` (Cobertura) - Extended `tools/coverage/coverage-ts` (and `.bat`) to emit `lcov.info` via the V8 provider - Extended `tools/coverage/coverage-rust` (and `.bat`) to emit `lcov.info` via `cargo-llvm-cov report` - Added a `SonarCloud Scan` step to the `check-linux` CI job, running after all checks pass and before the build cache is saved ## How to test ### Details **1. Install sonar-scanner** ```bash brew install sonar-scanner ``` **2. Generate and configure a token** Go to [sonarcloud.io](https://sonarcloud.io/) → My Account → Security → Generate Token Copy the generated token and export it in your shell: ``` export SONAR_TOKEN=your_token_here ``` **3. Generate coverage reports** ``` just test --coverage ``` Expected output files: - out/coverage/python-pylib/coverage.xml - out/coverage/python-qt/coverage.xml - out/coverage/typescript/lcov.info - out/coverage/rust/lcov.info **4. Run the scanner manually** ``` sonar-scanner ``` Results will appear in the SonarCloud dashboard To test coverage generation locally: ```bash just coverage # verify files exist: # out/coverage/python-pylib/coverage.xml # out/coverage/python-qt/coverage.xml # out/coverage/typescript/lcov.info # out/coverage/rust/lcov.info ```
40 lines
1.1 KiB
Bash
Executable File
40 lines
1.1 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
set -e
|
|
|
|
html="$1"
|
|
|
|
outdir="out/coverage/rust"
|
|
LLVMCOVPATH="out/bin"
|
|
|
|
mkdir -p $outdir $LLVMCOVPATH
|
|
|
|
export CARGO_TARGET_DIR="${CARGO_TARGET_DIR:-out/rust}"
|
|
|
|
if [[ "${CI:-}" == "true" ]]; then
|
|
# prebuilt binary shouldve been installed
|
|
cargo_cmd="cargo"
|
|
profile=ci
|
|
else
|
|
cargo_cmd="$LLVMCOVPATH/cargo-llvm-cov"
|
|
test -x "$cargo_cmd" || cargo install cargo-llvm-cov --version 0.8.4 --locked --root out
|
|
test -x "$LLVMCOVPATH/cargo-nextest" || cargo install cargo-nextest \
|
|
--version 0.9.99 --locked --no-default-features --features default-no-update --root out
|
|
profile=dev
|
|
fi
|
|
|
|
export PATH="$LLVMCOVPATH:$PATH"
|
|
|
|
ANKI_TEST_MODE=1 "$cargo_cmd" llvm-cov nextest --workspace --locked \
|
|
--cargo-profile "$profile" \
|
|
--json --summary-only \
|
|
--output-path $outdir/coverage-summary.json --fail-under-lines 64
|
|
ANKI_TEST_MODE=1 "$cargo_cmd" llvm-cov report --profile "$profile" --lcov \
|
|
--output-path $outdir/lcov.info
|
|
|
|
if [ "$html" = "--html" ]; then
|
|
ANKI_TEST_MODE=1 "$cargo_cmd" llvm-cov report --profile "$profile" \
|
|
--html --output-dir $outdir
|
|
echo "Rust coverage report: $outdir/html/index.html"
|
|
fi
|