syft/test/integration/utils_test.go

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/cli/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
}