Split the sbom.Format interface by encode and decode use cases (#2186)

* split up sbom.Format into encode and decode ops Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * update cmd pkg to inject format configs Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * bump cyclonedx schema to 1.5 Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * redact image metadata from github encoder tests Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add more testing around format decoder identify Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add test case for format version options Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix cli tests Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix CLI test Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * [wip] - review comments Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * keep encoder creation out of post load function Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * keep decider and identify functions Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add a few more doc comments Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * remove format encoder default function helpers Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * address PR feedback Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * move back to streaming based decode functions Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * with common convention for encoder constructors Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix tests and allow for encoders to be created from cli options Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix cli tests Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * fix linting Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * buffer reads from stdin to support seeking Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> --------- Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
2026-11-02 07:26:34 +01:00 · 2023-10-25 13:43:06 +00:00
parent 7315f83f9d
commit 7392d607b6
254 changed files with 10450 additions and 2714 deletions
@@ -8,43 +8,71 @@ import (

 	"github.com/docker/docker/pkg/homedir"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"

 	"github.com/anchore/syft/syft/sbom"
 )

 func Test_MakeSBOMWriter(t *testing.T) {
 	tests := []struct {
+		name    string
 		outputs []string
 		wantErr assert.ErrorAssertionFunc
 	}{
 		{
+			name:    "go case",
 			outputs: []string{"json"},
 			wantErr: assert.NoError,
 		},
 		{
+			name:    "multiple",
 			outputs: []string{"table", "json"},
 			wantErr: assert.NoError,
 		},
 		{
+			name:    "unknown format",
 			outputs: []string{"unknown"},
 			wantErr: func(t assert.TestingT, err error, bla ...interface{}) bool {
-				return assert.ErrorContains(t, err, `unsupported output format "unknown", supported formats are: [`)
+				return assert.ErrorContains(t, err, `unsupported output format "unknown", supported formats are:`)
 			},
 		},
 	}

 	for _, tt := range tests {
-		_, err := makeSBOMWriter(tt.outputs, "", "")
-		tt.wantErr(t, err)
+		t.Run(tt.name, func(t *testing.T) {
+			opt := DefaultOutput()
+			encoders, err := opt.Encoders()
+			require.NoError(t, err)
+			_, err = makeSBOMWriter(tt.outputs, "", encoders)
+			tt.wantErr(t, err)
+		})
 	}
 }

-func dummyEncoder(io.Writer, sbom.SBOM) error {
+func dummyFormat(name string) sbom.FormatEncoder {
+	return dummyEncoder{name: name}
+}
+
+var _ sbom.FormatEncoder = (*dummyEncoder)(nil)
+
+type dummyEncoder struct {
+	name string
+}
+
+func (d dummyEncoder) ID() sbom.FormatID {
+	return sbom.FormatID(d.name)
+}
+
+func (d dummyEncoder) Aliases() []string {
 	return nil
 }

-func dummyFormat(name string) sbom.Format {
-	return sbom.NewFormat(sbom.AnyVersion, dummyEncoder, nil, nil, sbom.FormatID(name))
+func (d dummyEncoder) Version() string {
+	return sbom.AnyVersion
+}
+
+func (d dummyEncoder) Encode(writer io.Writer, s sbom.SBOM) error {
+	return nil
 }

 func Test_newSBOMMultiWriter(t *testing.T) {
@@ -227,3 +255,39 @@ func Test_newSBOMWriterDescription(t *testing.T) {
 		})
 	}
 }
+
+func Test_formatVersionOptions(t *testing.T) {
+
+	tests := []struct {
+		name             string
+		nameVersionPairs []string
+		want             string
+	}{
+		{
+			name: "gocase",
+			nameVersionPairs: []string{
+				"cyclonedx-json@1.2", "cyclonedx-json@1.3", "cyclonedx-json@1.4", "cyclonedx-json@1.5",
+				"cyclonedx-xml@1.0", "cyclonedx-xml@1.1", "cyclonedx-xml@1.2", "cyclonedx-xml@1.3",
+				"cyclonedx-xml@1.4", "cyclonedx-xml@1.5", "github-json", "spdx-json@2.2", "spdx-json@2.3",
+				"spdx-tag-value@2.1", "spdx-tag-value@2.2", "spdx-tag-value@2.3", "syft-json@11.0.0",
+				"syft-table", "syft-text", "template",
+			},
+			want: `
+Available formats:
+   - cyclonedx-json @ 1.2, 1.3, 1.4, 1.5
+   - cyclonedx-xml @ 1.0, 1.1, 1.2, 1.3, 1.4, 1.5
+   - github-json
+   - spdx-json @ 2.2, 2.3
+   - spdx-tag-value @ 2.1, 2.2, 2.3
+   - syft-json
+   - syft-table
+   - syft-text
+   - template`,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			assert.Equal(t, tt.want, formatVersionOptions(tt.nameVersionPairs))
+		})
+	}
+}