[rustdoc-json] Output is currently under-tested #81359

CraftSpider · 2021-01-24T22:40:20Z

Currently, the output of rustdoc's JSON backend has very few tests, which only assure some of the most simple functionality. It would be nice to at least have tests for basic forms of each item, as well as any known issues. A quick list of things not really tested (non-exhaustive):

It also would be nice to know the desired layout of the tests. Currently, the directory holds the form

root
| structs
- | plain
  | tuple
  | generic
| traits
- | has_body
| unions
- | plain
| ...

This is slightly different from how normal rustdoc ui tests are structured, but on the other hand HTML output is very different and serves a somewhat different goal. If we want to establish guidelines on the test directory layout, now is a good time to discuss it, before the directories fill up.

The text was updated successfully, but these errors were encountered:

…ftSpider Rustdoc Json: Add tests for Reexports, and improve jsondocck The two changes are orthognal, so you can land just one if you want, but the improved errors realy helped write the tests. Notably does not have the case from rust-lang#80664, but I want to have all the ajacent cases tested before starting work on that to ensure I dont break anything. Improves rust-lang#81359 cc `@CraftSpider` r? `@jyn514` `@rustbot` modify labels: +A-testsuite +T-rustdoc +A-rustdoc-json

…ftSpider Rustdoc Json: Add tests for Reexports, and improve jsondocck The two changes are orthognal, so you can land just one if you want, but the improved errors realy helped write the tests. Notably does not have the case from rust-lang#80664, but I want to have all the ajacent cases tested before starting work on that to ensure I dont break anything. Improves rust-lang#81359 cc ``@CraftSpider`` r? ``@jyn514`` ``@rustbot`` modify labels: +A-testsuite +T-rustdoc +A-rustdoc-json

…ftSpider Rustdoc Json: Add tests for Reexports, and improve jsondocck The two changes are orthognal, so you can land just one if you want, but the improved errors realy helped write the tests. Notably does not have the case from rust-lang#80664, but I want to have all the ajacent cases tested before starting work on that to ensure I dont break anything. Improves rust-lang#81359 cc ```@CraftSpider``` r? ```@jyn514``` ```@rustbot``` modify labels: +A-testsuite +T-rustdoc +A-rustdoc-json

…=CraftSpider rustdoc-json: Add some tests for typealias item r? `@CraftSpider` Improves rust-lang#81359 The test's arn't pretty, and I think eventually we need a better way of doing repeated tests on a deeply nested path, without repeating the way to get to that path `@rustbot` modify labels: +A-rustdoc-json +T-rustdoc +A-rustdoc +A-testsuite

…=CraftSpider rustdoc-json: Add some tests for typealias item r? ``@CraftSpider`` Improves rust-lang#81359 The test's arn't pretty, and I think eventually we need a better way of doing repeated tests on a deeply nested path, without repeating the way to get to that path ``@rustbot`` modify labels: +A-rustdoc-json +T-rustdoc +A-rustdoc +A-testsuite

…=CraftSpider rustdoc-json: Add some tests for typealias item r? ```@CraftSpider``` Improves rust-lang#81359 The test's arn't pretty, and I think eventually we need a better way of doing repeated tests on a deeply nested path, without repeating the way to get to that path ```@rustbot``` modify labels: +A-rustdoc-json +T-rustdoc +A-rustdoc +A-testsuite

…aftSpider rustdoc-json: More tests, and better jsondocck errors Helps with rust-lang#81359 r? `@CraftSpider` `@rustbot` modify labels: +A-rustdoc-json +T-rustdoc +A-testsuite

…tSpider rustdoc-json: More tests, and better jsondocck errors Helps with rust-lang#81359 r? `@CraftSpider` `@rustbot` modify labels: +A-rustdoc-json +T-rustdoc +A-testsuite

aDotInTheVoid · 2022-08-24T14:15:15Z

Another thing we don't have tests for: ItemEnum::TraitAlias

aDotInTheVoid · 2022-09-07T15:49:03Z

Tests with --document-private-items and --document-hidden-items

…=notriddle Add test for `c_variadic` in rustdoc-json Helps with rust-lang#81359

… r=GuillaumeGomez rustdoc-json: Add test for private supertrait. Helps with rust-lang#81359 r? `@GuillaumeGomez`

… r=GuillaumeGomez rustdoc-json: Add test for private supertrait. Helps with rust-lang#81359 r? ``@GuillaumeGomez``

…umeGomez rustdoc-json: Add test for private supertrait. Helps with rust-lang/rust#81359 r? ``@GuillaumeGomez``

aDotInTheVoid · 2024-06-04T12:55:02Z

We apparently have no tests for Constants, either as items, or in the type system. Remove the ty field from type system Consts #125958 changed the repr in rustdoc-json-types, but this didn't need any test changes. Remove the ty field from type system Consts #125958 (review)

…as_tests, r=aDotInTheVoid rustdoc-json: add type/trait alias tests Not sure if this tests everything there is to test in them though. Updates rust-lang#81359

Rollup merge of rust-lang#127459 - its-the-shrimp:rustdocjson_add_alias_tests, r=aDotInTheVoid rustdoc-json: add type/trait alias tests Not sure if this tests everything there is to test in them though. Updates rust-lang#81359

aDotInTheVoid · 2024-07-28T23:37:43Z

We have no tests for provided_trait_methods

…=fmease rustdoc-json: Add test for `Self` type Inspired by rust-lang#128471, the rustdoc-json suite had no tests in place for the `Self` type. This PR adds one. I've also manually checked locally that this test passes on 29e9248, confirming that adding `clean::Type::SelfTy` didn't change the JSON output. (potentially adding a self type to json (insead of (ab)using generic) is tracked in rust-lang#128522) Updates rust-lang#81359 r? `@fmease`

…=fmease rustdoc-json: Add test for `Self` type Inspired by rust-lang#128471, the rustdoc-json suite had no tests in place for the `Self` type. This PR adds one. I've also manually checked locally that this test passes on 29e9248, confirming that adding `clean::Type::SelfTy` didn't change the JSON output. (potentially adding a self type to json (insead of (ab)using generic) is tracked in rust-lang#128522) Updates rust-lang#81359 r? ``@fmease``

…=fmease rustdoc-json: Add test for `Self` type Inspired by rust-lang#128471, the rustdoc-json suite had no tests in place for the `Self` type. This PR adds one. I've also manually checked locally that this test passes on 29e9248, confirming that adding `clean::Type::SelfTy` didn't change the JSON output. (potentially adding a self type to json (insead of (ab)using generic) is tracked in rust-lang#128522) Updates rust-lang#81359 r? ```@fmease```

…=fmease rustdoc-json: Add test for `Self` type Inspired by rust-lang#128471, the rustdoc-json suite had no tests in place for the `Self` type. This PR adds one. I've also manually checked locally that this test passes on 29e9248, confirming that adding `clean::Type::SelfTy` didn't change the JSON output. (potentially adding a self type to json (insead of (ab)using generic) is tracked in rust-lang#128522) Updates rust-lang#81359 r? ````@fmease````

…=fmease rustdoc-json: Add test for `Self` type Inspired by rust-lang#128471, the rustdoc-json suite had no tests in place for the `Self` type. This PR adds one. I've also manually checked locally that this test passes on 29e9248, confirming that adding `clean::Type::SelfTy` didn't change the JSON output. (potentially adding a self type to json (insead of (ab)using generic) is tracked in rust-lang#128522) Updates rust-lang#81359 r? `````@fmease`````

…=fmease rustdoc-json: Add test for `Self` type Inspired by rust-lang#128471, the rustdoc-json suite had no tests in place for the `Self` type. This PR adds one. I've also manually checked locally that this test passes on 29e9248, confirming that adding `clean::Type::SelfTy` didn't change the JSON output. (potentially adding a self type to json (insead of (ab)using generic) is tracked in rust-lang#128522) Updates rust-lang#81359 r? ``````@fmease``````

…=fmease rustdoc-json: Add test for `Self` type Inspired by rust-lang#128471, the rustdoc-json suite had no tests in place for the `Self` type. This PR adds one. I've also manually checked locally that this test passes on 29e9248, confirming that adding `clean::Type::SelfTy` didn't change the JSON output. (potentially adding a self type to json (insead of (ab)using generic) is tracked in rust-lang#128522) Updates rust-lang#81359 r? ```````@fmease```````

…=fmease rustdoc-json: Add test for `Self` type Inspired by rust-lang#128471, the rustdoc-json suite had no tests in place for the `Self` type. This PR adds one. I've also manually checked locally that this test passes on 29e9248, confirming that adding `clean::Type::SelfTy` didn't change the JSON output. (potentially adding a self type to json (insead of (ab)using generic) is tracked in rust-lang#128522) Updates rust-lang#81359 r? ````````@fmease````````

Rollup merge of rust-lang#129123 - aDotInTheVoid:rustdoc-json-self, r=fmease rustdoc-json: Add test for `Self` type Inspired by rust-lang#128471, the rustdoc-json suite had no tests in place for the `Self` type. This PR adds one. I've also manually checked locally that this test passes on 29e9248, confirming that adding `clean::Type::SelfTy` didn't change the JSON output. (potentially adding a self type to json (insead of (ab)using generic) is tracked in rust-lang#128522) Updates rust-lang#81359 r? ````````@fmease````````

…laumeGomez rustdoc-json: Add test for `impl Trait for dyn Trait` Found while investigating rust-lang#133719 Helps with rust-lang#81359 r? `@GuillaumeGomez`

Rollup merge of rust-lang#133721 - aDotInTheVoid:rdj-dyn-link, r=GuillaumeGomez rustdoc-json: Add test for `impl Trait for dyn Trait` Found while investigating rust-lang#133719 Helps with rust-lang#81359 r? `@GuillaumeGomez`

CraftSpider added the C-tracking-issue Category: An issue tracking the progress of sth. like the implementation of an RFC label Jan 24, 2021

jyn514 added A-rustdoc-json Area: Rustdoc JSON backend A-testsuite Area: The testsuite used to check the correctness of rustc T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jan 24, 2021

aDotInTheVoid mentioned this issue Feb 26, 2021

Rustdoc Json: Add tests for Reexports, and improve jsondocck #82571

Merged

Manishearth added A-rustdoc and removed A-rustdoc labels Apr 23, 2021

aDotInTheVoid mentioned this issue Feb 4, 2022

rustdoc-json: Add some tests for typealias item #93660

Merged

aDotInTheVoid mentioned this issue Mar 11, 2022

rustdoc-json: More tests, and better jsondocck errors #94861

Merged

aDotInTheVoid mentioned this issue Mar 18, 2023

Add test for c_variadic in rustdoc-json #109319

Merged

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Mar 20, 2023

Rollup merge of rust-lang#109319 - aDotInTheVoid:rdj-variadic-test, r…

7c69f98

…=notriddle Add test for `c_variadic` in rustdoc-json Helps with rust-lang#81359

aDotInTheVoid mentioned this issue Jul 14, 2023

rustdoc-json: Add test for private supertrait. #113681

Merged

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jul 14, 2023

Rollup merge of rust-lang#113681 - aDotInTheVoid:rdj-priv-supertrait,…

76e478b

… r=GuillaumeGomez rustdoc-json: Add test for private supertrait. Helps with rust-lang#81359 r? `@GuillaumeGomez`

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jul 14, 2023

Rollup merge of rust-lang#113681 - aDotInTheVoid:rdj-priv-supertrait,…

4bd62f7

… r=GuillaumeGomez rustdoc-json: Add test for private supertrait. Helps with rust-lang#81359 r? ``@GuillaumeGomez``

github-actions bot pushed a commit to rust-lang/miri that referenced this issue Jul 16, 2023

Rollup merge of #113681 - aDotInTheVoid:rdj-priv-supertrait, r=Guilla…

b884b65

…umeGomez rustdoc-json: Add test for private supertrait. Helps with rust-lang/rust#81359 r? ``@GuillaumeGomez``

aDotInTheVoid mentioned this issue Aug 23, 2023

rustdoc: Rename typedef to type alias #115078

Merged

aDotInTheVoid mentioned this issue Jul 8, 2024

rustdoc-json: add type/trait alias tests #127459

Merged

aDotInTheVoid mentioned this issue Aug 15, 2024

rustdoc-json: Add test for Self type #129123

Merged

aDotInTheVoid mentioned this issue Dec 1, 2024

rustdoc-json: Add test for impl Trait for dyn Trait #133721

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[rustdoc-json] Output is currently under-tested #81359

[rustdoc-json] Output is currently under-tested #81359

CraftSpider commented Jan 24, 2021

aDotInTheVoid commented Aug 24, 2022

aDotInTheVoid commented Sep 7, 2022

aDotInTheVoid commented Jun 4, 2024

aDotInTheVoid commented Jul 28, 2024

[rustdoc-json] Output is currently under-tested #81359

[rustdoc-json] Output is currently under-tested #81359

Comments

CraftSpider commented Jan 24, 2021

aDotInTheVoid commented Aug 24, 2022

aDotInTheVoid commented Sep 7, 2022

aDotInTheVoid commented Jun 4, 2024

aDotInTheVoid commented Jul 28, 2024