1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-11 10:07:54 -05:00
denoland-deno/cli/tests/unit/fs_events_test.ts
2024-01-01 19:58:21 +00:00

139 lines
3.6 KiB
TypeScript

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
import { assert, assertEquals, assertThrows, delay } from "./test_util.ts";
// TODO(ry) Add more tests to specify format.
Deno.test({ permissions: { read: false } }, function watchFsPermissions() {
assertThrows(() => {
Deno.watchFs(".");
}, Deno.errors.PermissionDenied);
});
Deno.test({ permissions: { read: true } }, function watchFsInvalidPath() {
if (Deno.build.os === "windows") {
assertThrows(
() => {
Deno.watchFs("non-existent.file");
},
Error,
"Input watch path is neither a file nor a directory",
);
} else {
assertThrows(() => {
Deno.watchFs("non-existent.file");
}, Deno.errors.NotFound);
}
});
async function getTwoEvents(
iter: Deno.FsWatcher,
): Promise<Deno.FsEvent[]> {
const events = [];
for await (const event of iter) {
events.push(event);
if (events.length > 2) break;
}
return events;
}
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;
}
Deno.test(
{ permissions: { read: true, write: true } },
async function watchFsBasic() {
const testDir = await makeTempDir();
const iter = Deno.watchFs(testDir);
// Asynchronously capture two fs events.
const eventsPromise = getTwoEvents(iter);
// 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]));
// 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));
},
);
// TODO(kt3k): This test is for the backward compatibility of `.return` method.
// This should be removed at 2.0
Deno.test(
{ permissions: { read: true, write: true } },
async function watchFsReturn() {
const testDir = await makeTempDir();
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, []);
},
);
Deno.test(
{ permissions: { read: true, write: true } },
async function watchFsClose() {
const testDir = await makeTempDir();
const iter = Deno.watchFs(testDir);
// Asynchronously loop events.
const eventsPromise = getTwoEvents(iter);
// Close the watcher.
iter.close();
// Expect zero events.
const events = await eventsPromise;
assertEquals(events, []);
},
);
Deno.test(
{ permissions: { read: true, write: true } },
async function watchFsExplicitResourceManagement() {
let res;
{
const testDir = await makeTempDir();
using iter = Deno.watchFs(testDir);
res = iter[Symbol.asyncIterator]().next();
}
const { done } = await res;
assert(done);
},
);
Deno.test(
{ permissions: { read: true, write: true } },
async function watchFsExplicitResourceManagementManualClose() {
const testDir = await makeTempDir();
using iter = Deno.watchFs(testDir);
const res = iter[Symbol.asyncIterator]().next();
iter.close();
const { done } = await res;
assert(done);
},
);