Add support for multiple output files in different formats #732
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/anchore/syft/internal/formats" | ||
| "github.com/anchore/syft/internal/output" | ||
| "github.com/anchore/syft/syft/format" | ||
| "github.com/anchore/syft/syft/sbom" | ||
| "github.com/hashicorp/go-multierror" | ||
| ) | ||
|
|
||
| // makeWriter creates a sbom.Writer for output or returns an error. this will either return a valid writer | ||
| // or an error but neither both and if there is no error, sbom.Writer.Close() should be called | ||
| func makeWriter(outputs []string, defaultFile string) (sbom.Writer, error) { | ||
| outputOptions, err := parseOptions(outputs, defaultFile) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| writer, err := output.MakeWriter(outputOptions...) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return writer, nil | ||
| } | ||
|
|
||
| // parseOptions utility to parse command-line option strings and retain the existing behavior of default format and file | ||
| func parseOptions(outputs []string, defaultFile string) (out []output.WriterOption, errs error) { | ||
| // always should have one option -- we generally get the default of "table", but just make sure | ||
| if len(outputs) == 0 { | ||
| outputs = append(outputs, string(format.TableOption)) | ||
| } | ||
|
|
||
| for _, name := range outputs { | ||
| name = strings.TrimSpace(name) | ||
|
|
||
| // split to at most two parts for <format>=<file> | ||
| parts := strings.SplitN(name, "=", 2) | ||
|
|
||
| // the format option is the first part | ||
| name = parts[0] | ||
|
|
||
| // default to the --file or empty string if not specified | ||
| file := defaultFile | ||
|
|
||
| // If a file is specified as part of the output option, use that | ||
| if len(parts) > 1 { | ||
| file = parts[1] | ||
| } | ||
|
|
||
| option := format.ParseOption(name) | ||
| if option == format.UnknownFormatOption { | ||
| errs = multierror.Append(errs, fmt.Errorf("bad output format: '%s'", name)) | ||
| continue | ||
| } | ||
|
|
||
| encoder := formats.ByOption(option) | ||
| if encoder == nil { | ||
| errs = multierror.Append(errs, fmt.Errorf("unknown format: %s", outputFormat)) | ||
| continue | ||
| } | ||
|
|
||
| out = append(out, output.WriterOption{ | ||
| Format: *encoder, | ||
| Path: file, | ||
| }) | ||
| } | ||
| return out, errs | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestOutputWriterConfig(t *testing.T) { | ||
| tmp := t.TempDir() + "/" | ||
|
|
||
| tests := []struct { | ||
| outputs []string | ||
| file string | ||
| err bool | ||
| expected []string | ||
| }{ | ||
| { | ||
| outputs: []string{}, | ||
| expected: []string{""}, | ||
| }, | ||
| { | ||
| outputs: []string{"json"}, | ||
| expected: []string{""}, | ||
| }, | ||
| { | ||
| file: "test-1.json", | ||
| expected: []string{"test-1.json"}, | ||
| }, | ||
| { | ||
| outputs: []string{"json=test-2.json"}, | ||
| expected: []string{"test-2.json"}, | ||
| }, | ||
| { | ||
| outputs: []string{"json=test-3-1.json", "spdx-json=test-3-2.json"}, | ||
| expected: []string{"test-3-1.json", "test-3-2.json"}, | ||
| }, | ||
| { | ||
| outputs: []string{"text", "json=test-4.json"}, | ||
| expected: []string{"", "test-4.json"}, | ||
| }, | ||
| } | ||
|
|
||
| for _, test := range tests { | ||
| t.Run(fmt.Sprintf("%s/%s", test.outputs, test.file), func(t *testing.T) { | ||
| outputs := test.outputs | ||
| for i, val := range outputs { | ||
| outputs[i] = strings.Replace(val, "=", "="+tmp, 1) | ||
| } | ||
|
|
||
| file := test.file | ||
| if file != "" { | ||
| file = tmp + file | ||
| } | ||
|
|
||
| _, err := makeWriter(test.outputs, file) | ||
|
|
||
| if test.err { | ||
| assert.Error(t, err) | ||
| return | ||
| } else { | ||
| assert.NoError(t, err) | ||
| } | ||
|
|
||
| for _, expected := range test.expected { | ||
kzantow marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if expected != "" { | ||
| assert.FileExists(t, tmp+expected) | ||
| } else if file != "" { | ||
| assert.FileExists(t, file) | ||
| } else { | ||
| assert.NoFileExists(t, expected) | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| } | ||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.