io.codemodder.codemods.VerboseRequestMappingCodemod Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-codemods Show documentation

Codemods for fixing common errors across many Java projects

There is a newer version: 0.97.3

package io.codemodder.codemods;

import static io.codemodder.ast.ASTTransforms.addImportIfMissing;
import static io.codemodder.ast.ASTTransforms.removeImportIfUnused;

import com.contrastsecurity.sarif.Result;
import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.ast.expr.MemberValuePair;
import com.github.javaparser.ast.expr.NormalAnnotationExpr;
import io.codemodder.*;
import io.codemodder.javaparser.ChangesResult;
import io.codemodder.providers.sarif.semgrep.SemgrepScan;
import java.util.Optional;
import javax.inject.Inject;

@Codemod(
    id = "pixee:java/verbose-request-mapping",
    importance = Importance.LOW,
    reviewGuidance = ReviewGuidance.MERGE_WITHOUT_REVIEW)
public final class VerboseRequestMappingCodemod
    extends SarifPluginJavaParserChanger {

  @Inject
  public VerboseRequestMappingCodemod(
      @SemgrepScan(ruleId = "verbose-request-mapping") final RuleSarif sarif) {
    super(sarif, NormalAnnotationExpr.class);
  }

  @Override
  public ChangesResult onResultFound(
      final CodemodInvocationContext context,
      final CompilationUnit cu,
      final NormalAnnotationExpr annotationExpr,
      final Result result) {

    // Find the http method if it exists
    Optional method =
        annotationExpr.getPairs().stream()
            .filter(pair -> pair.getNameAsString().equals("method"))
            .findFirst();
    if (method.isPresent()) {
      MemberValuePair methodAttribute = method.get();
      // Store method and remove the "method" attribute
      String httpMethod = methodAttribute.getValue().toString();
      Optional newType = getType(httpMethod);
      if (newType.isPresent()) {
        annotationExpr.getPairs().remove(methodAttribute);
        annotationExpr.setName(newType.get());
        addImportIfMissing(cu, "org.springframework.web.bind.annotation." + newType.get());
        removeImportIfUnused(cu, "org.springframework.web.bind.annotation.RequestMapping");
        removeImportIfUnused(cu, "org.springframework.web.bind.annotation.RequestMethod");
        return ChangesResult.changesApplied;
      }
    }
    return ChangesResult.noChanges;
  }

  public static Optional getType(final String httpMethod) {
    String newType =
        switch (httpMethod) {
          case "RequestMethod.GET", "GET" -> "GetMapping";
          case "RequestMethod.PUT", "PUT" -> "PutMapping";
          case "RequestMethod.DELETE", "DELETE" -> "DeleteMapping";
          case "RequestMethod.POST", "POST" -> "PostMapping";
          case "RequestMethod.PATCH", "PATCH" -> "PatchMapping";
          default -> null;
        };
    return Optional.ofNullable(newType);
  }
}