mirror of
https://github.com/AppFlowy-IO/AppFlowy.git
synced 2024-08-16 14:40:43 +03:00
Code coverage for Rust (#1263)
* feat: Bumped Rust to stable-2022-04-07 (1.60.0) * feat: Added coverage tests and report generation * feat: Added workflow for Rust Coverage * feat: Bumped Rust to 1.60.0 in Workflows * test: Testing for CI * ci: Added name and fixed path for Rust Coverage * revert: "test: Testing for CI" This reverts commit049a7b1088
. * fix: Added .pub-cache to PATH, change incremental builds to zero * test: Testing for CI * ci: Installing protobuf compiler in CI * revert: "test: Testing for CI" This reverts commit049a7b1088
. * ci: Added environment setup for dart * test: Testing for CI * feat: Added task to check if 'grcov' is installed * ci: Added steps to install grcov * test: Testing for CI * ci: Fixed name for grcov installation step * feat: Added cargo binaries to PATH in tests * revert: "test: Testing for CI" This reverts commit24e425db66
. * revert: "test: Testing for CI" This reverts commita5de816bce
. * ci: Fixed a very silly failing case * test: Created a test rust file for cov test
This commit is contained in:
parent
295b887cf1
commit
0bc0a72d8a
2
.github/workflows/ci.yaml
vendored
2
.github/workflows/ci.yaml
vendored
@ -29,7 +29,7 @@ jobs:
|
||||
- id: rust_toolchain
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: "stable-2022-01-20"
|
||||
toolchain: "stable-2022-04-07"
|
||||
|
||||
- id: flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
|
2
.github/workflows/dart_lint.yml
vendored
2
.github/workflows/dart_lint.yml
vendored
@ -34,7 +34,7 @@ jobs:
|
||||
channel: "stable"
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: "stable-2022-01-20"
|
||||
toolchain: "stable-2022-04-07"
|
||||
|
||||
- name: Cache Cargo
|
||||
id: cache-cargo
|
||||
|
2
.github/workflows/dart_test.yml
vendored
2
.github/workflows/dart_test.yml
vendored
@ -24,7 +24,7 @@ jobs:
|
||||
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: "stable-2022-01-20"
|
||||
toolchain: "stable-2022-04-07"
|
||||
|
||||
- uses: subosito/flutter-action@v2
|
||||
with:
|
||||
|
6
.github/workflows/release.yml
vendored
6
.github/workflows/release.yml
vendored
@ -44,7 +44,7 @@ jobs:
|
||||
- name: Setup environment - Rust and Cargo
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: 'stable-2022-01-20'
|
||||
toolchain: 'stable-2022-04-07'
|
||||
|
||||
- name: Setup environment - Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
@ -94,7 +94,7 @@ jobs:
|
||||
- name: Setup environment - Rust and Cargo
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: 'stable-2022-01-20'
|
||||
toolchain: 'stable-2022-04-07'
|
||||
|
||||
- name: Setup environment - Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
@ -143,7 +143,7 @@ jobs:
|
||||
- name: Setup environment - Rust and Cargo
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: 'stable-2022-01-20'
|
||||
toolchain: 'stable-2022-04-07'
|
||||
|
||||
- name: Setup environment - Flutter
|
||||
uses: subosito/flutter-action@v2
|
||||
|
71
.github/workflows/rust_coverage.yml
vendored
Normal file
71
.github/workflows/rust_coverage.yml
vendored
Normal file
@ -0,0 +1,71 @@
|
||||
name: Rust coverage tests
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- "main"
|
||||
paths:
|
||||
- "frontend/rust-lib/**"
|
||||
- "shared-lib/**"
|
||||
|
||||
pull_request:
|
||||
branches:
|
||||
- "main"
|
||||
paths:
|
||||
- "frontend/rust-lib/**"
|
||||
- "shared-lib/**"
|
||||
|
||||
env:
|
||||
CARGO_TERM_COLOR: always
|
||||
|
||||
|
||||
jobs:
|
||||
test-coverage:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- id: rust_toolchain
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: 'stable-2022-04-07'
|
||||
|
||||
- name: Cache Cargo
|
||||
uses: actions/cache@v2
|
||||
with:
|
||||
path: |
|
||||
~/.cargo
|
||||
key: ${{ runner.os }}-cargo-${{ steps.rust_toolchain.outputs.rustc_hash }}-${{ hashFiles('./frontend/rust-lib/Cargo.toml') }}
|
||||
|
||||
- name: Cache Rust
|
||||
uses: actions/cache@v2
|
||||
with:
|
||||
path: |
|
||||
frontend/rust-lib/target
|
||||
shared-lib/target
|
||||
key: ${{ runner.os }}-rust-rust-lib-share-lib-${{ steps.rust_toolchain.outputs.rustc_hash }}-${{ hashFiles('./frontend/rust-lib/Cargo.toml') }}
|
||||
|
||||
- name: Setup Environment
|
||||
run: |
|
||||
if [ "$RUNNER_OS" == "Linux" ]; then
|
||||
sudo wget -qO /etc/apt/trusted.gpg.d/dart_linux_signing_key.asc https://dl-ssl.google.com/linux/linux_signing_key.pub
|
||||
sudo wget -qO /etc/apt/sources.list.d/dart_stable.list https://storage.googleapis.com/download.dartlang.org/linux/debian/dart_stable.list
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y dart curl build-essential libsqlite3-dev libssl-dev clang cmake ninja-build pkg-config libgtk-3-dev
|
||||
sudo apt-get install keybinder-3.0
|
||||
elif [ "$RUNNER_OS" == "macOS" ]; then
|
||||
echo 'do nothing'
|
||||
fi
|
||||
shell: bash
|
||||
|
||||
- name: Install cargo-make, grcov and llvm-tools-preview
|
||||
working-directory: frontend
|
||||
run: |
|
||||
cargo install cargo-make
|
||||
cargo install grcov
|
||||
rustup component add llvm-tools-preview
|
||||
|
||||
- name: Run Coverage tests and generate LCOV report
|
||||
working-directory: frontend
|
||||
run: cargo make get_ci_test_coverage
|
2
.github/workflows/rust_lint.yml
vendored
2
.github/workflows/rust_lint.yml
vendored
@ -26,7 +26,7 @@ jobs:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: 'stable-2022-01-20'
|
||||
toolchain: 'stable-2022-04-07'
|
||||
override: true
|
||||
- uses: subosito/flutter-action@v1
|
||||
with:
|
||||
|
4
.github/workflows/rust_test.yml
vendored
4
.github/workflows/rust_test.yml
vendored
@ -28,7 +28,7 @@ jobs:
|
||||
- id: rust_toolchain
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: 'stable-2022-01-20'
|
||||
toolchain: 'stable-2022-04-07'
|
||||
|
||||
- name: Cache Cargo
|
||||
uses: actions/cache@v2
|
||||
@ -55,4 +55,4 @@ jobs:
|
||||
|
||||
- name: Run shared-lib tests
|
||||
working-directory: shared-lib
|
||||
run: RUST_LOG=info cargo test --no-default-features
|
||||
run: RUST_LOG=info cargo test --no-default-features
|
||||
|
0
frontend/rust-lib/covtest.rs
Normal file
0
frontend/rust-lib/covtest.rs
Normal file
@ -1,2 +1,2 @@
|
||||
[toolchain]
|
||||
channel = "stable-2022-01-20"
|
||||
channel = "stable-2022-04-07"
|
||||
|
@ -16,3 +16,203 @@ cd ../shared-lib
|
||||
RUST_LOG=info cargo test --no-default-features
|
||||
'''
|
||||
|
||||
[tasks.check_grcov]
|
||||
description = "Check if `grcov` is installled"
|
||||
script_runner = "@shell"
|
||||
script = '''
|
||||
export PATH=$PATH:"$HOME/.cargo/bin/"
|
||||
if command -v grcov > /dev/null; then
|
||||
echo "Found 'grcov' executable."
|
||||
else
|
||||
echo "[!] Could not find 'grcov' executable."
|
||||
echo "[!] Please install 'grcov' by running 'cargo install grcov'."
|
||||
echo "[!] You may also need to install 'llvm-tools-preview' using 'rustup component add llvm-tools-preview'."
|
||||
echo "[!] If installed, check if 'grcov' is in PATH."
|
||||
echo "[!] Exiting..."
|
||||
exit -1
|
||||
fi
|
||||
'''
|
||||
|
||||
[tasks.clean_profraw_files]
|
||||
description = "Cleans profraw files that are created by `cargo test`"
|
||||
script_runner = "@duckscript"
|
||||
script = [
|
||||
"""
|
||||
rust_lib_profs = glob_array ./rust-lib/**/*.profraw
|
||||
for prof in ${rust_lib_profs}
|
||||
full_path = canonicalize ${prof}
|
||||
rm ${full_path}
|
||||
end
|
||||
|
||||
shared_lib_profs = glob_array ../shared-lib/**/*.profraw
|
||||
for prof in ${shared_lib_profs}
|
||||
full_path = canonicalize ${prof}
|
||||
rm ${full_path}
|
||||
end
|
||||
|
||||
"""
|
||||
]
|
||||
|
||||
[tasks.run_rustlib_coverage_tests]
|
||||
description = "Run tests with coverage instrumentation"
|
||||
script_runner = "@shell"
|
||||
script = [
|
||||
"""
|
||||
echo --- Running coverage tests ---
|
||||
|
||||
# Install Protobuf compiler
|
||||
cargo make install_protobuf_compiler
|
||||
export PATH="$PATH":"$HOME/.pub-cache/bin"
|
||||
export PATH="$PATH":"$HOME/.cargo/bin/"
|
||||
|
||||
cd rust-lib/
|
||||
|
||||
CARGO_INCREMENTAL=0 \
|
||||
RUSTFLAGS='-C instrument-coverage' \
|
||||
LLVM_PROFILE_FILE='prof-%p-%m.profraw' \
|
||||
cargo test --no-default-features --features="sync"
|
||||
|
||||
"""
|
||||
]
|
||||
|
||||
[tasks.run_sharedlib_coverage_tests]
|
||||
description = "Run tests with coverage instrumentation"
|
||||
script_runner = "@shell"
|
||||
script = [
|
||||
"""
|
||||
echo --- Running coverage tests ---
|
||||
|
||||
# Install Protobuf compiler
|
||||
cargo make install_protobuf_compiler
|
||||
export PATH="$PATH":"$HOME/.pub-cache/bin"
|
||||
export PATH="$PATH":"$HOME/.cargo/bin/"
|
||||
|
||||
cd ../shared-lib
|
||||
|
||||
CARGO_INCREMENTAL=0 \
|
||||
RUSTFLAGS='-C instrument-coverage' \
|
||||
LLVM_PROFILE_FILE='prof-%p-%m.profraw' \
|
||||
cargo test --no-default-features
|
||||
|
||||
"""
|
||||
]
|
||||
|
||||
[tasks.get_rustlib_grcov_report]
|
||||
description = "Get `grcov` HTML report for test coverage for rust-lib"
|
||||
script_runner = "@shell"
|
||||
script = [
|
||||
"""
|
||||
echo --- Getting 'grcov' results for 'rust-lib' ---
|
||||
cd rust-lib/
|
||||
|
||||
grcov . \
|
||||
--binary-path target/debug/deps \
|
||||
--source-dir . \
|
||||
--output-type html \
|
||||
--branch \
|
||||
--ignore-not-existing \
|
||||
--log-level WARN \
|
||||
--output-path target/coverage-html
|
||||
|
||||
echo "--- Done! Generated HTML report under 'target/coverage-html' for rustlib."
|
||||
"""
|
||||
]
|
||||
|
||||
[tasks.get_sharedlib_grcov_report]
|
||||
description = "Get `grcov` HTML report for test coverage shared-lib"
|
||||
script_runner = "@shell"
|
||||
script = [
|
||||
"""
|
||||
echo --- Getting 'grcov' results 'shared-lib' ---
|
||||
cd ../shared-lib
|
||||
|
||||
grcov . \
|
||||
--binary-path target/debug/deps \
|
||||
--source-dir . \
|
||||
--output-type html \
|
||||
--branch \
|
||||
--ignore-not-existing \
|
||||
--log-level WARN \
|
||||
--output-path target/coverage-html
|
||||
|
||||
echo "--- Done! Generated HTML report under 'target/coverage-html' for sharedlib."
|
||||
"""
|
||||
]
|
||||
|
||||
[tasks.get_grcov_report]
|
||||
description = "Get `grcov` HTML report for test coverage"
|
||||
run_task = { name = [
|
||||
"get_rustlib_grcov_report",
|
||||
"get_sharedlib_grcov_report"
|
||||
], parallel = true }
|
||||
|
||||
[tasks.get_sharedlib_lcov_report]
|
||||
description = "Generates `lcov` report for `shared-lib`"
|
||||
script_runner = "@shell"
|
||||
script = [
|
||||
"""
|
||||
echo Getting 'lcov' results for 'shared-lib'
|
||||
|
||||
cd ../shared-lib
|
||||
|
||||
grcov . \
|
||||
--binary-path target/debug/deps \
|
||||
--source-dir . \
|
||||
--output-type lcov \
|
||||
--branch \
|
||||
--ignore-not-existing \
|
||||
--log-level WARN \
|
||||
--output-path target/coverage.lcov
|
||||
|
||||
echo "--- Done! Generated 'target/coverage.lcov' sharedlib."
|
||||
"""
|
||||
]
|
||||
|
||||
[tasks.get_rustlib_lcov_report]
|
||||
description = "Generates `lcov` report for `rust-lib`"
|
||||
script_runner = "@shell"
|
||||
script = [
|
||||
"""
|
||||
echo Getting 'lcov' results for 'rust-lib'
|
||||
|
||||
cd rust-lib/
|
||||
|
||||
grcov . \
|
||||
--binary-path target/debug/deps \
|
||||
--source-dir . \
|
||||
--output-type lcov \
|
||||
--branch \
|
||||
--ignore-not-existing \
|
||||
--log-level WARN \
|
||||
--output-path target/coverage.lcov
|
||||
|
||||
echo "--- Done! Generated 'target/coverage.lcov' for rustlib."
|
||||
"""
|
||||
]
|
||||
|
||||
[tasks.get_lcov_report]
|
||||
description = "Get `lcov` reports for test coverage"
|
||||
run_task = { name = [
|
||||
"get_sharedlib_lcov_report",
|
||||
"get_rustlib_lcov_report"
|
||||
], parallel = true }
|
||||
|
||||
[tasks.get_ci_test_coverage]
|
||||
description = "Get LCOV coverage reports for CI"
|
||||
run_task = { name = [
|
||||
"check_grcov",
|
||||
"run_rustlib_coverage_tests",
|
||||
"run_sharedlib_coverage_tests",
|
||||
"get_lcov_report",
|
||||
"clean_profraw_files"
|
||||
]}
|
||||
|
||||
[tasks.get_test_coverage]
|
||||
description = "Get human readable test coverage reports"
|
||||
run_task = { name = [
|
||||
"check_grcov",
|
||||
"run_rustlib_coverage_tests",
|
||||
"run_sharedlib_coverage_tests",
|
||||
"get_grcov_report",
|
||||
"clean_profraw_files"
|
||||
]}
|
||||
|
@ -1,2 +1,2 @@
|
||||
[toolchain]
|
||||
channel = "stable-2022-01-20"
|
||||
channel = "stable-2022-04-07"
|
||||
|
Loading…
Reference in New Issue
Block a user