Skip to content
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

Jump to bottom

Add support for multiple output files in different formats #732

Merged
merged 24 commits into from
Jan 6, 2022
Merged

Add support for multiple output files in different formats #732

merged 24 commits into from
Jan 6, 2022

Conversation

kzantow
Copy link
Contributor

@kzantow kzantow commented Jan 3, 2022 •
edited
Loading

This PR adds support for multiple -o / --output options (and similarly in yaml). It continues to support the yaml syntax with a single option of output: 'json'. Additionally, each output option can specify a file by appending =<file>. For example, to output a Syft JSON and SPDX JSON, one could use: syft -o json=my.syft.json -o spdx-json=my.spdx.json

TODO:

  • refactor all references to presenter
  • add tests

kzantow added 6 commits January 3, 2022 17:34
@kzantow
Add support for multiple output files in different formats
5c0b8e8 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
Some issues
20acbb2 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
> 60 lines
6572d2c 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
*sigh*
86aeb59 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
*double sigh*
98f12cf 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
*triple sigh* and update README
5a6b757 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
kzantow
kzantow commented Jan 4, 2022
View reviewed changes
README.md Show resolved Hide resolved
kzantow
kzantow commented Jan 4, 2022
View reviewed changes
cmd/packages.go Outdated Show resolved Hide resolved
kzantow
kzantow commented Jan 4, 2022
View reviewed changes
cmd/packages.go Outdated Show resolved Hide resolved
kzantow
kzantow commented Jan 4, 2022
View reviewed changes
cmd/packages.go
)

flags.StringP(
"file", "", "",
"file to write the report output to (default is STDOUT)",
"file to write the default report output to (default is STDOUT)",
Copy link
Contributor Author

@kzantow kzantow Jan 4, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

should this be deprecated? if so, how would that be done? just updates to this and the readme?

Copy link
Contributor

Choose a reason for hiding this comment

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

Is -o intended to replace --file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't really know, but the functionality is redundant. it would seem outputting a table to a file is fairly useless, so generally a user would have to do -o spdx-json --file <output-file>, for example. But this is already covered by the -o spdx-json=<output-file>...

Copy link
Contributor

Choose a reason for hiding this comment

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

I see your point on redundancy.

My take: I think it makes sense to leave the --file flag as it's not harming anything by leaving it. We probably don't need to add a deprecation notice if we aren't removing it (we could always decide to remove it in the future).

kzantow
kzantow commented Jan 4, 2022
View reviewed changes
syft/event/parsers/parsers.go Outdated Show resolved Hide resolved
kzantow added 11 commits January 4, 2022 10:47
@kzantow
minor cleanup
f6a649a 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
this probably shouldn't be a pointer
771eac3 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
main refactoring
44be52b 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
remove presenter references
c526bae 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
remove more presenter references
8f83297 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
Merge remote-tracking branch 'upstream/main' into multiple-sbom-outputs
6ab05a3
@kzantow
power_user should use json
81a923f 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
simplify a few things and hopefully fix power-user
69e00e2 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
make fields public
69c7cf1 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
minor refactor
b719dd6 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
add some tests for multi out configuration
c11f4f9 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow kzantow marked this pull request as ready for review January 6, 2022 00:34
@kzantow kzantow requested a review from a team January 6, 2022 14:26
wagoodman
wagoodman reviewed Jan 6, 2022
View reviewed changes
internal/output/writer.go Outdated Show resolved Hide resolved
wagoodman
wagoodman reviewed Jan 6, 2022
View reviewed changes
cmd/output_writer_test.go Outdated Show resolved Hide resolved
wagoodman
wagoodman reviewed Jan 6, 2022
View reviewed changes
cmd/power_user.go Outdated Show resolved Hide resolved
wagoodman
wagoodman reviewed Jan 6, 2022
View reviewed changes
Copy link
Contributor

@wagoodman wagoodman left a comment

Choose a reason for hiding this comment

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

Looks great! I only had minor code comments --can you also add a CLI test to test the wiring of multiple -o options and assert the formats were written correctly? I think we have some helpers that could get repurposed for this.

@sambhav sambhav mentioned this pull request Jan 6, 2022
Open
kzantow added 4 commits January 6, 2022 14:49
@kzantow
PR feedback: add CLI tests and better tmpdir handling
fa3beef 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
better tmpdir handling
d2b80bf 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
rename SBOMReady -> Exit
da7f39d 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
@kzantow
nit: terminology
49b227a 
Signed-off-by: Keith Zantow <kzantow@gmail.com>
wagoodman
wagoodman approved these changes Jan 6, 2022
View reviewed changes
Copy link
Contributor

@wagoodman wagoodman left a comment

Choose a reason for hiding this comment

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

Looks great 👍 nice work!

@kzantow kzantow merged commit 5e5312c into anchore:main Jan 6, 2022
@kzantow kzantow deleted the multiple-sbom-outputs branch January 6, 2022 22:52
@kzantow kzantow linked an issue Jan 6, 2022 that may be closed by this pull request
Support generating multiple BOM files in different formats within a run #325
Closed
@seabass-labrax
Copy link

Great addition; thanks! 😃

spiffcs added a commit that referenced this pull request Jan 19, 2022
@spiffcs
Merge branch 'hectorj2f/add_dependencies_to_cyclonedx' of https://git…
1a1e9f7 
…hub.com/hectorj2f/syft into hectorj2f/add_dependencies_to_cyclonedx

* 'hectorj2f/add_dependencies_to_cyclonedx' of https://github.com/hectorj2f/syft: (29 commits)
  Improve CycloneDX format output (#710)
  Add additional PHP metadata (#753)
  Update Syft formats for SyftJson (#752)
  Add support for "file" source type in syftjson unmarshaling (#750)
  remove contains file from spdx dependency generation
  support .sar for java ecosystem (#748)
  Start developer documentation (#746)
  Align SPDX export more with SPDX 2.2 specification (#743)
  Replace distro type (#742)
  update goreleaser with windows checksums (#740)
  bump stereoscope version to remove old containerd (#741)
  Add support for multiple output files in different formats (#732)
  Add support for searching for jars within archives (#734)
  683 windows filepath (#735)
  Fix CPE encode/decode when it contains special chars (#714)
  support .par for java ecosystems (#727)
  Add arm64 support to install script (#729)
  Revert "bump goreleaser to v1.2 (#720)" (#731)
  Add a version flag (#722)
  Add lpkg as java package format (#694)
  ...
fengshunli pushed a commit to fengshunli/syft that referenced this pull request Jan 24, 2022
@kzantow @fengshunli
Add support for multiple output files in different formats (anchore#732)
fb5340d 
Signed-off-by: fsl <1171313930@qq.com>
spiffcs pushed a commit that referenced this pull request Jan 24, 2022
@kzantow @spiffcs
Add support for multiple output files in different formats (#732)
5429dc0 
Signed-off-by: Christopher Phillips <christopher.phillips@anchore.com>
spiffcs pushed a commit that referenced this pull request Jan 25, 2022
@kzantow @spiffcs
Add support for multiple output files in different formats (#732)
226c816
jonasagx pushed a commit to jonasagx/syft that referenced this pull request Jan 28, 2022
@kzantow @jonasagx
Add support for multiple output files in different formats (anchore#732)
9374496
GijsCalis pushed a commit to GijsCalis/syft that referenced this pull request Feb 19, 2024
@kzantow
Add support for multiple output files in different formats (anchore#732)
6a0a6c4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wagoodman wagoodman wagoodman approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support generating multiple BOM files in different formats within a run
3 participants
@kzantow @seabass-labrax @wagoodman