Populate detectionTool metadata for Sonar codemods (#346)

add finding to sonar codemods and add assertion to check if
`FixOnlyCodeChanger` has findings

Issue #337

Author: carlosu7

core-codemods/src/main/java/io/codemodder/codemods/AddMissingOverrideCodemod.java

@@ -28,14 +28,6 @@ public AddMissingOverrideCodemod(
     super(issues, SimpleName.class);
   }
 
-  @Override
-  public DetectorRule getDetectorRule() {
-    return new DetectorRule(
-        "java:S1161",
-        "`@Override` should be used on overriding and implementing methods",
-        "https://rules.sonarsource.com/java/RSPEC-1161/");
-  }
-
   @Override
   public ChangesResult onIssueFound(
       final CodemodInvocationContext context,
@@ -53,4 +45,12 @@ public ChangesResult onIssueFound(
     }
     return ChangesResult.noChanges;
   }
+
+  @Override
+  public DetectorRule detectorRule() {
+    return new DetectorRule(
+        "java:S1161",
+        "`@Override` should be used on overriding and implementing methods",
+        "https://rules.sonarsource.com/java/RSPEC-1161/");
+  }
 }

core-codemods/src/main/java/io/codemodder/codemods/AvoidImplicitPublicConstructorCodemod.java

@@ -33,14 +33,6 @@ public AvoidImplicitPublicConstructorCodemod(
     super(issues, SimpleName.class);
   }
 
-  @Override
-  public DetectorRule getDetectorRule() {
-    return new DetectorRule(
-        "java:S1118",
-        "Utility classes should not have public constructors",
-        "https://rules.sonarsource.com/java/RSPEC-1118/");
-  }
-
   @Override
   public ChangesResult onIssueFound(
       final CodemodInvocationContext context,
@@ -68,4 +60,12 @@ public ChangesResult onIssueFound(
 
     return ChangesResult.noChanges;
   }
+
+  @Override
+  public DetectorRule detectorRule() {
+    return new DetectorRule(
+        "java:S1118",
+        "Utility classes should not have public constructors",
+        "https://rules.sonarsource.com/java/RSPEC-1118/");
+  }
 }

core-codemods/src/main/java/io/codemodder/codemods/DeclareVariableOnSeparateLineCodemod.java

@@ -30,14 +30,6 @@ public DeclareVariableOnSeparateLineCodemod(
     super(issues, VariableDeclarator.class);
   }
 
-  @Override
-  public DetectorRule getDetectorRule() {
-    return new DetectorRule(
-        "java:S1659",
-        "Multiple variables should not be declared on the same line",
-        "https://rules.sonarsource.com/java/RSPEC-1659/");
-  }
-
   @Override
   public ChangesResult onIssueFound(
       final CodemodInvocationContext context,
@@ -68,4 +60,12 @@ public ChangesResult onIssueFound(
         ? ChangesResult.changesApplied
         : ChangesResult.noChanges;
   }
+
+  @Override
+  public DetectorRule detectorRule() {
+    return new DetectorRule(
+        "java:S1659",
+        "Multiple variables should not be declared on the same line",
+        "https://rules.sonarsource.com/java/RSPEC-1659/");
+  }
 }

core-codemods/src/main/java/io/codemodder/codemods/DefectDojoSqlInjectionCodemod.java

@@ -13,7 +13,6 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
-import java.util.Optional;
 import javax.inject.Inject;
 
 /** This codemod knows how to translate */
@@ -40,18 +39,13 @@ public String vendorName() {
   }
 
   @Override
-  public DetectorRule getDetectorRule() {
+  public DetectorRule detectorRule() {
     return new DetectorRule(
         "java.lang.security.audit.sqli.jdbc-sqli.jdbc-sqli",
         "java.lang.security.audit.sqli.jdbc-sqli.jdbc-sqli",
         "https://semgrep.dev/r?q=java.lang.security.audit.sqli.jdbc-sqli.jdbc-sqli");
   }
 
-  @Override
-  public Optional<FixedFinding> getFixedFinding(String id) {
-    return Optional.of(new FixedFinding(id, getDetectorRule()));
-  }
-
   @Override
   public CodemodFileScanningResult visit(
       final CodemodInvocationContext context, final CompilationUnit cu) {
@@ -72,7 +66,7 @@ public CodemodFileScanningResult visit(
       if (line == null) {
         UnfixedFinding unfixableFinding =
             new UnfixedFinding(
-                id, getDetectorRule(), context.path().toString(), null, "No line number provided");
+                id, detectorRule(), context.path().toString(), null, "No line number provided");
         unfixedFindings.add(unfixableFinding);
         continue;
       }
@@ -87,7 +81,7 @@ public CodemodFileScanningResult visit(
         UnfixedFinding unfixableFinding =
             new UnfixedFinding(
                 id,
-                getDetectorRule(),
+                detectorRule(),
                 context.path().toString(),
                 line,
                 "No supported SQL methods found on the given line");
@@ -99,7 +93,7 @@ public CodemodFileScanningResult visit(
         UnfixedFinding unfixableFinding =
             new UnfixedFinding(
                 id,
-                getDetectorRule(),
+                detectorRule(),
                 context.path().toString(),
                 line,
                 "Multiple supported SQL methods found on the given line");
@@ -109,12 +103,12 @@ public CodemodFileScanningResult visit(
 
       MethodCallExpr methodCallExpr = supportedSqlMethodCallsOnThatLine.get(0);
       if (SQLParameterizerWithCleanup.checkAndFix(methodCallExpr)) {
-        changes.add(CodemodChange.from(line, getFixedFinding(id).get()));
+        changes.add(CodemodChange.from(line, new FixedFinding(id, detectorRule())));
       } else {
         UnfixedFinding unfixableFinding =
             new UnfixedFinding(
                 id,
-                getDetectorRule(),
+                detectorRule(),
                 context.path().toString(),
                 line,
                 "State changing effects possible or unrecognized code shape");

core-codemods/src/main/java/io/codemodder/codemods/DefineConstantForLiteralCodemod.java

@@ -26,14 +26,6 @@ public DefineConstantForLiteralCodemod(
     super(issues, StringLiteralExpr.class);
   }
 
-  @Override
-  public DetectorRule getDetectorRule() {
-    return new DetectorRule(
-        "java:S1192",
-        "String literals should not be duplicated",
-        "https://rules.sonarsource.com/java/RSPEC-1192/");
-  }
-
   @Override
   public ChangesResult onIssueFound(
       final CodemodInvocationContext context,
@@ -55,4 +47,12 @@ public ChangesResult onIssueFound(
         ? ChangesResult.changesApplied
         : ChangesResult.noChanges;
   }
+
+  @Override
+  public DetectorRule detectorRule() {
+    return new DetectorRule(
+        "java:S1192",
+        "String literals should not be duplicated",
+        "https://rules.sonarsource.com/java/RSPEC-1192/");
+  }
 }

core-codemods/src/main/java/io/codemodder/codemods/FixRedundantStaticOnEnumCodemod.java

@@ -26,14 +26,6 @@ public FixRedundantStaticOnEnumCodemod(
     super(issues, EnumDeclaration.class);
   }
 
-  @Override
-  public DetectorRule getDetectorRule() {
-    return new DetectorRule(
-        "java:S2786",
-        "Nested `enum`s should not be declared static",
-        "https://rules.sonarsource.com/java/RSPEC-2786/");
-  }
-
   @Override
   public ChangesResult onIssueFound(
       final CodemodInvocationContext context,
@@ -46,4 +38,12 @@ public ChangesResult onIssueFound(
     }
     return ChangesResult.noChanges;
   }
+
+  @Override
+  public DetectorRule detectorRule() {
+    return new DetectorRule(
+        "java:S2786",
+        "Nested `enum`s should not be declared static",
+        "https://rules.sonarsource.com/java/RSPEC-2786/");
+  }
 }

core-codemods/src/main/java/io/codemodder/codemods/HardenStringParseToPrimitivesCodemod.java

@@ -62,14 +62,6 @@ public HardenParseForConstructorChanger(
           CodemodReporterStrategy.empty());
     }
 
-    @Override
-    public DetectorRule getDetectorRule() {
-      return new DetectorRule(
-          "java:S2130",
-          "Parsing should be used to convert `String`s to primitives",
-          "https://rules.sonarsource.com/java/RSPEC-2130/");
-    }
-
     @Override
     public ChangesResult onIssueFound(
         final CodemodInvocationContext context,
@@ -105,6 +97,14 @@ private Optional<Expression> extractArgumentExpression(Expression argumentExpres
       // Handle other cases or return null if unable to extract the argument expression
       return Optional.empty();
     }
+
+    @Override
+    public DetectorRule detectorRule() {
+      return new DetectorRule(
+          "java:S2130",
+          "Parsing should be used to convert `String`s to primitives",
+          "https://rules.sonarsource.com/java/RSPEC-2130/");
+    }
   }
 
   /**
@@ -124,14 +124,6 @@ public HardenParseForValueOfChanger(
           CodemodReporterStrategy.empty());
     }
 
-    @Override
-    public DetectorRule getDetectorRule() {
-      return new DetectorRule(
-          "java:S2130",
-          "Parsing should be used to convert `String`s to primitives",
-          "https://rules.sonarsource.com/java/RSPEC-2130/");
-    }
-
     @Override
     public ChangesResult onIssueFound(
         final CodemodInvocationContext context,
@@ -189,5 +181,13 @@ private boolean handleMethodCallChainsAfterValueOfIfNeeded(
 
       return true;
     }
+
+    @Override
+    public DetectorRule detectorRule() {
+      return new DetectorRule(
+          "java:S2130",
+          "Parsing should be used to convert `String`s to primitives",
+          "https://rules.sonarsource.com/java/RSPEC-2130/");
+    }
   }
 }

core-codemods/src/main/java/io/codemodder/codemods/OverridesMatchParentSynchronizationCodemod.java

@@ -32,14 +32,6 @@ public OverridesMatchParentSynchronizationCodemod(
     super(issues, SimpleName.class);
   }
 
-  @Override
-  public DetectorRule getDetectorRule() {
-    return new DetectorRule(
-        "java:S3551",
-        "Overrides should match their parent class methods in synchronization",
-        "https://rules.sonarsource.com/java/RSPEC-3551");
-  }
-
   @Override
   public ChangesResult onIssueFound(
       CodemodInvocationContext context, CompilationUnit cu, SimpleName methodName, Issue issue) {
@@ -53,4 +45,12 @@ public ChangesResult onIssueFound(
     }
     return ChangesResult.noChanges;
   }
+
+  @Override
+  public DetectorRule detectorRule() {
+    return new DetectorRule(
+        "java:S3551",
+        "Overrides should match their parent class methods in synchronization",
+        "https://rules.sonarsource.com/java/RSPEC-3551");
+  }
 }

core-codemods/src/main/java/io/codemodder/codemods/RemoveCommentedCodeCodemod.java

@@ -41,14 +41,6 @@ public RemoveCommentedCodeCodemod(
     super(issues, Comment.class, regionNodeMatcher, NodeCollector.ALL_COMMENTS);
   }
 
-  @Override
-  public DetectorRule getDetectorRule() {
-    return new DetectorRule(
-        "java:S125",
-        "Sections of code should not be commented out",
-        "https://rules.sonarsource.com/java/RSPEC-125");
-  }
-
   @Override
   public ChangesResult onIssueFound(
       final CodemodInvocationContext context,
@@ -60,4 +52,12 @@ public ChangesResult onIssueFound(
 
     return ChangesResult.changesApplied;
   }
+
+  @Override
+  public DetectorRule detectorRule() {
+    return new DetectorRule(
+        "java:S125",
+        "Sections of code should not be commented out",
+        "https://rules.sonarsource.com/java/RSPEC-125");
+  }
 }

core-codemods/src/main/java/io/codemodder/codemods/RemoveRedundantVariableCreationCodemod.java

@@ -28,14 +28,6 @@ public RemoveRedundantVariableCreationCodemod(
     super(issues, ObjectCreationExpr.class);
   }
 
-  @Override
-  public DetectorRule getDetectorRule() {
-    return new DetectorRule(
-        "java:S1488",
-        "Local variables should not be declared and then immediately returned or thrown",
-        "https://rules.sonarsource.com/java/RSPEC-1488");
-  }
-
   @Override
   public ChangesResult onIssueFound(
       final CodemodInvocationContext context,
@@ -74,4 +66,12 @@ public ChangesResult onIssueFound(
 
     return ChangesResult.noChanges;
   }
+
+  @Override
+  public DetectorRule detectorRule() {
+    return new DetectorRule(
+        "java:S1488",
+        "Local variables should not be declared and then immediately returned or thrown",
+        "https://rules.sonarsource.com/java/RSPEC-1488");
+  }
 }