Add (a lot of) tests to rustdoc

rust-lang / rust

Empowering everyone to build reliable and efficient software.

https://www.rust-lang.org

Other

96.91k stars 12.52k forks source link

Add (a lot of) tests to rustdoc #42018

Open GuillaumeGomez opened 7 years ago

GuillaumeGomez commented 7 years ago

Since we now have a more complete way to compare two HTML contents, I think we can now strongly reinforce rustdoc's tests (which are a bit weak and lacking for now).

cc @rust-lang/docs

QuietMisdreavus commented 6 years ago

Some ideas:

src/librustdoc/html/markdown.rs already has a #[cfg(test)] block, but it doesn't test the "hide lines of code with # " behavior.
~~src/librustdoc/test.rs could use some tests to verify how it adds attributes to the test, whether it wraps tests in a fn main(), things like that.~~

QuietMisdreavus commented 6 years ago

One thing i'd like to see (that will probably need cooperation from some ~~rustbuild~~ compiletest experts) is the ability to test the stdout-printing behavior of rustdoc in various situations. We don't have UI tests for rustdoc the same way the compiler does, so right now there's no place for these in the testing setup.

camelid commented 3 years ago

ping: Is this still an issue?

GuillaumeGomez commented 3 years ago

Still waiting on https://github.com/rust-lang/rust/pull/70533.

rylev commented 3 years ago

Triage: #70533 was superseded by https://github.com/rust-lang/rust/pull/79979 which has been merged. @GuillaumeGomez can this be closed? If not, we should probably add more detail to what kind of tests need to be added since this issue is not very actionable right now.

GuillaumeGomez commented 3 years ago

Still far from done unfortunately. Please keep it open. As for the kind of tests, it's GUI ones. But being more precise is a bit complicated as we're still changing the front-end quickly for the moment.