2023-01-13 02:51:32 -05:00
|
|
|
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
|
|
|
|
|
2021-11-23 11:45:18 -05:00
|
|
|
import { assert, assertEquals, assertThrows, delay } from "./test_util.ts";
|
2020-02-21 13:21:51 -05:00
|
|
|
|
|
|
|
// TODO(ry) Add more tests to specify format.
|
|
|
|
|
2021-11-23 11:45:18 -05:00
|
|
|
Deno.test({ permissions: { read: false } }, function watchFsPermissions() {
|
2020-06-24 18:57:08 -04:00
|
|
|
assertThrows(() => {
|
2020-04-24 17:40:29 -04:00
|
|
|
Deno.watchFs(".");
|
2020-06-24 18:57:08 -04:00
|
|
|
}, Deno.errors.PermissionDenied);
|
2020-02-21 13:21:51 -05:00
|
|
|
});
|
|
|
|
|
2021-11-23 11:45:18 -05:00
|
|
|
Deno.test({ permissions: { read: true } }, function watchFsInvalidPath() {
|
2020-06-24 18:57:08 -04:00
|
|
|
if (Deno.build.os === "windows") {
|
|
|
|
assertThrows(
|
|
|
|
() => {
|
|
|
|
Deno.watchFs("non-existant.file");
|
|
|
|
},
|
|
|
|
Error,
|
2020-07-14 15:24:17 -04:00
|
|
|
"Input watch path is neither a file nor a directory",
|
2020-06-24 18:57:08 -04:00
|
|
|
);
|
|
|
|
} else {
|
|
|
|
assertThrows(() => {
|
|
|
|
Deno.watchFs("non-existant.file");
|
|
|
|
}, Deno.errors.NotFound);
|
2020-03-24 23:50:51 -04:00
|
|
|
}
|
|
|
|
});
|
|
|
|
|
2020-02-21 13:21:51 -05:00
|
|
|
async function getTwoEvents(
|
2021-06-01 02:35:06 -04:00
|
|
|
iter: Deno.FsWatcher,
|
2020-02-21 13:21:51 -05:00
|
|
|
): Promise<Deno.FsEvent[]> {
|
|
|
|
const events = [];
|
|
|
|
for await (const event of iter) {
|
|
|
|
events.push(event);
|
|
|
|
if (events.length > 2) break;
|
|
|
|
}
|
|
|
|
return events;
|
|
|
|
}
|
|
|
|
|
2021-10-19 07:50:13 -04:00
|
|
|
async function makeTempDir(): Promise<string> {
|
|
|
|
const testDir = await Deno.makeTempDir();
|
|
|
|
// The watcher sometimes witnesses the creation of it's own root
|
|
|
|
// directory. Delay a bit.
|
|
|
|
await delay(100);
|
|
|
|
return testDir;
|
|
|
|
}
|
|
|
|
|
2021-11-23 11:45:18 -05:00
|
|
|
Deno.test(
|
2021-09-22 19:50:50 -04:00
|
|
|
{ permissions: { read: true, write: true } },
|
2021-08-05 07:08:58 -04:00
|
|
|
async function watchFsBasic() {
|
2021-10-19 07:50:13 -04:00
|
|
|
const testDir = await makeTempDir();
|
2020-04-24 17:40:29 -04:00
|
|
|
const iter = Deno.watchFs(testDir);
|
2020-02-21 13:21:51 -05:00
|
|
|
|
2020-03-04 11:31:14 -05:00
|
|
|
// Asynchornously capture two fs events.
|
|
|
|
const eventsPromise = getTwoEvents(iter);
|
2020-02-21 13:21:51 -05:00
|
|
|
|
2020-03-04 11:31:14 -05:00
|
|
|
// Make some random file system activity.
|
|
|
|
const file1 = testDir + "/file1.txt";
|
|
|
|
const file2 = testDir + "/file2.txt";
|
|
|
|
Deno.writeFileSync(file1, new Uint8Array([0, 1, 2]));
|
|
|
|
Deno.writeFileSync(file2, new Uint8Array([0, 1, 2]));
|
2020-02-21 13:21:51 -05:00
|
|
|
|
2020-03-04 11:31:14 -05:00
|
|
|
// We should have gotten two fs events.
|
|
|
|
const events = await eventsPromise;
|
|
|
|
assert(events.length >= 2);
|
|
|
|
assert(events[0].kind == "create");
|
|
|
|
assert(events[0].paths[0].includes(testDir));
|
|
|
|
assert(events[1].kind == "create" || events[1].kind == "modify");
|
|
|
|
assert(events[1].paths[0].includes(testDir));
|
2020-07-14 15:24:17 -04:00
|
|
|
},
|
2020-03-04 11:31:14 -05:00
|
|
|
);
|
2020-07-23 21:33:52 -04:00
|
|
|
|
2021-06-01 02:35:06 -04:00
|
|
|
// TODO(kt3k): This test is for the backward compatibility of `.return` method.
|
|
|
|
// This should be removed at 2.0
|
2021-11-23 11:45:18 -05:00
|
|
|
Deno.test(
|
2021-09-22 19:50:50 -04:00
|
|
|
{ permissions: { read: true, write: true } },
|
2021-08-05 07:08:58 -04:00
|
|
|
async function watchFsReturn() {
|
2021-10-19 07:50:13 -04:00
|
|
|
const testDir = await makeTempDir();
|
2020-07-23 21:33:52 -04:00
|
|
|
const iter = Deno.watchFs(testDir);
|
|
|
|
|
|
|
|
// Asynchronously loop events.
|
|
|
|
const eventsPromise = getTwoEvents(iter);
|
|
|
|
|
|
|
|
// Close the watcher.
|
|
|
|
await iter.return!();
|
|
|
|
|
|
|
|
// Expect zero events.
|
|
|
|
const events = await eventsPromise;
|
|
|
|
assertEquals(events, []);
|
|
|
|
},
|
|
|
|
);
|
2021-06-01 02:35:06 -04:00
|
|
|
|
2021-11-23 11:45:18 -05:00
|
|
|
Deno.test(
|
2021-09-22 19:50:50 -04:00
|
|
|
{ permissions: { read: true, write: true } },
|
2021-08-05 07:08:58 -04:00
|
|
|
async function watchFsClose() {
|
2021-10-19 07:50:13 -04:00
|
|
|
const testDir = await makeTempDir();
|
2021-06-01 02:35:06 -04:00
|
|
|
const iter = Deno.watchFs(testDir);
|
|
|
|
|
|
|
|
// Asynchronously loop events.
|
|
|
|
const eventsPromise = getTwoEvents(iter);
|
|
|
|
|
|
|
|
// Close the watcher.
|
2021-10-19 07:50:13 -04:00
|
|
|
iter.close();
|
2021-06-01 02:35:06 -04:00
|
|
|
|
|
|
|
// Expect zero events.
|
|
|
|
const events = await eventsPromise;
|
|
|
|
assertEquals(events, []);
|
|
|
|
},
|
|
|
|
);
|