refactored project structure

nikololiahim · nikololiahim · commit 2472321b75b3 · 2022-05-27T19:31:23.000+03:00
diff --git a/build.sbt b/build.sbt
@@ -27,7 +27,7 @@ assembly / mainClass := Some("org.polystat.Main")
 
 enablePlugins(BuildInfoPlugin)
 buildInfoKeys := Seq(version)
-buildInfoPackage := "org.polystat"
+buildInfoPackage := "org.polystat.cli"
 
 Global / excludeLintKeys += nativeImageVersion
 
diff --git a/src/main/scala/org/polystat/cli/EO.scala b/src/main/scala/org/polystat/cli/EO.scala
@@ -1,14 +1,17 @@
-package org.polystat
+package org.polystat.cli
 
 import cats.effect.IO
-import PolystatConfig.*
-import InputUtils.*
+import cats.syntax.foldable.*
+import cats.syntax.traverse.*
+import io.circe.syntax.*
 import org.polystat.odin.analysis.ASTAnalyzer
 import org.polystat.odin.analysis.EOOdinAnalyzer
 import org.polystat.odin.parser.EoParser.sourceCodeEoParser
-import cats.syntax.traverse.*
-import cats.syntax.foldable.*
-import io.circe.syntax.*
+import org.polystat.sarif.AggregatedSarifOutput
+import org.polystat.sarif.SarifOutput
+
+import PolystatConfig.*
+import InputUtils.*
 
 object EO:
 
diff --git a/src/main/scala/org/polystat/cli/HoconConfig.scala b/src/main/scala/org/polystat/cli/HoconConfig.scala
@@ -1,4 +1,4 @@
-package org.polystat
+package org.polystat.cli
 
 import cats.Show
 import cats.data.NonEmptyList
diff --git a/src/main/scala/org/polystat/cli/InputUtils.scala b/src/main/scala/org/polystat/cli/InputUtils.scala
@@ -1,4 +1,4 @@
-package org.polystat
+package org.polystat.cli
 import cats.data.NonEmptyList
 import cats.effect.IO
 import fs2.Stream
diff --git a/src/main/scala/org/polystat/cli/Java.scala b/src/main/scala/org/polystat/cli/Java.scala
@@ -1,17 +1,18 @@
-package org.polystat
+package org.polystat.cli
 import cats.effect.*
 import cats.syntax.all.*
+import fs2.io.file.Files
+import fs2.io.file.Path
 import fs2.io.net.*
-import org.http4s.ember.client.EmberClientBuilder
-import org.http4s.ember.core.h2.*
-import org.http4s.implicits.*
-import org.http4s.Method.GET
 import fs2.text.utf8
+import org.http4s.Method.GET
 import org.http4s.Request
+import org.http4s.Uri
 import org.http4s.client.middleware.FollowRedirect
+import org.http4s.ember.client.EmberClientBuilder
+import org.http4s.ember.core.h2.*
+import org.http4s.implicits.*
 
-import fs2.io.file.{Path, Files}
-import org.http4s.Uri
 import sys.process.*
 import PolystatConfig.*
 import InputUtils.*
diff --git a/src/main/scala/org/polystat/cli/Main.scala b/src/main/scala/org/polystat/cli/Main.scala
@@ -1,4 +1,4 @@
-package org.polystat
+package org.polystat.cli
 
 import cats.effect.ExitCode
 import cats.effect.IO
@@ -14,12 +14,13 @@ import org.polystat.odin.analysis.ASTAnalyzer
 import org.polystat.odin.analysis.EOOdinAnalyzer
 import org.polystat.odin.analysis.EOOdinAnalyzer.OdinAnalysisResult
 import org.polystat.odin.parser.EoParser.sourceCodeEoParser
+import org.polystat.py2eo.parser.PythonLexer
 import org.polystat.py2eo.transpiler.Transpile
+import org.polystat.cli.BuildInfo
 
 import PolystatConfig.*
 import IncludeExclude.*
 import InputUtils.*
-import org.polystat.py2eo.parser.PythonLexer
 object Main extends IOApp:
   override def run(args: List[String]): IO[ExitCode] =
     for exitCode <- CommandIOApp.run(
diff --git a/src/main/scala/org/polystat/cli/PolystatConfig.scala b/src/main/scala/org/polystat/cli/PolystatConfig.scala
@@ -1,4 +1,4 @@
-package org.polystat
+package org.polystat.cli
 
 import cats.data.NonEmptyList
 import cats.effect.IO
diff --git a/src/main/scala/org/polystat/cli/PolystatOpts.scala b/src/main/scala/org/polystat/cli/PolystatOpts.scala
@@ -1,23 +1,23 @@
-package org.polystat
+package org.polystat.cli
 import cats.data.NonEmptyList
 import cats.data.Validated
+import cats.data.ValidatedNel
 import cats.effect.IO
 import cats.effect.IOApp
 import cats.syntax.all.*
+import com.monovore.decline.Argument
 import com.monovore.decline.Command
 import com.monovore.decline.Opts
 import fs2.io.file.Files
 import fs2.io.file.Path
-import org.polystat.PolystatConfig.*
-import com.monovore.decline.Argument
+import org.polystat.cli.PolystatConfig.*
+
 import java.io.FileNotFoundException
 import java.nio.file.Path as JPath
-import cats.data.ValidatedNel
 
 import IncludeExclude.*
 import Validated.*
 import InputUtils.toInput
-import com.monovore.decline.Argument
 
 object PolystatOpts:
 
diff --git a/src/main/scala/org/polystat/cli/Python.scala b/src/main/scala/org/polystat/cli/Python.scala
@@ -1,10 +1,12 @@
-package org.polystat
+package org.polystat.cli
 
+import cats.effect.IO
+import cats.effect.IOApp
+import fs2.io.file.Files
+import fs2.io.file.Path
+import org.polystat.cli.InputUtils.*
+import org.polystat.cli.PolystatConfig.*
 import org.polystat.py2eo.transpiler.Transpile
-import fs2.io.file.{Files, Path}
-import cats.effect.{IO, IOApp}
-import org.polystat.PolystatConfig.*
-import org.polystat.InputUtils.*
 
 object Python:
 
diff --git a/src/main/scala/org/polystat/sarif/AggregatedSarifOutput.scala b/src/main/scala/org/polystat/sarif/AggregatedSarifOutput.scala
@@ -0,0 +1,15 @@
+package org.polystat.sarif
+
+import fs2.io.file.Path
+import org.polystat.odin.analysis.EOOdinAnalyzer.OdinAnalysisResult
+
+import Sarif.*
+
+object AggregatedSarifOutput:
+  def fromAnalyzed(
+      analyzed: Map[Path, List[OdinAnalysisResult]]
+  ): Seq[SarifLog] =
+    analyzed.toSeq.map { case (path, results) =>
+      SarifOutput(path, results).sarif
+    }
+end AggregatedSarifOutput
diff --git a/src/main/scala/org/polystat/sarif/Sarif.scala b/src/main/scala/org/polystat/sarif/Sarif.scala
@@ -0,0 +1,108 @@
+package org.polystat.sarif
+
+import io.circe.Codec
+import io.circe.Decoder
+import io.circe.Encoder
+import io.circe.Json
+import org.polystat.cli.BuildInfo
+
+object Sarif:
+
+  final val SARIF_VERSION = "2.1.0"
+  final val SARIF_SCHEMA =
+    "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Documents/CommitteeSpecifications/2.1.0/sarif-schema-2.1.0.json"
+
+  final case class SarifLog(
+      runs: Seq[SarifRun],
+      version: String = SARIF_VERSION,
+      $schema: String = SARIF_SCHEMA,
+  ) derives Codec.AsObject
+
+  final case class SarifRun(
+      tool: SarifTool,
+      results: Seq[SarifResult],
+      invocations: Seq[SarifInvocation],
+  ) 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/",
+      semanticVersion: String = BuildInfo.version,
+  ) derives Codec.AsObject
+
+  final case class SarifResult(
+      ruleId: String,
+      level: SarifLevel,
+      kind: SarifKind,
+      message: SarifMessage,
+      locations: Seq[SarifLocation],
+  ) derives Codec.AsObject
+
+  final case class SarifLocation(
+      physicalLocation: SarifPhysicalLocation
+  ) derives Codec.AsObject
+
+  final case class SarifPhysicalLocation(
+      artifactLocation: SarifArtifactLocation
+  ) derives Codec.AsObject
+
+  final case class SarifArtifactLocation(
+      uri: String
+  ) derives Codec.AsObject
+
+  enum SarifLevel:
+    case ERROR, NONE
+
+  given Encoder[SarifLevel] with
+    final def apply(a: SarifLevel): Json = a match
+      case SarifLevel.ERROR => Json.fromString("error")
+      case SarifLevel.NONE  => Json.fromString("none")
+  end given
+
+  given Decoder[SarifLevel] with
+    def apply(c: io.circe.HCursor): Decoder.Result[SarifLevel] =
+      c.get[String]("level").map {
+        case "error" => SarifLevel.ERROR
+        case "none"  => SarifLevel.NONE
+      }
+  end given
+
+  enum SarifKind:
+    case FAIL, PASS
+
+  given Encoder[SarifKind] with
+    final def apply(a: SarifKind): Json = a match
+      case SarifKind.PASS => Json.fromString("pass")
+      case SarifKind.FAIL => Json.fromString("fail")
+  end given
+
+  given Decoder[SarifKind] with
+    def apply(c: io.circe.HCursor): Decoder.Result[SarifKind] =
+      c.get[String]("kind").map {
+        case "pass" => SarifKind.PASS
+        case "fail" => SarifKind.FAIL
+      }
+  end given
+
+  final case class SarifMessage(text: String) derives Codec.AsObject
+
+  final case class SarifInvocation(
+      toolExecutionNotifications: Seq[SarifNotification],
+      executionSuccessful: Boolean,
+  ) derives Codec.AsObject
+
+  final case class SarifNotification(
+      level: Option[SarifLevel],
+      message: SarifMessage,
+      exception: Option[SarifException],
+      associatedRule: SarifReportingDescriptor,
+  ) derives Codec.AsObject
+
+  final case class SarifException(kind: String, message: String)
+      derives Codec.AsObject
+
+  final case class SarifReportingDescriptor(id: String) derives Codec.AsObject
+
+end Sarif
diff --git a/src/main/scala/org/polystat/sarif/SarifOutput.scala b/src/main/scala/org/polystat/sarif/SarifOutput.scala
diff --git a/src/test/scala/org/polystat/HoconConfigTests.scala b/src/test/scala/org/polystat/HoconConfigTests.scala

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package org.polystat`
	`1`	`+package org.polystat.cli`
`2`	`2`
`3`	`3`	`import cats.Show`
`4`	`4`	`import cats.data.NonEmptyList`