Merge pull request #543 from codacy/upload-sourceid-CF-1813

feature: Upload sourceId when available CF-1813

Author: machadoit

cli/src/main/scala/com/codacy/analysis/cli/formatter/Text.scala

@@ -34,7 +34,7 @@ private[formatter] class Text(val stream: PrintStream) extends Formatter {
 
   private def add(element: Result): Unit = {
     element match {
-      case Issue(patternId, filename, message, level, category, location) =>
+      case Issue(patternId, filename, message, level, category, location, _) =>
         stream.println(prettyMessage(patternId, filename, message, level, category, location))
         stream.flush()
       case FileError(filename, message) =>

cli/src/test/scala/com/codacy/analysis/cli/analysis/ExitStatusSpec.scala

@@ -37,21 +37,24 @@ class ExitStatusSpec extends Specification with NoLanguageFeatures with Mockito
             Issue.Message("Mutable variable"),
             Result.Level.Err,
             Option(Pattern.Category.ErrorProne),
-            FullLocation(1, 20)),
+            FullLocation(1, 20),
+            None),
           Issue(
             Pattern.Id("NoMutableVariables"),
             Paths.get("Test.scala"),
             Issue.Message("Mutable variable"),
             Result.Level.Err,
             Option(Pattern.Category.ErrorProne),
-            FullLocation(2, 20)),
+            FullLocation(2, 20),
+            None),
           Issue(
             Pattern.Id("NoMutableVariables"),
             Paths.get("Test.scala"),
             Issue.Message("Mutable variable"),
             Result.Level.Err,
             Option(Pattern.Category.ErrorProne),
-            FullLocation(3, 20)))))))) should beEqualTo(ExitStatus.ExitCodes.success)
+            FullLocation(3, 20),
+            None))))))) should beEqualTo(ExitStatus.ExitCodes.success)
     }
 
     "send exceed max issues number code when issues do not exceed max issues number" in {
@@ -69,21 +72,24 @@ class ExitStatusSpec extends Specification with NoLanguageFeatures with Mockito
             Issue.Message("Mutable variable"),
             Result.Level.Err,
             Option(Pattern.Category.ErrorProne),
-            FullLocation(1, 20)),
+            FullLocation(1, 20),
+            None),
           Issue(
             Pattern.Id("NoMutableVariables"),
             Paths.get("Test.scala"),
             Issue.Message("Mutable variable"),
             Result.Level.Err,
             Option(Pattern.Category.ErrorProne),
-            FullLocation(2, 20)),
+            FullLocation(2, 20),
+            None),
           Issue(
             Pattern.Id("NoMutableVariables"),
             Paths.get("Test.scala"),
             Issue.Message("Mutable variable"),
             Result.Level.Err,
             Option(Pattern.Category.ErrorProne),
-            FullLocation(3, 20)))))))) should beEqualTo(ExitStatus.ExitCodes.maxAllowedIssuesExceeded)
+            FullLocation(3, 20),
+            None))))))) should beEqualTo(ExitStatus.ExitCodes.maxAllowedIssuesExceeded)
     }
 
     "send success code when no issues" in {

cli/src/test/scala/com/codacy/analysis/cli/formatter/SarifSpec.scala

@@ -36,7 +36,8 @@ class SarifSpec extends Specification with NoLanguageFeatures {
       Issue.Message("My Security Issue Message"),
       securityPatternLevel,
       Option(securityPatternCategory),
-      LineLocation(1))
+      LineLocation(1),
+      Some("someSourceId"))
 
     val duplicationPatternId = Pattern.Id("duplication-pattern-id")
     val duplicationPatternLevel = Result.Level.Err
@@ -54,7 +55,8 @@ class SarifSpec extends Specification with NoLanguageFeatures {
       Issue.Message("My Duplication Issue Message"),
       duplicationPatternLevel,
       Option(duplicationPatternCategory),
-      LineLocation(2))
+      LineLocation(2),
+      None)
 
     val toolSpecification = Tool.Specification(
       Tool.Name("Custom Tool"),

core/src/main/scala/com/codacy/analysis/core/tools/Tool.scala

@@ -101,7 +101,8 @@ class Tool(fullToolSpec: FullToolSpec,
             Issue.Message(r.message),
             r.level,
             r.category,
-            LineLocation(r.line)))(collection.breakOut): Set[ToolResult]) ++
+            LineLocation(r.line),
+            r.sourceId))(collection.breakOut): Set[ToolResult]) ++
           res.fileErrors.map(
             fe =>
               FileError(

model/src/main/scala/com/codacy/analysis/core/model/Result.scala

@@ -20,7 +20,8 @@ final case class Issue(patternId: results.Pattern.Id,
                        message: Issue.Message,
                        level: results.Result.Level,
                        category: Option[results.Pattern.Category],
-                       location: Location)
+                       location: Location,
+                       sourceId: Option[String])
     extends ToolResult
 
 object Issue {

model/src/test/scala/core/serializer/IssuesReportSerializerSpec.scala

@@ -28,14 +28,37 @@ class IssuesReportSerializerSpec extends Specification with NoLanguageFeatures {
               Issue.Message(patternMessage),
               com.codacy.plugins.api.results.Result.Level.Info,
               None,
-              FullLocation(lineNumber, lineNumber)))))))))
+              FullLocation(lineNumber, lineNumber),
+              None))))))))
 
       val expectedJSON =
         s"""[{"tool":"$toolName","issues":{"Success":{"results":[{"filename":"${filePath.toString}","results":[{"Issue":{"patternId":{"value":"$patternId"},"filename":"${filePath.toString}","message":{"text":"$patternMessage"},"level":"Info","location":{"FullLocation":{"line":$lineNumber,"column":$lineNumber}}}}]}]}}}]"""
 
       expectedJSON mustEqual issuesReporterAsJson
     }
 
+    "be converted to json when sourceId is defined" in {
+      val sourceId = "exampleSourceId"
+      val issuesReporterAsJson = IssuesReportSerializer.toJsonString(
+        Set(ToolResults(
+          toolName,
+          IssuesAnalysis.Success(Set(IssuesAnalysis.FileResults(
+            filePath,
+            Set(Issue(
+              Pattern.Id(patternId),
+              filePath,
+              Issue.Message(patternMessage),
+              com.codacy.plugins.api.results.Result.Level.Info,
+              None,
+              FullLocation(lineNumber, lineNumber),
+              Some(sourceId)))))))))
+
+      val expectedJSON =
+        s"""[{"tool":"$toolName","issues":{"Success":{"results":[{"filename":"${filePath.toString}","results":[{"Issue":{"patternId":{"value":"$patternId"},"filename":"${filePath.toString}","message":{"text":"$patternMessage"},"level":"Info","location":{"FullLocation":{"line":$lineNumber,"column":$lineNumber}},"sourceId":"exampleSourceId"}}]}]}}}]"""
+
+      expectedJSON mustEqual issuesReporterAsJson
+    }
+
     "have category in generated json" in {
       val issuesReporterAsJson = IssuesReportSerializer.toJsonString(
         Set(ToolResults(
@@ -48,7 +71,8 @@ class IssuesReportSerializerSpec extends Specification with NoLanguageFeatures {
               Issue.Message(patternMessage),
               com.codacy.plugins.api.results.Result.Level.Info,
               Some(com.codacy.plugins.api.results.Pattern.Category.UnusedCode),
-              FullLocation(lineNumber, lineNumber)))))))))
+              FullLocation(lineNumber, lineNumber),
+              None))))))))
 
       val expectedJSON =
         s"""[{"tool":"$toolName","issues":{"Success":{"results":[{"filename":"${filePath.toString}","results":[{"Issue":{"patternId":{"value":"$patternId"},"filename":"${filePath.toString}","message":{"text":"$patternMessage"},"level":"Info","category":"UnusedCode","location":{"FullLocation":{"line":$lineNumber,"column":$lineNumber}}}}]}]}}}]"""

project/Dependencies.scala

@@ -2,7 +2,7 @@ import sbt._
 
 object Dependencies {
 
-  val codacyPluginsVersion = "26.2.6_play_2.7"
+  val codacyPluginsVersion = "27.0.0_play_2.7"
   val circeVersion = "0.12.3"
   val specs2Version = "4.8.1"
   val codacyApiVersion = "49.31.14"
@@ -30,7 +30,7 @@ object Dependencies {
   val codacyPlugins =
     Seq("codacy-plugins", "codacy-plugins-runner-binary").map("com.codacy" %% _ % codacyPluginsVersion)
 
-  lazy val pluginsApi = "com.codacy" %% "codacy-plugins-api" % "9.1.6"
+  lazy val pluginsApi = "com.codacy" %% "codacy-plugins-api" % "10.0.0"
 
   lazy val pprint = "com.lihaoyi" %% "pprint" % "0.5.7"