-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(contrib): Add documentation for ui tests #10758
Conversation
r? @ehuss (rust-highfive has picked a reviewer for you, use r? to override) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the changes. It covers snapbox
and UI tests really well
This only adds information about snapshot testing using `snapbox` and keeps the functional testing documentation focused on the existing facilities. We can updated this as our use of `snapbox` matures. In writing this, I did notice that we define `cargo_test_support::compare::assert` but only use it for filesystem asserts and not binary asserts. We should probably add our own function that wraps `snapbox::cmd::Command::cargo()` and passes in `cargo_test_support::compare::assert`. I've left that out of this PR to keep things focused.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks really nice! Love the re-structure.
Thanks! @bors r+ |
📌 Commit 619630c has been approved by |
☀️ Test successful - checks-actions |
8 commits in 03a849043e25104e8b7ad0d4a96c525787b69379..a5e08c4703f202e30cdaf80ca3e7c00baa59c496 2022-06-20 14:47:36 +0000 to 2022-06-23 20:12:03 +0000 - Fix tests due to change in dead_code diagnostic. (rust-lang/cargo#10785) - Stabilize config-cli (rust-lang/cargo#10755) - Restrict duplicate deps warning only to published packages (rust-lang/cargo#10767) - Use fingerprint_hash when computing fingerprints for custom targets (rust-lang/cargo#10746) - Add preloading for workspace packages in `resolve_with_previous` (rust-lang/cargo#10761) - capitalise, for consistency (rust-lang/cargo#10772) - remove unused dependency from benchsuite (rust-lang/cargo#10774) - docs(contrib): Add documentation for ui tests (rust-lang/cargo#10758)
Update cargo 8 commits in 03a849043e25104e8b7ad0d4a96c525787b69379..a5e08c4703f202e30cdaf80ca3e7c00baa59c496 2022-06-20 14:47:36 +0000 to 2022-06-23 20:12:03 +0000 - Fix tests due to change in dead_code diagnostic. (rust-lang/cargo#10785) - Stabilize config-cli (rust-lang/cargo#10755) - Restrict duplicate deps warning only to published packages (rust-lang/cargo#10767) - Use fingerprint_hash when computing fingerprints for custom targets (rust-lang/cargo#10746) - Add preloading for workspace packages in `resolve_with_previous` (rust-lang/cargo#10761) - capitalise, for consistency (rust-lang/cargo#10772) - remove unused dependency from benchsuite (rust-lang/cargo#10774) - docs(contrib): Add documentation for ui tests (rust-lang/cargo#10758)
What does this PR try to resolve?
This only adds information about snapshot testing using
snapbox
andkeeps the functional testing documentation focused on the existing
facilities. We can updated this as our use of
snapbox
matures.How should we test and review this PR?
I did not generate and verify the HTML
In writing this, I did notice that we define
cargo_test_support::compare::assert
but only use it for filesystemasserts and not binary asserts. We should probably add our own function
that wraps
snapbox::cmd::Command::cargo()
and passes incargo_test_support::compare::assert
. I've left that out of this PR tokeep things focused.