generating clearer aggregated sarif output

Author: nikololiahim

src/main/scala/org/polystat/cli/EO.scala

@@ -63,11 +63,7 @@ object EO:
         cfg.fmts.traverse_ { case OutputFormat.Sarif =>
           for
             _ <- IO.println(s"Writing aggregated output to $outputPath...")
-            sariOutput = AggregatedSarifOutput
-              .fromAnalyzed(analyzed)
-              .asJson
-              .deepDropNullValues
-              .toString
+            sariOutput = AggregatedSarifOutput(analyzed).json.toString
             _ <- writeOutputTo(outputPath)(sariOutput)
           yield ()
         }

src/main/scala/org/polystat/sarif/AggregatedSarifOutput.scala

@@ -1,19 +1,22 @@
 package org.polystat.sarif
 
 import fs2.io.file.Path
+import io.circe.Json
+import io.circe.syntax.*
 import org.polystat.odin.analysis.EOOdinAnalyzer.OdinAnalysisResult
+import org.polystat.cli.BuildInfo
 
 import Sarif.*
 
 case class AggregatedSarifOutput(
     analyzed: Seq[(Path, List[OdinAnalysisResult])]
-)
-
-object AggregatedSarifOutput:
-  def fromAnalyzed(
-      analyzed: Seq[(Path, List[OdinAnalysisResult])]
-  ): Seq[SarifLog] =
-    analyzed.map { case (path, results) =>
-      SarifOutput(path, results).sarif
-    }
+):
+  val sarif: SarifLog = SarifLog(
+    runs = analyzed.map { case (path, errors) =>
+      SarifOutput.sarifRun(path, errors)
+    },
+    version = SARIF_VERSION,
+    $schema = SARIF_SCHEMA,
+  )
+  val json: Json = sarif.asJson.deepDropNullValues
 end AggregatedSarifOutput

src/main/scala/org/polystat/sarif/Sarif.scala

@@ -20,15 +20,20 @@ object Sarif:
 
   final case class SarifRun(
       tool: SarifTool,
+      artifacts: Seq[SarifArtifact],
       results: Seq[SarifResult],
       invocations: Seq[SarifInvocation],
   ) derives Codec.AsObject
 
+  final case class SarifArtifact(
+      location: SarifArtifactLocation
+  ) derives Codec.AsObject
+
   final case class SarifTool(driver: SarifDriver) derives Codec.AsObject
 
   final case class SarifDriver(
-      name: String = "Polystat",
-      informationUri: String = "https://www.polystat.org/",
+      name: String = "Polystat CLI",
+      informationUri: String = "https://github.com/nikololiahim/polystat-cli",
       semanticVersion: String = BuildInfo.version,
   ) derives Codec.AsObject
 
@@ -37,7 +42,7 @@ object Sarif:
       level: SarifLevel,
       kind: SarifKind,
       message: SarifMessage,
-      locations: Seq[SarifLocation],
+      locations: Option[Seq[SarifLocation]],
   ) derives Codec.AsObject
 
   final case class SarifLocation(

src/main/scala/org/polystat/sarif/SarifOutput.scala

@@ -14,17 +14,28 @@ import OdinAnalysisResult.*
 import Sarif.*
 
 final case class SarifOutput(filePath: Path, errors: List[OdinAnalysisResult]):
-  def json: Json = sarif.asJson.deepDropNullValues
-
-  private val sarifRun: SarifRun = SarifRun(
-    SarifTool(SarifDriver()),
-    results = errors.mapFilter(sarifResult),
-    invocations = errors.map(sarifInvocation),
-  )
+  private val sarifRun: SarifRun = SarifOutput.sarifRun(filePath, errors)
 
   val sarif: SarifLog = SarifLog(Seq(sarifRun))
 
-  private def sarifInvocation(
+  val json: Json = sarif.asJson.deepDropNullValues
+
+end SarifOutput
+
+object SarifOutput:
+
+  def sarifRun(filePath: Path, errors: List[OdinAnalysisResult]): SarifRun =
+    SarifRun(
+      tool = SarifTool(SarifDriver()),
+      results = errors.mapFilter(SarifOutput.sarifResult),
+      invocations = errors.map(SarifOutput.sarifInvocation),
+      artifacts = Seq(
+        SarifArtifact(location =
+          SarifArtifactLocation(uri = filePath.toNioPath.toUri.toString)
+        )
+      ),
+    )
+  def sarifInvocation(
       error: OdinAnalysisResult
   ): SarifInvocation =
     error match
@@ -74,7 +85,7 @@ final case class SarifOutput(filePath: Path, errors: List[OdinAnalysisResult]):
           executionSuccessful = true,
         )
 
-  private def sarifResult(error: OdinAnalysisResult): Option[SarifResult] =
+  def sarifResult(error: OdinAnalysisResult): Option[SarifResult] =
     error match
       case AnalyzerFailure(_, _) => None
       case DefectsDetected(ruleId, message) =>
@@ -84,13 +95,7 @@ final case class SarifOutput(filePath: Path, errors: List[OdinAnalysisResult]):
             level = SarifLevel.ERROR,
             kind = SarifKind.FAIL,
             message = SarifMessage(message.mkString_("\n")),
-            locations = Seq(
-              SarifLocation(physicalLocation =
-                SarifPhysicalLocation(artifactLocation =
-                  SarifArtifactLocation(uri = filePath.toNioPath.toUri.toString)
-                )
-              )
-            ),
+            locations = None,
           )
         )
       case Ok(ruleId) =>
@@ -100,13 +105,7 @@ final case class SarifOutput(filePath: Path, errors: List[OdinAnalysisResult]):
             level = SarifLevel.NONE,
             kind = SarifKind.PASS,
             message = SarifMessage("No errors were found."),
-            locations = Seq(
-              SarifLocation(physicalLocation =
-                SarifPhysicalLocation(artifactLocation =
-                  SarifArtifactLocation(uri = filePath.toNioPath.toUri.toString)
-                )
-              )
-            ),
+            locations = None,
           )
         )
 end SarifOutput