feat(advisor): Migrate the advisor to the new plugin API

Migrate the Advisor API and all plugins to the new plugin API. This
allows to simplify the code in several places, as the plugin factories
and service loader classes do not have to be created by hand anymore.

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

Author: mnonnenmacher

advisor/build.gradle.kts

@@ -24,6 +24,7 @@ plugins {
 
 dependencies {
     api(projects.model)
+    api(projects.plugins.api)
     api(projects.utils.commonUtils)
 
     implementation(projects.utils.ortUtils)

advisor/src/main/kotlin/AdviceProvider.kt

@@ -22,20 +22,21 @@ package org.ossreviewtoolkit.advisor
 import org.ossreviewtoolkit.model.AdvisorDetails
 import org.ossreviewtoolkit.model.AdvisorResult
 import org.ossreviewtoolkit.model.Package
+import org.ossreviewtoolkit.plugins.api.Plugin
 
 /**
  * An abstract class that represents a service that can retrieve any kind of advice information
  * for a list of given [Package]s. Examples of such information can be security vulnerabilities, known defects,
  * or code analysis results.
  */
-abstract class AdviceProvider(val providerName: String) {
+interface AdviceProvider : Plugin {
     /**
      * For a given set of [Package]s, retrieve findings and return a map that associates packages with [AdvisorResult]s.
      */
-    abstract suspend fun retrievePackageFindings(packages: Set<Package>): Map<Package, AdvisorResult>
+    suspend fun retrievePackageFindings(packages: Set<Package>): Map<Package, AdvisorResult>
 
     /**
      * An object with detail information about this [AdviceProvider].
      */
-    abstract val details: AdvisorDetails
+    val details: AdvisorDetails
 }

advisor/src/main/kotlin/AdviceProviderFactory.kt

@@ -21,24 +21,16 @@ package org.ossreviewtoolkit.advisor
 
 import java.util.ServiceLoader
 
-import org.ossreviewtoolkit.utils.common.Plugin
-import org.ossreviewtoolkit.utils.common.TypedConfigurablePluginFactory
+import org.ossreviewtoolkit.plugins.api.PluginFactory
 
 /**
  * A common abstract class for use with [ServiceLoader] that all [AdviceProviderFactory] classes need to implement.
  */
-abstract class AdviceProviderFactory<CONFIG>(override val type: String) :
-    TypedConfigurablePluginFactory<CONFIG, AdviceProvider> {
+interface AdviceProviderFactory : PluginFactory<AdviceProvider> {
     companion object {
         /**
          * All [advice provider factories][AdviceProviderFactory] available in the classpath, associated by their names.
          */
-        val ALL by lazy { Plugin.getAll<AdviceProviderFactory<*>>() }
+        val ALL by lazy { PluginFactory.getAll<AdviceProviderFactory, AdviceProvider>() }
     }
-
-    /**
-     * Return the provider's type here to allow Clikt to display something meaningful when listing the advisors which
-     * are enabled by default via their factories.
-     */
-    override fun toString() = type
 }

advisor/src/main/kotlin/Advisor.kt

@@ -33,14 +33,15 @@ import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.config.AdvisorConfiguration
+import org.ossreviewtoolkit.plugins.api.PluginConfig
 import org.ossreviewtoolkit.utils.ort.Environment
 
 /**
  * The class to manage [AdviceProvider]s. It invokes the configured providers and adds their findings to the current
  * [OrtResult].
  */
 class Advisor(
-    private val providerFactories: List<AdviceProviderFactory<*>>,
+    private val providerFactories: List<AdviceProviderFactory>,
     private val config: AdvisorConfiguration
 ) {
     /**
@@ -75,8 +76,8 @@ class Advisor(
                 logger.info { "There are no packages to give advice for." }
             } else {
                 val providers = providerFactories.map {
-                    val providerConfig = config.config?.get(it.type)
-                    it.create(providerConfig?.options.orEmpty(), providerConfig?.secrets.orEmpty())
+                    val providerConfig = config.config?.get(it.descriptor.className)
+                    it.create(PluginConfig(providerConfig?.options.orEmpty(), providerConfig?.secrets.orEmpty()))
                 }
 
                 providers.map { provider ->
@@ -85,7 +86,7 @@ class Advisor(
 
                         logger.info {
                             "Found ${providerResults.values.flatMap { it.vulnerabilities }.distinct().size} distinct " +
-                                "vulnerabilities via ${provider.providerName}. "
+                                "vulnerabilities via ${provider.descriptor.name}. "
                         }
 
                         providerResults.keys.takeIf { it.isNotEmpty() }?.let { pkgs ->

advisor/src/test/kotlin/AdvisorTest.kt

@@ -39,6 +39,8 @@ import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.Project
 import org.ossreviewtoolkit.model.config.AdvisorConfiguration
+import org.ossreviewtoolkit.plugins.api.PluginConfig
+import org.ossreviewtoolkit.plugins.api.PluginDescriptor
 
 class AdvisorTest : WordSpec({
     "retrieveFindings" should {
@@ -117,8 +119,8 @@ private fun createAdvisor(providers: List<AdviceProvider>): Advisor {
     val advisorConfig = AdvisorConfiguration()
 
     val factories = providers.map { provider ->
-        val factory = mockk<AdviceProviderFactory<*>>()
-        every { factory.create(emptyMap(), emptyMap()) } returns provider
+        val factory = mockk<AdviceProviderFactory>()
+        every { factory.create(PluginConfig(emptyMap(), emptyMap())) } returns provider
         factory
     }
 
@@ -146,7 +148,7 @@ private fun createPackage(index: Int): Package =
 
 private fun mockkAdviceProvider(): AdviceProvider =
     mockk<AdviceProvider>().apply {
-        every { providerName } returns "provider"
+        every { descriptor } returns PluginDescriptor("provider", "Provider", "", emptyList())
     }
 
 private fun mockkAdvisorResult(): AdvisorResult =

plugins/advisors/nexus-iq/build.gradle.kts

@@ -20,6 +20,9 @@
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
+
+    // Apply third-party plugins.
+    alias(libs.plugins.ksp)
 }
 
 dependencies {
@@ -29,4 +32,7 @@ dependencies {
     implementation(projects.clients.nexusIqClient)
     implementation(projects.utils.commonUtils)
     implementation(projects.utils.ortUtils)
+
+    ksp(projects.advisor)
+    ksp(projects.plugins.api)
 }

plugins/advisors/nexus-iq/src/main/kotlin/NexusIq.kt

@@ -44,7 +44,8 @@ import org.ossreviewtoolkit.model.utils.PurlType
 import org.ossreviewtoolkit.model.utils.getPurlType
 import org.ossreviewtoolkit.model.vulnerabilities.Vulnerability
 import org.ossreviewtoolkit.model.vulnerabilities.VulnerabilityReference
-import org.ossreviewtoolkit.utils.common.Options
+import org.ossreviewtoolkit.plugins.api.OrtPlugin
+import org.ossreviewtoolkit.plugins.api.PluginDescriptor
 import org.ossreviewtoolkit.utils.common.collectMessages
 import org.ossreviewtoolkit.utils.common.enumSetOf
 import org.ossreviewtoolkit.utils.ort.OkHttpClientHelper
@@ -77,27 +78,17 @@ private val READ_TIMEOUT = Duration.ofSeconds(60)
  *
  * If not both `username` and `password` are provided, authentication is disabled.
  */
-class NexusIq(name: String, private val config: NexusIqConfiguration) : AdviceProvider(name) {
-    class Factory : AdviceProviderFactory<NexusIqConfiguration>("NexusIQ") {
-        override fun create(config: NexusIqConfiguration) = NexusIq(type, config)
-
-        override fun parseConfig(options: Options, secrets: Options): NexusIqConfiguration {
-            val serverUrl = options.getValue("serverUrl")
-
-            return NexusIqConfiguration(
-                serverUrl = serverUrl,
-                browseUrl = options["browseUrl"] ?: serverUrl,
-                username = secrets["username"],
-                password = secrets["password"]
-            )
-        }
-    }
-
-    override val details: AdvisorDetails = AdvisorDetails(providerName, enumSetOf(AdvisorCapability.VULNERABILITIES))
+@OrtPlugin(
+    name = "Nexus IQ",
+    description = "An advisor that uses Sonatype's Nexus IQ Server to determine vulnerabilities in dependencies.",
+    factory = AdviceProviderFactory::class
+)
+class NexusIq(override val descriptor: PluginDescriptor, private val config: NexusIqConfiguration) : AdviceProvider {
+    override val details: AdvisorDetails = AdvisorDetails(descriptor.name, enumSetOf(AdvisorCapability.VULNERABILITIES))
 
     private val service by lazy {
         NexusIqService.create(
-            config.serverUrl,
+            config.serverUrl.orEmpty(),
             config.username,
             config.password,
             OkHttpClientHelper.buildClient {
@@ -141,7 +132,7 @@ class NexusIq(name: String, private val config: NexusIqConfiguration) : AdvicePr
                     component.packageUrl to ComponentDetails(component, SecurityData(emptyList()))
                 }
 
-                issues += Issue(source = providerName, message = it.collectMessages())
+                issues += Issue(source = descriptor.name, message = it.collectMessages())
             }
         }
 

plugins/advisors/nexus-iq/src/main/kotlin/NexusIqConfiguration.kt

@@ -29,19 +29,19 @@ data class NexusIqConfiguration(
     val serverUrl: String,
 
     /**
-     * A URL to use as a base for browsing vulnerability details. Defaults to the server URL.
+     * A URL to use as a base for browsing vulnerability details. If not set, the [serverUrl] is used.
      */
-    val browseUrl: String = serverUrl,
+    val browseUrl: String?,
 
     /**
      * The username to use for authentication. If not both [username] and [password] are provided, authentication is
      * disabled.
      */
-    val username: String? = null,
+    val username: String?,
 
     /**
      * The password to use for authentication. If not both [username] and [password] are provided, authentication is
      * disabled.
      */
-    val password: String? = null
+    val password: String?
 )

plugins/advisors/nexus-iq/src/main/resources/META-INF/services/org.ossreviewtoolkit.advisor.AdviceProviderFactory

@@ -20,6 +20,9 @@
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
+
+    // Apply third-party plugins.
+    alias(libs.plugins.ksp)
 }
 
 dependencies {
@@ -30,5 +33,8 @@ dependencies {
     implementation(projects.utils.commonUtils)
     implementation(projects.utils.ortUtils)
 
+    ksp(projects.advisor)
+    ksp(projects.plugins.api)
+
     testImplementation(libs.wiremock)
 }