1 use clippy_utils::consts::{constant, Constant};
2 use clippy_utils::diagnostics::span_lint_and_help;
3 use clippy_utils::higher;
4 use clippy_utils::source::snippet_opt;
5 use clippy_utils::{is_direct_expn_of, is_expn_of, match_panic_call};
6 use if_chain::if_chain;
7 use rustc_hir::{Expr, ExprKind, UnOp};
8 use rustc_lint::{LateContext, LateLintPass};
9 use rustc_session::{declare_lint_pass, declare_tool_lint};
11 declare_clippy_lint! {
13 /// Checks for `assert!(true)` and `assert!(false)` calls.
15 /// ### Why is this bad?
16 /// Will be optimized out by the compiler or should probably be replaced by a
17 /// `panic!()` or `unreachable!()`
19 /// ### Known problems
26 /// const B: bool = false;
29 #[clippy::version = "1.34.0"]
30 pub ASSERTIONS_ON_CONSTANTS,
32 "`assert!(true)` / `assert!(false)` will be optimized out by the compiler, and should probably be replaced by a `panic!()` or `unreachable!()`"
35 declare_lint_pass!(AssertionsOnConstants => [ASSERTIONS_ON_CONSTANTS]);
37 impl<'tcx> LateLintPass<'tcx> for AssertionsOnConstants {
38 fn check_expr(&mut self, cx: &LateContext<'tcx>, e: &'tcx Expr<'_>) {
39 let lint_true = |is_debug: bool| {
42 ASSERTIONS_ON_CONSTANTS,
45 "`debug_assert!(true)` will be optimized out by the compiler"
47 "`assert!(true)` will be optimized out by the compiler"
53 let lint_false_without_message = || {
56 ASSERTIONS_ON_CONSTANTS,
58 "`assert!(false)` should probably be replaced",
60 "use `panic!()` or `unreachable!()`",
63 let lint_false_with_message = |panic_message: String| {
66 ASSERTIONS_ON_CONSTANTS,
68 &format!("`assert!(false, {})` should probably be replaced", panic_message),
70 &format!("use `panic!({})` or `unreachable!({})`", panic_message, panic_message),
74 if let Some(debug_assert_span) = is_expn_of(e.span, "debug_assert") {
75 if debug_assert_span.from_expansion() {
79 if let ExprKind::Unary(_, lit) = e.kind;
80 if let Some((Constant::Bool(is_true), _)) = constant(cx, cx.typeck_results(), lit);
86 } else if let Some(assert_span) = is_direct_expn_of(e.span, "assert") {
87 if assert_span.from_expansion() {
90 if let Some(assert_match) = match_assert_with_message(cx, e) {
92 // matched assert but not message
93 AssertKind::WithoutMessage(false) => lint_false_without_message(),
94 AssertKind::WithoutMessage(true) | AssertKind::WithMessage(_, true) => lint_true(false),
95 AssertKind::WithMessage(panic_message, false) => lint_false_with_message(panic_message),
102 /// Result of calling `match_assert_with_message`.
104 WithMessage(String, bool),
105 WithoutMessage(bool),
108 /// Check if the expression matches
113 /// ::std::rt::begin_panic(message, _)
118 /// where `message` is any expression and `c` is a constant bool.
119 fn match_assert_with_message<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) -> Option<AssertKind> {
121 if let Some(higher::If { cond, then, .. }) = higher::If::hir(expr);
122 if let ExprKind::Unary(UnOp::Not, expr) = cond.kind;
123 // bind the first argument of the `assert!` macro
124 if let Some((Constant::Bool(is_true), _)) = constant(cx, cx.typeck_results(), expr);
126 if let ExprKind::Block(block, _) = then.kind;
127 if block.stmts.is_empty();
128 if let Some(block_expr) = &block.expr;
129 // inner block is optional. unwrap it if it exists, or use the expression as is otherwise.
130 if let Some(begin_panic_call) = match block_expr.kind {
131 ExprKind::Block(inner_block, _) => &inner_block.expr,
135 if let Some(arg) = match_panic_call(cx, begin_panic_call);
136 // bind the second argument of the `assert!` macro if it exists
137 if let panic_message = snippet_opt(cx, arg.span);
138 // second argument of begin_panic is irrelevant
139 // as is the second match arm
141 // an empty message occurs when it was generated by the macro
142 // (and not passed by the user)
144 .filter(|msg| !msg.is_empty())
145 .map(|msg| AssertKind::WithMessage(msg, is_true))
146 .or(Some(AssertKind::WithoutMessage(is_true)));