]> git.lizzy.rs Git - rust.git/commitdiff
Add UI tests for new rustdoc lint
authorGuillaume Gomez <guillaume1.gomez@gmail.com>
Tue, 21 Apr 2020 22:58:52 +0000 (00:58 +0200)
committerGuillaume Gomez <guillaume1.gomez@gmail.com>
Thu, 23 Apr 2020 14:18:50 +0000 (16:18 +0200)
src/test/rustdoc-ui/check-attr-test.rs [new file with mode: 0644]
src/test/rustdoc-ui/check-attr-test.stderr [new file with mode: 0644]
src/test/rustdoc-ui/check-attr.rs [new file with mode: 0644]
src/test/rustdoc-ui/check-attr.stderr [new file with mode: 0644]

diff --git a/src/test/rustdoc-ui/check-attr-test.rs b/src/test/rustdoc-ui/check-attr-test.rs
new file mode 100644 (file)
index 0000000..c4140bb
--- /dev/null
@@ -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() {}
diff --git a/src/test/rustdoc-ui/check-attr-test.stderr b/src/test/rustdoc-ui/check-attr-test.stderr
new file mode 100644 (file)
index 0000000..45a2d6e
--- /dev/null
@@ -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
+
diff --git a/src/test/rustdoc-ui/check-attr.rs b/src/test/rustdoc-ui/check-attr.rs
new file mode 100644 (file)
index 0000000..a93ec29
--- /dev/null
@@ -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() {}
diff --git a/src/test/rustdoc-ui/check-attr.stderr b/src/test/rustdoc-ui/check-attr.stderr
new file mode 100644 (file)
index 0000000..5d6939b
--- /dev/null
@@ -0,0 +1,217 @@
+error: unknown attribute `compile-fail`. Did you mean `compile_fail`?
+  --> $DIR/check-attr.rs:3:1
+   |
+LL | / /// foo
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+note: the lint level is defined here
+  --> $DIR/check-attr.rs:1:9
+   |
+LL | #![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.rs:3:1
+   |
+LL | / /// foo
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:3:1
+   |
+LL | / /// foo
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:13:1
+   |
+LL | / /// bar
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:13:1
+   |
+LL | / /// bar
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:13:1
+   |
+LL | / /// bar
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:23:1
+   |
+LL | / /// foobar
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:23:1
+   |
+LL | / /// foobar
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:23:1
+   |
+LL | / /// foobar
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:33:1
+   |
+LL | / /// barfoo
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:33:1
+   |
+LL | / /// barfoo
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:33:1
+   |
+LL | / /// barfoo
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:43:1
+   |
+LL | / /// b
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:43:1
+   |
+LL | / /// b
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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.rs:43:1
+   |
+LL | / /// b
+LL | |
+LL | |
+LL | |
+...  |
+LL | | /// boo
+LL | | /// ```
+   | |_______^
+   |
+   = 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
+