feat(fossid-webapp): Fill the snippet additional data

This information will be accessed in a future commit to fill a FossID
snippet report which will be added to ORT.
Additionally, the `id` will be used to fetch the matched lines of a
snippet using the function `FossIdRestService.listMatchedLines`.

Signed-off-by: Nicolas Nobelis <[email protected]>

Author: nnobelis

scanner/src/main/kotlin/scanners/fossid/FossId.kt

@@ -132,6 +132,18 @@ class FossId internal constructor(
         @JvmStatic
         internal val PROJECT_REVISION_LABEL = "projectVcsRevision"
 
+        @JvmStatic
+        internal val SNIPPET_DATA_ID = "id"
+
+        @JvmStatic
+        internal val SNIPPET_DATA_MATCH_TYPE = "matchType"
+
+        @JvmStatic
+        internal val SNIPPET_DATA_FILE = "file"
+
+        @JvmStatic
+        internal val SNIPPET_DATA_RELEASE_DATE = "releaseDate"
+
         /**
          * The scan states for which a scan can be triggered.
          */
@@ -825,6 +837,13 @@ class FossId internal constructor(
                 val snippetProvenance = ArtifactProvenance(RemoteArtifact(it.url, Hash.NONE))
                 val purl = it.purl ?: "pkg:${urlToPackageType(it.url)}/${it.author}/${it.artifact}@${it.version}"
 
+                val additionalSnippetData = mapOf(
+                    SNIPPET_DATA_ID to it.id.toString(),
+                    SNIPPET_DATA_FILE to it.file,
+                    SNIPPET_DATA_MATCH_TYPE to it.matchType.toString(),
+                    SNIPPET_DATA_RELEASE_DATE to it.releaseDate.orEmpty()
+                )
+
                 // TODO: FossID doesn't return the line numbers of the match, only the character range. One must use
                 //       another call "getMatchedLine" to retrieve the matched line numbers. Unfortunately, this is a
                 //       call per snippet which is too expensive. When it is available for a batch of snippets, it can
@@ -834,7 +853,8 @@ class FossId internal constructor(
                     TextLocation(it.file, TextLocation.UNKNOWN_LINE),
                     snippetProvenance,
                     purl,
-                    license
+                    license,
+                    additionalSnippetData
                 )
             }
 

scanner/src/test/kotlin/scanners/fossid/FossIdTest.kt

@@ -1319,7 +1319,13 @@ private fun createSnippetFindings(index: Int): Set<SnippetFinding> = (1..5).map
             TextLocation("file$snippetIndex", TextLocation.UNKNOWN_LINE),
             ArtifactProvenance(RemoteArtifact("url$snippetIndex", Hash.NONE)),
             "pkg:generic/author$snippetIndex/artifact$snippetIndex@version$snippetIndex",
-            SpdxExpression.parse("MIT")
+            SpdxExpression.Companion.parse("MIT"),
+            mapOf(
+                FossId.SNIPPET_DATA_ID to "$snippetIndex",
+                FossId.SNIPPET_DATA_FILE to "file$snippetIndex",
+                FossId.SNIPPET_DATA_RELEASE_DATE to "releaseDate$snippetIndex",
+                FossId.SNIPPET_DATA_MATCH_TYPE to MatchType.PARTIAL.toString()
+            )
         )
     )
 }.toSet()