Added Sonar codemod to remove unthrown exceptions (#445)

This change introduces a new codemod for removing unthrown exceptions as
reported by Sonar.

Author: nahsra

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

@@ -56,15 +56,16 @@ public static List<Class<? extends CodeChanger>> asList() {
         SemgrepOverlyPermissiveFilePermissionsCodemod.class,
         SimplifyRestControllerAnnotationsCodemod.class,
         SubstituteReplaceAllCodemod.class,
+        SonarRemoveUnthrowableExceptionCodemod.class,
         SonarXXECodemod.class,
         SonarSQLInjectionCodemod.class,
+        SonarUnsafeReflectionRemediationCodemod.class,
         SQLParameterizerCodemod.class,
         SSRFCodemod.class,
         StackTraceExposureCodemod.class,
         SwitchLiteralFirstComparisonsCodemod.class,
         SwitchToStandardCharsetsCodemod.class,
         UnverifiedJwtCodemod.class,
-        SonarUnsafeReflectionRemediationCodemod.class,
         UpgradeSSLContextTLSCodemod.class,
         UpgradeSSLEngineTLSCodemod.class,
         UpgradeSSLParametersTLSCodemod.class,

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

@@ -0,0 +1,46 @@
+package io.codemodder.codemods;
+
+import com.github.javaparser.ast.CompilationUnit;
+import com.github.javaparser.ast.type.ClassOrInterfaceType;
+import io.codemodder.*;
+import io.codemodder.codetf.DetectorRule;
+import io.codemodder.javaparser.ChangesResult;
+import io.codemodder.providers.sonar.ProvidedSonarScan;
+import io.codemodder.providers.sonar.RuleIssue;
+import io.codemodder.providers.sonar.SonarPluginJavaParserChanger;
+import io.codemodder.sonar.model.Issue;
+import javax.inject.Inject;
+
+/** A codemod for automatically removing unthrowable exceptions. */
+@Codemod(
+    id = "sonar:java/remove-unthrowable-exceptions-s1130",
+    reviewGuidance = ReviewGuidance.MERGE_AFTER_CURSORY_REVIEW,
+    importance = Importance.LOW,
+    executionPriority = CodemodExecutionPriority.HIGH)
+public final class SonarRemoveUnthrowableExceptionCodemod
+    extends SonarPluginJavaParserChanger<ClassOrInterfaceType, Issue> {
+
+  @Inject
+  public SonarRemoveUnthrowableExceptionCodemod(
+      @ProvidedSonarScan(ruleId = "java:S1130") final RuleIssue issues) {
+    super(issues, ClassOrInterfaceType.class);
+  }
+
+  @Override
+  public ChangesResult onFindingFound(
+      final CodemodInvocationContext context,
+      final CompilationUnit cu,
+      final ClassOrInterfaceType type,
+      final Issue issue) {
+    type.remove();
+    return ChangesResult.changesApplied;
+  }
+
+  @Override
+  public DetectorRule detectorRule() {
+    return new DetectorRule(
+        "java:S1130",
+        "Exceptions in \"throws\" clauses should not be superfluous",
+        "https://rules.sonarsource.com/java/RSPEC-1130/");
+  }
+}

core-codemods/src/main/resources/io/codemodder/codemods/SonarRemoveUnthrowableExceptionCodemod/description.md

@@ -0,0 +1,10 @@
+This change removes exceptions that Sonar believes are not possible to be thrown. Cleaning these improves readability and helps callers of the method understand how to effectively use the methods.
+
+Our changes look something like this:
+
+```diff
+-  void it_throws_stuff() throws URISyntaxException {
++  void it_throws_stuff() {
+     // not yet implemented
+   }     
+```

core-codemods/src/main/resources/io/codemodder/codemods/SonarRemoveUnthrowableExceptionCodemod/report.json

@@ -0,0 +1,8 @@
+{
+  "summary" : "Removed unthrowable exception",
+  "change" : "Removed unthrowable exception",
+  "reviewGuidanceJustification" : "There should be no functional difference after the change, but the source code will be easier to understand.",
+  "references" : [
+    "https://rules.sonarsource.com/java/RSPEC-1130/"
+  ]
+}

core-codemods/src/test/java/io/codemodder/codemods/SonarRemoveUnthrowableCodemodTest.java

@@ -0,0 +1,14 @@
+package io.codemodder.codemods;
+
+import io.codemodder.testutils.CodemodTestMixin;
+import io.codemodder.testutils.Metadata;
+
+/** Test for {@link SonarRemoveUnthrowableExceptionCodemod}. */
+@Metadata(
+    codemodType = SonarRemoveUnthrowableExceptionCodemod.class,
+    testResourceDir = "remove-unthrowable-s1130",
+    renameTestFile = "src/main/ThingTest.java",
+    expectingFixesAtLines = {24},
+    doRetransformTest = false,
+    dependencies = {})
+final class SonarRemoveUnthrowableCodemodTest implements CodemodTestMixin {}

core-codemods/src/test/resources/remove-unthrowable-s1130/Test.java.after

@@ -0,0 +1,28 @@
+package com.acme;
+
+import com.acme.Foo;
+import com.acme.Bar;
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.net.http.HttpResponse;
+import java.util.List;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+import org.kohsuke.github.GHIssueState;
+import org.kohsuke.github.GHPullRequest;
+import org.kohsuke.github.GHRepository;
+import org.kohsuke.github.GitHub;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/** This utility is not a real test -- just a way to quickly test these API invocations. */
+final class ThingTest {
+
+  @Disabled
+  @Test
+  void it_does_foo()
+      throws IOException, InterruptedException {
+    String a = "a";
+    String b = "b";
+  }
+}

core-codemods/src/test/resources/remove-unthrowable-s1130/Test.java.before

@@ -0,0 +1,28 @@
+package com.acme;
+
+import com.acme.Foo;
+import com.acme.Bar;
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.net.http.HttpResponse;
+import java.util.List;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+import org.kohsuke.github.GHIssueState;
+import org.kohsuke.github.GHPullRequest;
+import org.kohsuke.github.GHRepository;
+import org.kohsuke.github.GitHub;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/** This utility is not a real test -- just a way to quickly test these API invocations. */
+final class ThingTest {
+
+  @Disabled
+  @Test
+  void it_does_foo()
+      throws IOException, URISyntaxException, InterruptedException {
+    String a = "a";
+    String b = "b";
+  }
+}

core-codemods/src/test/resources/remove-unthrowable-s1130/sonar-issues.json

@@ -0,0 +1,57 @@
+{
+  "total": 4,
+  "p": 1,
+  "ps": 500,
+  "paging": {
+    "pageIndex": 1,
+    "pageSize": 500,
+    "total": 4
+  },
+  "effortTotal": 20,
+  "debtTotal": 20,
+  "issues": [
+    {
+      "key": "AY92LqQsXaXxNZYph9K2",
+      "rule": "java:S1130",
+      "severity": "MINOR",
+      "component": "project_foo:src/main/ThingTest.java",
+      "project": "project_foo",
+      "hash": "eb19688940073fe18e692e9a5fc935f3",
+      "textRange": {
+        "startLine": 24,
+        "endLine": 24,
+        "startOffset": 26,
+        "endOffset": 44
+      },
+      "flows": [],
+      "resolution": "FIXED",
+      "status": "CLOSED",
+      "message": "Remove the declaration of thrown exception 'java.net.URISyntaxException', as it cannot be thrown from method's body.",
+      "effort": "5min",
+      "debt": "5min",
+      "assignee": "zxc@github",
+      "author": "[email protected]",
+      "tags": [
+        "clumsy",
+        "error-handling",
+        "redundant",
+        "unused"
+      ],
+      "creationDate": "2022-07-27T16:44:52+0200",
+      "updateDate": "2024-08-14T00:29:42+0200",
+      "closeDate": "2024-08-14T00:29:42+0200",
+      "type": "CODE_SMELL",
+      "organization": "pixee",
+      "cleanCodeAttribute": "CLEAR",
+      "cleanCodeAttributeCategory": "INTENTIONAL",
+      "impacts": [
+        {
+          "softwareQuality": "MAINTAINABILITY",
+          "severity": "LOW"
+        }
+      ],
+      "issueStatus": "FIXED"
+    }
+  ]
+
+}