[`bool_assert_comparaison`] improve suggestion #7612

ABouttefeux · 2021-09-01T09:36:57Z

now code like

assert_eq!( a, true);

Will suggest to use assert(a) wherease previously it was assert(..).

Also what I would like to add is with

assert_eq!( a, true, "message {}", b);

is to suggest assert!( a, "message {}", b).
It is not the case at the moment.

changelog: [bool_assert_comparaison] improve suggestion

rust-highfive · 2021-09-01T09:37:00Z

r? @camsteffen

(rust-highfive has picked a reviewer for you, use r? to override)

clippy_lints/src/bool_assert_comparison.rs

tests/ui/bool_assert_comparison.stderr

camsteffen · 2021-09-01T20:22:35Z

clippy_lints/src/bool_assert_comparison.rs

+                            for el in &args[2..] {
+                                str = format!("{}, {}", str, source::snippet(cx, el.span, ""));
+                            }
+                            format!("{})", str)


Use the String API (push and push_str).

Or better yet, get just one snippet of all the format args with something like

match fmt_args { [] => None, [a] => Some(a.span), [a, .., b] => Some(a.span.to(b.span)), }

ABouttefeux · 2021-09-02T16:21:15Z

The problem I see is that higher::extract_assert_macro_args(expr) does not give me the formatting arguments. I do not know how to get them.

camsteffen · 2021-09-05T20:45:13Z

The problem I see is that higher::extract_assert_macro_args(expr) does not give me the formatting arguments. I do not know how to get them.

You can open a Rust Playground with an assert_eq! and run "Tools > Expand macros" to see what the expansion looks like. You will see a match expression. Currently the macro parsing in extract_assert_macro_args basically stops there. You need to extend the parsing farther to the part where you see Option::Some(...). The contents of the Some is format_args!, so that expression can be parsed with FormatArgsExpn::parse and just add Option<FormatArgsExpn> to the output of extract_assert_macro_args. Let me know if that makes sense.

ABouttefeux · 2021-09-06T11:53:57Z

Yes it does thank you.

camsteffen · 2021-09-07T13:28:26Z

Hi @ABouttefeux, it looks like tests are not passing. Also please do a rebase instead of a merge since we follow rust's no-merge policy: https://rustc-dev-guide.rust-lang.org/git.html#no-merge-policy

ABouttefeux · 2021-09-08T08:31:41Z

I am not able yet to extract the fist formatting argument, I change it to ".." temporarily. I will work on it later. Do you have any idea how to extract it ?

camsteffen · 2021-09-08T20:11:56Z

That would come from FormatArgsExpn::parse. See this.

clippy_utils/src/higher.rs

camsteffen

Nice work getting the macro stuff working! Just some feedback with how the utils are structured and we should enable rustfix for tests now that we have valid suggestions.

camsteffen · 2021-09-21T15:28:44Z

clippy_lints/src/bool_assert_comparison.rs

@@ -90,13 +101,46 @@ impl<'tcx> LateLintPass<'tcx> for BoolAssertComparison {
                        }

                        let non_eq_mac = &mac[..mac.len() - 3];
+                        let mut applicability = Applicability::MaybeIncorrect;


Use MachineApplicable here. Also add // run-rustfix to the top of the test file.

camsteffen · 2021-09-21T15:33:59Z

clippy_utils/src/higher.rs

+                        | StmtKind::Semi(call_assert_failed) = stmts_if_block[1].kind;
+                    if let ExprKind::Call(_, args_assert_failed) = call_assert_failed.kind;
+                    if args_assert_failed.len() >= 4;
+                    if let ExprKind::Call(_, args) =  args_assert_failed[3].kind;


Prefer destructuring for stmts, args, etc.

Suggested change

if let ExprKind::Call(_, args) = args_assert_failed[3].kind;

if let ExprKind::Call(_, [arg]) = args_assert_failed[3].kind;

camsteffen · 2021-09-21T15:38:31Z

clippy_utils/src/higher.rs

+                    if let Some (mut format_arg_expn) = FormatArgsExpn::parse(&args[0]);
+                    then {
+                        vec_arg.push(format_arg_expn.format_string);
+                        vec_arg.append(&mut format_arg_expn.value_args);


I think we should change extract_assert_macro_args to be more consistent with other utils here. We could have AssertExpn::parse and AssertExpn is a struct that contains a FormatArgsExpn.

Thanks I have done something similar, but now I would like to test parsing assert(expr, "format {}", value), how can I test that ?

Use Expand macros in the rust playground to see what you are trying to parse. For other tips, use dbg!() to set a checkpoint in your code and see if that line is being reached. Use dbg!(expr) to see the HIR. Use let _ = dbg!(); in if_chain!s.

clippy_utils/src/higher.rs

camsteffen · 2021-09-22T17:16:48Z

clippy_utils/src/higher.rs

+                                        second_assert_argument: None,
+                                        format_arg: None,
+                                    });
+                                }


Try to avoid else in if_chain! here since it adds an else clause to every if in the expansion. You should only need to "fork" at a single point.

camsteffen · 2021-09-22T17:20:39Z

clippy_utils/src/higher.rs

+    /// `Some(AssertExpn { first_assert_argument: a, second_assert_argument: Some(b),
+    /// format_arg:None })`
+    pub fn parse(e: &'tcx Expr<'tcx>) -> Option<Self> {
+        if let ExprKind::Block(block, _) = e.kind {


Consider doing something like this as a first step

if let ExpnKind::Macro(_, name) = expr.span.ctxt().outer_expn_data().kind; match *name.as_str() { "assert" | "debug_assert" => .., "assert_eq" | "debug_assert_eq" => .., }

giraffate · 2021-10-12T00:20:18Z

ping from triage @ABouttefeux. It looks like there are a few things left to fix. Can you address these?

bors · 2021-10-12T21:33:30Z

☔ The latest upstream changes (presumably #7682) made this pull request unmergeable. Please resolve the merge conflicts.

ABouttefeux · 2021-10-14T12:18:47Z

I have little time I will try to do it. Actually I am strugling a bit with assert!(exp, fmt, ...).

bors · 2021-10-15T17:18:02Z

☔ The latest upstream changes (presumably #7743) made this pull request unmergeable. Please resolve the merge conflicts.

bors · 2021-10-19T20:08:37Z

☔ The latest upstream changes (presumably #7811) made this pull request unmergeable. Please resolve the merge conflicts.

bors · 2021-10-21T10:34:46Z

☔ The latest upstream changes (presumably #7853) made this pull request unmergeable. Please resolve the merge conflicts.

camsteffen · 2021-10-21T13:35:42Z

Hey @ABouttefeux, let me know when you are ready for review.

Also I want to point out #7843 - we may need to take a different direction for parsing the assert macros that does not parse the exact structure of the expansion. Although this is somewhat pre-existing so maybe it's okay to continue with the current approach for this PR. (@rust-lang/clippy thoughts?) I think it is possible to take a different approach using a visitor and checking span expansion data, but this is quite tricky.

ABouttefeux · 2021-10-22T13:50:24Z

Yes this is ready. I have no idea how do to in a way that would be more robust to change of the macro however.

flip1995 · 2021-10-26T10:12:24Z

I'm really unsure if we should take up more technical debt here, since we know that this is not sustainable long term. This is a nice improvement of the suggestion, so definitely a welcome change. But I'm not sure if it is worth to take up the technical debt that comes with it.

bors · 2021-11-02T14:19:57Z

☔ The latest upstream changes (presumably #7906) made this pull request unmergeable. Please resolve the merge conflicts.

camsteffen · 2022-01-04T22:46:14Z

@ABouttefeux After #8219 is merged, have another look if you're still interested. There are new utils in place for assert macros.

flip1995 · 2022-01-12T12:58:39Z

ping from triage @ABouttefeux. #8219 was merged, and you should be able to use those new utils to implement this lint and get this PR merged.

camsteffen · 2022-02-16T21:57:29Z

Closing due to inactivity. Feel free to reopen if you'd like to pick this up again.

jonboh · 2023-10-10T18:42:15Z

@rustbot label -S-inactive-closed

rust-highfive assigned camsteffen Sep 1, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Sep 1, 2021

ABouttefeux force-pushed the bool_assert_comparison_improvment branch 3 times, most recently from bcfe69d to 522e3c7 Compare September 1, 2021 09:55

camsteffen suggested changes Sep 1, 2021

View reviewed changes

ABouttefeux force-pushed the bool_assert_comparison_improvment branch 2 times, most recently from e44bb26 to f244ec7 Compare September 8, 2021 07:30

camsteffen added S-waiting-on-author Status: This is awaiting some action from the author. (Use `@rustbot ready` to update this status) and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties labels Sep 12, 2021

ABouttefeux commented Sep 21, 2021

View reviewed changes

clippy_utils/src/higher.rs Outdated Show resolved Hide resolved

camsteffen suggested changes Sep 21, 2021

View reviewed changes

ABouttefeux force-pushed the bool_assert_comparison_improvment branch from bc62c10 to 29fc388 Compare September 22, 2021 15:24

camsteffen reviewed Sep 22, 2021

View reviewed changes

clippy_utils/src/higher.rs Show resolved Hide resolved

camsteffen reviewed Sep 22, 2021

View reviewed changes

ABouttefeux force-pushed the bool_assert_comparison_improvment branch 2 times, most recently from d006faa to 5c0488f Compare October 15, 2021 10:21

ABouttefeux force-pushed the bool_assert_comparison_improvment branch from 5c0488f to add7d76 Compare October 17, 2021 09:55

ABouttefeux force-pushed the bool_assert_comparison_improvment branch from add7d76 to 929610a Compare October 20, 2021 10:27

ABouttefeux force-pushed the bool_assert_comparison_improvment branch from 929610a to 3328501 Compare October 21, 2021 13:29

ABouttefeux added 8 commits October 22, 2021 15:49

improve suggestion for bool_assert_comparaison

90117a0

add extraction of fmt parameter

e696ba2

extract the formaing string and the values

3d17ede

change to a structure for parsing assert macro

b079660

remove the format_string_expr from the FormatArgsExpn

5f5ea41

change based on review and debug_assert

256e6c5

add assert to the parsing

073dd99

reomove unecessary import

103ac52

ABouttefeux force-pushed the bool_assert_comparison_improvment branch from 3328501 to 103ac52 Compare October 22, 2021 13:49

giraffate mentioned this pull request Oct 27, 2021

Improve suggestion of bool_assert_comparison lint #7888

Closed

camsteffen closed this Feb 16, 2022

flip1995 added S-inactive-closed Status: Closed due to inactivity and removed S-waiting-on-author Status: This is awaiting some action from the author. (Use `@rustbot ready` to update this status) labels Feb 17, 2022

rustbot removed the S-inactive-closed Status: Closed due to inactivity label Oct 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[`bool_assert_comparaison`] improve suggestion #7612

[`bool_assert_comparaison`] improve suggestion #7612

ABouttefeux commented Sep 1, 2021 •

edited

Loading

rust-highfive commented Sep 1, 2021

camsteffen Sep 1, 2021

ABouttefeux commented Sep 2, 2021

camsteffen commented Sep 5, 2021

ABouttefeux commented Sep 6, 2021

camsteffen commented Sep 7, 2021

ABouttefeux commented Sep 8, 2021

camsteffen commented Sep 8, 2021

camsteffen left a comment

camsteffen Sep 21, 2021

camsteffen Sep 21, 2021

camsteffen Sep 21, 2021

ABouttefeux Sep 22, 2021

camsteffen Sep 22, 2021

camsteffen Sep 22, 2021

camsteffen Sep 22, 2021

giraffate commented Oct 12, 2021

bors commented Oct 12, 2021

ABouttefeux commented Oct 14, 2021

bors commented Oct 15, 2021

bors commented Oct 19, 2021

bors commented Oct 21, 2021

camsteffen commented Oct 21, 2021

ABouttefeux commented Oct 22, 2021

flip1995 commented Oct 26, 2021

bors commented Nov 2, 2021

camsteffen commented Jan 4, 2022

flip1995 commented Jan 12, 2022

camsteffen commented Feb 16, 2022

jonboh commented Oct 10, 2023

	if let ExprKind::Call(_, args) = args_assert_failed[3].kind;
	if let ExprKind::Call(_, [arg]) = args_assert_failed[3].kind;

[bool_assert_comparaison] improve suggestion #7612

[bool_assert_comparaison] improve suggestion #7612

Conversation

ABouttefeux commented Sep 1, 2021 • edited Loading

rust-highfive commented Sep 1, 2021

Choose a reason for hiding this comment

ABouttefeux commented Sep 2, 2021

camsteffen commented Sep 5, 2021

ABouttefeux commented Sep 6, 2021

camsteffen commented Sep 7, 2021

ABouttefeux commented Sep 8, 2021

camsteffen commented Sep 8, 2021

camsteffen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

giraffate commented Oct 12, 2021

bors commented Oct 12, 2021

ABouttefeux commented Oct 14, 2021

bors commented Oct 15, 2021

bors commented Oct 19, 2021

bors commented Oct 21, 2021

camsteffen commented Oct 21, 2021

ABouttefeux commented Oct 22, 2021

flip1995 commented Oct 26, 2021

bors commented Nov 2, 2021

camsteffen commented Jan 4, 2022

flip1995 commented Jan 12, 2022

camsteffen commented Feb 16, 2022

jonboh commented Oct 10, 2023

[`bool_assert_comparaison`] improve suggestion #7612

[`bool_assert_comparaison`] improve suggestion #7612

ABouttefeux commented Sep 1, 2021 •

edited

Loading