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-10-30 14:02:26 +01:00 · 2023-10-25 13:43:06 +00:00
parent 7315f83f9d
commit 7392d607b6
254 changed files with 10450 additions and 2714 deletions
@@ -6,8 +6,9 @@ import (

 	"github.com/stretchr/testify/require"

-	"github.com/anchore/syft/syft/formats"
-	"github.com/anchore/syft/syft/formats/template"
+	"github.com/anchore/syft/cmd/syft/cli/options"
+	"github.com/anchore/syft/syft/format"
+	"github.com/anchore/syft/syft/format/template"
 )

 func TestAllFormatsExpressible(t *testing.T) {
@@ -20,9 +21,15 @@ func TestAllFormatsExpressible(t *testing.T) {
 		},
 		assertSuccessfulReturnCode,
 	}
-	formatNames := formats.AllIDs()
-	require.NotEmpty(t, formatNames)
-	for _, o := range formatNames {
+
+	opts := options.DefaultOutput()
+	encoders, err := opts.Encoders()
+	require.NoError(t, err)
+
+	encs := format.NewEncoderCollection(encoders...)
+	formatIDs := encs.IDs()
+	require.NotEmpty(t, formatIDs)
+	for _, o := range formatIDs {
 		t.Run(fmt.Sprintf("format:%s", o), func(t *testing.T) {
 			args := []string{"dir:./test-fixtures/image-pkg-coverage", "-o", string(o)}
 			if o == template.ID {
@@ -5,7 +5,11 @@ import (
 	"strings"
 	"testing"

+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
 	"github.com/anchore/stereoscope/pkg/imagetest"
+	"github.com/anchore/syft/syft/format/cyclonedxjson"
 )

 // We have schema validation mechanims in schema/cyclonedx/
@@ -95,13 +99,13 @@ func assertValidCycloneDX(tb testing.TB, stdout, stderr string, rc int) {
 // validate --input-format json --input-version v1_4 --input-file bom.json
 func validateCycloneDXJSON(t *testing.T, stdout string) {
 	f, err := os.CreateTemp("", "tmpfile-")
-	if err != nil {
-		t.Fatal(err)
-	}
+	require.NoError(t, err)

 	// close and remove the temporary file at the end of the program
-	defer f.Close()
-	defer os.Remove(f.Name())
+	t.Cleanup(func() {
+		assert.NoError(t, f.Close())
+		assert.NoError(t, os.Remove(f.Name()))
+	})

 	data := []byte(stdout)

@@ -109,18 +113,25 @@ func validateCycloneDXJSON(t *testing.T, stdout string) {
 		t.Fatal(err)
 	}

+	// get the latest supported version of CycloneDX by syft and convert the expression to the format used by cyclonedx-cli
+	// e.g. "1.5" -> "v1_5"
+	versions := cyclonedxjson.SupportedVersions()
+	version := versions[len(versions)-1]
+	versionInput := "v" + strings.Replace(version, ".", "_", -1)
+
 	args := []string{
 		"validate",
 		"--input-format",
 		"json",
 		"--input-version",
-		"v1_4",
+		versionInput,
 		"--input-file",
 		"/sbom",
 	}

 	cmd, stdout, stderr := runCycloneDXInDocker(t, nil, "cyclonedx/cyclonedx-cli", f, args...)
 	if strings.Contains(stdout, "BOM is not valid") {
+		t.Log("STDOUT:\n", stdout)
 		t.Errorf("expected no validation failures for cyclonedx-cli but found invalid BOM")
 	}