1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
|
package datafs
import (
"fmt"
"io"
"io/fs"
"os"
"path/filepath"
"runtime"
"testing"
"github.com/hack-pad/hackpadfs"
"github.com/hack-pad/hackpadfs/mem"
osfs "github.com/hack-pad/hackpadfs/os"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
tfs "gotest.tools/v3/fs"
)
func TestWDFS_ReadOps(t *testing.T) {
wd, _ := os.Getwd()
t.Cleanup(func() {
_ = os.Chdir(wd)
})
_ = os.Chdir("/")
memfs, _ := mem.NewFS()
_ = memfs.Mkdir("tmp", 0o777)
_ = hackpadfs.WriteFullFile(memfs, "tmp/foo", []byte("hello world"), 0o777)
_ = hackpadfs.WriteFullFile(memfs, "tmp/one.txt", []byte("one"), 0o644)
_ = hackpadfs.WriteFullFile(memfs, "tmp/two.txt", []byte("two"), 0o644)
_ = hackpadfs.WriteFullFile(memfs, "tmp/three.txt", []byte("three"), 0o644)
_ = memfs.Mkdir("tmp/sub", 0o777)
_ = hackpadfs.WriteFullFile(memfs, "tmp/sub/bar", []byte("goodnight moon"), 0o777)
fsys := WrapWdFS(memfs).(*wdFS)
f, err := fsys.Open("/tmp/foo")
require.NoError(t, err)
b, err := io.ReadAll(f)
require.NoError(t, err)
assert.Equal(t, "hello world", string(b))
fi, err := fs.Stat(fsys, "/tmp/sub/bar")
require.NoError(t, err)
assert.True(t, fi.Mode().IsRegular())
b, err = fs.ReadFile(fsys, "/tmp/sub/bar")
require.NoError(t, err)
assert.Equal(t, "goodnight moon", string(b))
des, err := fs.ReadDir(fsys, "/tmp")
require.NoError(t, err)
assert.Len(t, des, 5)
// note the relative path here, a requirement of fsys.Sub
subfs, err := fs.Sub(fsys, "tmp/sub")
require.NoError(t, err)
b, err = fs.ReadFile(subfs, "bar")
require.NoError(t, err)
assert.Equal(t, "goodnight moon", string(b))
}
func TestWDFS_WriteOps(t *testing.T) {
// this test is backed by the real filesystem so we can test permissions
// and have some confidence it'll run on Windows
tmpDir := tfs.NewDir(t, "gomplate-wdfs-test")
tmpPath := tmpDir.Path()
vol := filepath.VolumeName(tmpPath)
if vol != "" {
tmpPath = tmpPath[len(vol):]
} else if tmpPath[0] == '/' {
vol = "/"
tmpPath = tmpPath[1:]
}
var osfsys fs.FS
var err error
if vol != "/" {
osfsys, err = osfs.NewFS().SubVolume(vol)
require.NoError(t, err)
} else {
osfsys = osfs.NewFS()
}
osfsys, err = hackpadfs.Sub(osfsys, tmpPath)
require.NoError(t, err)
fsys := &wdFS{
vol: vol,
fsys: osfsys,
}
err = fsys.Mkdir("/tmp", 0o700)
require.NoError(t, err, "failed to create /tmp: %q", tmpDir.Path())
// use os.Stat to make sure the directory was created in the right place
fi, err := os.Stat(filepath.Join(vol, tmpPath, "tmp"))
require.NoError(t, err)
assert.True(t, fi.Mode().IsDir())
err = hackpadfs.WriteFullFile(fsys, "/tmp/foo", []byte("hello world"), 0o600)
require.NoError(t, err)
err = hackpadfs.WriteFullFile(fsys, "/tmp/one.txt", []byte("one"), 0o644)
require.NoError(t, err)
err = hackpadfs.WriteFullFile(fsys, "/tmp/two.txt", []byte("two"), 0o644)
require.NoError(t, err)
err = hackpadfs.WriteFullFile(fsys, "/tmp/three.txt", []byte("three"), 0o644)
require.NoError(t, err)
err = fsys.MkdirAll("/tmp/sub", 0o777)
require.NoError(t, err)
err = hackpadfs.WriteFullFile(fsys, "/tmp/sub/bar", []byte("goodnight moon"), 0o777)
require.NoError(t, err)
b, err := fs.ReadFile(fsys, "/tmp/foo")
require.NoError(t, err)
assert.Equal(t, "hello world", string(b))
b, err = fs.ReadFile(fsys, "/tmp/sub/bar")
require.NoError(t, err)
assert.Equal(t, "goodnight moon", string(b))
err = fsys.Chmod("/tmp/foo", 0o444)
require.NoError(t, err)
// check permissions
fi, err = fsys.Stat("/tmp/foo")
require.NoError(t, err)
assert.True(t, fi.Mode().IsRegular())
assert.Equal(t, "0444", fmt.Sprintf("%#o", fi.Mode().Perm()))
// now delete it
err = fsys.Remove("/tmp/foo")
require.NoError(t, err)
// and check that it's gone
_, err = fsys.Stat("/tmp/foo")
require.ErrorIs(t, err, fs.ErrNotExist)
// make sure we can write to a subfs
subfs, err := fs.Sub(fsys, "tmp")
require.NoError(t, err)
require.NotNil(t, subfs)
// this is no longer a wdFS so we need to make sure not to use absolute
// paths - the path is relative to the root of the subfs
err = hackpadfs.WriteFullFile(subfs, "foo", []byte("hello world"), 0o600)
require.NoError(t, err)
b, err = fs.ReadFile(subfs, "foo")
require.NoError(t, err)
assert.Equal(t, "hello world", string(b))
}
func skipWindows(t *testing.T) {
t.Helper()
if runtime.GOOS == osWindows {
t.Skip("skipping non-Windows test")
}
}
func skipNonWindows(t *testing.T) {
t.Helper()
if runtime.GOOS != osWindows {
t.Skip("skipping Windows test")
}
}
func TestResolveLocalPath_NonWindows(t *testing.T) {
skipWindows(t)
wd, _ := os.Getwd()
fsys := &wdFS{vol: "/", fsys: osfs.NewFS()}
wd = wd[1:]
testdata := []struct {
path string
expected string
}{
{"/tmp/foo", "tmp/foo"},
{"tmp/foo", wd + "/tmp/foo"},
{"./tmp/foo", wd + "/tmp/foo"},
{"tmp/../foo", wd + "/foo"},
{"/", "."},
}
for _, td := range testdata {
t.Run(td.path, func(t *testing.T) {
root, path, err := ResolveLocalPath(fsys, td.path)
require.NoError(t, err)
assert.Equal(t, "/", root)
assert.Equal(t, td.expected, path)
})
}
}
func TestResolveLocalPath_Windows(t *testing.T) {
skipNonWindows(t)
wd, _ := os.Getwd()
volname := filepath.VolumeName(wd)
wd = filepath.ToSlash(wd)
fsys := &wdFS{vol: volname, fsys: osfs.NewFS()}
wd = wd[len(volname)+1:]
testdata := []struct {
path string
expRoot string
expected string
}{
{"C:/tmp/foo", "C:", "tmp/foo"},
{"D:\\tmp\\foo", "D:", "tmp/foo"},
{"/tmp/foo", volname, "tmp/foo"},
{"tmp/foo", volname, wd + "/tmp/foo"},
{"./tmp/foo", volname, wd + "/tmp/foo"},
{"tmp/../foo", volname, wd + "/foo"},
}
for _, td := range testdata {
t.Run(td.path, func(t *testing.T) {
root, path, err := ResolveLocalPath(fsys, td.path)
require.NoError(t, err)
assert.Equal(t, td.expRoot, root)
assert.Equal(t, td.expected, path)
})
}
}
func TestWdFS_ResolveLocalPath_NonWindows(t *testing.T) {
skipWindows(t)
wd, _ := os.Getwd()
wd = wd[1:]
testdata := []struct {
path string
expected string
}{
{"/tmp/foo", "tmp/foo"},
{"tmp/foo", wd + "/tmp/foo"},
{"./tmp/foo", wd + "/tmp/foo"},
{"tmp/../foo", wd + "/foo"},
{"/", "."},
}
for _, td := range testdata {
root, path, err := resolveLocalPath("/", td.path)
require.NoError(t, err)
assert.Equal(t, "/", root)
assert.Equal(t, td.expected, path)
}
}
func TestWdFS_ResolveLocalPath_Windows(t *testing.T) {
skipNonWindows(t)
wd, _ := os.Getwd()
volname := filepath.VolumeName(wd)
wd = filepath.ToSlash(wd)
wd = wd[len(volname)+1:]
testdata := []struct {
path string
expRoot string
expected string
}{
{"C:/tmp/foo", "C:", "tmp/foo"},
{`D:\tmp\foo`, "D:", "tmp/foo"},
{"/tmp/foo", volname, "tmp/foo"},
{"tmp/foo", volname, wd + "/tmp/foo"},
{"./tmp/foo", volname, wd + "/tmp/foo"},
{"tmp/../foo", volname, wd + "/foo"},
{`\\?\C:\tmp\foo`, "C:", "tmp/foo"},
{`\\somehost\share\foo\bar`, "//somehost/share", "foo/bar"},
{`//?/C:/tmp/foo`, "C:", "tmp/foo"},
{`//somehost/share/foo/bar`, "//somehost/share", "foo/bar"},
}
for _, td := range testdata {
t.Run(td.path, func(t *testing.T) {
root, path, err := resolveLocalPath(volname, td.path)
require.NoError(t, err)
assert.Equal(t, td.expRoot, root)
assert.Equal(t, td.expected, path)
})
}
}
func TestWin32PathType(t *testing.T) {
testdata := []struct {
path string
expected winPathtype
}{
{"", winPathUnknown},
{`\`, winPathRooted},
{`\\`, winPathUncAbsolute},
{`x`, winPathRelative},
{`x:`, winPathDriveRelative},
{"C:/tmp/foo", winPathDriveAbsolute},
{`D:\tmp\foo`, winPathDriveAbsolute},
{"/tmp/foo", winPathRooted},
{"tmp/foo", winPathRelative},
{"./tmp/foo", winPathRelative},
{"tmp/../foo", winPathRelative},
{`\\?\C:\tmp\foo`, winPathLocalDevice},
{`\\somehost\share\foo\bar`, winPathUncAbsolute},
{`//./C:/tmp/foo`, winPathLocalDevice},
{`//./pipe/foo`, winPathLocalDevice},
{`//./COM2`, winPathLocalDevice},
{`\\.`, winPathRootLocalDevice},
{`//?`, winPathRootLocalDevice},
{`/??/C:/`, winPathNT},
{`/??/UNC/server/foo`, winPathNT},
}
for _, td := range testdata {
t.Run(td.path, func(t *testing.T) {
assert.Equal(t, td.expected, win32PathType(td.path))
})
}
}
|