WIP

Author: james-fossa

Changelog.md

@@ -1,5 +1,9 @@
 # FOSSA CLI Changelog
 
+## 3.11.0
+
+- Add a dependency on Ficus, a new internal tool.
+
 ## 3.10.14
 
 - gradle: Do not report version constraints, version contraints are contained within an`DependencyResult`, filter out any constraints by checking [`isConstraint()`](https://docs.gradle.org/current/javadoc/org/gradle/api/artifacts/result/DependencyResult.html#isConstraint()). ([#1563](https://github.com/fossas/fossa-cli/pull/1563))

src/App/Fossa/Analyze.hs

@@ -50,6 +50,8 @@ import App.Fossa.Config.Analyze (
  )
 import App.Fossa.Config.Analyze qualified as Config
 import App.Fossa.Config.Common (DestinationMeta (..), destinationApiOpts, destinationMetadata)
+import App.Fossa.Ficus.Analyze (analyzeWithFicus)
+import App.Fossa.Ficus.Types (FicusResults (..))
 import App.Fossa.FirstPartyScan (runFirstPartyScan)
 import App.Fossa.Lernie.Analyze (analyzeWithLernie)
 import App.Fossa.Lernie.Types (LernieResults (..))
@@ -335,6 +337,14 @@ analyze cfg = Diag.context "fossa-analyze" $ do
         if (fromFlag BinaryDiscovery $ Config.binaryDiscoveryEnabled $ Config.vsiOptions cfg)
           then analyzeDiscoverBinaries basedir filters
           else pure Nothing
+  maybeFicusResults <-
+    Diag.errorBoundaryIO . diagToDebug $
+      if filterIsVSIOnly filters
+        then do
+          logInfo "Running in VSI only mode, skipping snippet-scan"
+          pure Nothing
+        else Diag.context "snippet-scanning" . runStickyLogger SevInfo $ analyzeWithFicus basedir maybeApiOpts grepOptions $ Config.licenseScanPathFilters vendoredDepsOptions --TODO: fix these options
+  let ficusResults = join . resultToMaybe $ maybeFicusResults
   maybeLernieResults <-
     Diag.errorBoundaryIO . diagToDebug $
       if filterIsVSIOnly filters

src/App/Fossa/Analyze/Types.hs

@@ -12,6 +12,7 @@ module App.Fossa.Analyze.Types (
 
 import App.Fossa.Analyze.Project (ProjectResult)
 import App.Fossa.Config.Analyze (ExperimentalAnalyzeConfig)
+import App.Fossa.Ficus.Types (FicusResults)
 import App.Fossa.Lernie.Types (LernieResults)
 import App.Fossa.Reachability.Types (SourceUnitReachability (..))
 import App.Types (Mode)
@@ -80,6 +81,7 @@ data AnalysisScanResult = AnalysisScanResult
   { analyzersScanResult :: [DiscoveredProjectScan]
   , vsiScanResult :: Result (Maybe [SourceUnit])
   , binaryDepsScanResult :: Result (Maybe SourceUnit)
+  , ficusResult :: Result (Maybe FicusResults)
   , fossaDepsScanResult :: Result (Maybe SourceUnit)
   , dynamicLinkingResult :: Result (Maybe SourceUnit)
   , lernieResult :: Result (Maybe LernieResults)

src/App/Fossa/EmbeddedBinary.hs

@@ -4,12 +4,14 @@
 
 module App.Fossa.EmbeddedBinary (
   BinaryPaths,
+  Ficus,
   Lernie,
   ThemisIndex,
   ThemisBins (..),
   toPath,
   withThemisAndIndex,
   withBerkeleyBinary,
+  withFicusBinary,
   withLernieBinary,
   withMillhoneBinary,
   withCirceBinary,
@@ -57,6 +59,7 @@ data PackagedBinary
   = Themis
   | ThemisIndex
   | BerkeleyDB
+  | Ficus
   | Lernie
   | Millhone
   | Circe
@@ -77,6 +80,8 @@ data ThemisIndex
 
 data Lernie
 
+data Ficus
+
 data Circe
 
 data ThemisBins = ThemisBins
@@ -116,6 +121,9 @@ withBerkeleyBinary = withEmbeddedBinary BerkeleyDB
 withLernieBinary :: (Has (Lift IO) sig m) => (BinaryPaths -> m c) -> m c
 withLernieBinary = withEmbeddedBinary Lernie
 
+withFicusBinary :: (Has (Lift IO) sig m) => (BinaryPaths -> m c) -> m c
+withFicusBinary = withEmbeddedBinary Ficus
+
 withMillhoneBinary :: (Has (Lift IO) sig m) => (BinaryPaths -> m c) -> m c
 withMillhoneBinary = withEmbeddedBinary Millhone
 
@@ -148,6 +156,7 @@ writeBinary dest bin = sendIO . writeExecutable dest $ case bin of
   Themis -> embeddedBinaryThemis
   ThemisIndex -> embeddedBinaryThemisIndex
   BerkeleyDB -> embeddedBinaryBerkeleyDB
+  Ficus -> embeddedBinaryFicus
   Lernie -> embeddedBinaryLernie
   Millhone -> embeddedBinaryMillhone
   Circe -> embeddedBinaryCirce
@@ -163,6 +172,7 @@ extractedPath bin = case bin of
   Themis -> $(mkRelFile "themis-cli")
   ThemisIndex -> $(mkRelFile "index.gob.xz")
   BerkeleyDB -> $(mkRelFile "berkeleydb-plugin")
+  Ficus -> $(mkRelFile "ficus")
   Lernie -> $(mkRelFile "lernie")
   Millhone -> $(mkRelFile "millhone")
   Circe -> $(mkRelFile "circe")
@@ -211,6 +221,9 @@ embeddedBinaryLernie = $(embedFileIfExists "vendor-bins/lernie")
 embeddedBinaryCirce :: ByteString
 embeddedBinaryCirce = $(embedFileIfExists "vendor-bins/circe")
 
+embeddedBinaryFicus :: ByteString
+embeddedBinaryFicus = $(embedFileIfExists "vendor-bins/ficus")
+
 -- To build this, run `make build` or `cargo build --release`.
 #ifdef mingw32_HOST_OS
 embeddedBinaryMillhone :: ByteString