Skip to content

Commit

Permalink
refactor(plugins): Fix casing in plugin IDs
Browse files Browse the repository at this point in the history
Fix casing in plugin IDs where the class name does not exactly match the
spelling of the service it represents.

Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
  • Loading branch information
mnonnenmacher committed Sep 9, 2024
1 parent 723e003 commit 6ecdb9e
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 5 deletions.
2 changes: 1 addition & 1 deletion integrations/completions/ort-completion.fish
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ complete -c ort -n "__fish_seen_subcommand_from advise" -l output-dir -s o -r -F
complete -c ort -n "__fish_seen_subcommand_from advise" -l output-formats -s f -r -fa "JSON YAML" -d 'The list of output formats to be used for the ORT result file(s).'
complete -c ort -n "__fish_seen_subcommand_from advise" -l label -s l -r -d 'Set a label in the ORT result, overwriting any existing label of the same name. Can be used multiple times. For example: --label distribution=external'
complete -c ort -n "__fish_seen_subcommand_from advise" -l resolutions-file -r -F -d 'A file containing issue and rule violation resolutions.'
complete -c ort -n "__fish_seen_subcommand_from advise" -l advisors -s a -r -d 'The comma-separated advisors to use, any of [NexusIq, OssIndex, Osv, VulnerableCode].'
complete -c ort -n "__fish_seen_subcommand_from advise" -l advisors -s a -r -d 'The comma-separated advisors to use, any of [NexusIQ, OSSIndex, OSV, VulnerableCode].'
complete -c ort -n "__fish_seen_subcommand_from advise" -l skip-excluded -d 'Do not check excluded projects or packages.'
complete -c ort -n "__fish_seen_subcommand_from advise" -s h -l help -d 'Show this message and exit'

Expand Down
1 change: 1 addition & 0 deletions plugins/advisors/nexus-iq/src/main/kotlin/NexusIq.kt
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ private val READ_TIMEOUT = Duration.ofSeconds(60)
* If not both `username` and `password` are provided, authentication is disabled.
*/
@OrtPlugin(
id = "NexusIQ",
displayName = "Nexus IQ",
description = "An advisor that uses Sonatype's Nexus IQ Server to determine vulnerabilities in dependencies.",
factory = AdviceProviderFactory::class
Expand Down
1 change: 1 addition & 0 deletions plugins/advisors/oss-index/src/main/kotlin/OssIndex.kt
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ private const val BULK_REQUEST_SIZE = 128
* A wrapper for Sonatype's [OSS Index](https://ossindex.sonatype.org/) security vulnerability data.
*/
@OrtPlugin(
id = "OSSIndex",
displayName = "OSS Index",
description = "An advisor that uses Sonatype's OSS Index to determine vulnerabilities in dependencies.",
factory = AdviceProviderFactory::class
Expand Down
2 changes: 1 addition & 1 deletion plugins/advisors/oss-index/src/test/kotlin/OssIndexTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ class OssIndexTest : WordSpec({
}
})

private const val ADVISOR_NAME = "OssIndex"
private const val ADVISOR_NAME = "OSSIndex"

private const val TEST_FILES_ROOT = "src/test/assets"

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"NPM::find-my-way:3.0.0" : {
"advisor" : {
"name" : "Osv",
"name" : "OSV",
"capabilities" : [ "VULNERABILITIES" ]
},
"summary" : {
Expand Down Expand Up @@ -34,7 +34,7 @@
},
"NPM::discord-markdown:2.3.0" : {
"advisor" : {
"name" : "Osv",
"name" : "OSV",
"capabilities" : [ "VULNERABILITIES" ]
},
"summary" : {
Expand Down Expand Up @@ -63,7 +63,7 @@
},
"PyPI::donfig:0.2.0" : {
"advisor" : {
"name" : "Osv",
"name" : "OSV",
"capabilities" : [ "VULNERABILITIES" ]
},
"summary" : {
Expand Down
1 change: 1 addition & 0 deletions plugins/advisors/osv/src/main/kotlin/Osv.kt
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ import us.springett.cvss.Cvss
* OSV.dev API.
*/
@OrtPlugin(
id = "OSV",
displayName = "OSV",
description = "An advisor that retrieves vulnerability information from the Open Source Vulnerabilities database.",
factory = AdviceProviderFactory::class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ data class DosPackageConfigurationProviderConfig(
* A [PackageConfigurationProvider] that loads [PackageConfiguration]s from a Double Open Server instance.
*/
@OrtPlugin(
id = "DOS",
displayName = "Double Open Server Package Configuration Provider",
description = "A package configuration provider that loads package configurations from a Double Open Server " +
"instance.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ private const val PACKAGE_CONFIGURATIONS_DIR = "package-configurations"
* [ort-config repository](https://github.com/oss-review-toolkit/ort-config).
*/
@OrtPlugin(
id = "ORTConfig",
displayName = "ort-config",
description = "A package configuration provider that loads package configurations from the ort-config repository.",
factory = PackageConfigurationProviderFactory::class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ private const val ORT_CONFIG_REPOSITORY_URL = "https://github.com/oss-review-too
* [ort-config repository](https://github.com/oss-review-toolkit/ort-config).
*/
@OrtPlugin(
id = "ORTConfig",
displayName = "ort-config",
description = "A package curation provider that loads package curations from the ort-config repository.",
factory = PackageCurationProviderFactory::class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ data class Sw360PackageCurationProviderConfig(
* A [PackageCurationProvider] for curated package metadata from the configured SW360 instance using the REST API.
*/
@OrtPlugin(
id = "SW360",
displayName = "SW360 Package Curation Provider",
description = "Provides package metadata from the configured SW360 instance using the REST API.",
factory = PackageCurationProviderFactory::class
Expand Down

0 comments on commit 6ecdb9e

Please sign in to comment.