feat(requirements): Remove listing plugins from the RequirementsCommand

Remove the option to list plugins from the `RequirementsCommand` as now
all plugins are listed by the `PluginsCommand` [1]. Also update places
that refer to the old command to use the plugins command instead.

[1]: #9140 (comment)

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

Author: mnonnenmacher

.github/ISSUE_TEMPLATE/bug.md

@@ -34,7 +34,7 @@ No screenshots of plain text please, to keep text searchable.
 
 ### Environment
 
-Output of the `ort requirements -l commands` command:
+Output of the `ort requirements` command:
 
 ```
 <copy & paste console output to here; no screenshots please>

cli/src/main/dist/plugin/README.md

@@ -1,3 +1,3 @@
 Put the JARs (and their dependencies) for any custom ORT plugins into this directory for ORT to load them at runtime.
 
-Afterward, you can run `ort requirements --list plugins` to verify that they have been properly loaded by ORT.
+Afterward, you can run `ort plugins` to verify that they have been properly loaded by ORT.

integrations/completions/ort-completion.bash

@@ -1279,12 +1279,6 @@ _ort_requirements() {
           (( i = i + 1 ));
           continue
           ;;
-        --list|-l)
-          __skip_opt_eq
-          (( i = i + 1 ))
-          [[ ${i} -gt COMP_CWORD ]] && in_param='--list' || in_param=''
-          continue
-          ;;
         -h|--help)
           __skip_opt_eq
           in_param=''
@@ -1302,7 +1296,7 @@ _ort_requirements() {
   done
   local word="${COMP_WORDS[$COMP_CWORD]}"
   if [[ "${word}" =~ ^[-] ]]; then
-    COMPREPLY=($(compgen -W '--list -l -h --help' -- "${word}"))
+    COMPREPLY=($(compgen -W '-h --help' -- "${word}"))
     return
   fi
 
@@ -1312,9 +1306,6 @@ _ort_requirements() {
   [[ -z "${in_param}" ]] && in_param=${vararg_name}
 
   case "${in_param}" in
-    "--list")
-      COMPREPLY=($(compgen -W 'PLUGINS COMMANDS' -- "${word}"))
-      ;;
     "--help")
       ;;
   esac

integrations/completions/ort-completion.fish

@@ -166,7 +166,6 @@ complete -c ort -n "__fish_seen_subcommand_from report" -s h -l help -d 'Show th
 complete -c ort -f -n __fish_use_subcommand -a requirements -d 'Check for the command line tools required by ORT.'
 
 ## Options for requirements
-complete -c ort -n "__fish_seen_subcommand_from requirements" -l list -s l -r -fa "PLUGINS COMMANDS" -d 'A comma-separated list of requirements to list.'
 complete -c ort -n "__fish_seen_subcommand_from requirements" -s h -l help -d 'Show this message and exit'
 
 

integrations/completions/ort-completion.zsh

@@ -1284,12 +1284,6 @@ _ort_requirements() {
           (( i = i + 1 ));
           continue
           ;;
-        --list|-l)
-          __skip_opt_eq
-          (( i = i + 1 ))
-          [[ ${i} -gt COMP_CWORD ]] && in_param='--list' || in_param=''
-          continue
-          ;;
         -h|--help)
           __skip_opt_eq
           in_param=''
@@ -1307,7 +1301,7 @@ _ort_requirements() {
   done
   local word="${COMP_WORDS[$COMP_CWORD]}"
   if [[ "${word}" =~ ^[-] ]]; then
-    COMPREPLY=($(compgen -W '--list -l -h --help' -- "${word}"))
+    COMPREPLY=($(compgen -W '-h --help' -- "${word}"))
     return
   fi
 
@@ -1317,9 +1311,6 @@ _ort_requirements() {
   [[ -z "${in_param}" ]] && in_param=${vararg_name}
 
   case "${in_param}" in
-    "--list")
-      COMPREPLY=($(compgen -W 'PLUGINS COMMANDS' -- "${word}"))
-      ;;
     "--help")
       ;;
   esac

integrations/jenkins/Jenkinsfile

@@ -375,7 +375,7 @@ pipeline {
                     ORT_OPTIONS="$ORT_OPTIONS --stacktrace"
                 fi
 
-                /opt/ort/bin/ort $ORT_OPTIONS requirements --list plugins
+                /opt/ort/bin/ort $ORT_OPTIONS plugins
                 '''.stripIndent().trim()
             }
         }

plugins/commands/requirements/src/main/kotlin/RequirementsCommand.kt

@@ -20,18 +20,12 @@
 package org.ossreviewtoolkit.plugins.commands.requirements
 
 import com.github.ajalt.clikt.core.ProgramResult
-import com.github.ajalt.clikt.parameters.options.default
-import com.github.ajalt.clikt.parameters.options.option
-import com.github.ajalt.clikt.parameters.options.split
-import com.github.ajalt.clikt.parameters.types.enum
 import com.github.ajalt.mordant.rendering.Theme
 
 import java.io.File
 import java.lang.reflect.Modifier
 import java.util.EnumSet
 
-import kotlin.reflect.full.companionObjectInstance
-
 import org.apache.logging.log4j.kotlin.logger
 
 import org.ossreviewtoolkit.analyzer.PackageManager
@@ -42,7 +36,6 @@ import org.ossreviewtoolkit.plugins.api.PluginDescriptor
 import org.ossreviewtoolkit.plugins.commands.api.OrtCommand
 import org.ossreviewtoolkit.plugins.commands.api.OrtCommandFactory
 import org.ossreviewtoolkit.utils.common.CommandLineTool
-import org.ossreviewtoolkit.utils.common.Plugin
 import org.ossreviewtoolkit.utils.common.enumSetOf
 import org.ossreviewtoolkit.utils.spdx.scanCodeLicenseTextDir
 
@@ -64,8 +57,6 @@ private val SUCCESS_PREFIX = "\t${Theme.Default.success("*")} "
 class RequirementsCommand(
     descriptor: PluginDescriptor = RequirementsCommandFactory.descriptor
 ) : OrtCommand(descriptor) {
-    private enum class RequirementsType { PLUGINS, COMMANDS }
-
     private enum class VersionStatus {
         /** The determined version satisfies ORT's requirements. */
         SATISFIED,
@@ -80,17 +71,10 @@ class RequirementsCommand(
         UNAVAILABLE
     }
 
-    private val list by option(
-        "--list", "-l",
-        help = "A comma-separated list of requirements to list."
-    ).enum<RequirementsType>().split(",").default(RequirementsType.entries)
-
     private val reflections by lazy { Reflections("org.ossreviewtoolkit", Scanners.SubTypes) }
 
     override fun run() {
-        if (RequirementsType.PLUGINS in list) listPlugins()
-
-        val status = if (RequirementsType.COMMANDS in list) checkToolVersions() else enumSetOf(VersionStatus.SATISFIED)
+        val status = checkToolVersions()
 
         echo("Prefix legend:")
         echo("${DANGER_PREFIX}The tool was not found in the PATH environment.")
@@ -127,30 +111,6 @@ class RequirementsCommand(
         }
     }
 
-    private fun listPlugins() {
-        getPluginsByType().toSortedMap().forEach { (name, all) ->
-            echo(Theme.Default.info("$name plugins:"))
-            echo(all.joinToString("\n", postfix = "\n") { "${SUCCESS_PREFIX}$it" })
-        }
-    }
-
-    internal fun getPluginsByType(): Map<String, Set<String>> {
-        val pluginClasses = reflections.getSubTypesOf(Plugin::class.java)
-
-        val pluginTypes = pluginClasses.mapNotNull { clazz ->
-            val companion = clazz.declaredClasses.find { it.name.endsWith("\$Companion") }
-            val all = runCatching { companion?.getDeclaredMethod("getALL") }.getOrNull()
-
-            all?.let {
-                @Suppress("UNCHECKED_CAST")
-                val plugins = all.invoke(clazz.kotlin.companionObjectInstance) as Map<String, *>
-                clazz.simpleName to plugins.keys
-            }
-        }
-
-        return pluginTypes.toMap()
-    }
-
     private fun checkToolVersions(): EnumSet<VersionStatus> {
         // Toggle bits in here to denote the kind of error. Skip the first bit as status code 1 is already used above.
         val overallStatus = enumSetOf<VersionStatus>()