feat(evaluated-model): Add path includes properties to the evaluated model

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

Author: nnobelis

plugins/reporters/evaluated-model/src/main/kotlin/EvaluatedFinding.kt

@@ -38,5 +38,9 @@ data class EvaluatedFinding(
     val endLine: Int,
     val scanResult: EvaluatedScanResult,
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
-    val pathExcludes: List<PathExclude>
+    val pathExcludes: List<PathExclude>,
+
+    // If the finding is excluded by the presence of a [PathInclude], this property is true.
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    val isExcludedByPathIncludes: Boolean
 )

plugins/reporters/evaluated-model/src/main/kotlin/EvaluatedModel.kt

@@ -43,6 +43,7 @@ import org.ossreviewtoolkit.model.config.RepositoryConfiguration
 import org.ossreviewtoolkit.model.config.RuleViolationResolution
 import org.ossreviewtoolkit.model.config.ScopeExclude
 import org.ossreviewtoolkit.model.config.VulnerabilityResolution
+import org.ossreviewtoolkit.model.config.PathInclude
 import org.ossreviewtoolkit.model.mapperConfig
 import org.ossreviewtoolkit.reporter.Reporter
 import org.ossreviewtoolkit.reporter.ReporterInput
@@ -91,6 +92,7 @@ import org.ossreviewtoolkit.reporter.Statistics
  */
 data class EvaluatedModel(
     val pathExcludes: List<PathExclude>,
+    val pathIncludes: List<PathInclude>,
     val scopeExcludes: List<ScopeExclude>,
     val copyrights: List<CopyrightStatement>,
     val licenses: List<LicenseId>,

plugins/reporters/evaluated-model/src/main/kotlin/EvaluatedModelMapper.kt

@@ -44,6 +44,7 @@ import org.ossreviewtoolkit.model.config.Resolutions
 import org.ossreviewtoolkit.model.config.RuleViolationResolution
 import org.ossreviewtoolkit.model.config.ScopeExclude
 import org.ossreviewtoolkit.model.config.VulnerabilityResolution
+import org.ossreviewtoolkit.model.config.PathInclude
 import org.ossreviewtoolkit.model.licenses.LicenseView
 import org.ossreviewtoolkit.model.toYaml
 import org.ossreviewtoolkit.model.utils.FindingCurationMatcher
@@ -59,7 +60,7 @@ import org.ossreviewtoolkit.utils.spdx.calculatePackageVerificationCode
 /**
  * Maps the [reporter input][input] to an [EvaluatedModel].
  */
-@Suppress("TooManyFunctions")
+@Suppress("LargeClass", "TooManyFunctions")
 internal class EvaluatedModelMapper(private val input: ReporterInput) {
     private val packages = mutableMapOf<Identifier, EvaluatedPackage>()
     private val paths = mutableListOf<EvaluatedPackagePath>()
@@ -71,6 +72,7 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
     private val issues = mutableListOf<EvaluatedIssue>()
     private val issueResolutions = mutableListOf<IssueResolution>()
     private val pathExcludes = mutableListOf<PathExclude>()
+    private val pathIncludes = mutableListOf<PathInclude>()
     private val scopeExcludes = mutableListOf<ScopeExclude>()
     private val ruleViolations = mutableListOf<EvaluatedRuleViolation>()
     private val ruleViolationResolutions = mutableListOf<RuleViolationResolution>()
@@ -84,6 +86,7 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
         var id: Identifier,
         var isExcluded: Boolean,
         val pathExcludes: MutableList<PathExclude> = mutableListOf(),
+        val pathIncludes: MutableList<PathInclude> = mutableListOf(),
         val scopeExcludes: MutableList<ScopeExclude> = mutableListOf()
     )
 
@@ -134,6 +137,7 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
 
         return EvaluatedModel(
             pathExcludes = pathExcludes,
+            pathIncludes = pathIncludes,
             scopeExcludes = scopeExcludes,
             issueResolutions = issueResolutions,
             issues = issues,
@@ -169,21 +173,26 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
 
         input.ortResult.getProjects().forEach { project ->
             val pathExcludes = input.ortResult.getExcludes().findPathExcludes(project, input.ortResult)
+            val pathIncludes = input.ortResult.getIncludes().findPathIncludes(project, input.ortResult)
             val dependencies = input.ortResult.dependencyNavigator.projectDependencies(project)
-            if (pathExcludes.isEmpty()) {
+            if (pathExcludes.isEmpty() && pathIncludes.isEmpty()) {
                 val info = packageExcludeInfo.getValue(project.id)
                 if (info.isExcluded) {
                     info.isExcluded = false
                     info.pathExcludes.clear()
                     info.scopeExcludes.clear()
                 }
+
+                info.pathIncludes.clear()
             } else {
                 dependencies.forEach { id ->
                     val info = packageExcludeInfo.getOrPut(id) { PackageExcludeInfo(id, true) }
 
                     if (info.isExcluded) {
                         info.pathExcludes += pathExcludes
                     }
+
+                    info.pathIncludes += pathIncludes
                 }
             }
 
@@ -238,6 +247,14 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
                 .flatMap { it.pathExcludes }
         }
 
+    private fun getPathIncludes(id: Identifier, provenance: Provenance): List<PathInclude> =
+        if (input.ortResult.isProject(id)) {
+            input.ortResult.getIncludes().paths
+        } else {
+            input.ortResult.getPackageConfigurations(id, provenance)
+                .flatMap { it.pathIncludes }
+        }
+
     private fun addProject(project: Project) {
         val scanResults = mutableListOf<EvaluatedScanResult>()
         val detectedLicenses = mutableSetOf<LicenseId>()
@@ -246,7 +263,9 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
         val issues = mutableListOf<EvaluatedIssue>()
 
         val applicablePathExcludes = input.ortResult.getExcludes().findPathExcludes(project, input.ortResult)
+        val applicablePathIncludes = input.ortResult.getIncludes().findPathIncludes(project, input.ortResult)
         val evaluatedPathExcludes = pathExcludes.addIfRequired(applicablePathExcludes)
+        pathIncludes.addIfRequired(applicablePathIncludes)
 
         val evaluatedPackage = EvaluatedPackage(
             id = project.id,
@@ -287,7 +306,8 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
         findings.filter { it.type == EvaluatedFindingType.LICENSE }.mapNotNullTo(detectedLicenses) { it.license }
 
         val includedDetectedLicenses = findings.filter {
-            it.type == EvaluatedFindingType.LICENSE && it.pathExcludes.isEmpty()
+            val isIncluded = pathIncludes.isEmpty() || pathIncludes.any { include -> include.matches(it.path) }
+            it.type == EvaluatedFindingType.LICENSE && it.pathExcludes.isEmpty() && isIncluded
         }.mapNotNullTo(mutableSetOf()) { it.license }
 
         detectedExcludedLicenses += detectedLicenses - includedDetectedLicenses
@@ -660,6 +680,7 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
         findings: MutableList<EvaluatedFinding>
     ) {
         val pathExcludes = getPathExcludes(id, scanResult.provenance)
+        val pathIncludes = getPathIncludes(id, scanResult.provenance)
         val licenseFindingCurations = getLicenseFindingCurations(id, scanResult.provenance)
         // Sort the curated findings here to avoid the need to sort in the web-app each time it is loaded.
         val curatedFindings = curationsMatcher.applyAll(scanResult.summary.licenseFindings, licenseFindingCurations)
@@ -679,6 +700,16 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
                 val evaluatedPathExcludes = pathExcludes
                     .filter { it.matches(copyrightFinding.location.getRelativePathToRoot(id)) }
                     .let { this@EvaluatedModelMapper.pathExcludes.addIfRequired(it) }
+                pathIncludes.let { this@EvaluatedModelMapper.pathIncludes.addIfRequired(it) }
+
+                val evaluatedPathIncludes = if (pathIncludes.isEmpty() || pathIncludes.any { include ->
+                        include.matches(copyrightFinding.location.getRelativePathToRoot(id))
+                    }
+                ) {
+                    emptyList()
+                } else {
+                    pathIncludes
+                }
 
                 findings += EvaluatedFinding(
                     type = EvaluatedFindingType.COPYRIGHT,
@@ -688,7 +719,8 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
                     startLine = copyrightFinding.location.startLine,
                     endLine = copyrightFinding.location.endLine,
                     scanResult = evaluatedScanResult,
-                    pathExcludes = evaluatedPathExcludes
+                    pathExcludes = evaluatedPathExcludes,
+                    isExcludedByPathIncludes = evaluatedPathExcludes.isEmpty() && evaluatedPathIncludes.isNotEmpty()
                 )
             }
 
@@ -699,6 +731,18 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
                     .filter { it.matches(licenseFinding.location.getRelativePathToRoot(id)) }
                     .let { this@EvaluatedModelMapper.pathExcludes.addIfRequired(it) }
 
+                pathIncludes.let { this@EvaluatedModelMapper.pathIncludes.addIfRequired(it) }
+
+                val evaluatedPathIncludes = if (pathIncludes.isEmpty() || pathIncludes.any {
+                            include ->
+                        include.matches(licenseFinding.location.getRelativePathToRoot(id))
+                    }
+                ) {
+                    emptyList()
+                } else {
+                    pathIncludes
+                }
+
                 findings += EvaluatedFinding(
                     type = EvaluatedFindingType.LICENSE,
                     license = actualLicense,
@@ -707,7 +751,8 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
                     startLine = licenseFinding.location.startLine,
                     endLine = licenseFinding.location.endLine,
                     scanResult = evaluatedScanResult,
-                    pathExcludes = evaluatedPathExcludes
+                    pathExcludes = evaluatedPathExcludes,
+                    isExcludedByPathIncludes = evaluatedPathExcludes.isEmpty() && evaluatedPathIncludes.isNotEmpty()
                 )
             }
         }
@@ -772,6 +817,12 @@ internal class EvaluatedModelMapper(private val input: ReporterInput) {
             )
         }
 
-        return copy(config = config.copy(excludes = excludes, resolutions = resolutions))
+        val includes = with(config.includes) {
+            copy(
+                paths = paths.map { pathIncludes.addIfRequired(it) }
+            )
+        }
+
+        return copy(config = config.copy(excludes = excludes, includes = includes, resolutions = resolutions))
     }
 }