Add test for where clause order

[GuillaumeGomez]

I didn't use @snapshot because of the   characters, it's much simpler doing it through rustdoc-gui testsuite.

r? @camelid

[GuillaumeGomez]

Linked to #92296 and to #89098.

[camelid]

Please use @snapshot; this is not what rustdoc-gui is meant to be used for. I'd rather have htmldocck tests for things like this, and reserve rustdoc-gui for testing graphics (e.g., CSS styles).

I also imagine rustdoc-gui is somewhat slower since it spins up a browser, and rustdoc's tests are already quite slow.

@rustbot author

[GuillaumeGomez]

Like I said, there are a lot of \0xa0 characters, making the test writing very long in the rustdoc testsuite and absolutely ugly to read. A test should be easy to read, that would go against that.

[GuillaumeGomez]

Also: it would be very long because of all the links and tags (for syntax highlighting) in it. So I really don't think @snapshot is the right move here.

[camelid]

Can you try doing a snapshot test for the XPath //div[@id='impl-SomeTrait%3C(A%2C%20B%2C%20C%2C%20D%2C%20E)%3E-for-(A%2C%20B%2C%20C%2C%20D%2C%20E)']/h3/text()? I think it might get rid of the links.

[GuillaumeGomez]

The goal here isn't to check for the DOM but for the clause order. So once again, I really don't think that using @snapshot is the right call here (that and the reasons listed above).

[camelid]

The goal here isn't to check for the DOM but for the clause order. So once again, I really don't think that using @snapshot is the right call here (that and the reasons listed above).

The goal is to check the DOM—GUI tests are for checking dynamic components of a page, not the generated HTML. I really don't think using GUI tests for this is good. Can you please at least post the output of the snapshot test? I'm not sure what you mean about there being lots of \0x0a characters.

[GuillaumeGomez]

The goal is to check the DOM

No, the goal is to check the text to ensure that the where clause are generated in the correct order.

In any case, here what @snapshot looks like:

src/test/rustdoc/where-clause-order.rs:

#![crate_name = "foo"]

pub trait SomeTrait<Rhs = Self>
where Rhs: ?Sized
{}

// @has 'foo/trait.SomeTrait.html'
// @snapshot S1 - "//div[@id='impl-SomeTrait%3C(A%2C%20B%2C%20C%2C%20D%2C%20E)%3E-for-(A%2C%20B%2C%20C%\
2C%20D%2C%20E)']/h3"
impl<A, B, C, D, E> SomeTrait<(A, B, C, D, E)> for (A, B, C, D, E) where
    A: PartialOrd<A> + PartialEq<A>,
    B: PartialOrd<B> + PartialEq<B>,
    C: PartialOrd<C> + PartialEq<C>,
    D: PartialOrd<D> + PartialEq<D>,
    E: PartialOrd<E> + PartialEq<E> + ?Sized
{}

src/test/rustdoc/where-clause-order.S1.html

<h3 class="code-header in-band">impl&lt;A, B, C, D, E&gt; <a class="trait" href="trait.SomeTrait.html" \
title="trait foo::SomeTrait">SomeTrait</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nigh\
tly/std/primitive.tuple.html">(</a>A, B, C, D, E<a class="primitive" href="https://doc.rust-lang.org/ni\
ghtly/std/primitive.tuple.html">)</a>&gt; for <a class="primitive" href="https://doc.rust-lang.org/nigh\
tly/std/primitive.tuple.html">(</a>A, B, C, D, E<a class="primitive" href="https://doc.rust-lang.org/ni\
ghtly/std/primitive.tuple.html">)</a> <span class="where fmt-newline">where<br />&#160;&#160;&#160;&#16\
0;A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="tr\
ait core::cmp::PartialOrd">PartialOrd</a>&lt;A&gt; + <a class="trait" href="https://doc.rust-lang.org/n\
ightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>&lt;A&gt;,<br />&\
#160;&#160;&#160;&#160;B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Parti\
alOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>&lt;B&gt; + <a class="trait" href="https:\
//doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq\
</a>&lt;B&gt;,<br />&#160;&#160;&#160;&#160;C: <a class="trait" href="https://doc.rust-lang.org/nightly\
/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a>&lt;C&gt; + <a class\
="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp:\
:PartialEq">PartialEq</a>&lt;C&gt;,<br />&#160;&#160;&#160;&#160;D: <a class="trait" href="https://doc.\
rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a\
>&lt;D&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" ti\
tle="trait core::cmp::PartialEq">PartialEq</a>&lt;D&gt;,<br />&#160;&#160;&#160;&#160;E: <a class="trai\
t" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::Part\
ialOrd">PartialOrd</a>&lt;E&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/tra\
it.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>&lt;E&gt; + ?<a class="trait" href="\
https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized\
</a>,&#160;</span></h3>

Just like I said: it's not helpful at all to ensure the where clauses are sorted as expected...

[camelid]

I still don't think that GUI tests are the right way to test this, but for some reason /text() isn't working with snapshot tests. I'm going to re-assign this to someone more knowledgeable with GUI tests since I have a bunch of PRs assigned to me.

r? @jsha

[bors]

☔ The latest upstream changes (presumably #92465) made this pull request unmergeable. Please resolve the merge conflicts.

[jsha]

Here's a test against the HTML (i.e. not a GUI test) that passes and is equally as clear as the GUI test. It doesn't use @snapshot. @GuillaumeGomez would you be willing to do this instead?

src/test/rustdoc/where-clause-order.rs

#![crate_name = "foo"]

pub trait SomeTrait<Rhs = Self>
where Rhs: ?Sized
{}

// @has 'foo/trait.SomeTrait.html'
// @has - "//div[@id='impl-SomeTrait%3C(A%2C%20B%2C%20C%2C%20D%2C%20E)%3E-for-(A%2C%20B%2C%20C%2C%20D%2C%20E)']/h3" "impl<A, B, C, D, E> SomeTrait<(A, B, C, D, E)> for (A, B, C, D, E) where A: PartialOrd<A> + PartialEq<A>, B: PartialOrd<B> + PartialEq<B>, C: PartialOrd<C> + PartialEq<C>, D: PartialOrd<D> + PartialEq<D>, E: PartialOrd<E> + PartialEq<E> + ?Sized, "
impl<A, B, C, D, E> SomeTrait<(A, B, C, D, E)> for (A, B, C, D, E) where
    A: PartialOrd<A> + PartialEq<A>,
    B: PartialOrd<B> + PartialEq<B>,
    C: PartialOrd<C> + PartialEq<C>,
    D: PartialOrd<D> + PartialEq<D>,
    E: PartialOrd<E> + PartialEq<E> + ?Sized
{}

[GuillaumeGomez]

Yes it's fine. The reading isn't great but doesn't matter.

[GuillaumeGomez]

Done!

[jsha]

@bors r+ rollup

[bors]

📌 Commit ec0c838 has been approved by jsha