Skip to content

Commit

Permalink
refactor(reporter)!: Rename the reporter to AOSD2 to avoid confusion
Browse files Browse the repository at this point in the history
Resolves #9063.

Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
  • Loading branch information
sschuberth committed Sep 9, 2024
1 parent e609a22 commit c21b31b
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion integrations/completions/ort-completion.fish
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ complete -c ort -f -n __fish_use_subcommand -a report -d 'Present Analyzer, Scan
## Options for report
complete -c ort -n "__fish_seen_subcommand_from report" -l ort-file -s i -r -F -d 'The ORT result file to use.'
complete -c ort -n "__fish_seen_subcommand_from report" -l output-dir -s o -r -F -d 'The output directory to store the generated reports in.'
complete -c ort -n "__fish_seen_subcommand_from report" -l report-formats -s f -r -d 'A comma-separated list of report formats to generate, any of [AOSD, CtrlXAutomation, CycloneDx, DocBookTemplate, EvaluatedModel, FossId, FossIdSnippet, GitLabLicenseModel, HtmlTemplate, ManPageTemplate, Opossum, PdfTemplate, PlainTextTemplate, SpdxDocument, StaticHtml, TrustSource, WebApp].'
complete -c ort -n "__fish_seen_subcommand_from report" -l report-formats -s f -r -d 'A comma-separated list of report formats to generate, any of [AOSD2, CtrlXAutomation, CycloneDx, DocBookTemplate, EvaluatedModel, FossId, FossIdSnippet, GitLabLicenseModel, HtmlTemplate, ManPageTemplate, Opossum, PdfTemplate, PlainTextTemplate, SpdxDocument, StaticHtml, TrustSource, WebApp].'
complete -c ort -n "__fish_seen_subcommand_from report" -l copyright-garbage-file -r -F -d 'A file containing copyright statements which are marked as garbage. This can make the output inconsistent with the evaluator output but is useful when testing copyright garbage.'
complete -c ort -n "__fish_seen_subcommand_from report" -l custom-license-texts-dir -r -F -d 'A directory which maps custom license IDs to license texts. It should contain one text file per license with the license ID as the filename. A custom license text is used only if its ID has a \'LicenseRef-\' prefix and if the respective license text is not known by ORT.'
complete -c ort -n "__fish_seen_subcommand_from report" -l how-to-fix-text-provider-script -r -F -d 'The path to a Kotlin script which returns an instance of a \'HowToFixTextProvider\'. That provider injects how-to-fix texts in Markdown format for ORT issues.'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import org.ossreviewtoolkit.reporter.ORT_RESULT
import org.ossreviewtoolkit.reporter.ReporterInput
import org.ossreviewtoolkit.utils.test.getAssetFile

class AudiOpenSourceDiagnosticsReporterFunTest : WordSpec({
class Aosd2ReporterFunTest : WordSpec({
"The example JSON report" should {
"be valid according to the schema" {
val schemaFile = getAssetFile("aosd.schema.json")
Expand All @@ -64,7 +64,7 @@ class AudiOpenSourceDiagnosticsReporterFunTest : WordSpec({
"The generated report" should {
"match the expected result" {
val outputDir = tempdir()
val reportFiles = AudiOpenSourceDiagnosticsReporter().generateReport(ReporterInput(ORT_RESULT), outputDir)
val reportFiles = Aosd2Reporter().generateReport(ReporterInput(ORT_RESULT), outputDir)

reportFiles shouldHaveSize 2

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ import org.ossreviewtoolkit.reporter.Reporter
import org.ossreviewtoolkit.reporter.ReporterInput
import org.ossreviewtoolkit.utils.spdx.SpdxLicense

class AudiOpenSourceDiagnosticsReporter : Reporter {
override val type = "AOSD"
class Aosd2Reporter : Reporter {
override val type = "AOSD2"

override fun generateReport(
input: ReporterInput,
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
org.ossreviewtoolkit.plugins.reporters.aosd.AudiOpenSourceDiagnosticsReporter
org.ossreviewtoolkit.plugins.reporters.aosd.Aosd2Reporter
2 changes: 1 addition & 1 deletion website/docs/tools/reporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 6
The *reporter* generates a wide variety of documents in different formats from ORT result files.
Currently, the following formats are supported (reporter names are case-insensitive):

* [Audi Open Source Diagnostics](https://www.aosd.cloud.audi/help) (`-f AOSD`)
* [Audi Open Source Diagnostics 2](https://www.aosd.cloud.audi/help) (`-f AOSD2`)
* [AsciiDoc Template](../configuration/reporter-templates.md#asciidoc-templates) (`-f AsciiDocTemplate`)
* Customizable with [Apache Freemarker](https://freemarker.apache.org/) templates and [AsciiDoc](https://asciidoc.org/)
* PDF style customizable with Asciidoctor [PDF themes](https://docs.asciidoctor.org/pdf-converter/latest/theme/)
Expand Down

0 comments on commit c21b31b

Please sign in to comment.