Internal module for sonar-api-models (#372)

carlosu7 · web-flow · commit d758220ce423 · 2024-06-11T14:50:42.000-06:00
Make a common library for Sonar API objects
diff --git a/core-codemods/build.gradle.kts b/core-codemods/build.gradle.kts
@@ -24,6 +24,7 @@ dependencies {
     implementation(project(":plugins:codemodder-plugin-pmd"))
     implementation(project(":plugins:codemodder-plugin-sonar"))
     implementation(project(":plugins:codemodder-plugin-defectdojo"))
+    implementation(project(":sonar-api-model"))
     implementation(libs.java.semver)
     implementation(libs.juniversalchardet)
     implementation(libs.dom4j)
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/AddMissingOverrideCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/AddMissingOverrideCodemod.java
@@ -10,7 +10,7 @@
 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 io.codemodder.sonar.model.Issue;
 import java.util.Optional;
 import javax.inject.Inject;
 
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/AvoidImplicitPublicConstructorCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/AvoidImplicitPublicConstructorCodemod.java
@@ -14,7 +14,7 @@
 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 io.codemodder.sonar.model.Issue;
 import java.util.Optional;
 import javax.inject.Inject;
 
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/CreateConstantForLiteral.java b/core-codemods/src/main/java/io/codemodder/codemods/CreateConstantForLiteral.java
@@ -13,7 +13,7 @@
 import com.github.javaparser.ast.type.ClassOrInterfaceType;
 import com.github.javaparser.ast.type.Type;
 import io.codemodder.CodemodInvocationContext;
-import io.codemodder.providers.sonar.api.Issue;
+import io.codemodder.sonar.model.Issue;
 import java.util.List;
 import java.util.Optional;
 import java.util.Set;
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/DeclareVariableOnSeparateLineCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/DeclareVariableOnSeparateLineCodemod.java
@@ -12,7 +12,7 @@
 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 io.codemodder.sonar.model.Issue;
 import java.util.Optional;
 import javax.inject.Inject;
 
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/DefineConstantForLiteral.java b/core-codemods/src/main/java/io/codemodder/codemods/DefineConstantForLiteral.java
@@ -10,9 +10,9 @@
 import io.codemodder.Position;
 import io.codemodder.RegionNodeMatcher;
 import io.codemodder.SourceCodeRegion;
-import io.codemodder.providers.sonar.api.Flow;
-import io.codemodder.providers.sonar.api.Issue;
-import io.codemodder.providers.sonar.api.TextRange;
+import io.codemodder.sonar.model.Flow;
+import io.codemodder.sonar.model.Issue;
+import io.codemodder.sonar.model.TextRange;
 import java.util.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/DefineConstantForLiteralCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/DefineConstantForLiteralCodemod.java
@@ -8,7 +8,7 @@
 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 io.codemodder.sonar.model.Issue;
 import javax.inject.Inject;
 
 /** A codemod for defining a constant for a literal string that is duplicated n times. */
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/FixRedundantStaticOnEnumCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/FixRedundantStaticOnEnumCodemod.java
@@ -8,7 +8,7 @@
 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 io.codemodder.sonar.model.Issue;
 import javax.inject.Inject;
 
 /** A codemod for automatically removing redundant static flags on nested enums. */
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/HardenStringParseToPrimitivesCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/HardenStringParseToPrimitivesCodemod.java
@@ -11,7 +11,7 @@
 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 io.codemodder.sonar.model.Issue;
 import java.util.Optional;
 import javax.inject.Inject;
 
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/OverridesMatchParentSynchronizationCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/OverridesMatchParentSynchronizationCodemod.java
@@ -10,7 +10,7 @@
 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 io.codemodder.sonar.model.Issue;
 import java.util.Optional;
 import javax.inject.Inject;
 
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/RemoveCommentedCodeCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/RemoveCommentedCodeCodemod.java
@@ -8,7 +8,7 @@
 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 io.codemodder.sonar.model.Issue;
 import javax.inject.Inject;
 
 /**
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/RemoveRedundantVariableCreationCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/RemoveRedundantVariableCreationCodemod.java
@@ -9,7 +9,7 @@
 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 io.codemodder.sonar.model.Issue;
 import java.util.Optional;
 import javax.inject.Inject;
 
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/RemoveUnusedImportCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/RemoveUnusedImportCodemod.java
@@ -14,7 +14,7 @@
 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 io.codemodder.sonar.model.Issue;
 import javax.inject.Inject;
 
 @Codemod(
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/RemoveUnusedLocalVariableCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/RemoveUnusedLocalVariableCodemod.java
@@ -11,7 +11,7 @@
 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 io.codemodder.sonar.model.Issue;
 import java.util.Optional;
 import java.util.stream.Collectors;
 import javax.inject.Inject;
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/RemoveUnusedPrivateMethodCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/RemoveUnusedPrivateMethodCodemod.java
@@ -10,7 +10,7 @@
 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 io.codemodder.sonar.model.Issue;
 import java.util.Optional;
 import javax.inject.Inject;
 
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/RemoveUselessParenthesesCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/RemoveUselessParenthesesCodemod.java
@@ -9,7 +9,7 @@
 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 io.codemodder.sonar.model.Issue;
 import javax.inject.Inject;
 
 /** Codemod to remove useless pair of parentheses */
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/ReplaceStreamCollectorsToListCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/ReplaceStreamCollectorsToListCodemod.java
@@ -10,7 +10,7 @@
 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 io.codemodder.sonar.model.Issue;
 import java.util.Optional;
 import javax.inject.Inject;
 
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/SimplifyRestControllerAnnotationsCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/SimplifyRestControllerAnnotationsCodemod.java
@@ -14,7 +14,7 @@
 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 io.codemodder.sonar.model.Issue;
 import java.util.List;
 import java.util.Optional;
 import javax.inject.Inject;
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/SubstituteReplaceAllCodemod.java b/core-codemods/src/main/java/io/codemodder/codemods/SubstituteReplaceAllCodemod.java
@@ -8,7 +8,7 @@
 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 io.codemodder.sonar.model.Issue;
 import javax.inject.Inject;
 
 /** A codemod for automatically replacing replaceAll() calls to replace() . */
diff --git a/core-codemods/src/main/java/io/codemodder/codemods/UseExistingConstantForLiteral.java b/core-codemods/src/main/java/io/codemodder/codemods/UseExistingConstantForLiteral.java
@@ -3,7 +3,7 @@
 import com.github.javaparser.ast.CompilationUnit;
 import com.github.javaparser.ast.expr.StringLiteralExpr;
 import io.codemodder.CodemodInvocationContext;
-import io.codemodder.providers.sonar.api.Issue;
+import io.codemodder.sonar.model.Issue;
 
 /**
  * A class that extends DefineConstantForLiteral and specializes in using an existing constant
diff --git a/core-codemods/src/test/resources/test-applications/verbose-request-mapping/src/main/java/ai/pixee/integration/verboserequestmapping/api/TestController.java b/core-codemods/src/test/resources/test-applications/verbose-request-mapping/src/main/java/ai/pixee/integration/verboserequestmapping/api/TestController.java
@@ -44,4 +44,4 @@ public String deleteData() {
     public String createData() {
         return "Data Created!";
     }
-}
+}
diff --git a/plugins/codemodder-plugin-sonar/build.gradle.kts b/plugins/codemodder-plugin-sonar/build.gradle.kts
@@ -8,6 +8,7 @@ description = "Plugin to enable the use of Sonar in codemods"
 dependencies {
     compileOnly(libs.jetbrains.annotations)
     implementation(project(":framework:codemodder-base"))
+    implementation(project(":sonar-api-model"))
     testImplementation(testlibs.bundles.junit.jupiter)
     testImplementation(testlibs.bundles.hamcrest)
     testImplementation(testlibs.assertj)
diff --git a/plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/DefaultRuleIssues.java b/plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/DefaultRuleIssues.java
@@ -1,6 +1,6 @@
 package io.codemodder.providers.sonar;
 
-import io.codemodder.providers.sonar.api.Issue;
+import io.codemodder.sonar.model.Issue;
 import java.nio.file.Path;
 import java.util.List;
 import java.util.Map;
diff --git a/plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/RuleIssues.java b/plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/RuleIssues.java
@@ -1,6 +1,6 @@
 package io.codemodder.providers.sonar;
 
-import io.codemodder.providers.sonar.api.Issue;
+import io.codemodder.sonar.model.Issue;
 import java.nio.file.Path;
 import java.util.List;
 
diff --git a/plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/SonarModule.java b/plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/SonarModule.java
@@ -4,8 +4,8 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.inject.AbstractModule;
 import io.codemodder.CodeChanger;
-import io.codemodder.providers.sonar.api.Issue;
-import io.codemodder.providers.sonar.api.SearchIssueResponse;
+import io.codemodder.sonar.model.Issue;
+import io.codemodder.sonar.model.SearchIssueResponse;
 import io.github.classgraph.ClassGraph;
 import io.github.classgraph.ClassInfoList;
 import io.github.classgraph.ScanResult;
diff --git a/plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/SonarPluginJavaParserChanger.java b/plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/SonarPluginJavaParserChanger.java
@@ -7,7 +7,7 @@
 import io.codemodder.codetf.FixedFinding;
 import io.codemodder.javaparser.ChangesResult;
 import io.codemodder.javaparser.JavaParserChanger;
-import io.codemodder.providers.sonar.api.Issue;
+import io.codemodder.sonar.model.Issue;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
diff --git a/plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/api/Paging.java b/plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/api/Paging.java
diff --git a/plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/api/SearchIssueResponse.java b/plugins/codemodder-plugin-sonar/src/main/java/io/codemodder/providers/sonar/api/SearchIssueResponse.java
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -51,3 +51,4 @@ include("plugins:codemodder-plugin-sonar")
 include("plugins:codemodder-plugin-semgrep")
 include("plugins:codemodder-plugin-appscan")
 include("plugins:codemodder-plugin-defectdojo")
+include("sonar-api-model")
diff --git a/sonar-api-model/build.gradle.kts b/sonar-api-model/build.gradle.kts
@@ -0,0 +1,11 @@
+plugins {
+    id("io.codemodder.java-library")
+    id("io.codemodder.maven-publish")
+}
+
+dependencies {
+    api(libs.jackson.yaml)
+    api(libs.jackson.core)
+}
+
+description = "Library with API models for data from Sonar tools"
diff --git a/sonar-api-model/src/main/java/io/codemodder/sonar/model/Flow.java b/sonar-api-model/src/main/java/io/codemodder/sonar/model/Flow.java
@@ -1,4 +1,4 @@
-package io.codemodder.providers.sonar.api;
+package io.codemodder.sonar.model;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import java.util.List;
diff --git a/sonar-api-model/src/main/java/io/codemodder/sonar/model/Hotspot.java b/sonar-api-model/src/main/java/io/codemodder/sonar/model/Hotspot.java
@@ -0,0 +1,34 @@
+package io.codemodder.sonar.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.codemodder.sonar.model.update.FindingSeverity;
+
+/** Represents a Sonar "hotspot". */
+public final class Hotspot extends SonarFinding {
+
+  @JsonProperty("securityCategory")
+  private String securityCategory;
+
+  @JsonProperty("ruleKey")
+  private String ruleKey;
+
+  @JsonProperty("vulnerabilityProbability")
+  private FindingSeverity vulnerabilityProbability;
+
+  public FindingSeverity getVulnerabilityProbability() {
+    return vulnerabilityProbability;
+  }
+
+  public String getSecurityCategory() {
+    return securityCategory;
+  }
+
+  public String getRuleKey() {
+    return ruleKey;
+  }
+
+  @Override
+  public String typeName() {
+    return "hotspots";
+  }
+}
diff --git a/sonar-api-model/src/main/java/io/codemodder/sonar/model/Issue.java b/sonar-api-model/src/main/java/io/codemodder/sonar/model/Issue.java
@@ -0,0 +1,19 @@
+package io.codemodder.sonar.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/** Represents a Sonar "issue". */
+public final class Issue extends SonarFinding {
+
+  @JsonProperty("rule")
+  private String rule;
+
+  public String getRule() {
+    return rule;
+  }
+
+  @Override
+  public String typeName() {
+    return "issues";
+  }
+}
diff --git a/sonar-api-model/src/main/java/io/codemodder/sonar/model/Paging.java b/sonar-api-model/src/main/java/io/codemodder/sonar/model/Paging.java
@@ -0,0 +1,15 @@
+package io.codemodder.sonar.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+class Paging {
+
+  @JsonProperty("pageIndex")
+  int pageIndex;
+
+  @JsonProperty("pageSize")
+  int pageSize;
+
+  @JsonProperty("total")
+  int total;
+}
diff --git a/sonar-api-model/src/main/java/io/codemodder/sonar/model/SearchFindingResponse.java b/sonar-api-model/src/main/java/io/codemodder/sonar/model/SearchFindingResponse.java
@@ -0,0 +1,24 @@
+package io.codemodder.sonar.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/** The response when searching for a type of Sonar issue. */
+public abstract class SearchFindingResponse {
+
+  @JsonProperty("total")
+  private int total;
+
+  @JsonProperty("paging")
+  private Paging paging;
+
+  public int getTotal() {
+    return total;
+  }
+
+  public Paging getPaging() {
+    return paging;
+  }
+
+  /** Return the count of issues. */
+  public abstract int findingCount();
+}
diff --git a/sonar-api-model/src/main/java/io/codemodder/sonar/model/SearchHotspotsResponse.java b/sonar-api-model/src/main/java/io/codemodder/sonar/model/SearchHotspotsResponse.java
diff --git a/sonar-api-model/src/main/java/io/codemodder/sonar/model/SearchIssueResponse.java b/sonar-api-model/src/main/java/io/codemodder/sonar/model/SearchIssueResponse.java
diff --git a/sonar-api-model/src/main/java/io/codemodder/sonar/model/SonarFinding.java b/sonar-api-model/src/main/java/io/codemodder/sonar/model/SonarFinding.java
diff --git a/sonar-api-model/src/main/java/io/codemodder/sonar/model/SonarSeverity.java b/sonar-api-model/src/main/java/io/codemodder/sonar/model/SonarSeverity.java
diff --git a/sonar-api-model/src/main/java/io/codemodder/sonar/model/TextRange.java b/sonar-api-model/src/main/java/io/codemodder/sonar/model/TextRange.java
diff --git a/sonar-api-model/src/main/java/io/codemodder/sonar/model/update/FindingSeverity.java b/sonar-api-model/src/main/java/io/codemodder/sonar/model/update/FindingSeverity.java
