felixfoertsch/syncthing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

all: Grand test refactor (fixes #8779, fixes #8799)

Browse Source 
This fixes various test issues with Go 1.20.

- Most tests rewritten to use fakefs where possible
- Some tests that were already skipped, or dubious (invasive,
  unmaintainable, unclear what they even tested) have been removed
- Some actual code rewritten to better support testing in fakefs

Co-authored-by: Eric P <eric@kastelo.net>
This commit is contained in:
Jakob Borg
2023-05-09 10:01:57 +00:00
co-authored by Eric P
parent ddce692f72
commit 1103a27337
54 changed files with 1133 additions and 1594 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/config/config_test.go
+92 -62
View File
@@ -27,15 +27,21 @@ import (
"github.com/syncthing/syncthing/lib/events"
"github.com/syncthing/syncthing/lib/fs"
"github.com/syncthing/syncthing/lib/protocol"
"github.com/syncthing/syncthing/lib/rand"
)
var device1, device2, device3, device4 protocol.DeviceID
var testFs fs.Filesystem
func init() {
device1, _ = protocol.DeviceIDFromString("AIR6LPZ7K4PTTUXQSMUUCPQ5YWOEDFIIQJUG7772YQXXR5YD6AWQ")
device2, _ = protocol.DeviceIDFromString("GYRZZQB-IRNPV4Z-T7TC52W-EQYJ3TT-FDQW6MW-DFLMU42-SSSU6EM-FBK2VAY")
device3, _ = protocol.DeviceIDFromString("LGFPDIT-7SKNNJL-VJZA4FC-7QNCRKA-CE753K7-2BW5QDK-2FOZ7FR-FEP57QJ")
device4, _ = protocol.DeviceIDFromString("P56IOI7-MZJNU2Y-IQGDREY-DM2MGTI-MGL3BXN-PQ6W5BM-TBBZ4TJ-XZWICQ2")
testFs = fs.NewFilesystem(fs.FilesystemTypeFake, rand.String(32)+"?content=true")
loadTestFiles()
}
func TestDefaultValues(t *testing.T) {
@@ -144,19 +150,19 @@ func TestDefaultValues(t *testing.T) {
func TestDeviceConfig(t *testing.T) {
for i := OldestHandledVersion; i <= CurrentVersion; i++ {
cfgFile := fmt.Sprintf("testdata/v%d.xml", i)
if _, err := os.Stat(cfgFile); os.IsNotExist(err) {
cfgFile := fmt.Sprintf("v%d.xml", i)
if _, err := testFs.Stat(cfgFile); os.IsNotExist(err) {
continue
}
os.RemoveAll(filepath.Join("testdata", DefaultMarkerName))
wr, wrCancel, err := copyAndLoad(cfgFile, device1)
testFs.RemoveAll(DefaultMarkerName)
wr, wrCancel, err := copyAndLoad(testFs, cfgFile, device1)
defer wrCancel()
if err != nil {
t.Fatal(err)
}
_, err = os.Stat(filepath.Join("testdata", DefaultMarkerName))
_, err = testFs.Stat(DefaultMarkerName)
if i < 6 && err != nil {
t.Fatal(err)
} else if i >= 6 && err == nil {
@@ -217,7 +223,7 @@ func TestDeviceConfig(t *testing.T) {
t.Errorf("%d: Incorrect version %d != %d", i, cfg.Version, CurrentVersion)
}
if diff, equal := messagediff.PrettyDiff(expectedFolders, cfg.Folders); !equal {
t.Errorf("%d: Incorrect Folders. Diff:\n%s", i, diff)
t.Errorf("%d: Incorrect Folders. Diff:\n%s\n%v", i, diff, cfg)
}
if diff, equal := messagediff.PrettyDiff(expectedDevices, cfg.Devices); !equal {
t.Errorf("%d: Incorrect Devices. Diff:\n%s", i, diff)
@@ -229,10 +235,10 @@ func TestDeviceConfig(t *testing.T) {
}
func TestNoListenAddresses(t *testing.T) {
cfg, cfgCancel, err := copyAndLoad("testdata/nolistenaddress.xml", device1)
cfg, cfgCancel, err := copyAndLoad(testFs, "nolistenaddress.xml", device1)
defer cfgCancel()
if err != nil {
t.Error(err)
t.Fatal(err)
}
expected := []string{""}
@@ -292,7 +298,7 @@ func TestOverriddenValues(t *testing.T) {
expectedPath := "/media/syncthing"
os.Unsetenv("STNOUPGRADE")
cfg, cfgCancel, err := copyAndLoad("testdata/overridenvalues.xml", device1)
cfg, cfgCancel, err := copyAndLoad(testFs, "overridenvalues.xml", device1)
defer cfgCancel()
if err != nil {
t.Error(err)
@@ -338,7 +344,7 @@ func TestDeviceAddressesDynamic(t *testing.T) {
},
}
cfg, cfgCancel, err := copyAndLoad("testdata/deviceaddressesdynamic.xml", device4)
cfg, cfgCancel, err := copyAndLoad(testFs, "deviceaddressesdynamic.xml", device4)
defer cfgCancel()
if err != nil {
t.Error(err)
@@ -384,7 +390,7 @@ func TestDeviceCompression(t *testing.T) {
},
}
cfg, cfgCancel, err := copyAndLoad("testdata/devicecompression.xml", device4)
cfg, cfgCancel, err := copyAndLoad(testFs, "devicecompression.xml", device4)
defer cfgCancel()
if err != nil {
t.Error(err)
@@ -427,7 +433,7 @@ func TestDeviceAddressesStatic(t *testing.T) {
},
}
cfg, cfgCancel, err := copyAndLoad("testdata/deviceaddressesstatic.xml", device4)
cfg, cfgCancel, err := copyAndLoad(testFs, "deviceaddressesstatic.xml", device4)
defer cfgCancel()
if err != nil {
t.Error(err)
@@ -440,7 +446,7 @@ func TestDeviceAddressesStatic(t *testing.T) {
}
func TestVersioningConfig(t *testing.T) {
cfg, cfgCancel, err := copyAndLoad("testdata/versioningconfig.xml", device4)
cfg, cfgCancel, err := copyAndLoad(testFs, "versioningconfig.xml", device4)
defer cfgCancel()
if err != nil {
t.Error(err)
@@ -468,7 +474,7 @@ func TestIssue1262(t *testing.T) {
t.Skipf("path gets converted to absolute as part of the filesystem initialization on linux")
}
cfg, cfgCancel, err := copyAndLoad("testdata/issue-1262.xml", device4)
cfg, cfgCancel, err := copyAndLoad(testFs, "issue-1262.xml", device4)
defer cfgCancel()
if err != nil {
t.Fatal(err)
@@ -483,7 +489,7 @@ func TestIssue1262(t *testing.T) {
}
func TestIssue1750(t *testing.T) {
cfg, cfgCancel, err := copyAndLoad("testdata/issue-1750.xml", device4)
cfg, cfgCancel, err := copyAndLoad(testFs, "issue-1750.xml", device4)
defer cfgCancel()
if err != nil {
t.Fatal(err)
@@ -521,20 +527,15 @@ func TestFolderPath(t *testing.T) {
}
func TestFolderCheckPath(t *testing.T) {
n := t.TempDir()
testFs := fs.NewFilesystem(fs.FilesystemTypeBasic, n)
err := os.MkdirAll(filepath.Join(n, "dir", ".stfolder"), os.FileMode(0o777))
if err != nil {
t.Fatal(err)
}
tmpFs := fs.NewFilesystem(fs.FilesystemTypeFake, rand.String(16)+"?nostfolder=true")
_ = tmpFs.MkdirAll(filepath.Join("dir", ".stfolder"), 0o777)
testcases := []struct {
path string
err error
}{
{
path: "",
path: ".",
err: ErrMarkerMissing,
},
{
@@ -547,35 +548,20 @@ func TestFolderCheckPath(t *testing.T) {
},
}
err = fs.DebugSymlinkForTestsOnly(testFs, testFs, "dir", "link")
if err == nil {
t.Log("running with symlink check")
testcases = append(testcases, struct {
path string
err error
}{
path: "link",
err: nil,
})
} else if !build.IsWindows {
t.Log("running without symlink check")
t.Fatal(err)
}
for _, testcase := range testcases {
cfg := FolderConfiguration{
Path: filepath.Join(n, testcase.path),
MarkerName: DefaultMarkerName,
FilesystemType: fs.FilesystemTypeFake,
MarkerName: DefaultMarkerName,
}
if err := cfg.CheckPath(); testcase.err != err {
t.Errorf("unexpected error in case %s: %s != %v", testcase.path, err, testcase.err)
if err := cfg.checkFilesystemPath(tmpFs, testcase.path); testcase.err != err {
t.Errorf("unexpected error in case; path: [%s] err [%s] expected err [%v]", testcase.path, err, testcase.err)
}
}
}
func TestNewSaveLoad(t *testing.T) {
path := "testdata/temp.xml"
path := "temp.xml"
os.Remove(path)
defer os.Remove(path)
@@ -657,7 +643,7 @@ func TestPrepare(t *testing.T) {
}
func TestCopy(t *testing.T) {
wrapper, wrapperCancel, err := copyAndLoad("testdata/example.xml", device1)
wrapper, wrapperCancel, err := copyAndLoad(testFs, "example.xml", device1)
defer wrapperCancel()
if err != nil {
t.Fatal(err)
@@ -690,14 +676,12 @@ func TestCopy(t *testing.T) {
t.Error("Config should have changed")
}
if !bytes.Equal(bsOrig, bsCopy) {
// os.WriteFile("a", bsOrig, 0644)
// os.WriteFile("b", bsCopy, 0644)
t.Error("Copy should be unchanged")
}
}
func TestPullOrder(t *testing.T) {
wrapper, wrapperCleanup, err := copyAndLoad("testdata/pullorder.xml", device1)
wrapper, wrapperCleanup, err := copyAndLoad(testFs, "pullorder.xml", device1)
defer wrapperCleanup()
if err != nil {
t.Fatal(err)
@@ -750,7 +734,7 @@ func TestPullOrder(t *testing.T) {
}
func TestLargeRescanInterval(t *testing.T) {
wrapper, wrapperCancel, err := copyAndLoad("testdata/largeinterval.xml", device1)
wrapper, wrapperCancel, err := copyAndLoad(testFs, "largeinterval.xml", device1)
defer wrapperCancel()
if err != nil {
t.Fatal(err)
@@ -810,7 +794,7 @@ func TestGUIPasswordHash(t *testing.T) {
func TestDuplicateDevices(t *testing.T) {
// Duplicate devices should be removed
wrapper, wrapperCancel, err := copyAndLoad("testdata/dupdevices.xml", device1)
wrapper, wrapperCancel, err := copyAndLoad(testFs, "dupdevices.xml", device1)
defer wrapperCancel()
if err != nil {
t.Fatal(err)
@@ -829,7 +813,7 @@ func TestDuplicateDevices(t *testing.T) {
func TestDuplicateFolders(t *testing.T) {
// Duplicate folders are a loading error
_, _Cancel, err := copyAndLoad("testdata/dupfolders.xml", device1)
_, _Cancel, err := copyAndLoad(testFs, "dupfolders.xml", device1)
defer _Cancel()
if err == nil || !strings.Contains(err.Error(), errFolderIDDuplicate.Error()) {
t.Fatal(`Expected error to mention "duplicate folder ID":`, err)
@@ -841,7 +825,7 @@ func TestEmptyFolderPaths(t *testing.T) {
// get messed up by the prepare steps (e.g., become the current dir or
// get a slash added so that it becomes the root directory or similar).
_, _Cancel, err := copyAndLoad("testdata/nopath.xml", device1)
_, _Cancel, err := copyAndLoad(testFs, "nopath.xml", device1)
defer _Cancel()
if err == nil || !strings.Contains(err.Error(), errFolderPathEmpty.Error()) {
t.Fatal("Expected error due to empty folder path, got", err)
@@ -911,7 +895,7 @@ func TestIgnoredDevices(t *testing.T) {
// Verify that ignored devices that are also present in the
// configuration are not in fact ignored.
wrapper, wrapperCancel, err := copyAndLoad("testdata/ignoreddevices.xml", device1)
wrapper, wrapperCancel, err := copyAndLoad(testFs, "ignoreddevices.xml", device1)
defer wrapperCancel()
if err != nil {
t.Fatal(err)
@@ -930,7 +914,7 @@ func TestIgnoredFolders(t *testing.T) {
// configuration are not in fact ignored.
// Also, verify that folders that are shared with a device are not ignored.
wrapper, wrapperCancel, err := copyAndLoad("testdata/ignoredfolders.xml", device1)
wrapper, wrapperCancel, err := copyAndLoad(testFs, "ignoredfolders.xml", device1)
defer wrapperCancel()
if err != nil {
t.Fatal(err)
@@ -967,7 +951,7 @@ func TestIgnoredFolders(t *testing.T) {
func TestGetDevice(t *testing.T) {
// Verify that the Device() call does the right thing
wrapper, wrapperCancel, err := copyAndLoad("testdata/ignoreddevices.xml", device1)
wrapper, wrapperCancel, err := copyAndLoad(testFs, "ignoreddevices.xml", device1)
defer wrapperCancel()
if err != nil {
t.Fatal(err)
@@ -995,7 +979,8 @@ func TestGetDevice(t *testing.T) {
}
func TestSharesRemovedOnDeviceRemoval(t *testing.T) {
wrapper, wrapperCancel, err := copyAndLoad("testdata/example.xml", device1)
t.Skip("to fix: test hangs")
wrapper, wrapperCancel, err := copyAndLoad(testFs, "example.xml", device1)
defer wrapperCancel()
if err != nil {
t.Errorf("Failed: %s", err)
@@ -1307,38 +1292,63 @@ func defaultConfigAsMap() map[string]interface{} {
return tmp
}
func copyToTmp(path string) (string, error) {
orig, err := os.Open(path)
func copyToTmp(fs fs.Filesystem, path string) (string, error) {
orig, err := fs.Open(path)
if err != nil {
return "", err
}
defer orig.Close()
temp, err := os.CreateTemp("", "syncthing-configTest-")
temp, err := fs.Create("syncthing-configTest-" + rand.String(6))
if err != nil {
return "", err
}
defer temp.Close()
if _, err := io.Copy(temp, orig); err != nil {
return "", err
}
return temp.Name(), nil
}
func copyAndLoad(path string, myID protocol.DeviceID) (*testWrapper, func(), error) {
temp, err := copyToTmp(path)
func copyAndLoad(fs fs.Filesystem, path string, myID protocol.DeviceID) (*testWrapper, func(), error) {
temp, err := copyToTmp(fs, path)
if err != nil {
return nil, func() {}, err
}
wrapper, err := load(temp, myID)
wrapper, err := loadTest(fs, temp, myID)
if err != nil {
return nil, func() {}, err
}
return wrapper, func() {
fs.Remove(temp)
wrapper.stop()
os.Remove(temp)
}, nil
}
func loadTest(fs fs.Filesystem, path string, myID protocol.DeviceID) (*testWrapper, error) {
cfg, _, err := loadWrapTest(fs, path, myID, events.NoopLogger)
if err != nil {
return nil, err
}
return startWrapper(cfg), nil
}
func loadWrapTest(fs fs.Filesystem, path string, myID protocol.DeviceID, evLogger events.Logger) (Wrapper, int, error) {
fd, err := fs.Open(path)
if err != nil {
return nil, 0, err
}
defer fd.Close()
cfg, originalVersion, err := ReadXML(fd, myID)
if err != nil {
return nil, 0, err
}
return Wrap(filepath.Join(testFs.URI(), path), cfg, myID, evLogger), originalVersion, nil
}
func load(path string, myID protocol.DeviceID) (*testWrapper, error) {
cfg, _, err := Load(path, myID, events.NoopLogger)
if err != nil {
@@ -1478,3 +1488,23 @@ func TestXattrFilter(t *testing.T) {
}
}
}
func loadTestFiles() {
entries, err := os.ReadDir("testdata")
if err != nil {
return
}
for _, e := range entries {
handleFile(e.Name())
}
}
func handleFile(name string) {
fd, err := testFs.Create(name)
if err != nil {
return
}
origin, _ := os.ReadFile(filepath.Join("testdata", name))
fd.Write(origin)
fd.Close()
}
lib/config/folderconfiguration.go
+11 -6
View File
@@ -10,6 +10,7 @@ import (
"errors"
"fmt"
"path"
"path/filepath"
"sort"
"strings"
"time"
@@ -90,11 +91,11 @@ func (f *FolderConfiguration) CreateMarker() error {
return nil
}
permBits := fs.FileMode(0777)
permBits := fs.FileMode(0o777)
if build.IsWindows {
// Windows has no umask so we must chose a safer set of bits to
// begin with.
permBits = 0700
permBits = 0o700
}
fs := f.Filesystem(nil)
err := fs.Mkdir(DefaultMarkerName, permBits)
@@ -113,7 +114,11 @@ func (f *FolderConfiguration) CreateMarker() error {
// CheckPath returns nil if the folder root exists and contains the marker file
func (f *FolderConfiguration) CheckPath() error {
fi, err := f.Filesystem(nil).Stat(".")
return f.checkFilesystemPath(f.Filesystem(nil), ".")
}
func (f *FolderConfiguration) checkFilesystemPath(ffs fs.Filesystem, path string) error {
fi, err := ffs.Stat(path)
if err != nil {
if !fs.IsNotExist(err) {
return err
@@ -131,7 +136,7 @@ func (f *FolderConfiguration) CheckPath() error {
return ErrPathNotDirectory
}
_, err = f.Filesystem(nil).Stat(f.MarkerName)
_, err = ffs.Stat(filepath.Join(path, f.MarkerName))
if err != nil {
if !fs.IsNotExist(err) {
return err
@@ -145,11 +150,11 @@ func (f *FolderConfiguration) CheckPath() error {
func (f *FolderConfiguration) CreateRoot() (err error) {
// Directory permission bits. Will be filtered down to something
// sane by umask on Unixes.
permBits := fs.FileMode(0777)
permBits := fs.FileMode(0o777)
if build.IsWindows {
// Windows has no umask so we must chose a safer set of bits to
// begin with.
permBits = 0700
permBits = 0o700
}
filesystem := f.Filesystem(nil)
lib/config/wrapper.go
+3
View File
@@ -293,6 +293,9 @@ func (w *wrapper) Serve(ctx context.Context) error {
}
func (w *wrapper) serveSave() {
if w.path == "" {
return
}
if err := w.Save(); err != nil {
l.Warnln("Failed to save config:", err)
}