Add assert(true) and assert(false) lints

CHANGELOG.md

@@ -616,6 +616,7 @@ All notable changes to this project will be documented in this file.
 [`absurd_extreme_comparisons`]: https://rust-lang.github.io/rust-clippy/master/index.html#absurd_extreme_comparisons
 [`almost_swapped`]: https://rust-lang.github.io/rust-clippy/master/index.html#almost_swapped
 [`approx_constant`]: https://rust-lang.github.io/rust-clippy/master/index.html#approx_constant
+[`assertions_on_constants`]: https://rust-lang.github.io/rust-clippy/master/index.html#assertions_on_constants
 [`assign_op_pattern`]: https://rust-lang.github.io/rust-clippy/master/index.html#assign_op_pattern
 [`assign_ops`]: https://rust-lang.github.io/rust-clippy/master/index.html#assign_ops
 [`bad_bit_mask`]: https://rust-lang.github.io/rust-clippy/master/index.html#bad_bit_mask

README.md

@@ -7,7 +7,13 @@
 
 A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code.
 
-[There are 290 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)
+<<<<<<< HEAD
+[There are 291 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)
+||||||| merged common ancestors
+[There are 291 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)
+=======
+[There are 291 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)
+>>>>>>> run ./util/dev update_lints
 
 We have a bunch of lint categories to allow you to choose how much Clippy is supposed to ~~annoy~~ help you:
 

clippy_lints/src/assertions_on_constants.rs

@@ -0,0 +1,74 @@
+// Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution.
+//
+// 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.
+
+use crate::rustc::hir::{Expr, ExprKind};
+use crate::rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
+use crate::rustc::{declare_tool_lint, lint_array};
+use crate::syntax::ast::LitKind;
+use crate::utils::{is_direct_expn_of, span_lint, span_lint_and_sugg};
+use rustc_errors::Applicability;
+use if_chain::if_chain;
+
+/// **What it does:** Check explicit call assert!(true/false)
+///
+/// **Why is this bad?** Will be optimized out by the compiler or should probably be replaced by a panic!() or unreachable!()
+///
+/// **Known problems:** None
+///
+/// **Example:**
+/// ```rust
+/// assert!(false)
+/// // or
+/// assert!(true)
+/// // or
+/// const B: bool = false;
+/// assert!(B)
+/// ```
+declare_clippy_lint! {
+    pub ASSERTIONS_ON_CONSTANTS,
+    style,
+    "assert!(true/false) will be optimized out by the compiler/should probably be replaced by a panic!() or unreachable!()"
+}
+
+pub struct AssertionsOnConstants;
+
+impl LintPass for AssertionsOnConstants {
+    fn get_lints(&self) -> LintArray {
+        lint_array![ASSERTIONS_ON_CONSTANTS]
+    }
+}
+
+impl<'a, 'tcx> LateLintPass<'a, 'tcx> for AssertionsOnConstants {
+    fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr) {
+        if_chain! {
+            if is_direct_expn_of(e.span, "assert").is_some();
+            if let ExprKind::Unary(_, ref lit) = e.node;
+            if let ExprKind::Lit(ref inner) = lit.node;
+            then {
+                match inner.node {
+                    LitKind::Bool(true) => {
+                        span_lint(cx, ASSERTIONS_ON_CONSTANTS, e.span,
+                            "assert!(true) will be optimized out by the compiler");
+                    },
+                    LitKind::Bool(false) => {
+                        span_lint_and_sugg(
+                            cx,
+                            ASSERTIONS_ON_CONSTANTS,
+                            e.span,
+                            "assert!(false) should probably be replaced",
+                            "try",
+                            "panic!()".to_string(),
+                            Applicability::MachineApplicable);
+                    },
+                    _ => (),
+                }
+            }
+        }
+    }
+}

clippy_lints/src/lib.rs

@@ -88,6 +88,7 @@ mod utils;
 // begin lints modules, do not remove this comment, it’s used in `update_lints`
 pub mod approx_const;
 pub mod arithmetic;
+pub mod assertions_on_constants;
 pub mod assign_ops;
 pub mod attrs;
 pub mod bit_mask;
@@ -486,6 +487,7 @@ pub fn register_plugins(reg: &mut rustc_plugin::Registry<'_>, conf: &Conf) {
     reg.register_late_lint_pass(box ptr_offset_with_cast::Pass);
     reg.register_late_lint_pass(box redundant_clone::RedundantClone);
     reg.register_late_lint_pass(box slow_vector_initialization::Pass);
+    reg.register_late_lint_pass(box assertions_on_constants::AssertionsOnConstants);
 
     reg.register_lint_group("clippy::restriction", Some("clippy_restriction"), vec![
         arithmetic::FLOAT_ARITHMETIC,
@@ -563,6 +565,7 @@ pub fn register_plugins(reg: &mut rustc_plugin::Registry<'_>, conf: &Conf) {
 
     reg.register_lint_group("clippy::all", Some("clippy"), vec![
         approx_const::APPROX_CONSTANT,
+        assertions_on_constants::ASSERTIONS_ON_CONSTANTS,
         assign_ops::ASSIGN_OP_PATTERN,
         assign_ops::MISREFACTORED_ASSIGN_OP,
         attrs::DEPRECATED_CFG_ATTR,
@@ -784,6 +787,7 @@ pub fn register_plugins(reg: &mut rustc_plugin::Registry<'_>, conf: &Conf) {
     ]);
 
     reg.register_lint_group("clippy::style", Some("clippy_style"), vec![
+        assertions_on_constants::ASSERTIONS_ON_CONSTANTS,
         assign_ops::ASSIGN_OP_PATTERN,
         attrs::UNKNOWN_CLIPPY_LINTS,
         bit_mask::VERBOSE_BIT_MASK,

tests/ui/assertions_on_constants.rs

@@ -0,0 +1,13 @@
+// Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution.
+//
+// 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.
+
+fn main() {
+    assert!(true);
+    assert!(false);
+}

tests/ui/assertions_on_constants.stderr

@@ -0,0 +1,16 @@
+error: assert!(true) will be optimized out by the compiler
+  --> $DIR/assertions_on_constants.rs:11:5
+   |
+LL |     assert!(true);
+   |     ^^^^^^^^^^^^^^
+   |
+   = note: `-D clippy::assertions-on-constants` implied by `-D warnings`
+
+error: assert!(false) should probably be replaced
+  --> $DIR/assertions_on_constants.rs:12:5
+   |
+LL |     assert!(false);
+   |     ^^^^^^^^^^^^^^^ help: try: `panic!()`
+
+error: aborting due to 2 previous errors
+

tests/ui/attrs.rs

@@ -8,7 +8,7 @@
 // except according to those terms.
 
 #![warn(clippy::inline_always, clippy::deprecated_semver)]
-
+#![allow(clippy::assertions_on_constants::assertions_on_constants)]
 #[inline(always)]
 fn test_attr_lint() {
     assert!(true)

tests/ui/empty_line_after_outer_attribute.rs

@@ -8,7 +8,7 @@
 // except according to those terms.
 
 #![warn(clippy::empty_line_after_outer_attr)]
-
+#![allow(clippy::assertions_on_constants::assertions_on_constants)]
 // This should produce a warning
 #[crate_type = "lib"]
 

tests/ui/panic_unimplemented.rs

@@ -8,7 +8,7 @@
 // except according to those terms.
 
 #![warn(clippy::panic_params, clippy::unimplemented)]
-
+#![allow(clippy::assertions_on_constants::assertions_on_constants)]
 fn missing() {
     if true {
         panic!("{}");