Skip to content

Commit

Permalink
merge os-specific test cases
Browse files Browse the repository at this point in the history
  • Loading branch information
lkingland committed Feb 19, 2024
1 parent 1bdd09b commit d496fa8
Showing 1 changed file with 42 additions and 40 deletions.
82 changes: 42 additions & 40 deletions pkg/oci/containerize_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,59 +13,61 @@ import (
func Test_validatedLinkTarget(t *testing.T) {
root := "testdata/test-links"

allRuntimes := []string{} // optional list of runtimes a test applies to

testAppliesToCurrentRuntime := func(testRuntimes []string) bool {
if len(testRuntimes) == 0 {
return true // no filter defined.
}
for _, r := range testRuntimes {
if runtime.GOOS == r {
return true // filter defined, and current is defined.
}
}
return false // filter defined; current not in set.
}

tests := []struct {
path string // path of the file within test project root
valid bool // If it should be considered valid
name string // descriptive name of the test
path string // path of the file within test project root
valid bool // If it should be considered valid
target string // optional test of the returned value (target)
name string // descriptive name of the test
runtimes []string // only apply this test to the given runtime(s)
}{
{"absoluteLink", false, "disallow absolute-path links"},
{"a.lnk", true, "links to files within the root are allowed"},
{"...validName.lnk", true, "allow links with target of dot prefixed names"},
{"linkToRoot", true, "allow links to the project root"},
{"b/linkToRoot", true, "allow links to the project root from within subdir"},
{"b/linkToCurrentDir", true, "allow links to a subdirectory within the project"},
{"b/linkToRootsParent", false, "disallow links to the project's immediate parent"},
{"b/linkOutsideRootsParent", false, "disallow links outside project root and its parent"},
{"b/c/linkToParent", true, "allow links up, but within project"},
{"absoluteLink", false, "", "disallow absolute-path links", allRuntimes},
{"absoluteLinkWindows", false, "", "disallow absolute-path links", []string{"windows"}},
{"a.lnk", true, "", "links to files within the root are allowed", allRuntimes},
{"...validName.lnk", true, "", "allow links with target of dot prefixed names", allRuntimes},
{"linkToRoot", true, "", "allow links to the project root", allRuntimes},
{"b/linkToRoot", true, "", "allow links to the project root from within subdir", allRuntimes},
{"b/linkToCurrentDir", true, "", "allow links to a subdirectory within the project", allRuntimes},
{"b/linkToRootsParent", false, "", "disallow links to the project's immediate parent", allRuntimes},
{"b/linkOutsideRootsParent", false, "", "disallow links outside project root and its parent", allRuntimes},
{"b/c/linkToParent", true, "", " allow links up, but within project", allRuntimes},
{"a.lnk", true, "./a.txt", "spot-check link target on linux", []string{"linux"}},
{"a.lnk", true, ".\a.txt", "spot-check link target on windows ", []string{"windows"}},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if !testAppliesToCurrentRuntime(tt.runtimes) {
return // The test has a runtime filter defined
}

path := filepath.Join(root, tt.path)
info, err := os.Lstat(path) // filepath.Walk does not follow symlinks
if err != nil {
t.Fatal(err)
}
_, err = validatedLinkTarget(root, path, info)
target, err := validatedLinkTarget(root, path, info)

if err == nil != tt.valid {
t.Fatalf("expected %v, got %v", tt.valid, err)
t.Fatalf("expected validity '%v', got '%v'", tt.valid, err)
}
if tt.target != "" && target != tt.target {
t.Fatalf("expected target %q, got %q", tt.target, target)
}
})
}

// Run a windows-specific absolute path test
if runtime.GOOS == "windows" {
path := "testdata/test-links/absoluteLinkWindows"
info, err := os.Lstat(path)
if err != nil {
t.Fatal(err)
}
_, err = validatedLinkTarget(root, path, info)
if err == nil {
t.Fatal("absolute path should be invalid on windows")
}
}

// Spot-check the base case of being a decorator for os.ReadLink
path := "testdata/test-links/a.lnk"
info, err := os.Lstat(path)
if err != nil {
t.Fatal(err)
}
tgt, err := validatedLinkTarget(root, path, info)
if err != nil {
t.Fatal(err)
}
if tgt != "./a.txt" {
t.Fatalf("expected target of 'a/lnk' to be 'a.txt', got '%v'", tgt)
}
}

0 comments on commit d496fa8

Please sign in to comment.