Skip to content

Commit

Permalink
SBOM test cleanup (#1361)
Browse files Browse the repository at this point in the history
  • Loading branch information
@luhring
luhring authored Oct 24, 2024
1 parent 700686f commit 2566549
Show file tree
Hide file tree
Showing 6 changed files with 84 additions and 92 deletions.
172 changes: 82 additions & 90 deletions pkg/sbom/generator/spdx/spdx_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ package spdx
import (
"fmt"
"os"
"path"
"path/filepath"
"regexp"
"testing"
Expand All @@ -30,12 +31,9 @@ import (
"chainguard.dev/apko/pkg/sbom/options"
)

// TODO: clean this up and make consistent with the other test cases
var testOpts = &options.Options{
OS: struct {
Name string
ID string
Version string
}{
OS: options.OSInfo{
Name: "unknown",
ID: "unknown",
Version: "3.0",
Expand All @@ -60,54 +58,92 @@ var testOpts = &options.Options{
},
}

var testCustomLicenseOpts = &options.Options{
OS: struct {
Name string
ID string
Version string
func TestSPDX_Generate(t *testing.T) {
tests := []struct {
name string
opts *options.Options
}{
Name: "unknown",
ID: "unknown",
Version: "3.0",
},
FileName: "sbom",
Packages: []*apk.InstalledPackage{
{
Package: apk.Package{
Name: "font-ubuntu",
Version: "0.869-r1",
Arch: "x86_64",
Description: "Ubuntu font family",
License: "LicenseRef-ubuntu-font",
Origin: "font-ubuntu",
name: "custom license",
opts: &options.Options{
OS: options.OSInfo{
Name: "unknown",
ID: "unknown",
Version: "3.0",
},
FileName: "sbom",
Packages: []*apk.InstalledPackage{
{
Package: apk.Package{
Name: "font-ubuntu",
Version: "0.869-r1",
Arch: "x86_64",
Description: "Ubuntu font family",
License: "LicenseRef-ubuntu-font",
Origin: "font-ubuntu",
},
},
},
},
},
},
}

var testNoSupplierOpts = &options.Options{
OS: struct {
Name string
ID string
Version string
}{
Name: "Apko Images, Plc",
ID: "apko-images",
Version: "3.0",
},
FileName: "sbom",
Packages: []*apk.InstalledPackage{
{
Package: apk.Package{
Name: "libattr1",
Version: "2.5.1-r2",
Arch: "x86_64",
Description: "library for managing filesystem extended attributes",
License: "GPL-2.0-or-later",
Origin: "attr",
name: "no supplier",
opts: &options.Options{
OS: options.OSInfo{
Name: "Apko Images, Plc",
ID: "apko-images",
Version: "3.0",
},
FileName: "sbom",
Packages: []*apk.InstalledPackage{
{
Package: apk.Package{
Name: "libattr1",
Version: "2.5.1-r2",
Arch: "x86_64",
Description: "library for managing filesystem extended attributes",
License: "GPL-2.0-or-later",
Origin: "attr",
},
},
},
},
},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
pkgName := tt.opts.Packages[0].Name
apkSBOMPath := filepath.Join("testdata", "apk_sboms", fmt.Sprintf("%s.spdx.json", pkgName))
apkSBOMBytes, err := os.ReadFile(apkSBOMPath)
require.NoError(t, err)

fsys := apkfs.NewMemFS()
sbomDir := path.Join("var", "lib", "db", "sbom")
err = fsys.MkdirAll(sbomDir, 0750)
require.NoError(t, err)

sbomDestPath := path.Join(sbomDir, fmt.Sprintf("%s.spdx.json", pkgName))
err = fsys.WriteFile(sbomDestPath, apkSBOMBytes, 0644)
require.NoError(t, err)

sx := New(fsys)
imageSBOMDestPath := filepath.Join(t.TempDir(), pkgName+"."+sx.Ext())
err = sx.Generate(tt.opts, imageSBOMDestPath)
require.NoError(t, err)

actual, err := os.ReadFile(imageSBOMDestPath)
require.NoError(t, err)

expectedImageSBOMPath := filepath.Join("testdata", "expected_image_sboms", fmt.Sprintf("%s.spdx.json", pkgName))
expected, err := os.ReadFile(expectedImageSBOMPath)
require.NoError(t, err)

if diff := cmp.Diff(expected, actual); diff != "" {
t.Errorf("Unexpected image SBOM (-want, +got): \n%s", diff)
}
})
}
}

func TestGenerate(t *testing.T) {
Expand All @@ -120,50 +156,6 @@ func TestGenerate(t *testing.T) {
require.FileExists(t, path)
}

func TestGenerateCustomLicense(t *testing.T) {
spdx, err := os.ReadFile("testdata/font-ubuntu.spdx.json")
require.NoError(t, err)

fsys := apkfs.NewMemFS()
fsys.MkdirAll("/var/lib/db/sbom", 0750)

err = fsys.WriteFile("/var/lib/db/sbom/font-ubuntu.spdx.json", spdx, 0644)
require.NoError(t, err)

sx := New(fsys)
path := filepath.Join(t.TempDir(), testCustomLicenseOpts.FileName+"."+sx.Ext())
err = sx.Generate(testCustomLicenseOpts, path)
require.NoError(t, err)

got, err := os.ReadFile(path)
require.NoError(t, err)
expected, err := os.ReadFile("testdata/expected.ubuntu-font.spdx.json")
require.NoError(t, err)
require.Equal(t, expected, got, "CustomLicense SPDX")
}

func TestNoSupplier(t *testing.T) {
spdx, err := os.ReadFile("testdata/libattr1.spdx.json")
require.NoError(t, err)

fsys := apkfs.NewMemFS()
fsys.MkdirAll("/var/lib/db/sbom", 0750)

err = fsys.WriteFile("/var/lib/db/sbom/libattr1.spdx.json", spdx, 0644)
require.NoError(t, err)

sx := New(fsys)
path := filepath.Join(t.TempDir(), testNoSupplierOpts.FileName+"."+sx.Ext())
err = sx.Generate(testNoSupplierOpts, path)
require.NoError(t, err)

got, err := os.ReadFile(path)
require.NoError(t, err)
expected, err := os.ReadFile("testdata/expected.libattr1.spdx.json")
require.NoError(t, err)
require.Equal(t, expected, got, "NoSupplier SPDX")
}

func TestReproducible(t *testing.T) {
// Create two sboms based on the same input and ensure
// they are identical
Expand Down
0 ...rator/spdx/testdata/font-ubuntu.spdx.json → .../testdata/apk_sboms/font-ubuntu.spdx.json
View file
File renamed without changes.
0 ...enerator/spdx/testdata/libattr1.spdx.json → ...pdx/testdata/apk_sboms/libattr1.spdx.json
View file
File renamed without changes.
0 ...x/testdata/expected.ubuntu-font.spdx.json → ...xpected_image_sboms/font-ubuntu.spdx.json
View file
File renamed without changes.
0 ...spdx/testdata/expected.libattr1.spdx.json → ...a/expected_image_sboms/libattr1.spdx.json
View file
File renamed without changes.
4 changes: 2 additions & 2 deletions pkg/sbom/generator/spdx/testdata/generate.sh
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#!/bin/sh
curl -q https://packages.wolfi.dev/os/x86_64/font-ubuntu-0.869-r1.apk | tar Ozx var/lib/db/sbom/font-ubuntu-0.869-r1.spdx.json >font-ubuntu.spdx.json 2>/dev/null
curl -q https://packages.wolfi.dev/os/x86_64/libattr1-2.5.1-r2.apk | tar Ozx var/lib/db/sbom/libattr1-2.5.1-r2.spdx.json >libattr1.spdx.json 2>/dev/null
curl -q https://packages.wolfi.dev/os/x86_64/font-ubuntu-0.869-r1.apk | tar Ozx var/lib/db/sbom/font-ubuntu-0.869-r1.spdx.json >apk_sboms/font-ubuntu.spdx.json 2>/dev/null
curl -q https://packages.wolfi.dev/os/x86_64/libattr1-2.5.1-r2.apk | tar Ozx var/lib/db/sbom/libattr1-2.5.1-r2.spdx.json >apk_sboms/libattr1.spdx.json 2>/dev/null

0 comments on commit 2566549

Please sign in to comment.