Skip to content

Commit

Permalink
Add UI tests for new rustdoc lint
Browse files Browse the repository at this point in the history
  • Loading branch information
GuillaumeGomez committed Apr 23, 2020
1 parent c687d04 commit 96a352e
Show file tree
Hide file tree
Showing 4 changed files with 493 additions and 0 deletions.
38 changes: 38 additions & 0 deletions src/test/rustdoc-ui/check-attr-test.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// compile-flags:--test

#![deny(invalid_codeblock_attribute)]

/// foo
///
/// ```compile-fail,compilefail,comPile_fail
/// boo
/// ```
pub fn foo() {}

/// bar
///
/// ```should-panic,shouldpanic,shOuld_panic
/// boo
/// ```
pub fn bar() {}

/// foobar
///
/// ```no-run,norun,nO_run
/// boo
/// ```
pub fn foobar() {}

/// barfoo
///
/// ```allow-fail,allowfail,allOw_fail
/// boo
/// ```
pub fn barfoo() {}

/// b
///
/// ```test-harness,testharness,tesT_harness
/// boo
/// ```
pub fn b() {}
187 changes: 187 additions & 0 deletions src/test/rustdoc-ui/check-attr-test.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
error: unknown attribute `compile-fail`. Did you mean `compile_fail`?
--> $DIR/check-attr-test.rs:5:1
|
5 | / /// foo
6 | | ///
7 | | /// ```compile-fail,compilefail,comPile_fail
8 | | /// boo
9 | | /// ```
| |_______^
|
note: the lint level is defined here
--> $DIR/check-attr-test.rs:3:9
|
3 | #![deny(invalid_codeblock_attribute)]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^
= help: the code block will either not be tested if not marked as a rust one or won't fail if it compiles successfully

error: unknown attribute `compilefail`. Did you mean `compile_fail`?
--> $DIR/check-attr-test.rs:5:1
|
5 | / /// foo
6 | | ///
7 | | /// ```compile-fail,compilefail,comPile_fail
8 | | /// boo
9 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or won't fail if it compiles successfully

error: unknown attribute `comPile_fail`. Did you mean `compile_fail`?
--> $DIR/check-attr-test.rs:5:1
|
5 | / /// foo
6 | | ///
7 | | /// ```compile-fail,compilefail,comPile_fail
8 | | /// boo
9 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or won't fail if it compiles successfully

error: unknown attribute `should-panic`. Did you mean `should_panic`?
--> $DIR/check-attr-test.rs:12:1
|
12 | / /// bar
13 | | ///
14 | | /// ```should-panic,shouldpanic,shOuld_panic
15 | | /// boo
16 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or won't fail if it doesn't panic when running

error: unknown attribute `shouldpanic`. Did you mean `should_panic`?
--> $DIR/check-attr-test.rs:12:1
|
12 | / /// bar
13 | | ///
14 | | /// ```should-panic,shouldpanic,shOuld_panic
15 | | /// boo
16 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or won't fail if it doesn't panic when running

error: unknown attribute `shOuld_panic`. Did you mean `should_panic`?
--> $DIR/check-attr-test.rs:12:1
|
12 | / /// bar
13 | | ///
14 | | /// ```should-panic,shouldpanic,shOuld_panic
15 | | /// boo
16 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or won't fail if it doesn't panic when running

error: unknown attribute `no-run`. Did you mean `no_run`?
--> $DIR/check-attr-test.rs:19:1
|
19 | / /// foobar
20 | | ///
21 | | /// ```no-run,norun,nO_run
22 | | /// boo
23 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)

error: unknown attribute `norun`. Did you mean `no_run`?
--> $DIR/check-attr-test.rs:19:1
|
19 | / /// foobar
20 | | ///
21 | | /// ```no-run,norun,nO_run
22 | | /// boo
23 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)

error: unknown attribute `nO_run`. Did you mean `no_run`?
--> $DIR/check-attr-test.rs:19:1
|
19 | / /// foobar
20 | | ///
21 | | /// ```no-run,norun,nO_run
22 | | /// boo
23 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)

error: unknown attribute `allow-fail`. Did you mean `allow_fail`?
--> $DIR/check-attr-test.rs:26:1
|
26 | / /// barfoo
27 | | ///
28 | | /// ```allow-fail,allowfail,allOw_fail
29 | | /// boo
30 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)

error: unknown attribute `allowfail`. Did you mean `allow_fail`?
--> $DIR/check-attr-test.rs:26:1
|
26 | / /// barfoo
27 | | ///
28 | | /// ```allow-fail,allowfail,allOw_fail
29 | | /// boo
30 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)

error: unknown attribute `allOw_fail`. Did you mean `allow_fail`?
--> $DIR/check-attr-test.rs:26:1
|
26 | / /// barfoo
27 | | ///
28 | | /// ```allow-fail,allowfail,allOw_fail
29 | | /// boo
30 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)

error: unknown attribute `test-harness`. Did you mean `test_harness`?
--> $DIR/check-attr-test.rs:33:1
|
33 | / /// b
34 | | ///
35 | | /// ```test-harness,testharness,tesT_harness
36 | | /// boo
37 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function

error: unknown attribute `testharness`. Did you mean `test_harness`?
--> $DIR/check-attr-test.rs:33:1
|
33 | / /// b
34 | | ///
35 | | /// ```test-harness,testharness,tesT_harness
36 | | /// boo
37 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function

error: unknown attribute `tesT_harness`. Did you mean `test_harness`?
--> $DIR/check-attr-test.rs:33:1
|
33 | / /// b
34 | | ///
35 | | /// ```test-harness,testharness,tesT_harness
36 | | /// boo
37 | | /// ```
| |_______^
|
= help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function

error: aborting due to 15 previous errors

51 changes: 51 additions & 0 deletions src/test/rustdoc-ui/check-attr.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
#![deny(invalid_codeblock_attribute)]

/// foo
//~^ ERROR
//~^^ ERROR
//~^^^ ERROR
///
/// ```compile-fail,compilefail,comPile_fail
/// boo
/// ```
pub fn foo() {}

/// bar
//~^ ERROR
//~^^ ERROR
//~^^^ ERROR
///
/// ```should-panic,shouldpanic,sHould_panic
/// boo
/// ```
pub fn bar() {}

/// foobar
//~^ ERROR
//~^^ ERROR
//~^^^ ERROR
///
/// ```no-run,norun,no_Run
/// boo
/// ```
pub fn foobar() {}

/// barfoo
//~^ ERROR
//~^^ ERROR
//~^^^ ERROR
///
/// ```allow-fail,allowfail,alLow_fail
/// boo
/// ```
pub fn barfoo() {}

/// b
//~^ ERROR
//~^^ ERROR
//~^^^ ERROR
///
/// ```test-harness,testharness,teSt_harness
/// boo
/// ```
pub fn b() {}
Loading

0 comments on commit 96a352e

Please sign in to comment.