refactor(scanner): Introduce a ScannerMatcherCriteria interface

sschuberth · sschuberth · commit 97d1c08fc1a5 · 2025-05-28T09:42:57.000+02:00
Replace the `ScannerMatcherConfig` data class with a
`ScannerMatcherCriteria` interface which is implemented by the scanners'
config classes to directly retrieve the matcher criteria. This avoids some
code duplication in the scanner implementations.

Signed-off-by: Sebastian Schuberth &lt;sebastian@doubleopen.org&gt;
diff --git a/plugins/scanners/askalono/src/main/kotlin/Askalono.kt b/plugins/scanners/askalono/src/main/kotlin/Askalono.kt
@@ -38,7 +38,6 @@ import org.ossreviewtoolkit.scanner.LocalPathScannerWrapper
 import org.ossreviewtoolkit.scanner.ScanContext
 import org.ossreviewtoolkit.scanner.ScanException
 import org.ossreviewtoolkit.scanner.ScannerMatcher
-import org.ossreviewtoolkit.scanner.ScannerMatcherConfig
 import org.ossreviewtoolkit.scanner.ScannerWrapperFactory
 import org.ossreviewtoolkit.utils.common.CommandLineTool
 import org.ossreviewtoolkit.utils.common.Os
@@ -66,18 +65,7 @@ class Askalono(
     config: AskalonoConfig
 ) : LocalPathScannerWrapper() {
     override val configuration = ""
-
-    override val matcher by lazy {
-        ScannerMatcher.create(
-            details,
-            ScannerMatcherConfig(
-                config.regScannerName,
-                config.minVersion,
-                config.maxVersion,
-                config.configuration
-            )
-        )
-    }
+    override val matcher by lazy { ScannerMatcher.create(details, config) }
 
     override val version by lazy {
         require(AskalonoCommand.isInPath()) {
diff --git a/plugins/scanners/askalono/src/main/kotlin/AskalonoConfig.kt b/plugins/scanners/askalono/src/main/kotlin/AskalonoConfig.kt
@@ -20,28 +20,29 @@
 package org.ossreviewtoolkit.plugins.scanners.askalono
 
 import org.ossreviewtoolkit.plugins.api.OrtPluginOption
+import org.ossreviewtoolkit.scanner.ScannerMatcherCriteria
 
 data class AskalonoConfig(
     /**
      * A regular expression to match the scanner name when looking up scan results in the storage.
      */
-    val regScannerName: String?,
+    override val regScannerName: String?,
 
     /**
      * The minimum version of stored scan results to use.
      */
-    val minVersion: String?,
+    override val minVersion: String?,
 
     /**
      * The maximum version of stored scan results to use.
      */
-    val maxVersion: String?,
+    override val maxVersion: String?,
 
     /**
      * The configuration to use for the scanner. Only scan results with the same configuration are used when looking up
      * scan results in the storage.
      */
-    val configuration: String?,
+    override val configuration: String?,
 
     /**
      * Whether to read scan results from the storage.
@@ -54,4 +55,4 @@ data class AskalonoConfig(
      */
     @OrtPluginOption(defaultValue = "true")
     val writeToStorage: Boolean
-)
+) : ScannerMatcherCriteria
diff --git a/plugins/scanners/boyterlc/src/main/kotlin/BoyterLc.kt b/plugins/scanners/boyterlc/src/main/kotlin/BoyterLc.kt
@@ -37,7 +37,6 @@ import org.ossreviewtoolkit.scanner.LocalPathScannerWrapper
 import org.ossreviewtoolkit.scanner.ScanContext
 import org.ossreviewtoolkit.scanner.ScanException
 import org.ossreviewtoolkit.scanner.ScannerMatcher
-import org.ossreviewtoolkit.scanner.ScannerMatcherConfig
 import org.ossreviewtoolkit.scanner.ScannerWrapperFactory
 import org.ossreviewtoolkit.utils.common.CommandLineTool
 import org.ossreviewtoolkit.utils.common.Os
@@ -72,18 +71,7 @@ class BoyterLc(
     }
 
     override val configuration = CONFIGURATION_OPTIONS.joinToString(" ")
-
-    override val matcher by lazy {
-        ScannerMatcher.create(
-            details,
-            ScannerMatcherConfig(
-                config.regScannerName,
-                config.minVersion,
-                config.maxVersion,
-                config.configuration
-            )
-        )
-    }
+    override val matcher by lazy { ScannerMatcher.create(details, config) }
 
     override val version by lazy {
         require(BoyterLcCommand.isInPath()) {
diff --git a/plugins/scanners/boyterlc/src/main/kotlin/BoyterLcConfig.kt b/plugins/scanners/boyterlc/src/main/kotlin/BoyterLcConfig.kt
@@ -20,28 +20,29 @@
 package org.ossreviewtoolkit.plugins.scanners.boyterlc
 
 import org.ossreviewtoolkit.plugins.api.OrtPluginOption
+import org.ossreviewtoolkit.scanner.ScannerMatcherCriteria
 
 data class BoyterLcConfig(
     /**
      * A regular expression to match the scanner name when looking up scan results in the storage.
      */
-    val regScannerName: String?,
+    override val regScannerName: String?,
 
     /**
      * The minimum version of stored scan results to use.
      */
-    val minVersion: String?,
+    override val minVersion: String?,
 
     /**
      * The maximum version of stored scan results to use.
      */
-    val maxVersion: String?,
+    override val maxVersion: String?,
 
     /**
      * The configuration to use for the scanner. Only scan results with the same configuration are used when looking up
      * scan results in the storage.
      */
-    val configuration: String?,
+    override val configuration: String?,
 
     /**
      * Whether to read scan results from the storage.
@@ -54,4 +55,4 @@ data class BoyterLcConfig(
      */
     @OrtPluginOption(defaultValue = "true")
     val writeToStorage: Boolean
-)
+) : ScannerMatcherCriteria
diff --git a/plugins/scanners/licensee/src/main/kotlin/Licensee.kt b/plugins/scanners/licensee/src/main/kotlin/Licensee.kt
@@ -44,7 +44,6 @@ import org.ossreviewtoolkit.scanner.LocalPathScannerWrapper
 import org.ossreviewtoolkit.scanner.ScanContext
 import org.ossreviewtoolkit.scanner.ScanException
 import org.ossreviewtoolkit.scanner.ScannerMatcher
-import org.ossreviewtoolkit.scanner.ScannerMatcherConfig
 import org.ossreviewtoolkit.scanner.ScannerWrapperFactory
 import org.ossreviewtoolkit.utils.common.CommandLineTool
 import org.ossreviewtoolkit.utils.common.Os
@@ -75,18 +74,7 @@ class Licensee(
     }
 
     override val configuration = CONFIGURATION_OPTIONS.joinToString(" ")
-
-    override val matcher by lazy {
-        ScannerMatcher.create(
-            details,
-            ScannerMatcherConfig(
-                config.regScannerName,
-                config.minVersion,
-                config.maxVersion,
-                config.configuration
-            )
-        )
-    }
+    override val matcher by lazy { ScannerMatcher.create(details, config) }
 
     override val version by lazy {
         require(LicenseeCommand.isInPath()) {
diff --git a/plugins/scanners/licensee/src/main/kotlin/LicenseeConfig.kt b/plugins/scanners/licensee/src/main/kotlin/LicenseeConfig.kt
@@ -20,28 +20,29 @@
 package org.ossreviewtoolkit.plugins.scanners.licensee
 
 import org.ossreviewtoolkit.plugins.api.OrtPluginOption
+import org.ossreviewtoolkit.scanner.ScannerMatcherCriteria
 
 data class LicenseeConfig(
     /**
      * A regular expression to match the scanner name when looking up scan results in the storage.
      */
-    val regScannerName: String?,
+    override val regScannerName: String?,
 
     /**
      * The minimum version of stored scan results to use.
      */
-    val minVersion: String?,
+    override val minVersion: String?,
 
     /**
      * The maximum version of stored scan results to use.
      */
-    val maxVersion: String?,
+    override val maxVersion: String?,
 
     /**
      * The configuration to use for the scanner. Only scan results with the same configuration are used when looking up
      * scan results in the storage.
      */
-    val configuration: String?,
+    override val configuration: String?,
 
     /**
      * Whether to read scan results from the storage.
@@ -54,4 +55,4 @@ data class LicenseeConfig(
      */
     @OrtPluginOption(defaultValue = "true")
     val writeToStorage: Boolean
-)
+) : ScannerMatcherCriteria
diff --git a/plugins/scanners/scancode/src/main/kotlin/ScanCode.kt b/plugins/scanners/scancode/src/main/kotlin/ScanCode.kt
@@ -33,7 +33,6 @@ import org.ossreviewtoolkit.plugins.api.PluginDescriptor
 import org.ossreviewtoolkit.scanner.LocalPathScannerWrapper
 import org.ossreviewtoolkit.scanner.ScanContext
 import org.ossreviewtoolkit.scanner.ScannerMatcher
-import org.ossreviewtoolkit.scanner.ScannerMatcherConfig
 import org.ossreviewtoolkit.scanner.ScannerWrapperFactory
 import org.ossreviewtoolkit.utils.common.CommandLineTool
 import org.ossreviewtoolkit.utils.common.Os
@@ -115,17 +114,7 @@ class ScanCode(
         }.joinToString(" ")
     }
 
-    override val matcher by lazy {
-        ScannerMatcher.create(
-            details,
-            ScannerMatcherConfig(
-                config.regScannerName,
-                config.minVersion,
-                config.maxVersion,
-                config.configuration
-            )
-        )
-    }
+    override val matcher by lazy { ScannerMatcher.create(details, config) }
 
     override val version by lazy {
         require(ScanCodeCommand.isInPath()) {
diff --git a/plugins/scanners/scancode/src/main/kotlin/ScanCodeConfig.kt b/plugins/scanners/scancode/src/main/kotlin/ScanCodeConfig.kt
@@ -22,6 +22,7 @@ package org.ossreviewtoolkit.plugins.scanners.scancode
 import org.ossreviewtoolkit.model.ScannerDetails
 import org.ossreviewtoolkit.plugins.api.OrtPluginOption
 import org.ossreviewtoolkit.scanner.ScanStorage
+import org.ossreviewtoolkit.scanner.ScannerMatcherCriteria
 
 data class ScanCodeConfig(
     /**
@@ -53,23 +54,23 @@ data class ScanCodeConfig(
     /**
      * A regular expression to match the scanner name when looking up scan results in the storage.
      */
-    val regScannerName: String?,
+    override val regScannerName: String?,
 
     /**
      * The minimum version of stored scan results to use.
      */
-    val minVersion: String?,
+    override val minVersion: String?,
 
     /**
      * The maximum version of stored scan results to use.
      */
-    val maxVersion: String?,
+    override val maxVersion: String?,
 
     /**
      * The configuration to use for the scanner. Only scan results with the same configuration are used when looking up
      * scan results in the storage.
      */
-    val configuration: String?,
+    override val configuration: String?,
 
     /**
      * Whether to read scan results from the storage.
@@ -82,4 +83,4 @@ data class ScanCodeConfig(
      */
     @OrtPluginOption(defaultValue = "true")
     val writeToStorage: Boolean
-)
+) : ScannerMatcherCriteria
diff --git a/scanner/src/main/kotlin/ScannerMatcher.kt b/scanner/src/main/kotlin/ScannerMatcher.kt
@@ -63,14 +63,14 @@ data class ScannerMatcher(
         /**
          * Return a [ScannerMatcher] instance that is to be used when looking up existing scan results from a
          * [ScanStorageReader]. By default, the properties of this instance are initialized to match the scanner
-         * [details]. These defaults can be overridden by the provided [config].
+         * [details]. These defaults can be overridden by the provided [criteria].
          */
-        fun create(details: ScannerDetails, config: ScannerMatcherConfig = ScannerMatcherConfig.EMPTY): ScannerMatcher {
+        fun create(details: ScannerDetails, criteria: ScannerMatcherCriteria? = null): ScannerMatcher {
             val scannerVersion = checkNotNull(Semver.coerce(details.version))
-            val minVersion = Semver.coerce(config.minVersion) ?: scannerVersion
-            val maxVersion = Semver.coerce(config.maxVersion) ?: minVersion.nextMajor()
-            val name = config.regScannerName ?: details.name
-            val configuration = config.configuration ?: details.configuration
+            val minVersion = Semver.coerce(criteria?.minVersion) ?: scannerVersion
+            val maxVersion = Semver.coerce(criteria?.maxVersion) ?: minVersion.nextMajor()
+            val name = criteria?.regScannerName ?: details.name
+            val configuration = criteria?.configuration ?: details.configuration
 
             return ScannerMatcher(name, minVersion, maxVersion, configuration)
         }
@@ -96,17 +96,3 @@ data class ScannerMatcher(
         return version in minVersion..<maxVersion && configuration == details.configuration
     }
 }
-
-/**
- * A holder class for the [ScannerMatcher] configuration.
- */
-data class ScannerMatcherConfig(
-    val regScannerName: String? = null,
-    val minVersion: String? = null,
-    val maxVersion: String? = null,
-    val configuration: String? = null
-) {
-    companion object {
-        val EMPTY = ScannerMatcherConfig(null, null, null, null)
-    }
-}
diff --git a/scanner/src/main/kotlin/ScannerMatcherCriteria.kt b/scanner/src/main/kotlin/ScannerMatcherCriteria.kt
@@ -0,0 +1,52 @@
+/*
+ * Copyright (C) 2020 The ORT Project Authors (see <https://github.com/oss-review-toolkit/ort/blob/main/NOTICE>)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+package org.ossreviewtoolkit.scanner
+
+import org.ossreviewtoolkit.model.ScannerDetails
+
+/**
+ * A holder class for the [ScannerMatcher] criteria. Only non-null properties are taken into account for matching.
+ */
+interface ScannerMatcherCriteria {
+    /**
+     * Criterion to match the scanner name. This string is interpreted as a regular expression. In the most basic
+     * form, it can be an exact scanner name, but by using features of regular expressions, a more advanced
+     * matching can be achieved. So it is possible, for instance, to select multiple scanners using an alternative ('|')
+     * expression or an arbitrary one using a wildcard ('.*').
+     */
+    val regScannerName: String?
+
+    /**
+     * Criterion to match the scanner version, including this minimum version. Results are accepted if they are produced
+     * by scanners with a version greater than or equal to this version.
+     */
+    val minVersion: String?
+
+    /**
+     * Criterion to match the scanner version, excluding this maximum version. Results are accepted if they are produced
+     * by scanners with a version less than this version.
+     */
+    val maxVersion: String?
+
+    /**
+     * Criterion to match the [configuration][ScannerDetails.configuration] of the scanner.
+     */
+    val configuration: String?
+}
diff --git a/scanner/src/test/kotlin/ScannerMatcherTest.kt b/scanner/src/test/kotlin/ScannerMatcherTest.kt
