Merge pull request #293 from codacy/add-sarif-formatter

feature: Add sarif formatter

Author: rtfpessoa

.circleci/config.yml

@@ -144,18 +144,21 @@ workflows:
           write_sbt_version: true
       - codacy/sbt:
           name: compile
+          install_sbt_version: 1.3.12
           cmd: sbt coverage +test:compile
           persist_to_workspace: true
           requires:
             - codacy/checkout_and_version
       - codacy/sbt:
           name: lint
+          install_sbt_version: 1.3.12
           cmd: |
             sbt "scalafmtCheckAll;scalafmtSbtCheck;scapegoat;scalafixEnable;scalafix --test"
           requires:
             - compile
       - codacy/sbt:
           name: test
+          install_sbt_version: 1.3.12
           cmd: |
             git config --global user.email "team@codacy.com"
             git config --global user.name "Codacy Team"
@@ -165,6 +168,7 @@ workflows:
             - compile
       - codacy/sbt:
           name: publish_docker_locally
+          install_sbt_version: 1.3.12
           cmd: |
             sbt "set codacyAnalysisCli / version := \"dev-snapshot\";
                  codacyAnalysisCli/docker:publishLocal"
@@ -186,6 +190,7 @@ workflows:
             - maven_dependencies
       - codacy/sbt:
           name: publish_lib
+          install_sbt_version: 1.3.12
           context: CodacyAWS
           cmd: |
             sbt "retrieveGPGKeys;

.jvmopts

@@ -0,0 +1,6 @@
+-XX:+UnlockExperimentalVMOptions
+-XX:+UseCGroupMemoryLimitForHeap
+-XX:MaxRAMFraction=1
+-Xms1024M
+-Xss256M
+-Xmx3072M

cli/src/main/scala/com/codacy/analysis/cli/analysis/AnalyseExecutor.scala

@@ -15,7 +15,10 @@ import com.codacy.analysis.core.utils.InheritanceOps.InheritanceOps
 import com.codacy.analysis.core.utils.SeqOps._
 import com.codacy.analysis.core.utils.TryOps._
 import com.codacy.analysis.core.utils.{LanguagesHelper, SetOps}
+import com.codacy.plugins.api.PatternDescription
 import com.codacy.plugins.api.languages.Language
+import com.codacy.plugins.results.traits.DockerToolDocumentation
+import com.codacy.plugins.utils.impl.CacheDockerHelper
 import org.log4s.{Logger, getLogger}
 import play.api.libs.json.JsValue
 
@@ -54,10 +57,18 @@ class AnalyseExecutor(formatter: Formatter,
 
           tool match {
             case tool: Tool =>
+              val toolDocumentation = ToolCollector
+                .fromUuid(tool.uuid)
+                .map(dockerTool => new DockerToolDocumentation(dockerTool, new CacheDockerHelper()))
               val toolHasConfigFiles = fileCollector.hasConfigurationFiles(tool, allFiles)
               val analysisResults =
                 issues(tool, filteredFiles, configuration.toolConfiguration, toolHasConfigFiles)
-              IssuesToolExecutorResult(tool.name, filteredFiles.readableFiles, analysisResults)
+              IssuesToolExecutorResult(
+                tool.name,
+                toolDocumentation.flatMap(_.toolSpecification),
+                toolDocumentation.flatMap(_.patternDescriptions).getOrElse(Set.empty[PatternDescription]),
+                filteredFiles.readableFiles,
+                analysisResults)
             case metricsTool: MetricsTool =>
               val analysisResults =
                 analyser.metrics(metricsTool, filteredFiles.directory, Some(filteredFiles.readableFiles))
@@ -91,7 +102,13 @@ class AnalyseExecutor(formatter: Formatter,
       val executorResults = issuesResults ++ duplicationResults ++ processedFileMetrics
 
       formatter.begin()
-      executorResults.foreach(_.analysisResults.foreach(results => formatter.addAll(results.to[List])))
+      executorResults.foreach {
+        case toolResults: IssuesToolExecutorResult =>
+          toolResults.analysisResults.foreach(results =>
+            formatter.addAll(toolResults.toolSpecification, toolResults.patternDescriptions, results.to[List]))
+        case toolResults =>
+          toolResults.analysisResults.foreach(results => formatter.addAll(None, Set.empty, results.to[List]))
+      }
       formatter.end()
 
       executorResults
@@ -180,7 +197,12 @@ object AnalyseExecutor {
     def analysisResults: Try[Set[T]]
   }
 
-  final case class IssuesToolExecutorResult(toolName: String, files: Set[Path], analysisResults: Try[Set[ToolResult]])
+  final case class IssuesToolExecutorResult(
+    toolName: String,
+    toolSpecification: Option[com.codacy.plugins.api.results.Tool.Specification],
+    patternDescriptions: Set[PatternDescription],
+    files: Set[Path],
+    analysisResults: Try[Set[ToolResult]])
       extends ExecutorResult[ToolResult]
 
   final case class MetricsToolExecutorResult(language: String, files: Set[Path], analysisResults: Try[Set[FileMetrics]])

cli/src/main/scala/com/codacy/analysis/cli/command/AnalyseCommand.scala

@@ -40,7 +40,10 @@ object AnalyseCommand {
     val configuration: CLIConfiguration =
       CLIConfiguration(codacyClientOpt, environment, analyse, new CodacyConfigurationFileLoader)
     val formatter: Formatter =
-      Formatter(configuration.analysis.output.format, configuration.analysis.output.file)
+      Formatter(
+        configuration.analysis.output.format,
+        environment.baseProjectDirectory(analyse.directory),
+        configuration.analysis.output.file)
     val fileCollector: FileCollector[Try] = FileCollector.defaultCollector()
     val analyseExecutor: AnalyseExecutor =
       new AnalyseExecutor(formatter, Analyser(analyse.extras.analyser), fileCollector, configuration.analysis)
@@ -200,9 +203,9 @@ class AnalyseCommand(analyse: Analyse,
 
   private def issuesToUpload(toolAndIssuesResults: Seq[IssuesToolExecutorResult]): Seq[ResultsUploader.ToolResults] = {
     toolAndIssuesResults.map {
-      case IssuesToolExecutorResult(toolName, files, Success(issues)) =>
+      case IssuesToolExecutorResult(toolName, _, _, files, Success(issues)) =>
         ResultsUploader.ToolResults(toolName, files, Right(issues))
-      case IssuesToolExecutorResult(toolName, files, Failure(error)) =>
+      case IssuesToolExecutorResult(toolName, _, _, files, Failure(error)) =>
         ResultsUploader.ToolResults(toolName, files, Left(error.getMessage))
     }(collection.breakOut)
   }

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

@@ -4,11 +4,12 @@ import java.io.{FileOutputStream, PrintStream}
 
 import better.files.File
 import com.codacy.analysis.core.model.Result
+import com.codacy.plugins.api.PatternDescription
 import org.log4s.{Logger, getLogger}
 
 trait FormatterCompanion {
   def name: String
-  def apply(stream: PrintStream): Formatter
+  def apply(outputStream: PrintStream, executionDirectory: File): Formatter
 }
 
 trait Formatter {
@@ -17,9 +18,9 @@ trait Formatter {
 
   def begin(): Unit
 
-  def add(element: Result): Unit
-
-  def addAll(elements: Seq[Result]): Unit = elements.foreach(add)
+  def addAll(toolSpecification: Option[com.codacy.plugins.api.results.Tool.Specification],
+             patternDescriptions: Set[PatternDescription],
+             elements: Seq[Result]): Unit
 
   def end(): Unit
 
@@ -33,20 +34,21 @@ object Formatter {
 
   val defaultFormatter: FormatterCompanion = Text
 
-  val allFormatters: Set[FormatterCompanion] = Set(defaultFormatter, Json)
+  val allFormatters: Set[FormatterCompanion] = Set(defaultFormatter, Json, Sarif)
 
-  def apply(name: String,
-            file: Option[File] = Option.empty,
+  def apply(formatterName: String,
+            executionDirectory: File,
+            outputFile: Option[File] = Option.empty,
             printStream: Option[PrintStream] = Option.empty): Formatter = {
 
-    val builder = allFormatters.find(_.name.equalsIgnoreCase(name)).getOrElse {
-      logger.warn(s"Could not find formatter for name $name. Using ${defaultFormatter.name} as fallback.")
+    val builder = allFormatters.find(_.name.equalsIgnoreCase(formatterName)).getOrElse {
+      logger.warn(s"Could not find formatter for name $formatterName. Using ${defaultFormatter.name} as fallback.")
       defaultFormatter
     }
 
-    val stream = file.map(asPrintStream).orElse(printStream).getOrElse(defaultPrintStream)
+    val stream = outputFile.map(asPrintStream).orElse(printStream).getOrElse(defaultPrintStream)
 
-    builder(stream)
+    builder(stream, executionDirectory)
   }
 
   private def asPrintStream(file: File) = {

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

@@ -3,17 +3,18 @@ package com.codacy.analysis.cli.formatter
 import java.io.PrintStream
 import java.nio.file.Path
 
+import better.files.File
 import com.codacy.analysis.core.model.Result
-import com.codacy.plugins.api.results
+import com.codacy.plugins.api.{PatternDescription, results}
 import io.circe.Encoder
 import io.circe.generic.auto._
 import io.circe.syntax._
 
 import scala.util.Properties
 
 object Json extends FormatterCompanion {
-  val name: String = "json"
-  def apply(stream: PrintStream): Formatter = new Json(stream)
+  override val name: String = "json"
+  override def apply(outputStream: PrintStream, executionDirectory: File): Formatter = new Json(outputStream)
 }
 
 private[formatter] class Json(val stream: PrintStream) extends Formatter {
@@ -37,7 +38,11 @@ private[formatter] class Json(val stream: PrintStream) extends Formatter {
     stream.flush()
   }
 
-  def add(element: Result): Unit = {
+  override def addAll(toolSpecification: Option[com.codacy.plugins.api.results.Tool.Specification],
+                      patternDescriptions: Set[PatternDescription],
+                      elements: Seq[Result]): Unit = elements.foreach(add)
+
+  private def add(element: Result): Unit = {
     if (alreadyPrinted) stream.print(",") else alreadyPrinted = true
     stream.print(element.asJson.noSpaces)
   }