refactor: redundant_test_prefix rename option

Author: farazdagi

CHANGELOG.md

@@ -6439,6 +6439,8 @@ Released 2018-09-13
 [`msrv`]: https://doc.rust-lang.org/clippy/lint_configuration.html#msrv
 [`pass-by-value-size-limit`]: https://doc.rust-lang.org/clippy/lint_configuration.html#pass-by-value-size-limit
 [`pub-underscore-fields-behavior`]: https://doc.rust-lang.org/clippy/lint_configuration.html#pub-underscore-fields-behavior
+[`redundant-test-prefix-check-outside-cfg-test`]: https://doc.rust-lang.org/clippy/lint_configuration.html#redundant-test-prefix-check-outside-cfg-test
+[`redundant-test-prefix-custom-suffix`]: https://doc.rust-lang.org/clippy/lint_configuration.html#redundant-test-prefix-custom-suffix
 [`semicolon-inside-block-ignore-singleline`]: https://doc.rust-lang.org/clippy/lint_configuration.html#semicolon-inside-block-ignore-singleline
 [`semicolon-outside-block-ignore-multiline`]: https://doc.rust-lang.org/clippy/lint_configuration.html#semicolon-outside-block-ignore-multiline
 [`single-char-binding-names-threshold`]: https://doc.rust-lang.org/clippy/lint_configuration.html#single-char-binding-names-threshold
@@ -6460,6 +6462,4 @@ Released 2018-09-13
 [`verbose-bit-mask-threshold`]: https://doc.rust-lang.org/clippy/lint_configuration.html#verbose-bit-mask-threshold
 [`warn-on-all-wildcard-imports`]: https://doc.rust-lang.org/clippy/lint_configuration.html#warn-on-all-wildcard-imports
 [`warn-unsafe-macro-metavars-in-private-macros`]: https://doc.rust-lang.org/clippy/lint_configuration.html#warn-unsafe-macro-metavars-in-private-macros
-[`redundant-test-prefix-in-integration-tests`]: https://doc.rust-lang.org/clippy/lint_configuration.html#redundant-test-prefix-in-integration-tests
-[`redundant-test-prefix-custom-suffix`]: https://doc.rust-lang.org/clippy/lint_configuration.html#redundant-test-prefix-custom-suffix
 <!-- end autogenerated links to configuration documentation -->

book/src/lint_configuration.md

@@ -869,6 +869,34 @@ exported visibility, or whether they are marked as "pub".
 * [`pub_underscore_fields`](https://rust-lang.github.io/rust-clippy/master/index.html#pub_underscore_fields)
 
 
+## `redundant-test-prefix-check-outside-cfg-test`
+Whether to include functions outside of `#[cfg(test)]` in the linting process or not.
+
+This option allows running the lint against the integration tests: test functions located
+there are not inside a node marked with `#[cfg(test)]` annotation (although they are
+still marked using `#[test]` annotation and thus can have redundant "test_" prefix).
+
+**Default Value:** `false`
+
+---
+**Affected lints:**
+* [`redundant_test_prefix`](https://rust-lang.github.io/rust-clippy/master/index.html#redundant_test_prefix)
+
+
+## `redundant-test-prefix-custom-suffix`
+What suffix to use to avoid function name collisions when `test_` prefix is removed.
+
+If set to `"_works"`, the lint will suggest renaming `test_foo` to `foo_works`.
+Suffix is added only when there is a collision with an existing function name,
+otherwise just `test_` prefix is removed (and no suffix added).
+
+**Default Value:** `"_works"`
+
+---
+**Affected lints:**
+* [`redundant_test_prefix`](https://rust-lang.github.io/rust-clippy/master/index.html#redundant_test_prefix)
+
+
 ## `semicolon-inside-block-ignore-singleline`
 Whether to lint only if it's multiline.
 
@@ -1088,27 +1116,3 @@ Whether to also emit warnings for unsafe blocks with metavariable expansions in
 ---
 **Affected lints:**
 * [`macro_metavars_in_unsafe`](https://rust-lang.github.io/rust-clippy/master/index.html#macro_metavars_in_unsafe)
-
-
-## `redundant-test-prefix-in-integration-tests`
-Whether to include integration tests in the linting process or not.
-
-**Default Value:** `false`
-
----
-**Affected lints:**
-* [`redundant_test_prefix`](https://rust-lang.github.io/rust-clippy/master/index.html#redundant_test_prefix)
-
-
-## `redundant-test-prefix-custom-suffix`
-What suffix to use to avoid function name collisions when `test_` prefix is removed.
-
-If set to `"_works"`, the lint will suggest renaming `test_foo` to `foo_works`.
-Suffix is added only when there is a collision with an existing function name,
-otherwise just `test_` prefix is removed (and no suffix added).
-
-**Default Value:** `"_works"`
-
----
-**Affected lints:**
-* [`redundant_test_prefix`](https://rust-lang.github.io/rust-clippy/master/index.html#redundant_test_prefix)

clippy_lints/src/redundant_test_prefix.rs

@@ -42,14 +42,14 @@ declare_clippy_lint! {
 }
 
 pub struct RedundantTestPrefix {
-    in_integration_tests: bool,
+    check_outside_test_cfg: bool,
     custom_sufix: String,
 }
 
 impl RedundantTestPrefix {
     pub fn new(conf: &'static Conf) -> Self {
         Self {
-            in_integration_tests: conf.redundant_test_prefix_in_integration_tests,
+            check_outside_test_cfg: conf.redundant_test_prefix_check_outside_cfg_test,
             custom_sufix: conf.redundant_test_prefix_custom_suffix.clone(),
         }
     }
@@ -72,10 +72,10 @@ impl<'tcx> LateLintPass<'tcx> for RedundantTestPrefix {
             return;
         };
 
-        // Skip the lint if the function is not within a node with `#[cfg(test)]` attribute,
-        // which is true for integration tests. If the lint is enabled for integration tests,
-        // via configuration value, ignore this check.
-        if !(self.in_integration_tests || is_in_cfg_test(cx.tcx, body.id().hir_id)) {
+        // Skip the lint if the function is not within a node marked with `#[cfg(test)]` attribute.
+        // Continue if the function is inside the node marked with `#[cfg(test)]` or lint is enforced
+        // via configuration (most likely to include integration tests in lint's scope).
+        if !(self.check_outside_test_cfg || is_in_cfg_test(cx.tcx, body.id().hir_id)) {
             return;
         }
 

tests/ui-toml/redundant_test_prefix/custom_suffix/clippy.toml

@@ -0,0 +1,2 @@
+redundant-test-prefix-custom-suffix = "_ok"
+redundant-test-prefix-check-outside-cfg-test = true

tests/ui-toml/redundant_test_prefix/custom_suffix_tests/clippy.toml

@@ -1 +1 @@
-redundant-test-prefix-in-integration-tests = false
+redundant-test-prefix-check-outside-cfg-test = false

tests/ui-toml/redundant_test_prefix/default/clippy.toml

@@ -0,0 +1 @@
+redundant-test-prefix-check-outside-cfg-test = true

tests/ui-toml/redundant_test_prefix/in_integration_tests/clippy.toml

@@ -1,7 +1,7 @@
-//@revisions: default integ_tests suffix_tests
+//@revisions: default outside_cfg_test custom_suffix
 //@[default] rustc-env:CLIPPY_CONF_DIR=tests/ui-toml/redundant_test_prefix/default
-//@[integ_tests] rustc-env:CLIPPY_CONF_DIR=tests/ui-toml/redundant_test_prefix/in_integration_tests
-//@[suffix_tests] rustc-env:CLIPPY_CONF_DIR=tests/ui-toml/redundant_test_prefix/custom_suffix_tests
+//@[outside_cfg_test] rustc-env:CLIPPY_CONF_DIR=tests/ui-toml/redundant_test_prefix/outside_cfg_test
+//@[custom_suffix] rustc-env:CLIPPY_CONF_DIR=tests/ui-toml/redundant_test_prefix/custom_suffix
 //@compile-flags: --test
 #![allow(dead_code)]
 #![warn(clippy::redundant_test_prefix)]
@@ -13,15 +13,15 @@ mod tests_no_annotations {
 
     #[test]
     fn has_annotation() {
-        //~[integ_tests]^ redundant_test_prefix
+        //~[outside_cfg_test]^ redundant_test_prefix
     }
 
     fn no_annotation() {}
 }
 
 #[test]
 fn main_module_has_annotation() {
-    //~[integ_tests]^ redundant_test_prefix
+    //~[outside_cfg_test]^ redundant_test_prefix
 }
 
 fn test_main_module_no_annotation() {}
@@ -43,7 +43,7 @@ fn bar() {}
 
 #[test]
 fn bar_ok() {
-    //~[suffix_tests]^ redundant_test_prefix
+    //~[custom_suffix]^ redundant_test_prefix
 
     todo!()
     // Has prefix, has `#[test]` attribute.