htmldocck: Compare HTML tree instead of plain text html #95933
Merged
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
rustbot
added
the
T-rustdoc
rust-highfive
added
the
S-waiting-on-review
|
I don't think this is a good idea. We want to check the generated HTML as is, not that the attributes look like what we want. The problem lies in your PR I think. |
|
Fair enough. Closing this. |
|
So the best solution would be to compare the HTML content directly but it's currently not possible with the tool we use. This will at least prevent random sorting bugs. Thanks! @bors: r+ |
|
📌 Commit 7cc043333ca63e91966b69dca2d1254918a91c1c has been approved by |
This comment was marked as duplicate.
This comment was marked as duplicate.
bors
added
S-waiting-on-bors
This comment has been minimized.
This comment has been minimized.
|
@bors: r- |
bors
added
S-waiting-on-author
Urgau
force-pushed
the
rustdoc-htmldocck-tree-compare
branch
from
7cc0433 to
4cc2261
Compare
This comment has been minimized.
This comment has been minimized.
Urgau
force-pushed
the
rustdoc-htmldocck-tree-compare
branch
from
4cc2261 to
e6a8720
Compare
|
@bors: r+ |
|
📌 Commit e6a8720 has been approved by |
bors
added
S-waiting-on-bors
Dylan-DPC
added a commit
to Dylan-DPC/rust
that referenced
this pull request
Apr 16, 2022
…e, r=GuillaumeGomez htmldocck: Compare HTML tree instead of plain text html This PR improves `htmldocck` by comparing HTML trees instead of plain text html in the case of doing a ``@snapshot`` test. This fix the [CI issue](https://github.com/rust-lang-ci/rust/runs/5964305020?check_suite_focus=true) encounter in rust-lang#95813 where for some unknown reason one of the attributes is not always at the same place. The code is largely based on https://github.com/formencode/formencode/blob/3a1ba9de2fdd494dd945510a4568a3afeddb0b2e/formencode/doctest_xml_compare.py#L72-L120 which is behind MIT License. The comparison function is straightforward except for the `text_compare` function which does some weird stuff that we may want to simply reduce to a plain old comparison. r? `@GuillaumeGomez`
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Apr 17, 2022
Rollup of 6 pull requests Successful merges: - rust-lang#95346 (Stablize `const_extern_fn` for "Rust" and "C") - rust-lang#95933 (htmldocck: Compare HTML tree instead of plain text html) - rust-lang#96105 (Make the debug output for `TargetSelection` less verbose) - rust-lang#96112 (Strict provenance lint diagnostics improvements) - rust-lang#96119 (update Miri) - rust-lang#96124 (to_digit tweak) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Dylan-DPC
added a commit
to Dylan-DPC/rust
that referenced
this pull request
Apr 17, 2022
…=GuillaumeGomez Fix snapshot --bless not working anymore in htmldocck I broke it in rust-lang#95933 r? `@GuillaumeGomez`
Dylan-DPC
added a commit
to Dylan-DPC/rust
that referenced
this pull request
Apr 18, 2022
…=GuillaumeGomez Fix snapshot --bless not working anymore in htmldocck I broke it in rust-lang#95933 r? ``@GuillaumeGomez``
Dylan-DPC
added a commit
to Dylan-DPC/rust
that referenced
this pull request
Apr 18, 2022
…=GuillaumeGomez Fix snapshot --bless not working anymore in htmldocck I broke it in rust-lang#95933 r? ```@GuillaumeGomez```
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.
This PR improves
htmldocckby comparing HTML trees instead of plain text html in the case of doing a@snapshottest.This fix the CI issue encounter in #95813 where for some unknown reason one of the attributes is not always at the same place.
The code is largely based on https://github.com/formencode/formencode/blob/3a1ba9de2fdd494dd945510a4568a3afeddb0b2e/formencode/doctest_xml_compare.py#L72-L120 which is behind MIT License. The comparison function is straightforward except for the
text_comparefunction which does some weird stuff that we may want to simply reduce to a plain old comparison.r? @GuillaumeGomez