mirror of
https://github.com/anchore/syft.git
synced 2026-11-05 17:06:32 +01:00
Migrate location-related structs to the file package (#1751)
* migrate location structs to file package Signed-off-by: Alex Goodman <alex.goodman@anchore.com> * replace source.Location refs with file package call Signed-off-by: Alex Goodman <alex.goodman@anchore.com> * fix linting Signed-off-by: Alex Goodman <alex.goodman@anchore.com> * remove hardlink test for file based catalogers Signed-off-by: Alex Goodman <alex.goodman@anchore.com> * remove hardlink test for all-regular-files testing Signed-off-by: Alex Goodman <alex.goodman@anchore.com> * migrate file resolver implementations to separate package Signed-off-by: Alex Goodman <alex.goodman@anchore.com> * fix linting Signed-off-by: Alex Goodman <alex.goodman@anchore.com> * [wip] migrate resolvers to internal Signed-off-by: Alex Goodman <alex.goodman@anchore.com> * migrate resolvers to syft/internal Signed-off-by: Alex Goodman <alex.goodman@anchore.com> --------- Signed-off-by: Alex Goodman <alex.goodman@anchore.com> Signed-off-by: <>
This commit is contained in:
Alex Goodman
@@ -0,0 +1,541 @@
|
||||
package fileresolver
|
||||
|
||||
import (
|
||||
"io"
|
||||
"sort"
|
||||
"testing"
|
||||
|
||||
"github.com/google/go-cmp/cmp"
|
||||
"github.com/scylladb/go-set/strset"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/anchore/stereoscope/pkg/imagetest"
|
||||
"github.com/anchore/syft/syft/file"
|
||||
)
|
||||
|
||||
func TestImageSquashResolver_FilesByPath(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
linkPath string
|
||||
resolveLayer uint
|
||||
resolvePath string
|
||||
forcePositiveHasPath bool
|
||||
}{
|
||||
{
|
||||
name: "link with previous data",
|
||||
linkPath: "/link-1",
|
||||
resolveLayer: 1,
|
||||
resolvePath: "/file-1.txt",
|
||||
},
|
||||
{
|
||||
name: "link with in layer data",
|
||||
linkPath: "/link-within",
|
||||
resolveLayer: 5,
|
||||
resolvePath: "/file-3.txt",
|
||||
},
|
||||
{
|
||||
name: "link with overridden data",
|
||||
linkPath: "/link-2",
|
||||
resolveLayer: 7,
|
||||
resolvePath: "/file-2.txt",
|
||||
},
|
||||
{
|
||||
name: "indirect link (with overridden data)",
|
||||
linkPath: "/link-indirect",
|
||||
resolveLayer: 7,
|
||||
resolvePath: "/file-2.txt",
|
||||
},
|
||||
{
|
||||
name: "dead link",
|
||||
linkPath: "/link-dead",
|
||||
resolveLayer: 8,
|
||||
resolvePath: "",
|
||||
// the path should exist, even if the link is dead
|
||||
forcePositiveHasPath: true,
|
||||
},
|
||||
{
|
||||
name: "ignore directories",
|
||||
linkPath: "/bin",
|
||||
resolvePath: "",
|
||||
// the path should exist, even if we ignore it
|
||||
forcePositiveHasPath: true,
|
||||
},
|
||||
{
|
||||
name: "parent is a link (with overridden data)",
|
||||
linkPath: "/parent-link/file-4.txt",
|
||||
resolveLayer: 11,
|
||||
resolvePath: "/parent/file-4.txt",
|
||||
},
|
||||
}
|
||||
for _, c := range cases {
|
||||
t.Run(c.name, func(t *testing.T) {
|
||||
img := imagetest.GetFixtureImage(t, "docker-archive", "image-symlinks")
|
||||
|
||||
resolver, err := NewFromContainerImageSquash(img)
|
||||
if err != nil {
|
||||
t.Fatalf("could not create resolver: %+v", err)
|
||||
}
|
||||
|
||||
hasPath := resolver.HasPath(c.linkPath)
|
||||
if !c.forcePositiveHasPath {
|
||||
if c.resolvePath != "" && !hasPath {
|
||||
t.Errorf("expected HasPath() to indicate existance, but did not")
|
||||
} else if c.resolvePath == "" && hasPath {
|
||||
t.Errorf("expeced HasPath() to NOT indicate existance, but does")
|
||||
}
|
||||
} else if !hasPath {
|
||||
t.Errorf("expected HasPath() to indicate existance, but did not (force path)")
|
||||
}
|
||||
|
||||
refs, err := resolver.FilesByPath(c.linkPath)
|
||||
if err != nil {
|
||||
t.Fatalf("could not use resolver: %+v", err)
|
||||
}
|
||||
|
||||
expectedRefs := 1
|
||||
if c.resolvePath == "" {
|
||||
expectedRefs = 0
|
||||
}
|
||||
|
||||
if len(refs) != expectedRefs {
|
||||
t.Fatalf("unexpected number of resolutions: %d", len(refs))
|
||||
}
|
||||
|
||||
if expectedRefs == 0 {
|
||||
// nothing else to assert
|
||||
return
|
||||
}
|
||||
|
||||
actual := refs[0]
|
||||
|
||||
if string(actual.Reference().RealPath) != c.resolvePath {
|
||||
t.Errorf("bad resolve path: '%s'!='%s'", string(actual.Reference().RealPath), c.resolvePath)
|
||||
}
|
||||
|
||||
if c.resolvePath != "" && string(actual.Reference().RealPath) != actual.RealPath {
|
||||
t.Errorf("we should always prefer real paths over ones with links")
|
||||
}
|
||||
|
||||
layer := img.FileCatalog.Layer(actual.Reference())
|
||||
|
||||
if layer.Metadata.Index != c.resolveLayer {
|
||||
t.Errorf("bad resolve layer: '%d'!='%d'", layer.Metadata.Index, c.resolveLayer)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestImageSquashResolver_FilesByGlob(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
glob string
|
||||
resolveLayer uint
|
||||
resolvePath string
|
||||
}{
|
||||
{
|
||||
name: "link with previous data",
|
||||
glob: "**/link-1",
|
||||
resolveLayer: 1,
|
||||
resolvePath: "/file-1.txt",
|
||||
},
|
||||
{
|
||||
name: "link with in layer data",
|
||||
glob: "**/link-within",
|
||||
resolveLayer: 5,
|
||||
resolvePath: "/file-3.txt",
|
||||
},
|
||||
{
|
||||
name: "link with overridden data",
|
||||
glob: "**/link-2",
|
||||
resolveLayer: 7,
|
||||
resolvePath: "/file-2.txt",
|
||||
},
|
||||
{
|
||||
name: "indirect link (with overridden data)",
|
||||
glob: "**/link-indirect",
|
||||
resolveLayer: 7,
|
||||
resolvePath: "/file-2.txt",
|
||||
},
|
||||
{
|
||||
name: "dead link",
|
||||
glob: "**/link-dead",
|
||||
// dead links are dead! they shouldn't match on globs
|
||||
resolvePath: "",
|
||||
},
|
||||
{
|
||||
name: "ignore directories",
|
||||
glob: "**/bin",
|
||||
resolvePath: "",
|
||||
},
|
||||
{
|
||||
name: "parent without link",
|
||||
glob: "**/parent/*.txt",
|
||||
resolveLayer: 11,
|
||||
resolvePath: "/parent/file-4.txt",
|
||||
},
|
||||
{
|
||||
name: "parent is a link (override)",
|
||||
glob: "**/parent-link/file-4.txt",
|
||||
resolveLayer: 11,
|
||||
resolvePath: "/parent/file-4.txt",
|
||||
},
|
||||
}
|
||||
for _, c := range cases {
|
||||
t.Run(c.name, func(t *testing.T) {
|
||||
img := imagetest.GetFixtureImage(t, "docker-archive", "image-symlinks")
|
||||
|
||||
resolver, err := NewFromContainerImageSquash(img)
|
||||
if err != nil {
|
||||
t.Fatalf("could not create resolver: %+v", err)
|
||||
}
|
||||
|
||||
refs, err := resolver.FilesByGlob(c.glob)
|
||||
if err != nil {
|
||||
t.Fatalf("could not use resolver: %+v", err)
|
||||
}
|
||||
|
||||
expectedRefs := 1
|
||||
if c.resolvePath == "" {
|
||||
expectedRefs = 0
|
||||
}
|
||||
|
||||
if len(refs) != expectedRefs {
|
||||
t.Fatalf("unexpected number of resolutions: %d", len(refs))
|
||||
}
|
||||
|
||||
if expectedRefs == 0 {
|
||||
// nothing else to assert
|
||||
return
|
||||
}
|
||||
|
||||
actual := refs[0]
|
||||
|
||||
if string(actual.Reference().RealPath) != c.resolvePath {
|
||||
t.Errorf("bad resolve path: '%s'!='%s'", string(actual.Reference().RealPath), c.resolvePath)
|
||||
}
|
||||
|
||||
if c.resolvePath != "" && string(actual.Reference().RealPath) != actual.RealPath {
|
||||
t.Errorf("we should always prefer real paths over ones with links")
|
||||
}
|
||||
|
||||
layer := img.FileCatalog.Layer(actual.Reference())
|
||||
|
||||
if layer.Metadata.Index != c.resolveLayer {
|
||||
t.Errorf("bad resolve layer: '%d'!='%d'", layer.Metadata.Index, c.resolveLayer)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func Test_imageSquashResolver_FilesByMIMEType(t *testing.T) {
|
||||
|
||||
tests := []struct {
|
||||
fixtureName string
|
||||
mimeType string
|
||||
expectedPaths *strset.Set
|
||||
}{
|
||||
{
|
||||
fixtureName: "image-simple",
|
||||
mimeType: "text/plain",
|
||||
expectedPaths: strset.New("/somefile-1.txt", "/somefile-2.txt", "/really/nested/file-3.txt"),
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.fixtureName, func(t *testing.T) {
|
||||
img := imagetest.GetFixtureImage(t, "docker-archive", test.fixtureName)
|
||||
|
||||
resolver, err := NewFromContainerImageSquash(img)
|
||||
assert.NoError(t, err)
|
||||
|
||||
locations, err := resolver.FilesByMIMEType(test.mimeType)
|
||||
assert.NoError(t, err)
|
||||
|
||||
assert.Len(t, locations, test.expectedPaths.Size())
|
||||
for _, l := range locations {
|
||||
assert.True(t, test.expectedPaths.Has(l.RealPath), "does not have path %q", l.RealPath)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func Test_imageSquashResolver_hasFilesystemIDInLocation(t *testing.T) {
|
||||
img := imagetest.GetFixtureImage(t, "docker-archive", "image-duplicate-path")
|
||||
|
||||
resolver, err := NewFromContainerImageSquash(img)
|
||||
assert.NoError(t, err)
|
||||
|
||||
locations, err := resolver.FilesByMIMEType("text/plain")
|
||||
assert.NoError(t, err)
|
||||
assert.NotEmpty(t, locations)
|
||||
for _, location := range locations {
|
||||
assert.NotEmpty(t, location.FileSystemID)
|
||||
}
|
||||
|
||||
locations, err = resolver.FilesByGlob("*.txt")
|
||||
assert.NoError(t, err)
|
||||
assert.NotEmpty(t, locations)
|
||||
for _, location := range locations {
|
||||
assert.NotEmpty(t, location.FileSystemID)
|
||||
}
|
||||
|
||||
locations, err = resolver.FilesByPath("/somefile-1.txt")
|
||||
assert.NoError(t, err)
|
||||
assert.NotEmpty(t, locations)
|
||||
for _, location := range locations {
|
||||
assert.NotEmpty(t, location.FileSystemID)
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
func TestSquashImageResolver_FilesContents(t *testing.T) {
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
path string
|
||||
contents []string
|
||||
}{
|
||||
{
|
||||
name: "one degree",
|
||||
path: "link-2",
|
||||
contents: []string{
|
||||
"NEW file override!", // always from the squashed perspective
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "two degrees",
|
||||
path: "link-indirect",
|
||||
contents: []string{
|
||||
"NEW file override!", // always from the squashed perspective
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "dead link",
|
||||
path: "link-dead",
|
||||
contents: []string{},
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
img := imagetest.GetFixtureImage(t, "docker-archive", "image-symlinks")
|
||||
|
||||
resolver, err := NewFromContainerImageSquash(img)
|
||||
assert.NoError(t, err)
|
||||
|
||||
refs, err := resolver.FilesByPath(test.path)
|
||||
require.NoError(t, err)
|
||||
assert.Len(t, refs, len(test.contents))
|
||||
|
||||
for idx, loc := range refs {
|
||||
|
||||
reader, err := resolver.FileContentsByLocation(loc)
|
||||
require.NoError(t, err)
|
||||
|
||||
actual, err := io.ReadAll(reader)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Equal(t, test.contents[idx], string(actual))
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestSquashImageResolver_FilesContents_errorOnDirRequest(t *testing.T) {
|
||||
|
||||
img := imagetest.GetFixtureImage(t, "docker-archive", "image-symlinks")
|
||||
|
||||
resolver, err := NewFromContainerImageSquash(img)
|
||||
assert.NoError(t, err)
|
||||
|
||||
var dirLoc *file.Location
|
||||
for loc := range resolver.AllLocations() {
|
||||
entry, err := resolver.img.FileCatalog.Get(loc.Reference())
|
||||
require.NoError(t, err)
|
||||
if entry.Metadata.IsDir() {
|
||||
dirLoc = &loc
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
require.NotNil(t, dirLoc)
|
||||
|
||||
reader, err := resolver.FileContentsByLocation(*dirLoc)
|
||||
require.Error(t, err)
|
||||
require.Nil(t, reader)
|
||||
}
|
||||
|
||||
func Test_imageSquashResolver_resolvesLinks(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
runner func(file.Resolver) []file.Location
|
||||
expected []file.Location
|
||||
}{
|
||||
{
|
||||
name: "by mimetype",
|
||||
runner: func(resolver file.Resolver) []file.Location {
|
||||
// links should not show up when searching mimetype
|
||||
actualLocations, err := resolver.FilesByMIMEType("text/plain")
|
||||
assert.NoError(t, err)
|
||||
return actualLocations
|
||||
},
|
||||
expected: []file.Location{
|
||||
file.NewVirtualLocation("/etc/group", "/etc/group"),
|
||||
file.NewVirtualLocation("/etc/passwd", "/etc/passwd"),
|
||||
file.NewVirtualLocation("/etc/shadow", "/etc/shadow"),
|
||||
file.NewVirtualLocation("/file-1.txt", "/file-1.txt"),
|
||||
file.NewVirtualLocation("/file-3.txt", "/file-3.txt"),
|
||||
file.NewVirtualLocation("/file-2.txt", "/file-2.txt"),
|
||||
file.NewVirtualLocation("/parent/file-4.txt", "/parent/file-4.txt"),
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "by glob to links",
|
||||
runner: func(resolver file.Resolver) []file.Location {
|
||||
// links are searched, but resolve to the real files
|
||||
actualLocations, err := resolver.FilesByGlob("*ink-*")
|
||||
assert.NoError(t, err)
|
||||
return actualLocations
|
||||
},
|
||||
expected: []file.Location{
|
||||
file.NewVirtualLocation("/file-1.txt", "/link-1"),
|
||||
file.NewVirtualLocation("/file-2.txt", "/link-2"),
|
||||
|
||||
// though this is a link, and it matches to the file, the resolver de-duplicates files
|
||||
// by the real path, so it is not included in the results
|
||||
//file.NewVirtualLocation("/file-2.txt", "/link-indirect"),
|
||||
|
||||
file.NewVirtualLocation("/file-3.txt", "/link-within"),
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "by basename",
|
||||
runner: func(resolver file.Resolver) []file.Location {
|
||||
// links are searched, but resolve to the real files
|
||||
actualLocations, err := resolver.FilesByGlob("**/file-2.txt")
|
||||
assert.NoError(t, err)
|
||||
return actualLocations
|
||||
},
|
||||
expected: []file.Location{
|
||||
// this has two copies in the base image, which overwrites the same location
|
||||
file.NewVirtualLocation("/file-2.txt", "/file-2.txt"),
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "by basename glob",
|
||||
runner: func(resolver file.Resolver) []file.Location {
|
||||
// links are searched, but resolve to the real files
|
||||
actualLocations, err := resolver.FilesByGlob("**/file-?.txt")
|
||||
assert.NoError(t, err)
|
||||
return actualLocations
|
||||
},
|
||||
expected: []file.Location{
|
||||
file.NewVirtualLocation("/file-1.txt", "/file-1.txt"),
|
||||
file.NewVirtualLocation("/file-2.txt", "/file-2.txt"),
|
||||
file.NewVirtualLocation("/file-3.txt", "/file-3.txt"),
|
||||
file.NewVirtualLocation("/parent/file-4.txt", "/parent/file-4.txt"),
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "by basename glob to links",
|
||||
runner: func(resolver file.Resolver) []file.Location {
|
||||
actualLocations, err := resolver.FilesByGlob("**/link-*")
|
||||
assert.NoError(t, err)
|
||||
return actualLocations
|
||||
},
|
||||
expected: []file.Location{
|
||||
file.NewVirtualLocation("/file-1.txt", "/link-1"),
|
||||
file.NewVirtualLocation("/file-2.txt", "/link-2"),
|
||||
|
||||
// we already have this real file path via another link, so only one is returned
|
||||
// file.NewVirtualLocation("/file-2.txt", "/link-indirect"),
|
||||
|
||||
file.NewVirtualLocation("/file-3.txt", "/link-within"),
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "by extension",
|
||||
runner: func(resolver file.Resolver) []file.Location {
|
||||
// links are searched, but resolve to the real files
|
||||
actualLocations, err := resolver.FilesByGlob("**/*.txt")
|
||||
assert.NoError(t, err)
|
||||
return actualLocations
|
||||
},
|
||||
expected: []file.Location{
|
||||
file.NewVirtualLocation("/file-1.txt", "/file-1.txt"),
|
||||
file.NewVirtualLocation("/file-2.txt", "/file-2.txt"),
|
||||
file.NewVirtualLocation("/file-3.txt", "/file-3.txt"),
|
||||
file.NewVirtualLocation("/parent/file-4.txt", "/parent/file-4.txt"),
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "by path to degree 1 link",
|
||||
runner: func(resolver file.Resolver) []file.Location {
|
||||
// links resolve to the final file
|
||||
actualLocations, err := resolver.FilesByPath("/link-2")
|
||||
assert.NoError(t, err)
|
||||
return actualLocations
|
||||
},
|
||||
expected: []file.Location{
|
||||
// we have multiple copies across layers
|
||||
file.NewVirtualLocation("/file-2.txt", "/link-2"),
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "by path to degree 2 link",
|
||||
runner: func(resolver file.Resolver) []file.Location {
|
||||
// multiple links resolves to the final file
|
||||
actualLocations, err := resolver.FilesByPath("/link-indirect")
|
||||
assert.NoError(t, err)
|
||||
return actualLocations
|
||||
},
|
||||
expected: []file.Location{
|
||||
// we have multiple copies across layers
|
||||
file.NewVirtualLocation("/file-2.txt", "/link-indirect"),
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
|
||||
img := imagetest.GetFixtureImage(t, "docker-archive", "image-symlinks")
|
||||
|
||||
resolver, err := NewFromContainerImageSquash(img)
|
||||
assert.NoError(t, err)
|
||||
|
||||
actual := test.runner(resolver)
|
||||
|
||||
compareLocations(t, test.expected, actual)
|
||||
})
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
func TestSquashResolver_AllLocations(t *testing.T) {
|
||||
img := imagetest.GetFixtureImage(t, "docker-archive", "image-files-deleted")
|
||||
|
||||
resolver, err := NewFromContainerImageSquash(img)
|
||||
assert.NoError(t, err)
|
||||
|
||||
paths := strset.New()
|
||||
for loc := range resolver.AllLocations() {
|
||||
paths.Add(loc.RealPath)
|
||||
}
|
||||
expected := []string{
|
||||
"/Dockerfile",
|
||||
"/file-3.txt",
|
||||
"/target",
|
||||
"/target/file-2.txt",
|
||||
}
|
||||
|
||||
// depending on how the image is built (either from linux or mac), sys and proc might accidentally be added to the image.
|
||||
// this isn't important for the test, so we remove them.
|
||||
paths.Remove("/proc", "/sys", "/dev", "/etc")
|
||||
|
||||
pathsList := paths.List()
|
||||
sort.Strings(pathsList)
|
||||
|
||||
assert.ElementsMatchf(t, expected, pathsList, "expected all paths to be indexed, but found different paths: \n%s", cmp.Diff(expected, paths.List()))
|
||||
}
|
||||
Reference in New Issue
Block a user