forked from NativeScript/NativeScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfile-system-tests.ts
More file actions
601 lines (546 loc) · 20.5 KB
/
file-system-tests.ts
File metadata and controls
601 lines (546 loc) · 20.5 KB
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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
/* tslint:disable:no-unused-variable */
// >> file-system-require
import fs = require("file-system");
// << file-system-require
import TKUnit = require("./TKUnit");
import appModule = require("application");
import platform = require("platform");
export var testPathNormalize = function () {
// >> file-system-normalize
var documents = fs.knownFolders.documents();
var testPath = "///test.txt";
// Get a normalized path such as <folder.path>/test.txt from <folder.path>///test.txt
var normalizedPath = fs.path.normalize(documents.path + testPath);
// >> (hide)
var expected = documents.path + "/test.txt";
TKUnit.assert(normalizedPath === expected);
// << (hide)
// << file-system-normalize
};
export var testPathJoin = function () {
// >> file-system-multiple-args
var documents = fs.knownFolders.documents();
// Generate a path like <documents.path>/myFiles/test.txt
var path = fs.path.join(documents.path, "myFiles", "test.txt");
// >> (hide)
var expected = documents.path + "/myFiles/test.txt";
TKUnit.assert(path === expected);
// << (hide)
// << file-system-multiple-args
};
export var testPathSeparator = function () {
// >> file-system-separator
// An OS dependent path separator, "\" or "/".
var separator = fs.path.separator;
// >> (hide)
var expected = "/";
TKUnit.assert(separator === expected);
// << (hide)
// << file-system-separator
};
export var testFileFromPath = function () {
// >> file-system-create
var documents = fs.knownFolders.documents();
var path = fs.path.join(documents.path, "FileFromPath.txt");
var file = fs.File.fromPath(path);
// Writing text to the file.
file.writeText("Something")
.then(function () {
// Succeeded writing to the file.
// >> (hide)
file.readText()
.then(function (content) {
TKUnit.assert(content === "Something", "File read/write not working.");
file.remove();
}, function (error) {
TKUnit.assert(false, "Failed to read/write text");
//console.dump(error);
});
// << (hide)
}, function (error) {
// Failed to write to the file.
// >> (hide)
TKUnit.assert(false, "Failed to read/write text");
//console.dump(error);
// << (hide)
});
// << file-system-create
}
export var testFolderFromPath = function () {
// >> file-system-create-folder
var path = fs.path.join(fs.knownFolders.documents().path, "music");
var folder = fs.Folder.fromPath(path);
// >> (hide)
TKUnit.assert(<any>folder, "Folder.getFolder API not working.");
TKUnit.assert(fs.Folder.exists(folder.path), "Folder.getFolder API not working.");
folder.remove();
// << (hide)
// << file-system-create-folder
}
export var testFileWrite = function () {
// >> file-system-write-string
var documents = fs.knownFolders.documents();
var file = documents.getFile("Test_Write.txt");
// Writing text to the file.
file.writeText("Something")
.then(function () {
// Succeeded writing to the file.
// >> (hide)
file.readText()
.then(function (content) {
TKUnit.assert(content === "Something", "File read/write not working.");
file.remove();
}, function (error) {
TKUnit.assert(false, "Failed to read/write text");
//console.dump(error);
});
// << (hide)
}, function (error) {
// Failed to write to the file.
// >> (hide)
TKUnit.assert(false, "Failed to read/write text");
//console.dump(error);
// << (hide)
});
// << file-system-write-string
};
export var testGetFile = function () {
// >> file-system-create-file
var documents = fs.knownFolders.documents();
var file = documents.getFile("NewFileToCreate.txt");
// >> (hide)
TKUnit.assert(<any>file, "File.getFile API not working.");
TKUnit.assert(fs.File.exists(file.path), "File.getFile API not working.");
file.remove();
// << (hide)
// << file-system-create-file
}
export var testGetFolder = function () {
// >> file-system-get-folder
var documents = fs.knownFolders.documents();
var folder = documents.getFolder("NewFolderToCreate");
// >> (hide)
TKUnit.assert(<any>folder, "Folder.getFolder API not working.");
TKUnit.assert(fs.Folder.exists(folder.path), "Folder.getFolder API not working.");
folder.remove();
// << (hide)
// << file-system-get-folder
};
export var testFileRead = function () {
// >> file-system-example-text
var documents = fs.knownFolders.documents();
var myFile = documents.getFile("Test_Write.txt");
var written: boolean;
// Writing text to the file.
myFile.writeText("Something")
.then(function () {
// Succeeded writing to the file.
// Getting back the contents of the file.
myFile.readText()
.then(function (content) {
// Successfully read the file's content.
// >> (hide)
written = content === "Something";
TKUnit.assert(written, "File read/write not working.");
myFile.remove();
// << (hide)
}, function (error) {
// Failed to read from the file.
// >> (hide)
TKUnit.assert(false, "Failed to read/write text");
//console.dump(error);
// << (hide)
});
}, function (error) {
// Failed to write to the file.
// >> (hide)
TKUnit.assert(false, "Failed to read/write text");
//console.dump(error);
// << (hide)
});
// << file-system-example-text
};
export var testFileReadWriteBinary = function () {
// >> file-system-read-binary
var fileName = "logo.png";
var error;
var sourceFile = fs.File.fromPath(__dirname + "/" + fileName);
var destinationFile = fs.knownFolders.documents().getFile(fileName);
var source = sourceFile.readSync(e=> { error = e; });
destinationFile.writeSync(source, e=> { error = e; });
// >> (hide)
var destination = destinationFile.readSync(e=> { error = e; });
TKUnit.assertNull(error);
if (platform.device.os === platform.platformNames.ios) {
TKUnit.assertTrue(source.isEqualToData(destination));
} else {
TKUnit.assertEqual(new java.io.File(sourceFile.path).length(), new java.io.File(destinationFile.path).length());
}
destinationFile.removeSync();
// << (hide)
// << file-system-read-binary
};
export var testGetKnownFolders = function () {
// >> file-system-known-folders
// Getting the application's 'documents' folder.
var documents = fs.knownFolders.documents();
// >> (hide)
TKUnit.assert(<any>documents, "Could not retrieve the Documents known folder.");
TKUnit.assert(documents.isKnown, "The Documents folder should have its isKnown property set to true.");
// << (hide)
// Getting the application's 'temp' folder.
var temp = fs.knownFolders.temp();
// >> (hide)
TKUnit.assert(<any>temp, "Could not retrieve the Temporary known folder.");
TKUnit.assert(temp.isKnown, "The Temporary folder should have its isKnown property set to true.");
// << (hide)
// << file-system-known-folders
};
function _testIOSSpecificKnownFolder(knownFolderName: string){
let knownFolder: fs.Folder;
let createdFile: fs.File;
let testFunc = function testFunc(){
knownFolder = fs.knownFolders.ios[knownFolderName]();
if (knownFolder) {
createdFile = knownFolder.getFile("createdFile");
createdFile.writeTextSync("some text");
}
};
if (platform.isIOS){
testFunc();
if (knownFolder) {
TKUnit.assertTrue(knownFolder.isKnown, `The ${knownFolderName} folder should have its "isKnown" property set to true.`);
TKUnit.assertNotNull(createdFile, `Could not create a new file in the ${knownFolderName} known folder.`);
TKUnit.assertTrue(fs.File.exists(createdFile.path), `Could not create a new file in the ${knownFolderName} known folder.`);
TKUnit.assertEqual(createdFile.readTextSync(), "some text", `The contents of the new file created in the ${knownFolderName} known folder are not as expected.`);
}
}
else {
TKUnit.assertThrows(testFunc,
`Trying to retrieve the ${knownFolderName} known folder on a platform different from iOS should throw!`,
`The "${knownFolderName}" known folder is available on iOS only!`);
}
}
export var testIOSSpecificKnownFolders = function () {
_testIOSSpecificKnownFolder("library");
_testIOSSpecificKnownFolder("developer");
_testIOSSpecificKnownFolder("desktop");
_testIOSSpecificKnownFolder("downloads");
_testIOSSpecificKnownFolder("movies");
_testIOSSpecificKnownFolder("music");
_testIOSSpecificKnownFolder("pictures");
_testIOSSpecificKnownFolder("sharedPublic");
}
export var testGetEntities = function () {
// >> file-system-folders-content
var documents = fs.knownFolders.documents();
// >> (hide)
var file = documents.getFile("Test.txt");
var file1 = documents.getFile("Test1.txt");
var fileFound,
file1Found;
// IMPORTANT: console.log is mocked to make the snippet pretty.
var globalConsole = console;
var console = {
log: function (file) {
if (file === "Test.txt") {
fileFound = true;
} else if (file === "Test1.txt") {
file1Found = true;
}
}
};
// << (hide)
documents.getEntities()
.then(function (entities) {
// entities is array with the document's files and folders.
entities.forEach(function (entity) {
console.log(entity.name);
});
// >> (hide)
TKUnit.assert(fileFound, "Failed to enumerate Test.txt");
TKUnit.assert(file1Found, "Failed to enumerate Test1.txt");
file.remove();
file1.remove();
// << (hide)
}, function (error) {
// Failed to obtain folder's contents.
// globalConsole.error(error.message);
});
// << file-system-folders-content
};
export var testEnumEntities = function () {
// >> file-system-enum-content
var documents = fs.knownFolders.documents();
// >> (hide)
var file = documents.getFile("Test.txt");
var file1 = documents.getFile("Test1.txt");
var testFolder = documents.getFolder("testFolder");
var fileFound = false;
var file1Found = false;
var testFolderFound = false;
var console = {
log: function (file) {
if (file === "Test.txt") {
fileFound = true;
} else if (file === "Test1.txt") {
file1Found = true;
} else if (file === "testFolder") {
testFolderFound = true;
}
}
}
// << (hide)
documents.eachEntity(function (entity) {
console.log(entity.name);
// Return true to continue, or return false to stop the iteration.
return true;
});
// >> (hide)
TKUnit.assert(fileFound, "Failed to enumerate Test.txt");
TKUnit.assert(file1Found, "Failed to enumerate Test1.txt");
TKUnit.assert(testFolderFound, "Failed to enumerate testFolder");
file.remove();
file1.remove();
testFolder.remove();
// << (hide)
// << file-system-enum-content
};
export var testGetParent = function () {
// >> file-system-parent
var documents = fs.knownFolders.documents();
var file = documents.getFile("Test.txt");
// >> (hide)
TKUnit.assert(<any>file, "Failed to create file in the Documents folder.");
// << (hide)
// The parent folder of the file would be the documents folder.
var parent = file.parent;
// >> (hide)
TKUnit.assert(documents === parent, "The parent folder should be the Documents folder.");
file.remove();
// << (hide)
// << file-system-parent
};
export var testFileNameExtension = function () {
// >> file-system-extension
var documents = fs.knownFolders.documents();
var file = documents.getFile("Test.txt");
// Getting the file name "Test.txt".
var fileName = file.name;
// Getting the file extension ".txt".
var fileExtension = file.extension;
// >> (hide)
TKUnit.assert(fileName === "Test.txt", "Wrong file name.");
TKUnit.assert(fileExtension === ".txt", "Wrong extension.");
file.remove();
// << (hide)
// << file-system-extension
};
export var testFileExists = function () {
// >> file-system-fileexists
var documents = fs.knownFolders.documents();
var filePath = fs.path.join(documents.path, "Test.txt");
var exists = fs.File.exists(filePath);
// >> (hide)
TKUnit.assert(!exists, "File.exists API not working.");
var file = documents.getFile("Test.txt");
exists = fs.File.exists(file.path);
TKUnit.assert(exists, "File.exists API not working.");
file.remove();
// << (hide)
// << file-system-fileexists
};
export var testFolderExists = function () {
// >> file-system-folderexists
var documents = fs.knownFolders.documents();
var exists = fs.Folder.exists(documents.path);
// >> (hide)
TKUnit.assert(exists, "Folder.exists API not working.");
exists = fs.Folder.exists(documents.path + "_");
TKUnit.assert(!exists, "Folder.exists API not working.");
// << (hide)
// << file-system-folderexists
};
export var testContainsFile = function () {
var folder = fs.knownFolders.documents();
var file = folder.getFile("Test.txt");
var contains = folder.contains("Test.txt");
TKUnit.assert(contains, "Folder.contains API not working.");
contains = folder.contains("Test_xxx.txt");
TKUnit.assert(!contains, "Folder.contains API not working.");
file.remove();
};
export var testFileRename = function () {
// >> file-system-renaming
var documents = fs.knownFolders.documents();
var file = documents.getFile("Test.txt");
file.rename("Test_renamed.txt")
.then(function (result) {
// Successfully Renamed.
// >> (hide)
TKUnit.assert(file.name === "Test_renamed.txt", "File.rename API not working.");
file.remove();
documents.getFile("Test.txt").remove();
// << (hide)
}, function (error) {
// Failed to rename the file.
// >> (hide)
TKUnit.assert(false, "Failed to rename file");
// << (hide)
});
// << file-system-renaming
};
export var testFolderRename = function () {
// >> file-system-renaming-folder
var folder = fs.knownFolders.documents();
var myFolder = folder.getFolder("Test__");
myFolder.rename("Something")
.then(function (result) {
// Successfully Renamed.
// >> (hide)
TKUnit.assert(myFolder.name === "Something", "Folder.rename API not working.");
myFolder.remove();
folder.getFolder("Test__").remove();
// << (hide)
}, function (error) {
// Failed to rename the folder.
// >> (hide)
TKUnit.assert(false, "Folder.rename API not working.");
// << (hide)
});
// << file-system-renaming-folder
};
export var testFileRemove = function () {
// >> file-system-remove-file
var documents = fs.knownFolders.documents();
var file = documents.getFile("AFileToRemove.txt");
file.remove()
.then(function (result) {
// Success removing the file.
// >> (hide)
TKUnit.assert(!fs.File.exists(file.path));
// << (hide)
}, function (error) {
// Failed to remove the file.
// >> (hide)
TKUnit.assert(false, "File.remove API not working.");
// << (hide)
});
// << file-system-remove-file
};
export var testFolderRemove = function () {
// >> file-system-remove-folder
var documents = fs.knownFolders.documents();
var file = documents.getFolder("AFolderToRemove");
// Remove a folder and recursively its content.
file.remove()
.then(function (result) {
// Success removing the folder.
// >> (hide)
TKUnit.assert(!fs.File.exists(file.path));
// << (hide)
}, function (error) {
// Failed to remove the folder.
// >> (hide)
TKUnit.assert(false, "File.remove API not working.");
// << (hide)
});
// << file-system-remove-folder
}
export var testFolderClear = function () {
// >> file-system-clear-folder
var documents = fs.knownFolders.documents();
var folder = documents.getFolder("testFolderEmpty");
// >> (hide)
folder.getFile("Test1.txt");
folder.getFile("Test2.txt");
var subfolder = folder.getFolder("subfolder");
var emptied;
// << (hide)
folder.clear()
.then(function () {
// Successfully cleared the folder.
// >> (hide)
emptied = true;
// << (hide)
}, function (error) {
// Failed to clear the folder.
// >> (hide)
TKUnit.assert(false, error.message);
// << (hide)
});
// >> (hide)
folder.getEntities()
.then(function (entities) {
TKUnit.assertEqual(entities.length, 0, `${entities.length} entities left after clearing a folder.`);
folder.remove();
});
// << (hide)
// << file-system-clear-folder
};
// misc
export var testKnownFolderRename = function () {
// You can rename known folders in android - so skip this test.
if (!appModule.android) {
var folder = fs.knownFolders.documents();
folder.rename("Something")
.then(function (result) {
TKUnit.assert(false, "Known folders should not be renamed.");
}, function (error) {
TKUnit.assert(true);
});
}
};
export function testKnownFolderRemove(done) {
var result;
var knownFolder = fs.knownFolders.temp();
knownFolder.remove().then(
function () {
done(new Error("Remove known folder should resolve as error."));
},
function (error) {
done(null);
});
};
export function test_FSEntity_Properties() {
var documents = fs.knownFolders.documents();
var file = documents.getFile("Test_File.txt");
TKUnit.assert(file.extension === ".txt", "FileEntity.extension not working.");
TKUnit.assert(file.isLocked === false, "FileEntity.isLocked not working.");
TKUnit.assert(file.lastModified instanceof Date, "FileEntity.lastModified not working.");
TKUnit.assert(file.name === "Test_File.txt", "FileEntity.name not working.");
TKUnit.assert(file.parent === documents, "FileEntity.parent not working.");
file.remove();
}
export function test_UnlockAfterWrite(done) {
var file = fs.knownFolders.documents().getFile("Test_File_Lock.txt");
file.writeText("Hello World!").then(() => {
return file.readText();
}).then(value => {
TKUnit.assert(value === "Hello World!");
return file.remove();
}).then(() => done())
.catch(done);
}
export function test_CreateParentOnNewFile(done) {
var documentsFolderName = fs.knownFolders.documents().path;
var tempFileName = fs.path.join(documentsFolderName, "folder1", "folder2", "Test_File_Create_Parent.txt");
var file = fs.File.fromPath(tempFileName);
file.writeText("Hello World!").then(() => {
return fs.knownFolders.documents().getFolder("folder1").remove();
}).then(() => done())
.catch(done);
}
export function test_FolderClear_RemovesEmptySubfolders(done) {
let documents = fs.knownFolders.documents();
let rootFolder = documents.getFolder("rootFolder");
let emptySubfolder = rootFolder.getFolder("emptySubfolder");
TKUnit.assertTrue(fs.Folder.exists(emptySubfolder.path), "emptySubfolder should exist before parent folder is cleared.");
rootFolder.clear().then(
() => {
TKUnit.assertFalse(fs.File.exists(emptySubfolder.path), "emptySubfolder should not exist after parent folder was cleared.");
rootFolder.remove();
done();
})
.catch(done);
}