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: <>
2026-11-07 18:04:18 +01:00 · 2023-05-24 17:06:38 -04:00
parent 4bf17a94b9
commit 07e76907f6
313 changed files with 2316 additions and 2191 deletions
@@ -0,0 +1,197 @@
+package file
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/anchore/syft/syft/artifact"
+)
+
+func TestLocationSet(t *testing.T) {
+
+	etcHostsLinkVar := Location{
+		LocationData: LocationData{
+			Coordinates: Coordinates{
+				RealPath:     "/etc/hosts",
+				FileSystemID: "a",
+			},
+			VirtualPath: "/var/etc/hosts",
+		},
+	}
+
+	etcHostsLinkHome := Location{
+		LocationData: LocationData{
+			Coordinates: Coordinates{
+				RealPath:     "/etc/hosts",
+				FileSystemID: "a",
+			},
+			VirtualPath: "/home/wagoodman/hosts",
+		},
+	}
+
+	binA := Location{
+		LocationData: LocationData{
+			Coordinates: Coordinates{
+				RealPath:     "/bin",
+				FileSystemID: "a",
+			},
+			VirtualPath: "/usr/bin",
+		},
+	}
+
+	binB := Location{
+		LocationData: LocationData{
+			Coordinates: Coordinates{
+				RealPath:     "/bin",
+				FileSystemID: "b",
+			},
+			VirtualPath: "/usr/bin",
+		},
+	}
+
+	tests := []struct {
+		name     string
+		input    []Location
+		expected []Location
+	}{
+		{
+			name: "de-dup same location",
+			input: []Location{
+				binA, binA, binA,
+			},
+			expected: []Location{
+				binA,
+			},
+		},
+		{
+			name: "dont de-dup different filesystem",
+			input: []Location{
+				binB, binA,
+			},
+			expected: []Location{
+				binA, binB,
+			},
+		},
+		{
+			name: "dont de-dup different virtual paths",
+			input: []Location{
+				etcHostsLinkVar, etcHostsLinkHome,
+			},
+			expected: []Location{
+				etcHostsLinkHome, etcHostsLinkVar,
+			},
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			set := NewLocationSet(test.input...)
+			assert.Equal(t, test.expected, set.ToSlice())
+		})
+	}
+}
+
+func TestLocationSet_Hash(t *testing.T) {
+	etcAlink := Location{
+		LocationData: LocationData{
+			Coordinates: Coordinates{
+				RealPath:     "/etc/hosts",
+				FileSystemID: "a",
+			},
+			VirtualPath: "/var/etc/hosts",
+		},
+	}
+
+	etcA := Location{
+		LocationData: LocationData{
+			Coordinates: Coordinates{
+				RealPath:     "/etc/hosts",
+				FileSystemID: "a",
+			},
+		},
+	}
+
+	etcB := Location{
+		LocationData: LocationData{
+			Coordinates: Coordinates{
+				RealPath:     "/etc/hosts",
+				FileSystemID: "b",
+			},
+		},
+	}
+
+	binA := Location{
+		LocationData: LocationData{
+			Coordinates: Coordinates{
+				RealPath:     "/bin",
+				FileSystemID: "a",
+			},
+			VirtualPath: "/usr/bin",
+		},
+	}
+
+	binB := Location{
+		LocationData: LocationData{
+			Coordinates: Coordinates{
+				RealPath:     "/bin",
+				FileSystemID: "b",
+			},
+			VirtualPath: "/usr/bin",
+		},
+	}
+
+	tests := []struct {
+		name string
+		setA LocationSet
+		setB LocationSet
+		want assert.ComparisonAssertionFunc
+	}{
+		{
+			name: "empty sets have the same hash",
+			setA: NewLocationSet(),
+			setB: NewLocationSet(),
+			want: assert.Equal,
+		},
+		{
+			name: "sets with same elements accessed through different paths have the same hash",
+			setA: NewLocationSet(binA, etcA),
+			setB: NewLocationSet(etcAlink, binA),
+			want: assert.Equal,
+		},
+		{
+			name: "sets with same elements have the same hash",
+			setA: NewLocationSet(binA, etcA),
+			setB: NewLocationSet(etcA, binA),
+			want: assert.Equal,
+		},
+		{
+			name: "sets with different element counts have different hashes",
+			setA: NewLocationSet(binA, etcA),
+			setB: NewLocationSet(binA),
+			want: assert.NotEqual,
+		},
+		{
+			name: "sets with same path but different FS IDs have the same hash",
+			setA: NewLocationSet(binA),
+			setB: NewLocationSet(binB),
+			want: assert.Equal,
+		},
+		{
+			name: "sets with same paths but different FS IDs have the same hash",
+			setA: NewLocationSet(etcA, binA),
+			setB: NewLocationSet(binB, etcB),
+			want: assert.Equal,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			gotA, err := artifact.IDByHash(tt.setA)
+			require.NoError(t, err)
+			gotB, err := artifact.IDByHash(tt.setB)
+			require.NoError(t, err)
+			tt.want(t, gotA, gotB)
+		})
+	}
+}