✨ implement OverridesMatchParentSynchronizationCodemod

Author: ryandens

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

@@ -0,0 +1,48 @@
+package io.codemodder.codemods;
+
+import com.github.javaparser.ast.CompilationUnit;
+import com.github.javaparser.ast.Node;
+import com.github.javaparser.ast.body.MethodDeclaration;
+import com.github.javaparser.ast.expr.SimpleName;
+import io.codemodder.Codemod;
+import io.codemodder.CodemodExecutionPriority;
+import io.codemodder.CodemodInvocationContext;
+import io.codemodder.ReviewGuidance;
+import io.codemodder.providers.sonar.ProvidedSonarScan;
+import io.codemodder.providers.sonar.RuleIssues;
+import io.codemodder.providers.sonar.SonarPluginJavaParserChanger;
+import io.codemodder.providers.sonar.api.Issue;
+import java.util.Optional;
+import javax.inject.Inject;
+
+/**
+ * A codemod for automatically fixing overridden methods that do not match their parent methods in
+ * synchronization.
+ */
+@Codemod(
+    id = "sonar:java/overrides-match-synchronization-s3551",
+    reviewGuidance = ReviewGuidance.MERGE_WITHOUT_REVIEW,
+    executionPriority = CodemodExecutionPriority.HIGH)
+public final class OverridesMatchParentSynchronizationCodemod
+    extends SonarPluginJavaParserChanger<SimpleName> {
+
+  @Inject
+  public OverridesMatchParentSynchronizationCodemod(
+      @ProvidedSonarScan(ruleId = "java:S3551") final RuleIssues issues) {
+    super(issues, SimpleName.class);
+  }
+
+  @Override
+  public boolean onIssueFound(
+      CodemodInvocationContext context, CompilationUnit cu, SimpleName methodName, Issue issue) {
+    Optional<Node> parentNodeRef = methodName.getParentNode();
+    if (parentNodeRef.isPresent()) {
+      Node parentNode = parentNodeRef.get();
+      if (parentNode instanceof MethodDeclaration method) {
+        method.setSynchronized(true);
+        return true;
+      }
+    }
+    return false;
+  }
+}

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

@@ -0,0 +1,18 @@
+This change adds missing synchronized keyword to methods that override a synchronized method in the parent class.
+Our changes look something like this:
+
+```diff
+  interface AcmeParent {
+     synchronized void doThing();
+  } 
+
+  class AcmeChild implements AcmeParent {
+
+    @Override
+-    void doThing() {
++    synchronized void doThing() {
+      thing();
+    }
+    
+  }
+```

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

@@ -0,0 +1,8 @@
+{
+  "summary" : "Added missing synchronized keyword (Sonar)",
+  "change" : "Added missing synchronized keyword",
+  "references" : [
+    "https://rules.sonarsource.com/java/RSPEC-3551/",
+    "https://wiki.sei.cmu.edu/confluence/display/java/TSM00-J.+Do+not+override+thread-safe+methods+with+methods+that+are+not+thread-safe"
+  ]
+}