/
copy-sync-prevent-copying-into-itself.test.js
423 lines (343 loc) · 14.9 KB
/
copy-sync-prevent-copying-into-itself.test.js
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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
'use strict'
const assert = require('assert')
const os = require('os')
const path = require('path')
const fs = require('../../')
const klawSync = require('klaw-sync')
/* global beforeEach, afterEach, describe, it */
// these files are used for all tests
const FILES = [
'file0.txt',
path.join('dir1', 'file1.txt'),
path.join('dir1', 'dir2', 'file2.txt'),
path.join('dir1', 'dir2', 'dir3', 'file3.txt')
]
const dat0 = 'file0'
const dat1 = 'file1'
const dat2 = 'file2'
const dat3 = 'file3'
describe('+ copySync() - prevent copying into itself', () => {
let TEST_DIR, src
beforeEach(done => {
TEST_DIR = path.join(os.tmpdir(), 'fs-extra', 'copy-sync-prevent-copying-into-itself')
src = path.join(TEST_DIR, 'src')
fs.mkdirpSync(src)
fs.outputFileSync(path.join(src, FILES[0]), dat0)
fs.outputFileSync(path.join(src, FILES[1]), dat1)
fs.outputFileSync(path.join(src, FILES[2]), dat2)
fs.outputFileSync(path.join(src, FILES[3]), dat3)
done()
})
afterEach(done => fs.remove(TEST_DIR, done))
describe('> when source is a file', () => {
it('should copy the file successfully even if dest parent is a subdir of src', () => {
const srcFile = path.join(TEST_DIR, 'src', 'srcfile.txt')
const destFile = path.join(TEST_DIR, 'src', 'dest', 'destfile.txt')
fs.writeFileSync(srcFile, dat0)
fs.copySync(srcFile, destFile)
assert(fs.existsSync(destFile, 'file copied'))
const out = fs.readFileSync(destFile, 'utf8')
assert.strictEqual(out, dat0, 'file contents matched')
})
})
// test for these cases:
// - src is directory, dest is directory
// - src is directory, dest is symlink
// - src is symlink, dest is directory
// - src is symlink, dest is symlink
describe('> when source is a directory', () => {
describe('>> when dest is a directory', () => {
it(`of not itself`, () => {
const dest = path.join(TEST_DIR, src.replace(/^\w:/, ''))
return testSuccess(src, dest)
})
it(`of itself`, () => {
const dest = path.join(src, 'dest')
return testError(src, dest)
})
it(`should copy the directory successfully when dest is 'src_dest'`, () => {
const dest = path.join(TEST_DIR, 'src_dest')
return testSuccess(src, dest)
})
it(`should copy the directory successfully when dest is 'src-dest'`, () => {
const dest = path.join(TEST_DIR, 'src-dest')
return testSuccess(src, dest)
})
it(`should copy the directory successfully when dest is 'dest_src'`, () => {
const dest = path.join(TEST_DIR, 'dest_src')
return testSuccess(src, dest)
})
it(`should copy the directory successfully when dest is 'src_dest/src'`, () => {
const dest = path.join(TEST_DIR, 'src_dest', 'src')
return testSuccess(src, dest)
})
it(`should copy the directory successfully when dest is 'src-dest/src'`, () => {
const dest = path.join(TEST_DIR, 'src-dest', 'src')
return testSuccess(src, dest)
})
it(`should copy the directory successfully when dest is 'dest_src/src'`, () => {
const dest = path.join(TEST_DIR, 'dest_src', 'src')
return testSuccess(src, dest)
})
it(`should copy the directory successfully when dest is 'src_src/dest'`, () => {
const dest = path.join(TEST_DIR, 'src_src', 'dest')
return testSuccess(src, dest)
})
it(`should copy the directory successfully when dest is 'src-src/dest'`, () => {
const dest = path.join(TEST_DIR, 'src-src', 'dest')
return testSuccess(src, dest)
})
it(`should copy the directory successfully when dest is 'srcsrc/dest'`, () => {
const dest = path.join(TEST_DIR, 'srcsrc', 'dest')
return testSuccess(src, dest)
})
it(`should copy the directory successfully when dest is 'dest/src'`, () => {
const dest = path.join(TEST_DIR, 'dest', 'src')
return testSuccess(src, dest)
})
it('should copy the directory successfully when dest is very nested that all its parents need to be created', () => {
const dest = path.join(TEST_DIR, 'dest', 'src', 'foo', 'bar', 'baz', 'qux', 'quux', 'waldo',
'grault', 'garply', 'fred', 'plugh', 'thud', 'some', 'highly', 'deeply',
'badly', 'nasty', 'crazy', 'mad', 'nested', 'dest')
return testSuccess(src, dest)
})
it(`should error when dest is 'src/dest'`, () => {
const dest = path.join(TEST_DIR, 'src', 'dest')
return testError(src, dest)
})
it(`should error when dest is 'src/src_dest'`, () => {
const dest = path.join(TEST_DIR, 'src', 'src_dest')
return testError(src, dest)
})
it(`should error when dest is 'src/dest_src'`, () => {
const dest = path.join(TEST_DIR, 'src', 'dest_src')
return testError(src, dest)
})
it(`should error when dest is 'src/dest/src'`, () => {
const dest = path.join(TEST_DIR, 'src', 'dest', 'src')
return testError(src, dest)
})
})
describe('>> when dest is a symlink', () => {
it('should error when dest points exactly to src', () => {
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.symlinkSync(src, destLink, 'dir')
const srclenBefore = klawSync(src).length
assert(srclenBefore > 2)
try {
fs.copySync(src, destLink)
} catch (err) {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
}
const srclenAfter = klawSync(src).length
assert.strictEqual(srclenAfter, srclenBefore, 'src length should not change')
const link = fs.readlinkSync(destLink)
assert.strictEqual(link, src)
})
it('should error when dest is a subdirectory of src (bind-mounted directory with subdirectory)', () => {
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.symlinkSync(src, destLink, 'dir')
const srclenBefore = klawSync(src).length
assert(srclenBefore > 2)
const dest = path.join(destLink, 'dir1')
assert(fs.existsSync(dest))
let errThrown = false
try {
fs.copySync(src, dest)
} catch (err) {
assert.strictEqual(err.message, `Cannot copy '${src}' to a subdirectory of itself, '${dest}'.`)
errThrown = true
} finally {
assert(errThrown)
const srclenAfter = klawSync(src).length
assert.strictEqual(srclenAfter, srclenBefore, 'src length should not change')
const link = fs.readlinkSync(destLink)
assert.strictEqual(link, src)
}
})
it('should error when dest is a subdirectory of src (more than one level depth)', () => {
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.symlinkSync(src, destLink, 'dir')
const srclenBefore = klawSync(src).length
assert(srclenBefore > 2)
const dest = path.join(destLink, 'dir1', 'dir2')
assert(fs.existsSync(dest))
let errThrown = false
try {
fs.copySync(src, dest)
} catch (err) {
assert.strictEqual(err.message, `Cannot copy '${src}' to a subdirectory of itself, '${path.join(destLink, 'dir1')}'.`)
errThrown = true
} finally {
assert(errThrown)
const srclenAfter = klawSync(src).length
assert.strictEqual(srclenAfter, srclenBefore, 'src length should not change')
const link = fs.readlinkSync(destLink)
assert.strictEqual(link, src)
}
})
it('should copy the directory successfully when src is a subdir of resolved dest path', () => {
const srcInDest = path.join(TEST_DIR, 'dest', 'some', 'nested', 'src')
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.copySync(src, srcInDest) // put some stuff in srcInDest
const dest = path.join(TEST_DIR, 'dest')
fs.symlinkSync(dest, destLink, 'dir')
const srclen = klawSync(srcInDest).length
const destlenBefore = klawSync(dest).length
assert(srclen > 2)
fs.copySync(srcInDest, destLink)
const destlenAfter = klawSync(dest).length
// assert dest length is oldlen + length of stuff copied from src
assert.strictEqual(destlenAfter, destlenBefore + srclen, 'dest length should be equal to old length + copied legnth')
FILES.forEach(f => assert(fs.existsSync(path.join(dest, f)), 'file copied'))
const o0 = fs.readFileSync(path.join(dest, FILES[0]), 'utf8')
const o1 = fs.readFileSync(path.join(dest, FILES[1]), 'utf8')
const o2 = fs.readFileSync(path.join(dest, FILES[2]), 'utf8')
const o3 = fs.readFileSync(path.join(dest, FILES[3]), 'utf8')
assert.strictEqual(o0, dat0, 'files contents matched')
assert.strictEqual(o1, dat1, 'files contents matched')
assert.strictEqual(o2, dat2, 'files contents matched')
assert.strictEqual(o3, dat3, 'files contents matched')
})
})
})
describe('> when source is a symlink', () => {
describe('>> when dest is a directory', () => {
it('should error when resolved src path points to dest', () => {
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
const dest = path.join(TEST_DIR, 'src')
try {
fs.copySync(srcLink, dest)
} catch (err) {
assert(err)
}
// assert source not affected
const link = fs.readlinkSync(srcLink)
assert.strictEqual(link, src)
})
it('should error when dest is a subdir of resolved src path', () => {
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
const dest = path.join(TEST_DIR, 'src', 'some', 'nested', 'dest')
fs.mkdirsSync(dest)
try {
fs.copySync(srcLink, dest)
} catch (err) {
assert(err)
}
const link = fs.readlinkSync(srcLink)
assert.strictEqual(link, src)
})
it('should error when resolved src path is a subdir of dest', () => {
const dest = path.join(TEST_DIR, 'dest')
const resolvedSrcPath = path.join(dest, 'contains', 'src')
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.copySync(src, resolvedSrcPath)
// make symlink that points to a subdir in dest
fs.symlinkSync(resolvedSrcPath, srcLink, 'dir')
try {
fs.copySync(srcLink, dest)
} catch (err) {
assert(err)
}
})
it(`should copy the directory successfully when dest is 'src_src/dest'`, () => {
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
const dest = path.join(TEST_DIR, 'src_src', 'dest')
testSuccess(srcLink, dest)
const link = fs.readlinkSync(dest)
assert.strictEqual(link, src)
})
it(`should copy the directory successfully when dest is 'srcsrc/dest'`, () => {
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
const dest = path.join(TEST_DIR, 'srcsrc', 'dest')
testSuccess(srcLink, dest)
const link = fs.readlinkSync(dest)
assert.strictEqual(link, src)
})
})
describe('>> when dest is a symlink', () => {
it('should error when resolved dest path is exactly the same as resolved src path', () => {
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
const destLink = path.join(TEST_DIR, 'dest-symlink')
fs.symlinkSync(src, destLink, 'dir')
const srclenBefore = klawSync(srcLink).length
const destlenBefore = klawSync(destLink).length
assert(srclenBefore > 2)
assert(destlenBefore > 2)
try {
fs.copySync(srcLink, destLink)
} catch (err) {
assert.strictEqual(err.message, 'Source and destination must not be the same.')
} finally {
const srclenAfter = klawSync(srcLink).length
assert.strictEqual(srclenAfter, srclenBefore, 'src length should not change')
const destlenAfter = klawSync(destLink).length
assert.strictEqual(destlenAfter, destlenBefore, 'dest length should not change')
const srcln = fs.readlinkSync(srcLink)
assert.strictEqual(srcln, src)
const destln = fs.readlinkSync(destLink)
assert.strictEqual(destln, src)
}
})
it('should error when resolved dest path is a subdir of resolved src path', () => {
const srcLink = path.join(TEST_DIR, 'src-symlink')
fs.symlinkSync(src, srcLink, 'dir')
const destLink = path.join(TEST_DIR, 'dest-symlink')
const resolvedDestPath = path.join(TEST_DIR, 'src', 'some', 'nested', 'dest')
fs.ensureFileSync(path.join(resolvedDestPath, 'subdir', 'somefile.txt'))
fs.symlinkSync(resolvedDestPath, destLink, 'dir')
try {
fs.copySync(srcLink, destLink)
} catch (err) {
assert.strictEqual(err.message, `Cannot copy '${src}' to a subdirectory of itself, '${resolvedDestPath}'.`)
} finally {
const destln = fs.readlinkSync(destLink)
assert.strictEqual(destln, resolvedDestPath)
}
})
it('should error when resolved src path is a subdir of resolved dest path', () => {
const srcInDest = path.join(TEST_DIR, 'dest', 'some', 'nested', 'src')
const srcLink = path.join(TEST_DIR, 'src-symlink')
const destLink = path.join(TEST_DIR, 'dest-symlink')
const dest = path.join(TEST_DIR, 'dest')
fs.ensureDirSync(srcInDest)
fs.ensureSymlinkSync(srcInDest, srcLink, 'dir')
fs.ensureSymlinkSync(dest, destLink, 'dir')
try {
fs.copySync(srcLink, destLink)
} catch (err) {
assert.strictEqual(err.message, `Cannot overwrite '${dest}' with '${srcInDest}'.`)
} finally {
const destln = fs.readlinkSync(destLink)
assert.strictEqual(destln, dest)
}
})
})
})
})
function testSuccess (src, dest) {
const srclen = klawSync(src).length
assert(srclen > 2)
fs.copySync(src, dest)
FILES.forEach(f => assert(fs.existsSync(path.join(dest, f)), 'file copied'))
const o0 = fs.readFileSync(path.join(dest, FILES[0]), 'utf8')
const o1 = fs.readFileSync(path.join(dest, FILES[1]), 'utf8')
const o2 = fs.readFileSync(path.join(dest, FILES[2]), 'utf8')
const o3 = fs.readFileSync(path.join(dest, FILES[3]), 'utf8')
assert.strictEqual(o0, dat0, 'file contents matched')
assert.strictEqual(o1, dat1, 'file contents matched')
assert.strictEqual(o2, dat2, 'file contents matched')
assert.strictEqual(o3, dat3, 'file contents matched')
}
function testError (src, dest) {
try {
fs.copySync(src, dest)
} catch (err) {
assert.strictEqual(err.message, `Cannot copy '${src}' to a subdirectory of itself, '${dest}'.`)
}
}