feat(scanner): Expose includes in the scan context

As for the excludes, the includes are only passed to scanners without a
scanner matcher i.e. scanners for which results are never taken from a scan
storage. This is for preventing the need to do an invalidation of the scan
results if the includes change.

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

Author: nnobelis

scanner/src/main/kotlin/ScanContext.kt

@@ -24,6 +24,7 @@ import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.PackageType
 import org.ossreviewtoolkit.model.config.Excludes
+import org.ossreviewtoolkit.model.config.Includes
 import org.ossreviewtoolkit.model.config.ScannerConfiguration
 import org.ossreviewtoolkit.model.config.SnippetChoices
 import org.ossreviewtoolkit.utils.spdx.SpdxExpression
@@ -47,6 +48,11 @@ data class ScanContext(
      */
     val excludes: Excludes? = null,
 
+    /**
+     * The [Includes] of the project to scan.
+     */
+    val includes: Includes? = null,
+
     /**
      * The detected license mappings configured in the
      * [scanner configuration][ScannerConfiguration.detectedLicenseMapping]. Can be used by [ScannerWrapper]

scanner/src/main/kotlin/Scanner.kt

@@ -114,6 +114,7 @@ class Scanner(
                 ortResult.labels + labels,
                 PackageType.PROJECT,
                 ortResult.repository.config.excludes,
+                ortResult.repository.config.includes,
                 scannerConfig.detectedLicenseMapping,
                 snippetChoices = ortResult.repository.config.snippetChoices
             )
@@ -127,6 +128,7 @@ class Scanner(
                 ortResult.labels,
                 PackageType.PACKAGE,
                 ortResult.repository.config.excludes,
+                ortResult.repository.config.includes,
                 scannerConfig.detectedLicenseMapping,
                 snippetChoices = ortResult.repository.config.snippetChoices
             )
@@ -332,8 +334,9 @@ class Scanner(
                 val nestedProvenance = controller.getNestedProvenance(referencePackage.id) ?: return@scanner
 
                 val adjustedContext = context.copy(
-                    // Hide excludes from scanners with a scanner matcher.
+                    // Hide includes and excludes from scanners with a scanner matcher.
                     excludes = context.excludes.takeUnless { scanner.matcher != null },
+                    includes = context.includes.takeUnless { scanner.matcher != null },
                     // Tell scanners also about the non-reference packages.
                     coveredPackages = packagesWithIncompleteScanResult
                 )
@@ -399,8 +402,13 @@ class Scanner(
                         "'${scanner.descriptor.displayName}'."
                 }
 
-                // Filter the scan context to hide the excludes from scanner with scan matcher.
-                val filteredContext = if (scanner.matcher == null) context else context.copy(excludes = null)
+                // Filter the scan context to hide the includes and excludes from scanner with scan matcher.
+                val filteredContext = if (scanner.matcher == null) {
+                    context
+                } else {
+                    context.copy(excludes = null, includes = null)
+                }
+
                 val scanResult = scanner.scanProvenance(provenance, filteredContext)
 
                 val completedPackages = controller.getPackagesCompletedByProvenance(scanner, provenance)
@@ -581,8 +589,12 @@ class Scanner(
         val results = scanners.mapNotNull { scanner ->
             logger.info { "Scan of $provenance with path scanner '${scanner.descriptor.displayName}' started." }
 
-            // Filter the scan context to hide the excludes from scanner with scan matcher.
-            val filteredContext = if (scanner.matcher == null) context else context.copy(excludes = null)
+            // Filter the scan context to hide the includes and excludes from scanner with scan matcher.
+            val filteredContext = if (scanner.matcher == null) {
+                context
+            } else {
+                context.copy(excludes = null, includes = null)
+            }
 
             val summary = runCatching {
                 scanner.scanPath(downloadDir, filteredContext)