mirror of
https://github.com/anchore/syft.git
synced 2025-11-17 16:33:21 +01:00
42fa9e4965
this PR makes the following changes to update the underlying license model to have more expressive capabilities it also provides some guarantee's surrounding the license values themselves - Licenses are updated from string -> pkg.LicenseSet which contain pkg.License with the following fields: - original `Value` read by syft - If it's possible to construct licenses will always have a valid SPDX expression for downstream consumption - the above is run against a generated list of SPDX license ID to try and find the correct ID - SPDX concluded vs declared is added to the new struct - URL source for license is added to the new struct - Location source is added to the new struct to show where the expression was pulled from
104 lines
3.2 KiB
Go
104 lines
3.2 KiB
Go
package integration
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"regexp"
|
|
"testing"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/sergi/go-diff/diffmatchpatch"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/anchore/syft/syft/formats"
|
|
"github.com/anchore/syft/syft/formats/cyclonedxjson"
|
|
"github.com/anchore/syft/syft/formats/cyclonedxxml"
|
|
"github.com/anchore/syft/syft/formats/syftjson"
|
|
"github.com/anchore/syft/syft/sbom"
|
|
"github.com/anchore/syft/syft/source"
|
|
)
|
|
|
|
// TestEncodeDecodeEncodeCycleComparison is testing for differences in how SBOM documents get encoded on multiple cycles.
|
|
// By encoding and decoding the sbom we can compare the differences between the set of resulting objects. However,
|
|
// this requires specific comparisons being done, and select redactions/omissions being made. Additionally, there are
|
|
// already unit tests on each format encoder-decoder for properly functioning comparisons in depth, so there is no need
|
|
// to do an object-to-object comparison. For this reason this test focuses on a bytes-to-bytes comparison after an
|
|
// encode-decode-encode loop which will detect lossy behavior in both directions.
|
|
func TestEncodeDecodeEncodeCycleComparison(t *testing.T) {
|
|
// use second image for relationships
|
|
images := []string{"image-pkg-coverage", "image-owning-package"}
|
|
tests := []struct {
|
|
formatOption sbom.FormatID
|
|
redactor func(in []byte) []byte
|
|
json bool
|
|
}{
|
|
{
|
|
formatOption: syftjson.ID,
|
|
redactor: func(in []byte) []byte {
|
|
// no redactions necessary
|
|
return in
|
|
},
|
|
json: true,
|
|
},
|
|
{
|
|
formatOption: cyclonedxjson.ID,
|
|
redactor: func(in []byte) []byte {
|
|
// unstable values
|
|
in = regexp.MustCompile(`"(timestamp|serialNumber|bom-ref)": "[^"]+",`).ReplaceAll(in, []byte{})
|
|
|
|
return in
|
|
},
|
|
json: true,
|
|
},
|
|
{
|
|
formatOption: cyclonedxxml.ID,
|
|
redactor: func(in []byte) []byte {
|
|
// unstable values
|
|
in = regexp.MustCompile(`(serialNumber|bom-ref)="[^"]+"`).ReplaceAll(in, []byte{})
|
|
in = regexp.MustCompile(`<timestamp>[^<]+</timestamp>`).ReplaceAll(in, []byte{})
|
|
|
|
return in
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
t.Run(fmt.Sprintf("%s", test.formatOption), func(t *testing.T) {
|
|
for _, image := range images {
|
|
originalSBOM, _ := catalogFixtureImage(t, image, source.SquashedScope, nil)
|
|
|
|
format := formats.ByName(string(test.formatOption))
|
|
require.NotNil(t, format)
|
|
|
|
by1, err := formats.Encode(originalSBOM, format)
|
|
require.NoError(t, err)
|
|
|
|
newSBOM, newFormat, err := formats.Decode(bytes.NewReader(by1))
|
|
require.NoError(t, err)
|
|
require.Equal(t, format.ID(), newFormat.ID())
|
|
|
|
by2, err := formats.Encode(*newSBOM, format)
|
|
require.NoError(t, err)
|
|
|
|
if test.redactor != nil {
|
|
by1 = test.redactor(by1)
|
|
by2 = test.redactor(by2)
|
|
}
|
|
|
|
if test.json {
|
|
s1 := string(by1)
|
|
s2 := string(by2)
|
|
if diff := cmp.Diff(s1, s2); diff != "" {
|
|
t.Errorf("Encode/Decode mismatch (-want +got) [image %q]:\n%s", image, diff)
|
|
}
|
|
} else if !assert.True(t, bytes.Equal(by1, by2)) {
|
|
dmp := diffmatchpatch.New()
|
|
diffs := dmp.DiffMain(string(by1), string(by2), true)
|
|
t.Errorf("diff: %s", dmp.DiffPrettyText(diffs))
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|