Issue-105, Brro Compressor E2E Tests and test workflow imrpovement #117
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…gets before it fails
worryg0d
force-pushed
the
issue-105
branch
2 times, most recently
from
aa65a51 to
09acfa4
Compare
|
Tests fail here until #118 is fixed |
cjrolo
approved these changes
Sep 18, 2024
testisnullus
approved these changes
Sep 23, 2024
rukai
reviewed
Sep 23, 2024
| @@ -48,8 +48,28 @@ jobs: | |||
| - name: Ensure that all crates compile and have no warnings under every possible combination of features | |||
| # some things to explicitly point out: | |||
| # * clippy also reports rustc warnings and errors | |||
| # * clippy --all-targets causes clippy to run against tests and examples which it doesnt do by default. | |||
| run: cargo hack --feature-powerset clippy --all-targets --locked ${{ matrix.cargo_flags }} -- -D warnings | |||
| # * clippy --all-targets causes clippy to run against tests and examples which it doesn't do by default. | |||
There was a problem hiding this comment.
I think we could achieve this more simply as:
run:
# Display all clippy lint failures as warnings
cargo hack --feature-powerset clippy --all-targets --locked ${{ matrix.cargo_flags }}
# Fail CI on the first crate to fail clippy lints
cargo hack --feature-powerset clippy --all-targets --locked ${{ matrix.cargo_flags }} -- -D warningsIts the -D warnings that causes clippy to abort and not continue on to other crates.
But we also need the -D warnings to actually return non-zero exit code and fail CI.
Its also worth noting that clippy is easy to run locally, it is automatically installed already and you can just cargo clippy to see most of the failures locally. (I think it skips tests and benches) Since we dont use any features in fft-compressor yet: cargo clippy --all-targets will test everything including tests/benches
There was a problem hiding this comment.
Thanks a lot! I like this approach much more. I added this one to the CI job.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Workflow improvement
The current workflow sequentially checks all crates in the workspace until one fails.
This PR solves this problem by running a script that runs
cargo clippyon each project in the workspace separately. If one of those checks fails it stops the job when all checks are completed.Brro Compressor E2E
This PR covers the brro compressor CLI tool with a few e2e tests. It mostly covers compression and decompression flows.
Relates to #105