Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(suse): SUSE - update OSType constants and references for compatility [backport: release/v0.58] #8237

Merged
merged 1 commit into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions pkg/fanal/applier/applier_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -961,6 +961,91 @@ func TestApplier_ApplyLayers(t *testing.T) {
},
wantErr: "unknown OS",
},
{
name: "SUSE images - legacy OS name with backward compatibility",
args: args{
imageID: "sha256:fb44d01953611ba18d43d88e158c25579d18eff42db671182245010620a283f3",
layerIDs: []string{
"sha256:2615f175cf3da67c48c6542914744943ee5e9c253547b03e3cfe8aae605c3199",
},
},
getLayerExpectations: []cache.LocalArtifactCacheGetBlobExpectation{
{
Args: cache.LocalArtifactCacheGetBlobArgs{
BlobID: "sha256:2615f175cf3da67c48c6542914744943ee5e9c253547b03e3cfe8aae605c3199",
},
Returns: cache.LocalArtifactCacheGetBlobReturns{
BlobInfo: types.BlobInfo{
SchemaVersion: 1,
Digest: "sha256:fb44d01953611ba18d43d88e158c25579d18eff42db671182245010620a283f3",
DiffID: "sha256:d555e1b0b42f21a1cf198e52bcb12fe66aa015348e4390d2d5acddd327d79073",
OS: types.OS{
Family: "suse linux enterprise server",
Name: "15.4",
},
PackageInfos: []types.PackageInfo{
{
FilePath: "usr/lib/sysimage/rpm/Packages.db",
Packages: types.Packages{
{
Name: "curl",
Version: "7.79.1",
SrcName: "curl",
SrcVersion: "7.79.1",
},
},
},
},
},
},
},
},
getArtifactExpectations: []cache.LocalArtifactCacheGetArtifactExpectation{
{
Args: cache.LocalArtifactCacheGetArtifactArgs{
ArtifactID: "sha256:fb44d01953611ba18d43d88e158c25579d18eff42db671182245010620a283f3",
},
Returns: cache.LocalArtifactCacheGetArtifactReturns{
ArtifactInfo: types.ArtifactInfo{
SchemaVersion: 1,
},
},
},
},
want: types.ArtifactDetail{
OS: types.OS{
Family: "sles",
Name: "15.4",
},
Packages: types.Packages{
{
Name: "curl",
Version: "7.79.1",
SrcName: "curl",
SrcVersion: "7.79.1",
Identifier: types.PkgIdentifier{
UID: "1e9b3d3a73785651",
PURL: &packageurl.PackageURL{
Type: packageurl.TypeRPM,
Namespace: "suse",
Name: "curl",
Version: "7.79.1",
Qualifiers: packageurl.Qualifiers{
{
Key: "distro",
Value: "sles-15.4",
},
},
},
},
Layer: types.Layer{
Digest: "sha256:fb44d01953611ba18d43d88e158c25579d18eff42db671182245010620a283f3",
DiffID: "sha256:d555e1b0b42f21a1cf198e52bcb12fe66aa015348e4390d2d5acddd327d79073",
},
},
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down
12 changes: 12 additions & 0 deletions pkg/fanal/types/artifact.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ func (o *OS) Detected() bool {
return o.Family != ""
}

// Normalize normalizes OS family names for backward compatibility
func (o *OS) Normalize() {
if alias, ok := OSTypeAliases[o.Family]; ok {
o.Family = alias
}
}

// Merge merges OS version and enhanced security maintenance programs
func (o *OS) Merge(newOS OS) {
if lo.IsEmpty(newOS) {
Expand All @@ -45,6 +52,11 @@ func (o *OS) Merge(newOS OS) {
o.Extended = true
}
}
// When merging layers, there are cases when a layer contains an OS with an old name:
// - Cache contains a layer derived from an old version of Trivy.
// - `client` uses an old version of Trivy, but `server` is a new version of Trivy (for `client/server` mode).
// So we need to normalize the OS name for backward compatibility.
o.Normalize()
}

type Repository struct {
Expand Down
9 changes: 9 additions & 0 deletions pkg/fanal/types/const.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ const (
Wolfi OSType = "wolfi"
)

// OSTypeAliases is a map of aliases for operating systems.
// This is used to map the old family names to the new ones for backward compatibility.
var OSTypeAliases = map[OSType]OSType{
"opensuse.leap": OpenSUSELeap,
"opensuse.tumbleweed": OpenSUSETumbleweed,
"suse linux enterprise micro": SLEMicro,
"suse linux enterprise server": SLES,
}

// Programming language dependencies
const (
Bundler LangType = "bundler"
Expand Down
Loading