refactor(plugins-api)!: Rename PluginDescriptor.name to displayName

The new name makes the purpose of the property clearer. Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
oss-review-toolkit · Sep 2, 2024 · 9b13596 · 9b13596
1 parent b42f894
commit 9b13596
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 11 deletions.
diff --git a/advisor/src/main/kotlin/Advisor.kt b/advisor/src/main/kotlin/Advisor.kt
@@ -86,7 +86,7 @@ class Advisor(
 
                         logger.info {
                             "Found ${providerResults.values.flatMap { it.vulnerabilities }.distinct().size} distinct " +
-                                "vulnerabilities via ${provider.descriptor.name}. "
+                                "vulnerabilities via ${provider.descriptor.displayName}. "
                         }
 
                         providerResults.keys.takeIf { it.isNotEmpty() }?.let { pkgs ->

diff --git a/plugins/advisors/nexus-iq/src/main/kotlin/NexusIq.kt b/plugins/advisors/nexus-iq/src/main/kotlin/NexusIq.kt
@@ -132,7 +132,7 @@ class NexusIq(override val descriptor: PluginDescriptor, private val config: Nex
                     component.packageUrl to ComponentDetails(component, SecurityData(emptyList()))
                 }
 
-                issues += Issue(source = descriptor.name, message = it.collectMessages())
+                issues += Issue(source = descriptor.displayName, message = it.collectMessages())
             }
         }
 

diff --git a/plugins/advisors/oss-index/src/main/kotlin/OssIndex.kt b/plugins/advisors/oss-index/src/main/kotlin/OssIndex.kt
@@ -113,7 +113,7 @@ class OssIndex(override val descriptor: PluginDescriptor, config: OssIndexConfig
                     ComponentReport(purl, reference = "", vulnerabilities = emptyList())
                 }
 
-                issues += Issue(source = descriptor.name, message = it.collectMessages())
+                issues += Issue(source = descriptor.displayName, message = it.collectMessages())
             }
         }
 

diff --git a/plugins/advisors/vulnerable-code/src/main/kotlin/VulnerableCode.kt b/plugins/advisors/vulnerable-code/src/main/kotlin/VulnerableCode.kt
@@ -111,7 +111,7 @@ class VulnerableCode(override val descriptor: PluginDescriptor, config: Vulnerab
                 // issues that are not associated to any package.
                 allVulnerabilities += chunk.associateWith { emptyList() }
 
-                issues += Issue(source = descriptor.name, message = it.collectMessages())
+                issues += Issue(source = descriptor.displayName, message = it.collectMessages())
 
                 logger.error {
                     "The request of chunk ${index + 1} of ${chunks.size} failed for the following ${chunk.size} " +
@@ -161,7 +161,11 @@ class VulnerableCode(override val descriptor: PluginDescriptor, config: Vulnerab
                 VulnerabilityReference(sourceUri, it.scoringSystem, severity)
             }
         }.onFailure {
-            issues += createAndLogIssue(descriptor.name, "Failed to map $this to ORT model due to $it.", Severity.HINT)
+            issues += createAndLogIssue(
+                descriptor.displayName,
+                "Failed to map $this to ORT model due to $it.",
+                Severity.HINT
+            )
         }.getOrElse { emptyList() }
 
     /**

diff --git a/plugins/api/src/main/kotlin/PluginDescriptor.kt b/plugins/api/src/main/kotlin/PluginDescriptor.kt
@@ -24,9 +24,9 @@ package org.ossreviewtoolkit.plugins.api
  */
 data class PluginDescriptor(
     /**
-     * The name of the plugin. Must be unique among all plugins for the same factory class.
+     * The display name of the plugin. Must be unique among all plugins for the same factory class.
      */
-    val name: String,
+    val displayName: String,
 
     /**
      * The name of the plugin class.

diff --git a/plugins/compiler/src/main/kotlin/JsonSpecGenerator.kt b/plugins/compiler/src/main/kotlin/JsonSpecGenerator.kt
@@ -40,7 +40,7 @@ class JsonSpecGenerator(private val codeGenerator: CodeGenerator) {
     fun generate(pluginSpec: PluginSpec) {
         val jsonObject = buildJsonObject {
             putJsonObject("descriptor") {
-                put("name", pluginSpec.descriptor.name)
+                put("displayName", pluginSpec.descriptor.displayName)
                 put("className", pluginSpec.descriptor.className)
                 put("description", pluginSpec.descriptor.description)
 

diff --git a/plugins/compiler/src/main/kotlin/PluginFactoryGenerator.kt b/plugins/compiler/src/main/kotlin/PluginFactoryGenerator.kt
@@ -148,13 +148,13 @@ class PluginFactoryGenerator(private val codeGenerator: CodeGenerator) {
             add(
                 """
                 PluginDescriptor(
-                    name = %S,
+                    displayName = %S,
                     className = %S,
                     description = %S,
                     options = listOf(
             
                 """.trimIndent(),
-                descriptor.name,
+                descriptor.displayName,
                 descriptor.className,
                 descriptor.description
             )

diff --git a/plugins/compiler/src/main/kotlin/PluginSpecFactory.kt b/plugins/compiler/src/main/kotlin/PluginSpecFactory.kt
@@ -63,7 +63,7 @@ class PluginSpecFactory {
         return PluginSpec(
             containingFile = pluginClass.containingFile,
             descriptor = PluginDescriptor(
-                name = ortPlugin.name,
+                displayName = ortPlugin.name,
                 className = pluginClass.simpleName.asString(),
                 description = ortPlugin.description,
                 options = pluginOptions