|
| 1 | +package filesystem |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "strings" |
| 6 | + "testing" |
| 7 | + |
| 8 | + "github.com/ARM-software/golang-utils/utils/commonerrors" |
| 9 | + "github.com/ARM-software/golang-utils/utils/commonerrors/errortest" |
| 10 | + "github.com/ARM-software/golang-utils/utils/platform" |
| 11 | + "github.com/go-faker/faker/v4" |
| 12 | + "github.com/stretchr/testify/assert" |
| 13 | + "github.com/stretchr/testify/require" |
| 14 | +) |
| 15 | + |
| 16 | +func printWarningOnWindows(t *testing.T) { |
| 17 | + t.Helper() |
| 18 | + if platform.IsWindows() { |
| 19 | + t.Log("⚠️ In order to run TestLink on Windows, Developer mode must be enabled: https://github.com/golang/go/pull/24307") |
| 20 | + } |
| 21 | +} |
| 22 | + |
| 23 | +func skipIfLinksNotSupported(t *testing.T, err error) { |
| 24 | + t.Helper() |
| 25 | + if commonerrors.Any(err, commonerrors.ErrNotImplemented, commonerrors.ErrForbidden, commonerrors.ErrUnsupported) { |
| 26 | + t.Skipf("⚠️ links not supported on this system: %v", err) |
| 27 | + } else { |
| 28 | + require.NoError(t, err) |
| 29 | + } |
| 30 | +} |
| 31 | + |
| 32 | +func TestLink(t *testing.T) { |
| 33 | + printWarningOnWindows(t) |
| 34 | + for _, fsType := range FileSystemTypes { |
| 35 | + t.Run(fmt.Sprintf("%v_for_fs_%v", t.Name(), fsType), func(t *testing.T) { |
| 36 | + fs := NewFs(fsType) |
| 37 | + tmpDir, err := fs.TempDirInTempDir("test-link-") |
| 38 | + require.NoError(t, err) |
| 39 | + defer func() { _ = fs.Rm(tmpDir) }() |
| 40 | + |
| 41 | + txt := fmt.Sprintf("This is a test sentence!!! %v", faker.Sentence()) |
| 42 | + tmpFile, err := fs.TouchTempFile(tmpDir, "test-*.txt") |
| 43 | + require.NoError(t, err) |
| 44 | + err = fs.WriteFile(tmpFile, []byte(txt), 0755) |
| 45 | + require.NoError(t, err) |
| 46 | + |
| 47 | + symlink := FilePathJoin(fs, tmpDir, "symlink-tofile") |
| 48 | + hardlink := FilePathJoin(fs, tmpDir, "hardlink-tofile") |
| 49 | + |
| 50 | + err = fs.Symlink(tmpFile, symlink) |
| 51 | + skipIfLinksNotSupported(t, err) |
| 52 | + |
| 53 | + err = fs.Link(tmpFile, hardlink) |
| 54 | + require.NoError(t, err) |
| 55 | + |
| 56 | + assert.True(t, fs.Exists(symlink)) |
| 57 | + assert.True(t, fs.Exists(hardlink)) |
| 58 | + |
| 59 | + isLink, err := fs.IsLink(symlink) |
| 60 | + require.NoError(t, err) |
| 61 | + assert.True(t, isLink) |
| 62 | + |
| 63 | + isFile, err := fs.IsFile(symlink) |
| 64 | + require.NoError(t, err) |
| 65 | + assert.True(t, isFile) |
| 66 | + |
| 67 | + isLink, err = fs.IsLink(hardlink) |
| 68 | + require.NoError(t, err) |
| 69 | + assert.False(t, isLink) |
| 70 | + |
| 71 | + isFile, err = fs.IsFile(hardlink) |
| 72 | + require.NoError(t, err) |
| 73 | + assert.True(t, isFile) |
| 74 | + |
| 75 | + link, err := fs.Readlink(symlink) |
| 76 | + require.NoError(t, err) |
| 77 | + assert.Equal(t, tmpFile, link) |
| 78 | + |
| 79 | + link, err = fs.Readlink(hardlink) |
| 80 | + require.Error(t, err) |
| 81 | + assert.Empty(t, link) |
| 82 | + |
| 83 | + bytes, err := fs.ReadFile(symlink) |
| 84 | + require.NoError(t, err) |
| 85 | + assert.Equal(t, txt, string(bytes)) |
| 86 | + |
| 87 | + bytes, err = fs.ReadFile(hardlink) |
| 88 | + require.NoError(t, err) |
| 89 | + assert.Equal(t, txt, string(bytes)) |
| 90 | + _ = fs.Rm(tmpDir) |
| 91 | + }) |
| 92 | + } |
| 93 | +} |
| 94 | + |
| 95 | +func TestEvalSymlinks_ResolvesToRealPath(t *testing.T) { |
| 96 | + printWarningOnWindows(t) |
| 97 | + for _, fsType := range FileSystemTypes { |
| 98 | + t.Run(fmt.Sprintf("%v_for_fs_%v", t.Name(), fsType), func(t *testing.T) { |
| 99 | + fs := NewFs(fsType) |
| 100 | + tmpDir, err := fs.TempDirInTempDir("test-eval-link-") |
| 101 | + require.NoError(t, err) |
| 102 | + defer func() { _ = fs.Rm(tmpDir) }() |
| 103 | + realTmpDir, err := fs.TempDir(tmpDir, "real-dir-") |
| 104 | + require.NoError(t, err) |
| 105 | + symTmpDir, err := fs.TempDir(tmpDir, "sym-dir-") |
| 106 | + require.NoError(t, err) |
| 107 | + // real target: <realTmpDir>/real/nested/file.txt |
| 108 | + realDir := FilePathJoin(fs, realTmpDir, "real", "nested") |
| 109 | + require.NoError(t, fs.MkDir(realDir)) |
| 110 | + realFile := FilePathJoin(fs, realDir, "file.txt") |
| 111 | + expectedContent := fmt.Sprintf("hello world! hello %v! %v", faker.Name(), faker.Sentence()) |
| 112 | + require.NoError(t, fs.WriteFile(realFile, []byte(expectedContent), 0o644)) |
| 113 | + currentDir, err := fs.CurrentDirectory() |
| 114 | + require.NoError(t, err) |
| 115 | + expectedAbs := FilePathAbs(fs, realFile, currentDir) |
| 116 | + |
| 117 | + // First symlink: <symTmpDir>/random -> <realTmpDir>/real/nested |
| 118 | + symDir := FilePathJoin(fs, symTmpDir, faker.Word()) |
| 119 | + err = fs.Symlink(realDir, symDir) |
| 120 | + skipIfLinksNotSupported(t, err) |
| 121 | + |
| 122 | + // symlink to a symlink |
| 123 | + symTmpDir2, err := fs.TempDir(tmpDir, "sym-dir2-") |
| 124 | + require.NoError(t, err) |
| 125 | + symAgain := FilePathJoin(fs, symTmpDir2, fmt.Sprintf("%v-sym2sym", faker.Word())) |
| 126 | + err = fs.Symlink(symDir, symAgain) |
| 127 | + skipIfLinksNotSupported(t, err) |
| 128 | + |
| 129 | + pathThroughSymlinks := FilePathJoin(fs, symAgain, "file.txt") |
| 130 | + symlinkFile := FilePathJoin(fs, symAgain, "symfile.txt") |
| 131 | + err = fs.Symlink(pathThroughSymlinks, symlinkFile) |
| 132 | + skipIfLinksNotSupported(t, err) |
| 133 | + |
| 134 | + resolved, err := EvalSymlinks(fs, pathThroughSymlinks) |
| 135 | + require.NoError(t, err) |
| 136 | + |
| 137 | + resolvedAbs := FilePathAbs(fs, resolved, currentDir) |
| 138 | + resolvedAbs = FilePathClean(fs, resolvedAbs) |
| 139 | + expectedAbs = FilePathClean(fs, expectedAbs) |
| 140 | + |
| 141 | + resolved2, err := EvalSymlinks(fs, symlinkFile) |
| 142 | + require.NoError(t, err) |
| 143 | + resolvedAbs2 := FilePathAbs(fs, resolved2, currentDir) |
| 144 | + resolvedAbs2 = FilePathClean(fs, resolvedAbs2) |
| 145 | + |
| 146 | + if platform.IsWindows() { |
| 147 | + assert.True(t, strings.EqualFold(resolvedAbs, expectedAbs)) |
| 148 | + assert.True(t, strings.EqualFold(resolvedAbs2, expectedAbs)) |
| 149 | + } else { |
| 150 | + assert.Equal(t, expectedAbs, resolvedAbs) |
| 151 | + assert.Equal(t, expectedAbs, resolvedAbs2) |
| 152 | + } |
| 153 | + |
| 154 | + content, err := fs.ReadFile(symlinkFile) |
| 155 | + require.NoError(t, err) |
| 156 | + assert.Equal(t, string(content), expectedContent) |
| 157 | + |
| 158 | + }) |
| 159 | + } |
| 160 | +} |
| 161 | + |
| 162 | +func TestEvalSymlinks_notExist(t *testing.T) { |
| 163 | + printWarningOnWindows(t) |
| 164 | + for _, fsType := range FileSystemTypes { |
| 165 | + t.Run(fmt.Sprintf("%v_for_fs_%v", t.Name(), fsType), func(t *testing.T) { |
| 166 | + fs := NewFs(fsType) |
| 167 | + tmpDir, err := fs.TempDirInTempDir("test-eval-link-not-exist-") |
| 168 | + require.NoError(t, err) |
| 169 | + defer func() { _ = fs.Rm(tmpDir) }() |
| 170 | + _, err = EvalSymlinks(fs, "notexist") |
| 171 | + errortest.AssertError(t, err, commonerrors.ErrNotFound) |
| 172 | + dest := FilePathJoin(fs, tmpDir, "link") |
| 173 | + err = fs.Symlink("notexist", dest) |
| 174 | + skipIfLinksNotSupported(t, err) |
| 175 | + _, err = EvalSymlinks(fs, dest) |
| 176 | + errortest.AssertError(t, err, commonerrors.ErrNotFound) |
| 177 | + }) |
| 178 | + } |
| 179 | +} |
0 commit comments