Provide SPDX file as output

oss-review-toolkit / ort

A suite of tools to automate software compliance checks.

https://oss-review-toolkit.org

Apache License 2.0

1.59k stars 309 forks source link

Provide SPDX file as output #1913

Closed silverhook closed 4 years ago

silverhook commented 4 years ago

It would be really useful if ORT would provide an SPDX file as output, so one can import them into other tools.

From what I follow the development of SPDX, it seems like most additional tags that OTR uses are being discussed as being integrated into the new SPDX spec. Also it seems a JSON or YAML version of format is being discussed. So both of those issues should not be blockers any more.

tsteenbe commented 4 years ago

@silverhook We did not have an issue for it be we have already started the prep work for ORT to produce SPDX output, see for example https://github.com/heremaps/oss-review-toolkit/pull/1903.

sschuberth commented 4 years ago

Actually, our original idea was to not have SPDX output from the reporter at all, but only from the documenter (which does not exist yet). The envisioned difference between reporter and documenter was that the reporter is used to visualize "intermediate" / potentially incomplete results (like analysis results without scan results), and the documenter would be used at the end of the pipeline to create "real BOMs" that also include license conclusions / policy waivers.

However, we've softened that strict (and maybe somewhat artificial) distinction already anyway on user demand by adding CycloneDX BOM output to the reporter, so I agree we should also add SPDX (tag-value and RDF) output, probably via https://github.com/spdx/tools.

tsteenbe commented 4 years ago

Now that SPDX 2.2 has been released work has started on implementing SPDX reporter.

Tasks:

[ ] Update https://github.com/oss-review-toolkit/ort/tree/spdx-reporter to match v2.2 specification.
[ ] Generate a basic SPDX document
[ ] Map packages in OrtResult to packages array in SPDX document
[ ] Map file findings in OrtResult to files array in SPDX document
[ ] Render dependency tree as set of relationships
[ ] Add support hasExtractedLicensingInfos e.g. inclusion in SPDX file output of id and full license text for non SPDX licenses

sschuberth commented 4 years ago

The SPDX reporter was implemented as part of https://github.com/oss-review-toolkit/ort/pull/2800 and meanwhile improved with several follow-up PRs, so I believe this is good to be closed.