From 14e5e0e9c9f01e29cd1e8d7da10e85b655288b2e Mon Sep 17 00:00:00 2001
From: Russell Cohen <russell.r.cohen@gmail.com>
Date: Thu, 12 Apr 2018 12:30:37 -0700
Subject: [PATCH] Don't allow #[should_panic] with non-() tests
---
src/libsyntax/test.rs | 67 +++++++++++--------
.../termination-trait-in-test-should-panic.rs | 26 +++++++
...mination-trait-in-test-should-panic.stderr | 12 ++++
.../termination-trait-in-test.rs | 8 +--
4 files changed, 79 insertions(+), 34 deletions(-)
create mode 100644 src/test/ui/rfc-1937-termination-trait/termination-trait-in-test-should-panic.rs
create mode 100644 src/test/ui/rfc-1937-termination-trait/termination-trait-in-test-should-panic.stderr
rename src/test/{run-pass => ui}/rfc-1937-termination-trait/termination-trait-in-test.rs (89%)
diff --git a/src/libsyntax/test.rs b/src/libsyntax/test.rs
index fd2e760e9bee0..325927ed83237 100644
--- a/src/libsyntax/test.rs
+++ b/src/libsyntax/test.rs
@@ -320,37 +320,48 @@ fn ignored_span(cx: &TestCtxt, sp: Span) -> Span {
#[derive(PartialEq)]
enum HasTestSignature {
Yes,
- No,
+ No(BadTestSignature),
+}
+
+#[derive(PartialEq)]
+enum BadTestSignature {
NotEvenAFunction,
+ WrongTypeSignature,
+ NoArgumentsAllowed,
+ ShouldPanicOnlyWithNoArgs,
}
fn is_test_fn(cx: &TestCtxt, i: &ast::Item) -> bool {
let has_test_attr = attr::contains_name(&i.attrs, "test");
fn has_test_signature(cx: &TestCtxt, i: &ast::Item) -> HasTestSignature {
+ let has_should_panic_attr = attr::contains_name(&i.attrs, "should_panic");
match i.node {
ast::ItemKind::Fn(ref decl, _, _, _, ref generics, _) => {
// If the termination trait is active, the compiler will check that the output
// type implements the `Termination` trait as `libtest` enforces that.
- let output_matches = if cx.features.termination_trait_test {
- true
- } else {
- let no_output = match decl.output {
- ast::FunctionRetTy::Default(..) => true,
- ast::FunctionRetTy::Ty(ref t) if t.node == ast::TyKind::Tup(vec![]) => true,
- _ => false
- };
-
- no_output && !generics.is_parameterized()
+ let has_output = match decl.output {
+ ast::FunctionRetTy::Default(..) => false,
+ ast::FunctionRetTy::Ty(ref t) if t.node == ast::TyKind::Tup(vec![]) => false,
+ _ => true
};
- if decl.inputs.is_empty() && output_matches {
- Yes
- } else {
- No
+ if !decl.inputs.is_empty() {
+ return No(BadTestSignature::NoArgumentsAllowed);
+ }
+
+ match (has_output, cx.features.termination_trait_test, has_should_panic_attr) {
+ (true, true, true) => No(BadTestSignature::ShouldPanicOnlyWithNoArgs),
+ (true, true, false) => if generics.is_parameterized() {
+ No(BadTestSignature::WrongTypeSignature)
+ } else {
+ Yes
+ },
+ (true, false, _) => No(BadTestSignature::WrongTypeSignature),
+ (false, _, _) => Yes
}
}
- _ => NotEvenAFunction,
+ _ => No(BadTestSignature::NotEvenAFunction),
}
}
@@ -358,18 +369,20 @@ fn is_test_fn(cx: &TestCtxt, i: &ast::Item) -> bool {
let diag = cx.span_diagnostic;
match has_test_signature(cx, i) {
Yes => true,
- No => {
- if cx.features.termination_trait_test {
- diag.span_err(i.span, "functions used as tests can not have any arguments");
- } else {
- diag.span_err(i.span, "functions used as tests must have signature fn() -> ()");
+ No(cause) => {
+ match cause {
+ BadTestSignature::NotEvenAFunction =>
+ diag.span_err(i.span, "only functions may be used as tests"),
+ BadTestSignature::WrongTypeSignature =>
+ diag.span_err(i.span,
+ "functions used as tests must have signature fn() -> ()"),
+ BadTestSignature::NoArgumentsAllowed =>
+ diag.span_err(i.span, "functions used as tests can not have any arguments"),
+ BadTestSignature::ShouldPanicOnlyWithNoArgs =>
+ diag.span_err(i.span, "functions using `#[should_panic]` must return `()`"),
}
false
- },
- NotEvenAFunction => {
- diag.span_err(i.span, "only functions may be used as tests");
- false
- },
+ }
}
} else {
false
@@ -407,7 +420,7 @@ fn is_bench_fn(cx: &TestCtxt, i: &ast::Item) -> bool {
// well before resolve, can't get too deep.
input_cnt == 1 && output_matches
}
- _ => false
+ _ => false
}
}
diff --git a/src/test/ui/rfc-1937-termination-trait/termination-trait-in-test-should-panic.rs b/src/test/ui/rfc-1937-termination-trait/termination-trait-in-test-should-panic.rs
new file mode 100644
index 0000000000000..73a0150c0bb3f
--- /dev/null
+++ b/src/test/ui/rfc-1937-termination-trait/termination-trait-in-test-should-panic.rs
@@ -0,0 +1,26 @@
+// Copyright 2017 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+// compile-flags: --test
+
+#![feature(termination_trait_test)]
+#![feature(test)]
+
+extern crate test;
+use std::num::ParseIntError;
+use test::Bencher;
+
+#[test]
+#[should_panic]
+fn not_a_num() -> Result<(), ParseIntError> {
+ //~^ ERROR functions using `#[should_panic]` must return `()`
+ let _: u32 = "abc".parse()?;
+ Ok(())
+}
diff --git a/src/test/ui/rfc-1937-termination-trait/termination-trait-in-test-should-panic.stderr b/src/test/ui/rfc-1937-termination-trait/termination-trait-in-test-should-panic.stderr
new file mode 100644
index 0000000000000..e3dab82df41b9
--- /dev/null
+++ b/src/test/ui/rfc-1937-termination-trait/termination-trait-in-test-should-panic.stderr
@@ -0,0 +1,12 @@
+error: functions using `#[should_panic]` must return `()`
+ --> $DIR/termination-trait-in-test-should-panic.rs:22:1
+ |
+LL | / fn not_a_num() -> Result<(), ParseIntError> {
+LL | | //~^ ERROR functions using `#[should_panic]` must return `()`
+LL | | let _: u32 = "abc".parse()?;
+LL | | Ok(())
+LL | | }
+ | |_^
+
+error: aborting due to previous error
+
diff --git a/src/test/run-pass/rfc-1937-termination-trait/termination-trait-in-test.rs b/src/test/ui/rfc-1937-termination-trait/termination-trait-in-test.rs
similarity index 89%
rename from src/test/run-pass/rfc-1937-termination-trait/termination-trait-in-test.rs
rename to src/test/ui/rfc-1937-termination-trait/termination-trait-in-test.rs
index 11997eb691728..2cb4552a4b29e 100644
--- a/src/test/run-pass/rfc-1937-termination-trait/termination-trait-in-test.rs
+++ b/src/test/ui/rfc-1937-termination-trait/termination-trait-in-test.rs
@@ -9,6 +9,7 @@
// except according to those terms.
// compile-flags: --test
+// run-pass
#![feature(termination_trait_test)]
#![feature(test)]
@@ -23,13 +24,6 @@ fn is_a_num() -> Result<(), ParseIntError> {
Ok(())
}
-#[test]
-#[should_panic]
-fn not_a_num() -> Result<(), ParseIntError> {
- let _: u32 = "abc".parse()?;
- Ok(())
-}
-
#[bench]
fn test_a_positive_bench(_: &mut Bencher) -> Result<(), ParseIntError> {
Ok(())