SONARPY-3261: Rule S7508: Add secondary location to improve user experience (#455)

GitOrigin-RevId: 7327d29a9ff6c50e8f17bdcc5ac7a76ba985b84d

Author: joke1196

python-checks/src/main/java/org/sonar/python/checks/NestedCollectionsCreationCheck.java

@@ -43,6 +43,7 @@
 @Rule(key = "S7508")
 public class NestedCollectionsCreationCheck extends PythonSubscriptionCheck {
   private static final String MESSAGE = "Remove this redundant call.";
+  private static final String SECONDARY_MESSAGE = "A redundant call is done here.";
   private static final String QUICK_FIX_MESSAGE = MESSAGE;
 
   private static final String LIST_FQN = "list";
@@ -55,8 +56,7 @@ public class NestedCollectionsCreationCheck extends PythonSubscriptionCheck {
     Map.entry(LIST_FQN, Set.of(LIST_FQN, TUPLE_FQN, SORTED_FQN)),
     Map.entry(SET_FQN, Set.of(LIST_FQN, SET_FQN, TUPLE_FQN, REVERSED_FQN, SORTED_FQN)),
     Map.entry(SORTED_FQN, Set.of(LIST_FQN, TUPLE_FQN, SORTED_FQN)),
-    Map.entry(TUPLE_FQN, Set.of(LIST_FQN, TUPLE_FQN))
-  );
+    Map.entry(TUPLE_FQN, Set.of(LIST_FQN, TUPLE_FQN)));
 
   private TypeCheckMap<Set<TypeCheckBuilder>> sensitiveCallCombinationChecks;
 
@@ -82,20 +82,23 @@ private void check(SubscriptionContext ctx) {
     sensitiveCallCombinationChecks.getOptionalForType(callExpression.callee().typeV2())
       .ifPresent(nestedCallTypeChecks -> TreeUtils.nthArgumentOrKeywordOptional(0, "", callExpression.arguments())
         .map(RegularArgument::expression)
-        .ifPresent(argumentExpression -> {
-          findSensitiveMethodCall(argumentExpression, nestedCallTypeChecks)
-            .ifPresent(redundantCallExpression -> {
-              var issue = ctx.addIssue(callExpression, MESSAGE);
-              createQuickFix(redundantCallExpression).ifPresent(issue::addQuickFix);
-            });
-          findAssignedToSensitiveMethodCall(argumentExpression, nestedCallTypeChecks)
-            .ifPresent(argumentAssignedCall -> {
-              var issue = ctx.addIssue(callExpression, MESSAGE);
-              createAssignedQuickFix(argumentExpression, argumentAssignedCall).ifPresent(issue::addQuickFix);
-            });
-
+        .ifPresent(argumentExpression -> checkCallArgumentsForSensitiveMethods(callExpression, argumentExpression, nestedCallTypeChecks, ctx)));
+  }
 
-        }));
+  private static void checkCallArgumentsForSensitiveMethods(CallExpression callExpression, Expression argumentExpression, Set<TypeCheckBuilder> nestedCallTypeChecks,
+    SubscriptionContext ctx) {
+    findSensitiveMethodCall(argumentExpression, nestedCallTypeChecks)
+      .ifPresent(redundantCallExpression -> {
+        var issue = ctx.addIssue(redundantCallExpression.callee(), MESSAGE)
+          .secondary(callExpression.callee(), SECONDARY_MESSAGE);
+        createQuickFix(redundantCallExpression).ifPresent(issue::addQuickFix);
+      });
+    findAssignedToSensitiveMethodCall(argumentExpression, nestedCallTypeChecks)
+      .ifPresent(argumentAssignedCall -> {
+        var issue = ctx.addIssue(argumentAssignedCall.callee(), MESSAGE)
+          .secondary(callExpression.callee(), SECONDARY_MESSAGE);
+        createAssignedQuickFix(argumentExpression, argumentAssignedCall).ifPresent(issue::addQuickFix);
+      });
   }
 
   private static Optional<CallExpression> findSensitiveMethodCall(@Nullable Expression expression,

python-checks/src/test/resources/checks/nestedCollectionsCreation.py

@@ -1,6 +1,8 @@
 def case1():
   iterable = (3, 1, 4, 1)
-  list(list(iterable)) # Noncompliant
+  list(list(iterable)) # Noncompliant {{Remove this redundant call.}}
+#      ^^^^ 
+# ^^^^@-1< {{A redundant call is done here.}}
   list(tuple(iterable)) # Noncompliant
   list(sorted(iterable)) # Noncompliant
 
@@ -35,8 +37,10 @@ def case5():
 
 def case6():
   iterable = (3, 1, 4, 1)
-  single_usage_assigned_list = list(iterable)
-  list_of_list = list(single_usage_assigned_list) # Noncompliant
+  single_usage_assigned_list = list(iterable) # Noncompliant
+  #                            ^^^^
+  list_of_list = list(single_usage_assigned_list) 
+  #              ^^^^< {{A redundant call is done here.}}
   single_usage_assigned_not_sensitive = something_else(iterable)
   list_of_list = list(single_usage_assigned_not_sensitive)
   multiple_usage_assigned_list = list(iterable)
@@ -47,4 +51,4 @@ def case7():
   iterable = (3, 1, 4, 1)
   sorted(reversed(iterable)) # OK, it should be raided by S7510
   reversed(sorted(iterable)) # OK, it should be raided by S7510
-  list(set(iterable))
+  list(set(iterable))