mirror of
https://github.com/anchore/syft.git
synced 2026-11-03 16:06:36 +01:00
chore: simplify and cleanup
Signed-off-by: Keith Zantow <keith.zantow@anchore.com>
This commit is contained in:
Keith Zantow
@@ -14,165 +14,92 @@ import (
|
||||
func TestTraversalContextRoundTrip(t *testing.T) {
|
||||
assert.Nil(t, TraversalFromContext(context.Background()))
|
||||
|
||||
trav := &Traversal{
|
||||
Location: file.NewLocation("app.war"),
|
||||
VirtualPath: "app.war",
|
||||
}
|
||||
trav := &Traversal{Location: file.NewLocation("app.war")}
|
||||
ctx := WithTraversal(context.Background(), trav)
|
||||
require.Same(t, trav, TraversalFromContext(ctx))
|
||||
|
||||
child := &Traversal{
|
||||
Location: file.NewLocation("/WEB-INF/lib/dep.jar"),
|
||||
VirtualPath: trav.VirtualPathOf("/WEB-INF/lib/dep.jar"),
|
||||
}
|
||||
child := &Traversal{Location: locationIn("app.war", "/WEB-INF/lib/dep.jar")}
|
||||
ctx = WithTraversal(ctx, child)
|
||||
require.Same(t, child, TraversalFromContext(ctx))
|
||||
}
|
||||
|
||||
func TestTraversal_VirtualPathOf(t *testing.T) {
|
||||
// locationIn is a location as the Index returns it: an entry path stamped with the containing chain.
|
||||
func locationIn(archivePath, entryPath string) file.Location {
|
||||
loc := file.NewLocation(entryPath)
|
||||
loc.ArchivePath = archivePath
|
||||
return loc
|
||||
}
|
||||
|
||||
func TestVirtualPath(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
traversal *Traversal
|
||||
entryPath string
|
||||
expected string
|
||||
name string
|
||||
location file.Location
|
||||
expected string
|
||||
}{
|
||||
{
|
||||
name: "nil traversal returns entry path unchanged",
|
||||
traversal: nil,
|
||||
entryPath: "/WEB-INF/lib/dep.jar",
|
||||
expected: "/WEB-INF/lib/dep.jar",
|
||||
name: "outside an archive returns the path unchanged",
|
||||
location: file.NewLocation("/WEB-INF/lib/dep.jar"),
|
||||
expected: "/WEB-INF/lib/dep.jar",
|
||||
},
|
||||
{
|
||||
name: "nil traversal preserves relative path",
|
||||
traversal: nil,
|
||||
entryPath: "some/dir/example.jar",
|
||||
expected: "some/dir/example.jar",
|
||||
name: "outside an archive preserves a relative path",
|
||||
location: file.NewLocation("some/dir/example.jar"),
|
||||
expected: "some/dir/example.jar",
|
||||
},
|
||||
{
|
||||
name: "single level trims leading slash",
|
||||
traversal: &Traversal{VirtualPath: "app.war"},
|
||||
entryPath: "/WEB-INF/lib/dep.jar",
|
||||
expected: "app.war:WEB-INF/lib/dep.jar",
|
||||
name: "single level trims leading slash",
|
||||
location: locationIn("app.war", "/WEB-INF/lib/dep.jar"),
|
||||
expected: "app.war:WEB-INF/lib/dep.jar",
|
||||
},
|
||||
{
|
||||
name: "single level with slash-less entry",
|
||||
traversal: &Traversal{VirtualPath: "app.war"},
|
||||
entryPath: "WEB-INF/lib/dep.jar",
|
||||
expected: "app.war:WEB-INF/lib/dep.jar",
|
||||
name: "single level with slash-less entry",
|
||||
location: locationIn("app.war", "WEB-INF/lib/dep.jar"),
|
||||
expected: "app.war:WEB-INF/lib/dep.jar",
|
||||
},
|
||||
{
|
||||
name: "multi-level chain",
|
||||
traversal: &Traversal{VirtualPath: "app.war:WEB-INF/lib/dep.jar"},
|
||||
entryPath: "/inner/most.jar",
|
||||
expected: "app.war:WEB-INF/lib/dep.jar:inner/most.jar",
|
||||
name: "multi-level chain",
|
||||
location: locationIn("app.war:WEB-INF/lib/dep.jar", "/inner/most.jar"),
|
||||
expected: "app.war:WEB-INF/lib/dep.jar:inner/most.jar",
|
||||
},
|
||||
{
|
||||
// a colon in the entry name must not be mistaken for a chain delimiter - see
|
||||
// decisions.md#colon-in-an-entry-path-is-escaped
|
||||
name: "colon in entry path is escaped",
|
||||
traversal: &Traversal{VirtualPath: "app.war"},
|
||||
entryPath: "WEB-INF/lib/dep:special.jar",
|
||||
expected: "app.war:WEB-INF/lib/dep%3Aspecial.jar",
|
||||
// a colon in the entry name must not be mistaken for a chain delimiter
|
||||
name: "colon in entry path is escaped",
|
||||
location: locationIn("app.war", "WEB-INF/lib/dep:special.jar"),
|
||||
expected: "app.war:WEB-INF/lib/dep%3Aspecial.jar",
|
||||
},
|
||||
{
|
||||
name: "every colon in the entry path is escaped",
|
||||
traversal: &Traversal{VirtualPath: "app.war"},
|
||||
entryPath: "lib/a:b:c.jar",
|
||||
expected: "app.war:lib/a%3Ab%3Ac.jar",
|
||||
name: "every colon in the entry path is escaped",
|
||||
location: locationIn("app.war", "lib/a:b:c.jar"),
|
||||
expected: "app.war:lib/a%3Ab%3Ac.jar",
|
||||
},
|
||||
{
|
||||
// a traversal carrying no virtual path (as distinct from a nil traversal) still yields
|
||||
// the entry path alone, never a bare leading colon
|
||||
name: "empty virtual path yields the entry path alone, no leading colon",
|
||||
traversal: &Traversal{VirtualPath: ""},
|
||||
entryPath: "WEB-INF/lib/dep.jar",
|
||||
expected: "WEB-INF/lib/dep.jar",
|
||||
name: "access path is preferred over real path",
|
||||
location: file.NewVirtualLocation("/real/dep.jar", "/link/dep.jar"),
|
||||
expected: "/link/dep.jar",
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
assert.Equal(t, tt.expected, tt.traversal.VirtualPathOf(tt.entryPath))
|
||||
assert.Equal(t, tt.expected, VirtualPath(tt.location))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestTraversal_VirtualPathOf_noColonIsByteIdenticalToPreEscaping carries the compatibility guarantee
|
||||
// behind java-virtual-path-identity-preserved (decisions.md#colon-in-an-entry-path-is-escaped):
|
||||
// escaping a colon must not alter the result for any entry path without one. Every case below is
|
||||
// colon-free, and every expected value is what VirtualPathOf produced before escaping existed. Do not
|
||||
// fix a failure here by updating the expected string - that is the regression this test catches.
|
||||
func TestTraversal_VirtualPathOf_noColonIsByteIdenticalToPreEscaping(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
traversal *Traversal
|
||||
entryPath string
|
||||
expected string
|
||||
}{
|
||||
{
|
||||
name: "nil traversal, absolute entry path",
|
||||
traversal: nil,
|
||||
entryPath: "/WEB-INF/lib/dep.jar",
|
||||
expected: "/WEB-INF/lib/dep.jar",
|
||||
},
|
||||
{
|
||||
name: "nil traversal, relative entry path",
|
||||
traversal: nil,
|
||||
entryPath: "some/dir/example.jar",
|
||||
expected: "some/dir/example.jar",
|
||||
},
|
||||
{
|
||||
name: "single level, leading slash trimmed",
|
||||
traversal: &Traversal{VirtualPath: "app.war"},
|
||||
entryPath: "/WEB-INF/lib/dep.jar",
|
||||
expected: "app.war:WEB-INF/lib/dep.jar",
|
||||
},
|
||||
{
|
||||
name: "single level, no leading slash",
|
||||
traversal: &Traversal{VirtualPath: "app.war"},
|
||||
entryPath: "WEB-INF/lib/dep.jar",
|
||||
expected: "app.war:WEB-INF/lib/dep.jar",
|
||||
},
|
||||
{
|
||||
name: "multi-level chain",
|
||||
traversal: &Traversal{VirtualPath: "app.war:WEB-INF/lib/dep.jar"},
|
||||
entryPath: "/inner/most.jar",
|
||||
expected: "app.war:WEB-INF/lib/dep.jar:inner/most.jar",
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
assert.Equal(t, tt.expected, tt.traversal.VirtualPathOf(tt.entryPath))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestTraversal_VirtualPathOf_escapingComposesAcrossNestingLevels asserts escaping applies at every
|
||||
// level of a chain, not only the first: splitting the composed result on ':' yields exactly one
|
||||
// segment per archive boundary, since no escaped colon survives as a literal ':' byte.
|
||||
func TestTraversal_VirtualPathOf_theEscapeCharacterIsNotItselfEscaped(t *testing.T) {
|
||||
// a known and accepted limit: an entry path holding the literal text %3A is indistinguishable from
|
||||
// one holding a colon. Escaping % as %25 would close it and is deliberately not done, since % is far
|
||||
// more common in real paths than : and doing so would move many well-defined identities.
|
||||
t.Parallel()
|
||||
|
||||
outer := &Traversal{VirtualPath: "outer.zip"}
|
||||
|
||||
fromColon := outer.VirtualPathOf("a:b.jar")
|
||||
fromLiteral := outer.VirtualPathOf("a%3Ab.jar")
|
||||
func TestVirtualPath_theEscapeCharacterIsNotItselfEscaped(t *testing.T) {
|
||||
// an accepted limit: an entry path holding the literal text %3A is indistinguishable from one holding
|
||||
// a colon. Escaping % too would move many more real identities than it protects.
|
||||
fromColon := VirtualPath(locationIn("outer.zip", "a:b.jar"))
|
||||
fromLiteral := VirtualPath(locationIn("outer.zip", "a%3Ab.jar"))
|
||||
|
||||
assert.Equal(t, "outer.zip:a%3Ab.jar", fromColon)
|
||||
assert.Equal(t, "outer.zip:a%3Ab.jar", fromLiteral)
|
||||
assert.Equal(t, fromColon, fromLiteral,
|
||||
"the collision is accepted; if this ever differs, the escape character started being escaped")
|
||||
assert.Equal(t, fromColon, fromLiteral)
|
||||
}
|
||||
|
||||
func TestTraversal_VirtualPathOf_escapingComposesAcrossNestingLevels(t *testing.T) {
|
||||
level1 := &Traversal{VirtualPath: "outer.zip"}
|
||||
level2VirtualPath := level1.VirtualPathOf("lib/mid:dle.war")
|
||||
require.Equal(t, "outer.zip:lib/mid%3Adle.war", level2VirtualPath)
|
||||
func TestVirtualPath_escapingComposesAcrossNestingLevels(t *testing.T) {
|
||||
level2 := VirtualPath(locationIn("outer.zip", "lib/mid:dle.war"))
|
||||
require.Equal(t, "outer.zip:lib/mid%3Adle.war", level2)
|
||||
|
||||
level2 := &Traversal{VirtualPath: level2VirtualPath}
|
||||
final := level2.VirtualPathOf("WEB-INF/lib/inn:er.jar")
|
||||
final := VirtualPath(locationIn(level2, "WEB-INF/lib/inn:er.jar"))
|
||||
require.Equal(t, "outer.zip:lib/mid%3Adle.war:WEB-INF/lib/inn%3Aer.jar", final)
|
||||
|
||||
assert.Equal(t,
|
||||
|
||||
Reference in New Issue
Block a user