Add option to output SBOM report to a file #530
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Benchmark Test ResultsBenchmark results from the latest changes vs base branch |
Signed-off-by: Alex Goodman <[email protected]>
0c11369 to
a5e7281
Compare
luhring
reviewed
Oct 5, 2021
internal/ui/select.go
Outdated
| // Select is responsible for determining the specific UI function given select user option, the current platform | ||
| // config values, and environment status (such as a TTY being present). | ||
| func Select(verbose, quiet bool) UI { | ||
| func Select(verbose, quiet bool, reportWriter io.Writer) UI { |
There was a problem hiding this comment.
It'd be nice to explain the correct usage of this new parameter (even very briefly) in the function's doc comment
internal/config/application.go
Outdated
| type Application struct { | ||
| ConfigPath string `yaml:",omitempty" json:"configPath"` // the location where the application config was read from (either from -c or discovered while loading) | ||
| Output string `yaml:"output" json:"output" mapstructure:"output"` // -o, the Presenter hint string to use for report formatting | ||
| File string `yaml:"file" json:"file" mapstructure:"file"` // -f, the file to write report output to |
There was a problem hiding this comment.
We should probably remove -f from this line's comment for now
cmd/root.go
Outdated
| rootCmd.PersistentFlags().CountVarP(&persistentOpts.Verbosity, "verbose", "v", "increase verbosity (-v = info, -vv = debug)") | ||
|
|
||
| rootCmd.PersistentFlags().StringP( | ||
| "file", "f", "", |
There was a problem hiding this comment.
Should we remove the "f" for now?
There was a problem hiding this comment.
this was my bad --I removed it but was restoring work from the reflog and accidentally brought it back. Removing again...
cmd/report_writer.go
Outdated
| } | ||
| return reportFile, func() error { | ||
| if !appConfig.Quiet { | ||
| _, _ = fmt.Fprintf(os.Stderr, "Report written to %q\n", path) |
There was a problem hiding this comment.
Curious: Can we not use logging here?
Signed-off-by: Alex Goodman <[email protected]>
Signed-off-by: Alex Goodman <[email protected]>
Signed-off-by: Alex Goodman <[email protected]>
Signed-off-by: Alex Goodman <[email protected]>
Signed-off-by: Alex Goodman <[email protected]>
spiffcs
approved these changes
Oct 5, 2021
luhring
approved these changes
Oct 5, 2021
This was referenced Oct 5, 2021
|
Just as a note, most command line applications seem to use |
GijsCalis
pushed a commit
to GijsCalis/syft
that referenced
this pull request
Feb 19, 2024
* add output to file option Signed-off-by: Alex Goodman <[email protected]> * log errors on close of the report destination Signed-off-by: Alex Goodman <[email protected]> * remove file option from persistent args Signed-off-by: Alex Goodman <[email protected]> * update file option comments and logging Signed-off-by: Alex Goodman <[email protected]> * allow for multiple UI fallback options Signed-off-by: Alex Goodman <[email protected]> * update UI select signatures + tests Signed-off-by: Alex Goodman <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This PR adds a new
--fileoption that writes the report bytes out to the given file path. Note: since the same functionality will be ported to grype it was decided that-fwill not be used since that option is already taken in grype.