Internalize majority of cmd package (#2533)

* internalize majority of cmd package and migrate integration tests Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * add internal api encoder Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * create internal representation of all formats Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * export capability to get default encoders Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> * restore test fixtures Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com> --------- Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
2026-11-03 16:06:36 +01:00 · 2024-01-24 13:29:51 -05:00
parent bf3cd9ed3b
commit e0e1c4ba0a
232 changed files with 809 additions and 661 deletions
@@ -0,0 +1,91 @@
+package integration
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/anchore/clio"
+	"github.com/anchore/stereoscope/pkg/imagetest"
+	"github.com/anchore/syft/cmd/syft/internal/options"
+	"github.com/anchore/syft/syft"
+	"github.com/anchore/syft/syft/cataloging/pkgcataloging"
+	"github.com/anchore/syft/syft/sbom"
+	"github.com/anchore/syft/syft/source"
+)
+
+func catalogFixtureImage(t *testing.T, fixtureImageName string, scope source.Scope, catalogerSelection ...string) (sbom.SBOM, source.Source) {
+	cfg := options.DefaultCatalog().ToSBOMConfig(clio.Identification{
+		Name:    "syft-tester",
+		Version: "v0.99.0",
+	}).WithCatalogerSelection(
+		pkgcataloging.NewSelectionRequest().
+			WithExpression(catalogerSelection...),
+	)
+	cfg.Search.Scope = scope
+
+	return catalogFixtureImageWithConfig(t, fixtureImageName, cfg)
+}
+
+func catalogFixtureImageWithConfig(t *testing.T, fixtureImageName string, cfg *syft.CreateSBOMConfig) (sbom.SBOM, source.Source) {
+	cfg.CatalogerSelection = cfg.CatalogerSelection.WithDefaults(pkgcataloging.ImageTag)
+
+	// get the fixture image tar file
+	imagetest.GetFixtureImage(t, "docker-archive", fixtureImageName)
+	tarPath := imagetest.GetFixtureImageTarPath(t, fixtureImageName)
+	userInput := "docker-archive:" + tarPath
+
+	// get the source to build an SBOM against
+	detection, err := source.Detect(userInput, source.DefaultDetectConfig())
+	require.NoError(t, err)
+
+	theSource, err := detection.NewSource(source.DefaultDetectionSourceConfig())
+	require.NoError(t, err)
+
+	t.Cleanup(func() {
+		theSource.Close()
+	})
+
+	s, err := syft.CreateSBOM(context.Background(), theSource, cfg)
+
+	require.NoError(t, err)
+	require.NotNil(t, s)
+
+	return *s, theSource
+}
+
+func catalogDirectory(t *testing.T, dir string, catalogerSelection ...string) (sbom.SBOM, source.Source) {
+	cfg := options.DefaultCatalog().ToSBOMConfig(clio.Identification{
+		Name:    "syft-tester",
+		Version: "v0.99.0",
+	}).WithCatalogerSelection(
+		pkgcataloging.NewSelectionRequest().
+			WithExpression(catalogerSelection...),
+	)
+
+	return catalogDirectoryWithConfig(t, dir, cfg)
+}
+
+func catalogDirectoryWithConfig(t *testing.T, dir string, cfg *syft.CreateSBOMConfig) (sbom.SBOM, source.Source) {
+	cfg.CatalogerSelection = cfg.CatalogerSelection.WithDefaults(pkgcataloging.DirectoryTag)
+
+	// get the source to build an sbom against
+	userInput := "dir:" + dir
+	detection, err := source.Detect(userInput, source.DefaultDetectConfig())
+	require.NoError(t, err)
+
+	theSource, err := detection.NewSource(source.DefaultDetectionSourceConfig())
+	require.NoError(t, err)
+	t.Cleanup(func() {
+		theSource.Close()
+	})
+
+	// build the SBOM
+	s, err := syft.CreateSBOM(context.Background(), theSource, cfg)
+
+	require.NoError(t, err)
+	require.NotNil(t, s)
+
+	return *s, theSource
+}