feat(compare): Introduce an option to ignore tool versions

For now, this only affects the scanner version stored in scan results as
part of scanner details. Once [1] is implemented, those analyzer project
tool versions would need to be ignored as well.

Resolves #10750.

[1]: #10676

Signed-off-by: Sebastian Schuberth <[email protected]>

Author: sschuberth

integrations/completions/ort-completion.bash

@@ -435,6 +435,11 @@ _ort_compare() {
           in_param=''
           continue
           ;;
+        --ignore-tool-versions|-v)
+          __skip_opt_eq
+          in_param=''
+          continue
+          ;;
         --ignore-tmp-dir|-d)
           __skip_opt_eq
           in_param=''
@@ -457,7 +462,7 @@ _ort_compare() {
   done
   local word="${COMP_WORDS[$COMP_CWORD]}"
   if [[ "${word}" =~ ^[-] ]]; then
-    COMPREPLY=($(compgen -W '--method -m --context-size -C --ignore-time -t --ignore-environment -e --ignore-tmp-dir -d -h --help' -- "${word}"))
+    COMPREPLY=($(compgen -W '--method -m --context-size -C --ignore-time -t --ignore-environment -e --ignore-tool-versions -v --ignore-tmp-dir -d -h --help' -- "${word}"))
     return
   fi
 
@@ -476,6 +481,8 @@ _ort_compare() {
       ;;
     "--ignore-environment")
       ;;
+    "--ignore-tool-versions")
+      ;;
     "--ignore-tmp-dir")
       ;;
     "--help")

integrations/completions/ort-completion.fish

@@ -52,6 +52,7 @@ complete -c ort -n "__fish_seen_subcommand_from compare" -l method -s m -r -fa "
 complete -c ort -n "__fish_seen_subcommand_from compare" -l context-size -s C -r -d 'The number of unmodified lines to display in the context of a modified line. Only applies to unified diff output.'
 complete -c ort -n "__fish_seen_subcommand_from compare" -l ignore-time -s t -d 'Ignore time differences.'
 complete -c ort -n "__fish_seen_subcommand_from compare" -l ignore-environment -s e -d 'Ignore environment differences.'
+complete -c ort -n "__fish_seen_subcommand_from compare" -l ignore-tool-versions -s v -d 'Ignore tool version differences.'
 complete -c ort -n "__fish_seen_subcommand_from compare" -l ignore-tmp-dir -s d -d 'Ignore temporary directory differences.'
 complete -c ort -n "__fish_seen_subcommand_from compare" -s h -l help -d 'Show this message and exit'
 

integrations/completions/ort-completion.zsh

@@ -440,6 +440,11 @@ _ort_compare() {
           in_param=''
           continue
           ;;
+        --ignore-tool-versions|-v)
+          __skip_opt_eq
+          in_param=''
+          continue
+          ;;
         --ignore-tmp-dir|-d)
           __skip_opt_eq
           in_param=''
@@ -462,7 +467,7 @@ _ort_compare() {
   done
   local word="${COMP_WORDS[$COMP_CWORD]}"
   if [[ "${word}" =~ ^[-] ]]; then
-    COMPREPLY=($(compgen -W '--method -m --context-size -C --ignore-time -t --ignore-environment -e --ignore-tmp-dir -d -h --help' -- "${word}"))
+    COMPREPLY=($(compgen -W '--method -m --context-size -C --ignore-time -t --ignore-environment -e --ignore-tool-versions -v --ignore-tmp-dir -d -h --help' -- "${word}"))
     return
   fi
 
@@ -481,6 +486,8 @@ _ort_compare() {
       ;;
     "--ignore-environment")
       ;;
+    "--ignore-tool-versions")
+      ;;
     "--ignore-tmp-dir")
       ;;
     "--help")

plugins/commands/compare/src/main/kotlin/CompareCommand.kt

@@ -42,6 +42,7 @@ import com.github.difflib.UnifiedDiffUtils
 import java.time.Instant
 
 import org.ossreviewtoolkit.model.OrtResult
+import org.ossreviewtoolkit.model.ScannerDetails
 import org.ossreviewtoolkit.model.mapper
 import org.ossreviewtoolkit.plugins.api.OrtPlugin
 import org.ossreviewtoolkit.plugins.api.PluginDescriptor
@@ -93,6 +94,11 @@ class CompareCommand(descriptor: PluginDescriptor = CompareCommandFactory.descri
         help = "Ignore environment differences."
     ).flag()
 
+    private val ignoreToolVersions by option(
+        "--ignore-tool-versions", "-v",
+        help = "Ignore tool version differences."
+    ).flag()
+
     private val ignoreTmpDir by option(
         "--ignore-tmp-dir", "-d",
         help = "Ignore temporary directory differences."
@@ -115,6 +121,7 @@ class CompareCommand(descriptor: PluginDescriptor = CompareCommandFactory.descri
                 // TODO: Find a way to also ignore temporary directories (when diffing semantically).
                 if (ignoreTime) addDeserializer(Instant::class.java, EpochInstantDeserializer())
                 if (ignoreEnvironment) addDeserializer(Environment::class.java, DefaultEnvironmentDeserializer())
+                if (ignoreToolVersions) addDeserializer(ScannerDetails::class.java, EmptyScannerVersionDeserializer())
             }
         )
 
@@ -197,6 +204,13 @@ private class DefaultEnvironmentDeserializer : StdDeserializer<Environment>(Envi
         }
 }
 
+private class EmptyScannerVersionDeserializer : StdDeserializer<ScannerDetails>(ScannerDetails::class.java) {
+    override fun deserialize(parser: JsonParser, context: DeserializationContext): ScannerDetails {
+        val node = parser.codec.readTree<JsonNode>(parser)
+        return ScannerDetails(node["name"].textValue(), "", node["configuration"].textValue())
+    }
+}
+
 private fun Map<Regex, String>.replaceIn(text: String) =
     entries.fold(text) { currentText, (from, to) ->
         currentText.replace(from, to)