refactor(scanner)!: Rename ScannerCriteria to ScannerMatcher

Rename `ScannerCriteria` to `ScannerMatcher` as the class does not only
contain the criteria but also the logic for matching scanner details,
and to align with other similar classes like `FileMatcher` or
`FindingsMatcher`.

Signed-off-by: Martin Nonnenmacher <[email protected]>

Author: mnonnenmacher

plugins/scanners/askalono/src/main/kotlin/Askalono.kt

@@ -35,7 +35,7 @@ import org.ossreviewtoolkit.model.TextLocation
 import org.ossreviewtoolkit.scanner.CommandLinePathScannerWrapper
 import org.ossreviewtoolkit.scanner.ScanContext
 import org.ossreviewtoolkit.scanner.ScanException
-import org.ossreviewtoolkit.scanner.ScannerCriteria
+import org.ossreviewtoolkit.scanner.ScannerMatcher
 import org.ossreviewtoolkit.scanner.ScannerWrapperFactory
 import org.ossreviewtoolkit.utils.common.Options
 import org.ossreviewtoolkit.utils.common.Os
@@ -51,7 +51,7 @@ class Askalono internal constructor(name: String, private val options: Options)
 
     override val configuration = ""
 
-    override val criteria by lazy { ScannerCriteria.create(details, options) }
+    override val matcher by lazy { ScannerMatcher.create(details, options) }
 
     override fun command(workingDir: File?) =
         listOfNotNull(workingDir, if (Os.isWindows) "askalono.exe" else "askalono").joinToString(File.separator)

plugins/scanners/boyterlc/src/main/kotlin/BoyterLc.kt

@@ -34,7 +34,7 @@ import org.ossreviewtoolkit.model.TextLocation
 import org.ossreviewtoolkit.scanner.CommandLinePathScannerWrapper
 import org.ossreviewtoolkit.scanner.ScanContext
 import org.ossreviewtoolkit.scanner.ScanException
-import org.ossreviewtoolkit.scanner.ScannerCriteria
+import org.ossreviewtoolkit.scanner.ScannerMatcher
 import org.ossreviewtoolkit.scanner.ScannerWrapperFactory
 import org.ossreviewtoolkit.utils.common.Options
 import org.ossreviewtoolkit.utils.common.Os
@@ -57,7 +57,7 @@ class BoyterLc internal constructor(name: String, private val options: Options)
 
     override val configuration = CONFIGURATION_OPTIONS.joinToString(" ")
 
-    override val criteria by lazy { ScannerCriteria.create(details, options) }
+    override val matcher by lazy { ScannerMatcher.create(details, options) }
 
     override fun command(workingDir: File?) =
         listOfNotNull(workingDir, if (Os.isWindows) "lc.exe" else "lc").joinToString(File.separator)

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

@@ -77,7 +77,7 @@ import org.ossreviewtoolkit.model.createAndLogIssue
 import org.ossreviewtoolkit.scanner.PackageScannerWrapper
 import org.ossreviewtoolkit.scanner.ProvenanceScannerWrapper
 import org.ossreviewtoolkit.scanner.ScanContext
-import org.ossreviewtoolkit.scanner.ScannerCriteria
+import org.ossreviewtoolkit.scanner.ScannerMatcher
 import org.ossreviewtoolkit.scanner.ScannerWrapperFactory
 import org.ossreviewtoolkit.utils.common.Options
 import org.ossreviewtoolkit.utils.common.enumSetOf
@@ -202,7 +202,7 @@ class FossId internal constructor(
     override val version = service.version
     override val configuration = ""
 
-    override val criteria: ScannerCriteria? = null
+    override val matcher: ScannerMatcher? = null
 
     override fun filterSecretOptions(options: Options) =
         options.mapValues { (k, v) ->

plugins/scanners/licensee/src/main/kotlin/Licensee.kt

@@ -35,7 +35,7 @@ import org.ossreviewtoolkit.model.TextLocation
 import org.ossreviewtoolkit.scanner.CommandLinePathScannerWrapper
 import org.ossreviewtoolkit.scanner.ScanContext
 import org.ossreviewtoolkit.scanner.ScanException
-import org.ossreviewtoolkit.scanner.ScannerCriteria
+import org.ossreviewtoolkit.scanner.ScannerMatcher
 import org.ossreviewtoolkit.scanner.ScannerWrapperFactory
 import org.ossreviewtoolkit.utils.common.Options
 import org.ossreviewtoolkit.utils.common.Os
@@ -56,7 +56,7 @@ class Licensee internal constructor(name: String, private val options: Options)
 
     override val configuration = CONFIGURATION_OPTIONS.joinToString(" ")
 
-    override val criteria by lazy { ScannerCriteria.create(details, options) }
+    override val matcher by lazy { ScannerMatcher.create(details, options) }
 
     override fun command(workingDir: File?) =
         listOfNotNull(workingDir, if (Os.isWindows) "licensee.bat" else "licensee").joinToString(File.separator)

plugins/scanners/scancode/src/main/kotlin/ScanCode.kt

@@ -32,7 +32,7 @@ import org.ossreviewtoolkit.model.config.ScannerConfiguration
 import org.ossreviewtoolkit.scanner.CommandLinePathScannerWrapper
 import org.ossreviewtoolkit.scanner.ScanContext
 import org.ossreviewtoolkit.scanner.ScanResultsStorage
-import org.ossreviewtoolkit.scanner.ScannerCriteria
+import org.ossreviewtoolkit.scanner.ScannerMatcher
 import org.ossreviewtoolkit.scanner.ScannerWrapperFactory
 import org.ossreviewtoolkit.utils.common.Options
 import org.ossreviewtoolkit.utils.common.Os
@@ -95,7 +95,7 @@ class ScanCode internal constructor(name: String, private val options: Options)
         override fun create(options: Options) = ScanCode(type, options)
     }
 
-    override val criteria by lazy { ScannerCriteria.create(details, options) }
+    override val matcher by lazy { ScannerMatcher.create(details, options) }
 
     override val configuration by lazy {
         buildList {

plugins/scanners/scanoss/src/main/kotlin/ScanOss.kt

@@ -40,7 +40,7 @@ import org.ossreviewtoolkit.clients.scanoss.ScanOssService
 import org.ossreviewtoolkit.model.ScanSummary
 import org.ossreviewtoolkit.scanner.PathScannerWrapper
 import org.ossreviewtoolkit.scanner.ScanContext
-import org.ossreviewtoolkit.scanner.ScannerCriteria
+import org.ossreviewtoolkit.scanner.ScannerMatcher
 import org.ossreviewtoolkit.scanner.ScannerWrapperFactory
 import org.ossreviewtoolkit.utils.common.Options
 import org.ossreviewtoolkit.utils.common.VCS_DIRECTORIES
@@ -69,7 +69,7 @@ class ScanOss internal constructor(override val name: String, private val option
 
     override val configuration = ""
 
-    override val criteria by lazy { ScannerCriteria.create(details, options) }
+    override val matcher by lazy { ScannerMatcher.create(details, options) }
 
     /**
      * The name of the file corresponding to the fingerprints can be sent to SCANOSS for more precise matches.

scanner/src/funTest/kotlin/scanners/ScannerIntegrationFunTest.kt

@@ -44,7 +44,7 @@ import org.ossreviewtoolkit.model.toYaml
 import org.ossreviewtoolkit.scanner.PathScannerWrapper
 import org.ossreviewtoolkit.scanner.ScanContext
 import org.ossreviewtoolkit.scanner.Scanner
-import org.ossreviewtoolkit.scanner.ScannerCriteria
+import org.ossreviewtoolkit.scanner.ScannerMatcher
 import org.ossreviewtoolkit.scanner.ScannerWrapper
 import org.ossreviewtoolkit.scanner.provenance.DefaultNestedProvenanceResolver
 import org.ossreviewtoolkit.scanner.provenance.DefaultPackageProvenanceResolver
@@ -215,7 +215,7 @@ internal class DummyScanner(override val name: String = "Dummy") : PathScannerWr
     override val version = "1.0.0"
     override val configuration = ""
 
-    override val criteria = ScannerCriteria.create(details)
+    override val matcher = ScannerMatcher.create(details)
 
     override fun scanPath(path: File, context: ScanContext): ScanSummary {
         val relevantFiles = path.walk()

scanner/src/funTest/kotlin/storages/AbstractProvenanceBasedStorageFunTest.kt

@@ -43,7 +43,7 @@ import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.VcsType
 import org.ossreviewtoolkit.scanner.ProvenanceBasedScanStorage
 import org.ossreviewtoolkit.scanner.ScanStorageException
-import org.ossreviewtoolkit.scanner.ScannerCriteria
+import org.ossreviewtoolkit.scanner.ScannerMatcher
 
 abstract class AbstractProvenanceBasedStorageFunTest(vararg listeners: TestListener) : WordSpec() {
     private lateinit var storage: ProvenanceBasedScanStorage
@@ -131,10 +131,10 @@ abstract class AbstractProvenanceBasedStorageFunTest(vararg listeners: TestListe
 
             "fail if the provenance contains a VCS path" {
                 val provenance = createRepositoryProvenance(vcsInfo = VcsInfo.valid().copy(path = "path"))
-                val criteria = ScannerCriteria.create(createScannerDetails())
+                val matcher = ScannerMatcher.create(createScannerDetails())
 
                 shouldThrow<ScanStorageException> { storage.read(provenance) }
-                shouldThrow<ScanStorageException> { storage.read(provenance, criteria) }
+                shouldThrow<ScanStorageException> { storage.read(provenance, matcher) }
             }
 
             "find scan result for a specific scanner" {
@@ -146,7 +146,7 @@ abstract class AbstractProvenanceBasedStorageFunTest(vararg listeners: TestListe
 
                 val readResult = storage.read(
                     scanResult1.provenance as KnownProvenance,
-                    ScannerCriteria.create(scanResult1.scanner)
+                    ScannerMatcher.create(scanResult1.scanner)
                 )
 
                 readResult should containExactly(scanResult1)
@@ -156,13 +156,13 @@ abstract class AbstractProvenanceBasedStorageFunTest(vararg listeners: TestListe
                 val scanResult1 = createScanResult(scannerDetails = createScannerDetails(name = "name1"))
                 val scanResult2 = createScanResult(scannerDetails = createScannerDetails(name = "name2"))
                 val scanResult3 = createScanResult(scannerDetails = createScannerDetails(name = "other name"))
-                val criteria = ScannerCriteria.create(scanResult1.scanner).copy(regScannerName = "name.+")
+                val matcher = ScannerMatcher.create(scanResult1.scanner).copy(regScannerName = "name.+")
 
                 storage.write(scanResult1)
                 storage.write(scanResult2)
                 storage.write(scanResult3)
 
-                val readResult = storage.read(scanResult1.provenance as KnownProvenance, criteria)
+                val readResult = storage.read(scanResult1.provenance as KnownProvenance, matcher)
 
                 readResult should containExactlyInAnyOrder(scanResult1, scanResult2)
             }
@@ -173,14 +173,14 @@ abstract class AbstractProvenanceBasedStorageFunTest(vararg listeners: TestListe
                 val scanResultCompatible2 =
                     createScanResult(scannerDetails = createScannerDetails(version = "1.0.1-alpha.1"))
                 val scanResultIncompatible = createScanResult(scannerDetails = createScannerDetails(version = "2.0.0"))
-                val criteria = ScannerCriteria.create(scanResult.scanner)
+                val matcher = ScannerMatcher.create(scanResult.scanner)
 
                 storage.write(scanResult)
                 storage.write(scanResultCompatible1)
                 storage.write(scanResultCompatible2)
                 storage.write(scanResultIncompatible)
 
-                val readResult = storage.read(scanResult.provenance as KnownProvenance, criteria)
+                val readResult = storage.read(scanResult.provenance as KnownProvenance, matcher)
 
                 readResult should containExactlyInAnyOrder(scanResult, scanResultCompatible1, scanResultCompatible2)
             }