reporter: Add a very basic SpdxDocumentReporter #2800

fviernau · 2020-06-29T15:43:48Z

Add an initial SPDX document reporter which for now only creates the
document header. Logic for serializing additional data will be added
incrementally in following changes.

Signed-off-by: Frank Viernau frank.viernau@here.com

reporter/src/funTest/assets/spdx-document-reporter-expected-output.spdx.json

reporter/src/funTest/kotlin/reporters/SpdxDocumentReporterTest.kt

reporter/src/main/kotlin/reporters/SpdxDocumentReporter.kt

reporter/src/main/kotlin/utils/SpdxDocumentModelMapper.kt

reporter/src/funTest/kotlin/reporters/SpdxDocumentReporterTest.kt

reporter/src/main/kotlin/reporters/SpdxDocumentReporter.kt

reporter/src/main/kotlin/utils/SpdxDocumentModelMapper.kt

tsteenbe · 2020-06-30T08:48:49Z

@fviernau Could you add a debug statement to show how long it took to generate the report? Like the other reporter have, see for example https://github.com/oss-review-toolkit/ort/blob/master/reporter/src/main/kotlin/reporters/EvaluatedModelReporter.kt#L68

sschuberth · 2020-06-30T08:50:12Z

Could you add a debug statement to show how long it took to generate the report?

That shouldn't be necessary as the generation of any report is timed.

test-utils/src/main/kotlin/Utils.kt

reporter/src/funTest/assets/spdx-document-reporter-expected-output.spdx.json

reporter/src/funTest/kotlin/reporters/SpdxDocumentReporterTest.kt

reporter/src/main/kotlin/reporters/SpdxDocumentReporter.kt

reporter/src/main/kotlin/utils/SpdxDocumentModelMapper.kt

To prepare for an upcoming change. Signed-off-by: Frank Viernau <frank.viernau@here.com>

reporter/src/funTest/kotlin/reporters/SpdxDocumentReporterTest.kt

reporter/src/main/kotlin/reporters/SpdxDocumentReporter.kt

All change requests addressed

reporter/src/main/kotlin/reporters/SpdxDocumentReporter.kt

Add an initial SPDX document reporter which for now only creates the document header. Logic for serializing additional data will be added incrementally in following changes. Signed-off-by: Frank Viernau <frank.viernau@here.com>

swinslow

I happened to see this linked from another issue in spdx/spdx-spec -- added a couple of comments re: the Document Creation Info section in the generated output samples.

swinslow · 2020-06-30T13:55:35Z

reporter/src/funTest/assets/spdx-document-reporter-expected-output.spdx.json

@@ -0,0 +1,14 @@
+{
+  "SPDXID" : "SPDXRef-<REPLACE_UUID>",


The SPDXID for the document itself should always be the literal text "SPDXRef-DOCUMENT" -- see https://spdx.github.io/spdx-spec/v2-draft/document-creation-information/#63-spdx-identifier-field

Thanks @swinslow, greatly appreciated!
I'll merge the PR as is now, and then address your comment(s) in a follow up PR.

@swinslow - I've addressed your findings with #2812 .

LGTM, thanks @fviernau!

swinslow · 2020-06-30T13:57:05Z

reporter/src/funTest/assets/spdx-document-reporter-expected-output.spdx.json

@@ -0,0 +1,14 @@
+{
+  "SPDXID" : "SPDXRef-<REPLACE_UUID>",
+  "spdxVersion" : "SPDX-2.2.1",


The format for the SPDX version field is SPDX-M.N -- the major and minor versions are included, but not the point releases if there is one -- see https://spdx.github.io/spdx-spec/v2-draft/document-creation-information/#61-spdx-version-field

So this should just be "SPDX-2.2", even after the 2.2.1 release of the spec comes out. The intention is that the point release 2.2.1 is not changing anything substantive in the spec, so SPDX 2.2.1 documents should be identical to 2.2.

swinslow · 2020-06-30T13:57:43Z

reporter/src/funTest/assets/spdx-document-reporter-expected-output.spdx.yml

@@ -0,0 +1,13 @@
+---
+SPDXID: "SPDXRef-<REPLACE_UUID>"


same comment as in JSON file, the value here should be SPDXRef-DOCUMENT

swinslow · 2020-06-30T13:58:00Z

reporter/src/funTest/assets/spdx-document-reporter-expected-output.spdx.yml

@@ -0,0 +1,13 @@
+---
+SPDXID: "SPDXRef-<REPLACE_UUID>"
+spdxVersion: "SPDX-2.2.1"


same comment as in JSON file, the value here should be SPDX-2.2

fviernau requested review from mnonnenmacher and sschuberth as code owners June 29, 2020 15:43

mnonnenmacher reviewed Jun 29, 2020

View reviewed changes

reporter/src/funTest/assets/spdx-document-reporter-expected-output.spdx.json Show resolved Hide resolved

mnonnenmacher previously requested changes Jun 29, 2020

View reviewed changes

sschuberth requested changes Jun 30, 2020

View reviewed changes

fviernau force-pushed the basic-spdx-reporter branch 3 times, most recently from 957b11c to 7df851c Compare June 30, 2020 09:51

fviernau requested review from sschuberth, mnonnenmacher and tsteenbe June 30, 2020 09:53

sschuberth requested changes Jun 30, 2020

View reviewed changes

Utils: Let patchExpectedResult() accept multiple custom replacements

a0df61c

To prepare for an upcoming change. Signed-off-by: Frank Viernau <frank.viernau@here.com>

fviernau force-pushed the basic-spdx-reporter branch from 7df851c to b9d0089 Compare June 30, 2020 10:07

sschuberth requested changes Jun 30, 2020

View reviewed changes

reporter/src/funTest/kotlin/reporters/SpdxDocumentReporterTest.kt Outdated Show resolved Hide resolved

reporter/src/main/kotlin/reporters/SpdxDocumentReporter.kt Outdated Show resolved Hide resolved

fviernau force-pushed the basic-spdx-reporter branch 2 times, most recently from c29ade7 to cac7349 Compare June 30, 2020 10:25

fviernau requested a review from sschuberth June 30, 2020 10:25

sschuberth previously approved these changes Jun 30, 2020

View reviewed changes

tsteenbe reviewed Jun 30, 2020

View reviewed changes

reporter/src/main/kotlin/reporters/SpdxDocumentReporter.kt Show resolved Hide resolved

fviernau dismissed sschuberth’s stale review via 8915e7f June 30, 2020 12:21

fviernau force-pushed the basic-spdx-reporter branch from cac7349 to 8915e7f Compare June 30, 2020 12:21

reporter: Add a very basic SpdxDocumentReporter

6a285dd

Add an initial SPDX document reporter which for now only creates the document header. Logic for serializing additional data will be added incrementally in following changes. Signed-off-by: Frank Viernau <frank.viernau@here.com>

fviernau force-pushed the basic-spdx-reporter branch from 8915e7f to 6a285dd Compare June 30, 2020 12:25

mnonnenmacher approved these changes Jun 30, 2020

View reviewed changes

swinslow reviewed Jun 30, 2020

View reviewed changes

fviernau merged commit 0695f55 into master Jun 30, 2020

fviernau deleted the basic-spdx-reporter branch June 30, 2020 14:31

fviernau mentioned this pull request Jul 1, 2020

Spdx document model fixes #2812

Merged

sschuberth mentioned this pull request Sep 8, 2020

Provide SPDX file as output #1913

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

reporter: Add a very basic SpdxDocumentReporter #2800

reporter: Add a very basic SpdxDocumentReporter #2800

fviernau commented Jun 29, 2020

tsteenbe commented Jun 30, 2020

sschuberth commented Jun 30, 2020 •

edited

Loading

swinslow left a comment

swinslow Jun 30, 2020

fviernau Jun 30, 2020

fviernau Jul 1, 2020

swinslow Jul 1, 2020

swinslow Jun 30, 2020

swinslow Jun 30, 2020

swinslow Jun 30, 2020

reporter: Add a very basic SpdxDocumentReporter #2800

reporter: Add a very basic SpdxDocumentReporter #2800

Conversation

fviernau commented Jun 29, 2020

tsteenbe commented Jun 30, 2020

sschuberth commented Jun 30, 2020 • edited Loading

swinslow left a comment

Choose a reason for hiding this comment

swinslow Jun 30, 2020

Choose a reason for hiding this comment

fviernau Jun 30, 2020

Choose a reason for hiding this comment

fviernau Jul 1, 2020

Choose a reason for hiding this comment

swinslow Jul 1, 2020

Choose a reason for hiding this comment

swinslow Jun 30, 2020

Choose a reason for hiding this comment

swinslow Jun 30, 2020

Choose a reason for hiding this comment

swinslow Jun 30, 2020

Choose a reason for hiding this comment

sschuberth commented Jun 30, 2020 •

edited

Loading