feat(outputs): allow to set multiple outputs (#648) #1346

olivierboudet · 2023-06-10T22:07:48Z

I tried to resolve #648 with this PR but I am not a Go developer so you may have remarks...

This PR allows to specify multiple outputs like in syft, for example -o json=report.json -o template=report.html -t template.html

I need to add more tests but if someone could tell me if it looks ok overall ?

kzantow

Are you able to add tests for this change?

cmd/writer.go

olivierboudet · 2023-07-03T20:53:57Z

Are you able to add tests for this change?

I just added some tests

wagoodman · 2023-07-10T18:16:29Z

Right now this doesn't seem to work when providing multiple files:

$ go run . alpine:3.2 -o json=/tmp/json -o table -o cyclonedx=/tmp/cyclone

# stdout is cyclonedx, not the table output

That being said, I think I can update this PR to include additional pattern changes to how we encode the final reports (which should make this change easier to make). I'll think about it this afternoon and try to get something pushed before the end of the day.

wagoodman · 2023-07-10T20:16:43Z

test/quality/vulnerability-match-labels

was updating this submodule intentional?

No it was not intentional, sorry for this.

all good 😄

wagoodman · 2023-07-10T20:28:21Z

grype/presenter/json/presenter.go

 }
 }

 // Present creates a JSON-based reporting
-func (pres *Presenter) Present(output io.Writer) error {
+func (pres *Presenter) Present(defaultOutput io.Writer) error {


unfortunately this is breaking the presenter abstraction by adding filesystem concerns.

Today the presenter acts as a two-way facade... the caller provides doesn't need to know about any format concerns (is this json, table, xml, etc) and the presenter only needs to write bytes to the writer, but does not need to know about the concerns of that writer (is it to a file, the screen, streaming to a socket, etc).

I think ultimately we should probably be getting rid of the presenter abstraction and inverting this entire flow... so instead of providing a writer to an object, we should ask the object to return bytes. If this is the way to go, we should try to do this incrementally. A good approach to this would be to take the GetPresenter() function and adapt that to return the new object and write a short generalized helper function that takes a presenter and returns bytes. Initially we'd leave all of the presenters alone and fix everything above the GetPresenter() call (maybe call it GetWriter instead since it would no longer return a presenter). Then over time we can swap all of the presenters to encoders/writers.

I haven't thought this entirely though, but these are some initial thoughts.

@olivierboudet I can try out the above suggestion on your branch, as it would ultimately enable the multi -o feature (which would be awesome). Would you mind if I pushed updates to your branch? Or would you like to take a stab at these suggestions? (or of course, shout out if you have other suggestions here too!)

(Alternatively I could try and get these changes in another PR then rebase this, which isn't a problem, but I feel the rebase would be nasty and the features on this branch nicely motivate the need for the change.)

Thanks for the review ! Of course you can push on my branch ☺️

Signed-off-by: Olivier Boudet <o.boudet@gmail.com> Signed-off-by: Olivier Boudet <olivier.boudet@cooperl.com> Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

review Signed-off-by: Olivier Boudet <olivier.boudet@cooperl.com> Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

wagoodman · 2023-07-11T17:18:36Z

@olivierboudet I updated the PR based on #1346 (comment) by leveraging the multi-writer patterns in syft. In doing so I needed to change some underlying eventing and presentation functionality, which we were overdue for. This doesn't address larger concerns with the presenter pattern and how it works with the execution flow, but instead nudges grype in the right direction (larger refactors can be done in future PRs)

wagoodman

this one has been a long time coming!

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

olivierboudet · 2023-07-11T18:14:03Z

Thanks a lot @wagoodman

olivierboudet force-pushed the feature/multiple_outputs branch 3 times, most recently from 002bf75 to 93474b2 Compare June 15, 2023 20:57

kzantow reviewed Jun 30, 2023

View reviewed changes

cmd/writer.go Outdated Show resolved Hide resolved

olivierboudet force-pushed the feature/multiple_outputs branch 4 times, most recently from ec1360d to 21e25b9 Compare July 3, 2023 20:52

olivierboudet force-pushed the feature/multiple_outputs branch from 21e25b9 to 1ac5a4e Compare July 3, 2023 21:05

wagoodman self-assigned this Jul 6, 2023

wagoodman reviewed Jul 10, 2023

View reviewed changes

wagoodman force-pushed the feature/multiple_outputs branch from 1ac5a4e to 79cf8d0 Compare July 11, 2023 17:14

olivierboudet and others added 2 commits July 11, 2023 13:15

feat(outputs): allow to set multiple outputs (anchore#648)

7d02d25

Signed-off-by: Olivier Boudet <o.boudet@gmail.com> Signed-off-by: Olivier Boudet <olivier.boudet@cooperl.com> Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

feat(outputs): allow to set multiple outputs (anchore#648)

ba08acf

review Signed-off-by: Olivier Boudet <olivier.boudet@cooperl.com> Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

wagoodman force-pushed the feature/multiple_outputs branch from 79cf8d0 to 46c543c Compare July 11, 2023 17:16

wagoodman approved these changes Jul 11, 2023

View reviewed changes

use syft format writter pattern and de-emphasize presenter package

269f7f0

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

wagoodman force-pushed the feature/multiple_outputs branch from 01f98d8 to 269f7f0 Compare July 11, 2023 17:26

wagoodman enabled auto-merge (squash) July 11, 2023 17:27

wagoodman merged commit 9050883 into anchore:main Jul 11, 2023
9 checks passed

p-linnane mentioned this pull request Jul 13, 2023

grype 0.64.0 Homebrew/homebrew-core#136523

Merged

dependabot bot mentioned this pull request Jul 14, 2023

Bump github.com/anchore/grype from 0.63.1 to 0.64.0 anchore/grype-db#128

Closed

abg mentioned this pull request Jul 14, 2023

grype v0.64.0 template zeroes the template content #1388

Closed

This was referenced Jul 18, 2023

Bump github.com/anchore/grype from 0.63.1 to 0.64.1 anchore/grype-db#130

Closed

Bump github.com/anchore/grype from 0.63.1 to 0.64.2 anchore/grype-db#133

Closed

dependabot bot mentioned this pull request Jul 28, 2023

Bump github.com/anchore/grype from 0.63.2-0.20230710175255-d6bd01a4fa5b to 0.64.2 wolfi-dev/wolfictl#314

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(outputs): allow to set multiple outputs (#648) #1346

feat(outputs): allow to set multiple outputs (#648) #1346

olivierboudet commented Jun 10, 2023 •

edited

Loading

kzantow left a comment

olivierboudet commented Jul 3, 2023

wagoodman commented Jul 10, 2023 •

edited

Loading

wagoodman Jul 10, 2023

olivierboudet Jul 10, 2023

wagoodman Jul 10, 2023

wagoodman Jul 10, 2023

wagoodman Jul 10, 2023

wagoodman Jul 10, 2023 •

edited

Loading

olivierboudet Jul 10, 2023

wagoodman commented Jul 11, 2023

wagoodman left a comment

olivierboudet commented Jul 11, 2023

feat(outputs): allow to set multiple outputs (#648) #1346

feat(outputs): allow to set multiple outputs (#648) #1346

Conversation

olivierboudet commented Jun 10, 2023 • edited Loading

kzantow left a comment

Choose a reason for hiding this comment

olivierboudet commented Jul 3, 2023

wagoodman commented Jul 10, 2023 • edited Loading

wagoodman Jul 10, 2023

Choose a reason for hiding this comment

olivierboudet Jul 10, 2023

Choose a reason for hiding this comment

wagoodman Jul 10, 2023

Choose a reason for hiding this comment

wagoodman Jul 10, 2023

Choose a reason for hiding this comment

wagoodman Jul 10, 2023

Choose a reason for hiding this comment

wagoodman Jul 10, 2023 • edited Loading

Choose a reason for hiding this comment

olivierboudet Jul 10, 2023

Choose a reason for hiding this comment

wagoodman commented Jul 11, 2023

wagoodman left a comment

Choose a reason for hiding this comment

olivierboudet commented Jul 11, 2023

olivierboudet commented Jun 10, 2023 •

edited

Loading

wagoodman commented Jul 10, 2023 •

edited

Loading

wagoodman Jul 10, 2023 •

edited

Loading