Launcher sboms copy only sbom extensions (#984)

* fsutils FilesWithExtensions filters directory listings

Signed-off-by: Joe Kimmel <jkimmel@vmware.com>

* exporter: launcher sbom copy

only copies sbom files

Signed-off-by: Joe Kimmel <jkimmel@vmware.com>

* exporter launcher sbom copy: more thorough test

Signed-off-by: Joe Kimmel <jkimmel@vmware.com>

Signed-off-by: Joe Kimmel <jkimmel@vmware.com>

Author: joe-kimmel-vmw

exporter.go

@@ -181,11 +181,33 @@ func (e *Exporter) copyBuildpacksioSBOMs(opts ExportOptions) error {
 		opts.LauncherConfig.SBOMDir == platform.DefaultBuildpacksioSBOMDir:
 		return e.copyDefaultSBOMsForComponent("launcher", targetLaunchDir)
 	default:
-		// if provided a custom launcher SBOM directory, just copy everything in the directory
-		return fsutil.Copy(opts.LauncherConfig.SBOMDir, targetLaunchDir)
+		// if provided a custom launcher SBOM directory, copy all files that look like sboms in that directory
+		return e.copyLauncherSBOMs(opts.LauncherConfig.SBOMDir, targetLaunchDir)
 	}
 }
 
+func (e *Exporter) copyLauncherSBOMs(srcDir string, dstDir string) error {
+	sboms, err := fsutil.FilesWithExtensions(srcDir, SBOMExtensions())
+	if err != nil {
+		e.Logger.Warnf("Failed to list contents of directory %s", srcDir)
+		return err
+	}
+
+	if err := os.MkdirAll(dstDir, 0755); err != nil {
+		return err
+	}
+
+	for _, sbom := range sboms {
+		dstPath := filepath.Join(dstDir, filepath.Base(sbom))
+		err = fsutil.Copy(sbom, dstPath)
+		if err != nil {
+			e.Logger.Warnf("failed while copying SBOM from %s to %s", sbom, dstPath)
+			return err
+		}
+	}
+	return nil
+}
+
 func (e *Exporter) copyDefaultSBOMsForComponent(component, dstDir string) error {
 	for _, extension := range SBOMExtensions() {
 		srcFilename := fmt.Sprintf("%s.%s", component, extension)

exporter_test.go

@@ -1504,14 +1504,17 @@ version = "4.5.6"
 			when("custom launcher SBOM is provided", func() {
 				it.Before(func() {
 					h.RecursiveCopy(t, filepath.Join("testdata", "exporter", "launcher-sbom", "layers"), opts.LayersDir)
+					// later we'll assert that this file doesn't get copied, but that's only meaningful if it exists at the source
+					h.AssertPathExists(t, filepath.Join(opts.LayersDir, "some-launcher-sbom-dir", "a-regular-file.txt"))
 					opts.LauncherConfig.SBOMDir = filepath.Join(opts.LayersDir, "some-launcher-sbom-dir")
 				})
 
-				it("copies everything in the launcher SBOM directory", func() {
+				it("copies sboms from the launcher SBOM directory", func() {
 					_, err := exporter.Export(opts)
 					h.AssertNil(t, err)
 
-					h.AssertPathExists(t, filepath.Join(opts.LayersDir, "sbom", "launch", "buildpacksio_lifecycle", "launcher", "some-sbom-file"))
+					h.AssertPathExists(t, filepath.Join(opts.LayersDir, "sbom", "launch", "buildpacksio_lifecycle", "launcher", "some-sbom-file.sbom.spdx.json"))
+					h.AssertPathDoesNotExist(t, filepath.Join(opts.LayersDir, "sbom", "launch", "buildpacksio_lifecycle", "launcher", "a-regular-file.txt"))
 				})
 			})
 		})

…rs/some-launcher-sbom-dir/some-sbom-file internal/fsutil/testdata/file2.txttestdata/exporter/launcher-sbom/layers/some-launcher-sbom-dir/some-sbom-file renamed to internal/fsutil/testdata/file2.txt testdata/exporter/launcher-sbom/layers/some-launcher-sbom-dir/some-sbom-file renamed to internal/fsutil/testdata/file2.txt

@@ -5,6 +5,7 @@ import (
 	"os"
 	"path/filepath"
 	"runtime"
+	"strings"
 )
 
 func Copy(src, dst string) error {
@@ -52,6 +53,26 @@ func copyDir(src, dst string) error {
 	return nil
 }
 
+// FilesWithExtensions returns a list of all files in directory that end in any of the extensions provided.
+// top level only - does not recursively visit directories.
+func FilesWithExtensions(dir string, extensions []string) ([]string, error) {
+	files, err := os.ReadDir(dir)
+	if err != nil {
+		return nil, err
+	}
+	matches := []string{}
+	for _, f := range files {
+		if !f.IsDir() {
+			for _, extension := range extensions {
+				if strings.HasSuffix(f.Name(), extension) {
+					matches = append(matches, filepath.Join(dir, f.Name()))
+				}
+			}
+		}
+	}
+	return matches, nil
+}
+
 func copyFile(src, dst string) error {
 	in, err := os.Open(src)
 	if err != nil {

internal/fsutil/testdata/file3.json

@@ -79,4 +79,17 @@ func testIO(t *testing.T, when spec.G, it spec.S) {
 			})
 		})
 	})
+
+	when("#FilesWithExtensions", func() {
+		when("called with directory and extensions", func() {
+			it("filters the files", func() {
+				src := "testdata"
+				exts := []string{".txt", ".json"}
+				files, err := fsutil.FilesWithExtensions(src, exts)
+				h.AssertNil(t, err)
+				h.AssertEq(t, len(files), 2)
+				h.AssertContains(t, files, filepath.Join(src, "file2.txt"), filepath.Join(src, "file3.json"))
+			})
+		})
+	})
 }