Files
syncthing/lib/osutil/traversessymlink_test.go
T
Jakob Borg 92ff9ac078 chore(osutil): fixup test for symlinked folder root (#10758)
This test was incorrectly rewritten to use fakefs, which doesn't really
test what it's supposed to test.

Signed-off-by: Jakob Borg <jakob@kastelo.net>
2026-06-21 19:48:15 +02:00

115 lines
3.0 KiB
Go

// Copyright (C) 2016 The Syncthing Authors.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
// You can obtain one at https://mozilla.org/MPL/2.0/.
package osutil_test
import (
"path/filepath"
"slices"
"testing"
"github.com/syncthing/syncthing/lib/build"
"github.com/syncthing/syncthing/lib/fs"
"github.com/syncthing/syncthing/lib/osutil"
"github.com/syncthing/syncthing/lib/rand"
)
func TestTraversesSymlink(t *testing.T) {
testFs := fs.NewFilesystem(fs.FilesystemTypeFake, rand.String(32))
testFs.MkdirAll("a/b/c", 0o755)
if err := testFs.CreateSymlink(filepath.Join("a", "b"), filepath.Join("a", "l")); err != nil {
t.Fatal(err)
}
// a/l -> b, so a/l/c should resolve by normal stat
info, err := testFs.Lstat("a/l/c")
if err != nil {
t.Fatal("unexpected error", err)
}
if !info.IsDir() {
t.Fatal("error in setup, a/l/c should be a directory")
}
cases := []struct {
name string
traverses bool
}{
// Exist
{".", false},
{"a", false},
{"a/b", false},
{"a/b/c", false},
// Don't exist
{"x", false},
{"a/x", false},
{"a/b/x", false},
{"a/x/c", false},
// Symlink or behind symlink
{"a/l", true},
{"a/l/c", true},
// Non-existing behind a symlink
{"a/l/x", true},
}
for _, tc := range cases {
if res := osutil.TraversesSymlink(testFs, tc.name); tc.traverses == (res == nil) {
t.Errorf("TraversesSymlink(%q) = %v, should be %v", tc.name, res, tc.traverses)
}
}
}
func TestSymlinkedFSRootTraversal(t *testing.T) {
// Normal FS operations should work inside a folder root that is a symlink
if build.IsWindows {
t.Skip("symlinks unavailable")
}
testFsPath := t.TempDir()
testFs := fs.NewFilesystem(fs.FilesystemTypeBasic, testFsPath)
testFs.MkdirAll(filepath.Join("a", "b", "c"), 0o755)
if err := testFs.CreateSymlink("b", filepath.Join("a", "l")); err != nil {
t.Fatal(err)
}
// a/l -> b, so a/l/c should resolve by normal stat
info, err := testFs.Lstat("a/l/c")
if err != nil {
t.Fatal("unexpected error", err)
}
if !info.IsDir() {
t.Fatal("error in setup, a/l/c should be a directory")
}
testFs = fs.NewFilesystem(fs.FilesystemTypeBasic, filepath.Join(testFsPath, "a/l"))
if err := osutil.TraversesSymlink(testFs, "."); err != nil {
t.Error(`TraversesSymlink on filesystem with symlink at root returned error for ".":`, err)
}
// We should be able to create and list files within the symlinked root
if _, err := testFs.Create("test"); err != nil {
t.Fatal(err)
}
if names, err := testFs.DirNames("."); err != nil {
t.Fatal(err)
} else if !slices.Contains(names, "test") {
t.Log(names)
t.Error("missing test file in listing")
}
}
var traversesSymlinkResult error
func BenchmarkTraversesSymlink(b *testing.B) {
fs := fs.NewFilesystem(fs.FilesystemTypeFake, rand.String(32))
fs.MkdirAll("a/b/c", 0o755)
for i := 0; i < b.N; i++ {
traversesSymlinkResult = osutil.TraversesSymlink(fs, "a/b/c")
}
b.ReportAllocs()
}