Skip to content

test: Add test for CycloneDX XML with authors #10271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

test: Add test for CycloneDX XML with authors #10271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions plugins/reporters/cyclonedx/src/funTest/kotlin/CycloneDxReporterFunTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ import io.kotest.matchers.shouldNotBe
import org.cyclonedx.parsers.JsonParser
import org.cyclonedx.parsers.XmlParser

import org.ossreviewtoolkit.model.Identifier
import org.ossreviewtoolkit.model.OrtResult
import org.ossreviewtoolkit.plugins.reporters.cyclonedx.CycloneDxReporter.Companion.REPORT_BASE_FILENAME
import org.ossreviewtoolkit.reporter.ORT_RESULT
import org.ossreviewtoolkit.reporter.ORT_RESULT_WITH_ILLEGAL_COPYRIGHTS
Expand Down Expand Up @@ -94,6 +96,30 @@ class CycloneDxReporterFunTest : WordSpec({
}
}

"create the expected XML file with authors" {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe instead of adding a new separate test, it would make sense to instead enhance the input of "create the expected XML file". For enhancing it withAuthors() imo is ok. Furthermore, the analog JSON test case IMO should also use / keep on using the same input, so that XML and JSON tests remain analog.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MarcelBochtler would you agree with above? (and update the commit)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MarcelBochtler would you agree with above? (and update the commit)

I would agree if the tests would pass.

But as the test is currently expected to fail, it would either have to be disabled or not being merged at all.
If I add the withAuthors() to the "create the expected XML file" file, we can no longer disable the test.

I'm not sure how to continue here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how to continue here.

I think the best we can do is to either push at CycloneDX/cyclonedx-core-java#638 for a fix, or contribute the fix ourselves.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would agree if the tests would pass.

If we re-target this commit to update the test input data to illustrate an issue with the authors (not serialized), wouldn't the be ok? (And once it's fixed upstream and integrated, the expected results would be updated for good). (If this was merged as-is, then we have to revert it and update the existing tests, which seems unnecessary work)

val expectedBom = readResource("/cyclonedx-reporter-expected-result-with-authors.xml")

val ortResult = ORT_RESULT.withAuthors(
packageId = Identifier("NPM:@ort:license-file:1.0"),
authors = setOf("Author One", "Author Two")
)

val bomFileResults = CycloneDxReporterFactory.create(
singleBom = true,
outputFileFormats = listOf("xml")
).generateReport(ReporterInput(ortResult), outputDir)

bomFileResults.shouldBeSingleton {
it shouldBeSuccess { bomFile ->
bomFile shouldBe aFile()
bomFile shouldNotBe emptyFile()

val actualBom = bomFile.readText().patchCycloneDxResult().normalizeLineBreaks()
actualBom shouldBe expectedBom
}
}
}

"the expected XML file even if some copyrights contain non printable characters" {
val bomFileResults = CycloneDxReporterFactory.create(
singleBom = true,
Expand Down Expand Up @@ -224,6 +250,26 @@ class CycloneDxReporterFunTest : WordSpec({
}
})

/**
* Add [authors] to the [package][packageId].
*/
private fun OrtResult.withAuthors(packageId: Identifier, authors: Set<String>): OrtResult =
analyzer?.let { analyzer ->
copy(
analyzer = analyzer.copy(
result = analyzer.result.copy(
packages = analyzer.result.packages.map { pkg ->
if (pkg.id == packageId) {
pkg.copy(authors = authors)
} else {
pkg
}
}.toSet()
)
)
)
} ?: this

private fun String.patchCycloneDxResult(): String =
replaceFirst(
"""urn:uuid:[a-f0-9]{8}(?:-[a-f0-9]{4}){4}[a-f0-9]{8}""".toRegex(),
Expand Down
Loading
Loading