Add bom document todot
#537
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind feature
What this PR does / why we need it:
Adds the
todot
sub command forbom document
. This command dumps the contents of the provided spdx file as a string of dotlang to stdout. This output can then be piped into a file for visualization by graphvis or other related programs. This overcomes the visualization limitations ofbom document outline
detailed here #530.todot
comes with a few cli arguments to help filter large SBOMs into a more digestible graph.--find
finds the reverse dependencies of a given package--subgraph
promotes a node with the given SPDXID to root ignoring all nodes that aren't descendants of the given node.--depth
the recursive depth.for example the sbom.
Will produce the dot
bom document todot file.spdx > file.dot
which when rendered with graphviz produces the following
.png
dot -Tpng file.dot > file.png
Which issue(s) this PR fixes:
Fixes #530
Special notes for your reviewer:
Does this PR introduce a user-facing change?