Migrate to nextest (#9921)

## Summary

We've had success with `nextest` in other projects, so lets migrate
Ruff.

The Linux tests look a little bit faster (from 2m32s down to 2m8s), the
Windows tests look a little bit slower but not dramatically so.
This commit is contained in:
Charlie Marsh 2024-02-10 13:58:56 -05:00 committed by GitHub
parent 8ec56277e9
commit af2cba7c0a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 20 additions and 8 deletions

View file

@ -111,13 +111,16 @@ jobs:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: "Install Rust toolchain" - name: "Install Rust toolchain"
run: rustup show run: rustup show
- name: "Install cargo insta" - name: "Install mold"
uses: rui314/setup-mold@v1
- name: "Install cargo nextest"
uses: taiki-e/install-action@v2 uses: taiki-e/install-action@v2
with: with:
tool: cargo-insta tool: cargo-nextest
- uses: Swatinem/rust-cache@v2 - uses: Swatinem/rust-cache@v2
- name: "Run tests" - name: "Run tests"
run: cargo insta test --all --all-features --unreferenced reject shell: bash
run: cargo nextest run --workspace --status-level skip --failure-output immediate-final --no-fail-fast -j 12
# Check for broken links in the documentation. # Check for broken links in the documentation.
- run: cargo doc --all --no-deps - run: cargo doc --all --no-deps
env: env:
@ -138,15 +141,14 @@ jobs:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: "Install Rust toolchain" - name: "Install Rust toolchain"
run: rustup show run: rustup show
- name: "Install cargo insta" - name: "Install cargo nextest"
uses: taiki-e/install-action@v2 uses: taiki-e/install-action@v2
with: with:
tool: cargo-insta tool: cargo-nextest
- uses: Swatinem/rust-cache@v2 - uses: Swatinem/rust-cache@v2
- name: "Run tests" - name: "Run tests"
shell: bash shell: bash
# We can't reject unreferenced snapshots on windows because flake8_executable can't run on windows run: cargo nextest run --workspace --status-level skip --failure-output immediate-final --no-fail-fast -j 12
run: cargo insta test --all --exclude ruff_dev --all-features
cargo-test-wasm: cargo-test-wasm:
name: "cargo test (wasm)" name: "cargo test (wasm)"

View file

@ -63,7 +63,7 @@ You'll also need [Insta](https://insta.rs/docs/) to update snapshot tests:
cargo install cargo-insta cargo install cargo-insta
``` ```
and pre-commit to run some validation checks: And you'll need pre-commit to run some validation checks:
```shell ```shell
pipx install pre-commit # or `pip install pre-commit` if you have a virtualenv pipx install pre-commit # or `pip install pre-commit` if you have a virtualenv
@ -76,6 +76,16 @@ when making a commit:
pre-commit install pre-commit install
``` ```
We recommend [nextest](https://nexte.st/) to run Ruff's test suite (via `cargo nextest run`),
though it's not strictly necessary:
```shell
cargo install nextest
```
Throughout this guide, any usages of `cargo test` can be replaced with `cargo nextest run`,
if you choose to install `nextest`.
### Development ### Development
After cloning the repository, run Ruff locally from the repository root with: After cloning the repository, run Ruff locally from the repository root with: