Skip to content

Commit

Permalink
test: use a scoped options object
Browse files Browse the repository at this point in the history
  • Loading branch information
@43081j
43081j committed Sep 11, 2024
1 parent 69d67f3 commit 11bf22d
Showing 1 changed file with 39 additions and 39 deletions.
78 changes: 39 additions & 39 deletions test.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ const allWatchers = [];
const PERM_ARR = 0o755; // rwe, r+e, r+e
const TEST_TIMEOUT = 8000;
let subdirId = 0;
let options;
let currentDir;
let slowerDelay;

Expand Down Expand Up @@ -101,7 +100,7 @@ const getGlobPath = (subPath) => {
};
currentDir = getFixturePath('');

const chokidar_watch = (path = currentDir, opts = options) => {
const chokidar_watch = (path = currentDir, opts) => {
const wt = chokidar.watch(path, opts);
allWatchers.push(wt);
return wt;
Expand Down Expand Up @@ -156,6 +155,7 @@ const dateNow = () => Date.now().toString();
const runTests = (baseopts) => {
let macosFswatch;
let win32Polling;
let options;

baseopts.persistent = true;

Expand All @@ -180,7 +180,7 @@ const runTests = (baseopts) => {
options.alwaysStat = true;
readySpy = sinon.spy(function readySpy(){});
rawSpy = sinon.spy(function rawSpy(){});
watcher = chokidar_watch().on(EV.READY, readySpy).on(EV.RAW, rawSpy);
watcher = chokidar_watch(currentDir, options).on(EV.READY, readySpy).on(EV.RAW, rawSpy);
await waitForWatcher(watcher);
});
afterEach(async () => {
Expand Down Expand Up @@ -293,7 +293,7 @@ const runTests = (baseopts) => {
await delay();

readySpy.resetHistory();
watcher2 = chokidar_watch().on(EV.READY, readySpy).on(EV.RAW, rawSpy);
watcher2 = chokidar_watch(currentDir, options).on(EV.READY, readySpy).on(EV.RAW, rawSpy);
const spy = await aspy(watcher2, EV.ADD, null, true);

const filesToWrite = [
Expand Down Expand Up @@ -586,7 +586,7 @@ const runTests = (baseopts) => {
describe('watch individual files', () => {
it('should emit `ready` when three files were added', async () => {
const readySpy = sinon.spy(function readySpy(){});
const watcher = chokidar_watch().on(EV.READY, readySpy);
const watcher = chokidar_watch(currentDir, options).on(EV.READY, readySpy);
const path1 = getFixturePath('add1.txt');
const path2 = getFixturePath('add2.txt');
const path3 = getFixturePath('add3.txt');
Expand Down Expand Up @@ -868,7 +868,7 @@ const runTests = (baseopts) => {
const filePath = getFixturePath('nota[glob].txt');
await write(filePath, 'b');
await delay();
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
spy.should.have.been.calledWith(EV.ADD, filePath);

await delay();
Expand Down Expand Up @@ -994,7 +994,7 @@ const runTests = (baseopts) => {
it('should not recurse indefinitely on circular symlinks', async () => {
await fs_symlink(currentDir, getFixturePath('subdir/circular'), isWindows ? 'dir' : null);
return new Promise((resolve, reject) => {
const watcher = chokidar_watch();
const watcher = chokidar_watch(currentDir, options);
watcher.on(EV.ERROR, resolve());
watcher.on(EV.READY, reject('The watcher becomes ready, although he watches a circular symlink.'));
})
Expand All @@ -1010,7 +1010,7 @@ const runTests = (baseopts) => {
});
it('should follow newly created symlinks', async () => {
options.ignoreInitial = true;
const watcher = chokidar_watch();
const watcher = chokidar_watch(currentDir, options);
const spy = await aspy(watcher, EV.ALL);
await delay();
await fs_symlink(getFixturePath('subdir'), getFixturePath('link'), isWindows ? 'dir' : null);
Expand Down Expand Up @@ -1049,7 +1049,7 @@ const runTests = (baseopts) => {
// Create symlink in linkPath
const linkPath = getFixturePath('link');
fs.symlinkSync(getFixturePath('subdir'), linkPath);
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await delay(300);
setTimeout(() => {
fs.writeFileSync(getFixturePath('subdir/add.txt'), dateNow());
Expand Down Expand Up @@ -1124,7 +1124,7 @@ const runTests = (baseopts) => {
spy.should.have.been.calledWith(EV.CHANGE, testPath);
});
it('should throw if provided any non-string paths', () => {
expect(chokidar_watch.bind(null, [[currentDir], /notastring/]))
expect(chokidar_watch.bind(null, [[currentDir], /notastring/], options))
.to.throw(TypeError, /non-string/i);
});
});
Expand Down Expand Up @@ -1157,7 +1157,7 @@ const runTests = (baseopts) => {
describe('true', () => {
beforeEach(() => { options.ignoreInitial = true; });
it('should ignore initial add events', async () => {
const watcher = chokidar_watch();
const watcher = chokidar_watch(currentDir, options);
const spy = await aspy(watcher, EV.ADD);
await delay();
spy.should.not.have.been.called;
Expand All @@ -1172,7 +1172,7 @@ const runTests = (baseopts) => {
it('should notice when a file appears in an empty directory', async () => {
const testDir = getFixturePath('subdir');
const testPath = getFixturePath('subdir/add.txt');
const spy = await aspy(chokidar_watch(), EV.ADD);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ADD);
spy.should.not.have.been.called;
await fs_mkdir(testDir, PERM_ARR);
await write(testPath, dateNow());
Expand All @@ -1182,7 +1182,7 @@ const runTests = (baseopts) => {
});
it('should emit a change on a preexisting file as a change', async () => {
const testPath = getFixturePath('change.txt');
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
spy.should.not.have.been.called;
await write(testPath, dateNow());
await waitFor([spy.withArgs(EV.CHANGE, testPath)]);
Expand All @@ -1195,7 +1195,7 @@ const runTests = (baseopts) => {
await fs_mkdir(getFixturePath('subdir'), PERM_ARR);

await delay(200);
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await write(testPath, dateNow());
await waitFor([spy]);

Expand Down Expand Up @@ -1223,7 +1223,7 @@ const runTests = (baseopts) => {
});
it('should not choke on an ignored watch path', async () => {
options.ignored = () => { return true; };
await waitForWatcher(chokidar_watch());
await waitForWatcher(chokidar_watch(currentDir, options));
});
it('should ignore the contents of ignored dirs', async () => {
const testDir = getFixturePath('subdir');
Expand Down Expand Up @@ -1272,7 +1272,7 @@ const runTests = (baseopts) => {
});
it('should not recurse if depth is 0', async () => {
options.depth = 0;
const watcher = chokidar_watch();
const watcher = chokidar_watch(currentDir, options);
const spy = await aspy(watcher, EV.ALL);
await write(getFixturePath('subdir/add.txt'), dateNow());
await waitFor([[spy, 4]]);
Expand All @@ -1288,7 +1288,7 @@ const runTests = (baseopts) => {
const addPath = getFixturePath('subdir/add.txt');
const changePath = getFixturePath('change.txt');
const ignoredPath = getFixturePath('subdir/subsub/ab.txt');
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await delay();
await write(getFixturePath('change.txt'), dateNow());
await write(addPath, dateNow());
Expand All @@ -1306,7 +1306,7 @@ const runTests = (baseopts) => {
options.depth = 1;
await fs_symlink(getFixturePath('subdir'), getFixturePath('link'), isWindows ? 'dir' : null);
await delay();
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
spy.should.have.been.calledWith(EV.ADD_DIR, getFixturePath('link'));
spy.should.have.been.calledWith(EV.ADD_DIR, getFixturePath('link/subsub'));
spy.should.have.been.calledWith(EV.ADD, getFixturePath('link/add.txt'));
Expand All @@ -1318,7 +1318,7 @@ const runTests = (baseopts) => {
options.ignoreInitial = true;
const linkPath = getFixturePath('link');
const dirPath = getFixturePath('link/subsub');
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await fs_symlink(getFixturePath('subdir'), linkPath, isWindows ? 'dir' : null);
await waitFor([[spy, 3], spy.withArgs(EV.ADD_DIR, dirPath)]);
spy.should.have.been.calledWith(EV.ADD_DIR, linkPath);
Expand All @@ -1329,7 +1329,7 @@ const runTests = (baseopts) => {
it('should correctly handle dir events when depth is 0', async () => {
options.depth = 0;
const subdir2 = getFixturePath('subdir2');
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
const addSpy = spy.withArgs(EV.ADD_DIR);
const unlinkSpy = spy.withArgs(EV.UNLINK_DIR);
spy.should.have.been.calledWith(EV.ADD_DIR, currentDir);
Expand All @@ -1351,7 +1351,7 @@ const runTests = (baseopts) => {
options.ignoreInitial = true;
});
it('should ignore vim/emacs/Sublime swapfiles', async () => {
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await write(getFixturePath('.change.txt.swp'), 'a'); // vim
await write(getFixturePath('add.txt~'), 'a'); // vim/emacs
await write(getFixturePath('.subl5f4.tmp'), 'a'); // sublime
Expand All @@ -1370,7 +1370,7 @@ const runTests = (baseopts) => {
options.ignoreInitial = false;
await write(getFixturePath('old.txt~'), 'a');
await delay();
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
spy.should.not.have.been.calledWith(getFixturePath('old.txt'));
spy.should.not.have.been.calledWith(getFixturePath('old.txt~'));
});
Expand Down Expand Up @@ -1478,7 +1478,7 @@ const runTests = (baseopts) => {
});
it('should not watch files without read permissions', async () => {
if (isWindows) return true;
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
spy.should.not.have.been.calledWith(EV.ADD, filePath);
await write(filePath, dateNow());

Expand All @@ -1489,7 +1489,7 @@ const runTests = (baseopts) => {
describe('true', () => {
beforeEach(() => { options.ignorePermissionErrors = true; });
it('should watch unreadable files if possible', async () => {
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
spy.should.have.been.calledWith(EV.ADD, filePath);
});
it('should not choke on non-existent files', async () => {
Expand All @@ -1505,20 +1505,20 @@ const runTests = (baseopts) => {
});
it('should use default options if none given', () => {
options.awaitWriteFinish = true;
const watcher = chokidar_watch();
const watcher = chokidar_watch(currentDir, options);
expect(watcher.options.awaitWriteFinish.pollInterval).to.equal(100);
expect(watcher.options.awaitWriteFinish.stabilityThreshold).to.equal(2000);
});
it('should not emit add event before a file is fully written', async () => {
const testPath = getFixturePath('add.txt');
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await write(testPath, 'hello');
await delay(200);
spy.should.not.have.been.calledWith(EV.ADD);
});
it('should wait for the file to be fully written before emitting the add event', async () => {
const testPath = getFixturePath('add.txt');
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await write(testPath, 'hello');

await delay(300);
Expand All @@ -1528,7 +1528,7 @@ const runTests = (baseopts) => {
});
it('should emit with the final stats', async () => {
const testPath = getFixturePath('add.txt');
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await write(testPath, 'hello ');

await delay(300);
Expand All @@ -1540,7 +1540,7 @@ const runTests = (baseopts) => {
});
it('should not emit change event while a file has not been fully written', async () => {
const testPath = getFixturePath('add.txt');
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await write(testPath, 'hello');
await delay(100);
await write(testPath, 'edit');
Expand All @@ -1549,14 +1549,14 @@ const runTests = (baseopts) => {
});
it('should not emit change event before an existing file is fully updated', async () => {
const testPath = getFixturePath('change.txt');
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await write(testPath, 'hello');
await delay(300);
spy.should.not.have.been.calledWith(EV.CHANGE, testPath);
});
it('should wait for an existing file to be fully updated before emitting the change event', async () => {
const testPath = getFixturePath('change.txt');
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
fs.writeFile(testPath, 'hello', () => {});

await delay(300);
Expand All @@ -1566,7 +1566,7 @@ const runTests = (baseopts) => {
});
it('should emit change event after the file is fully written', async () => {
const testPath = getFixturePath('add.txt');
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await delay();
await write(testPath, 'hello');

Expand All @@ -1578,7 +1578,7 @@ const runTests = (baseopts) => {
});
it('should not raise any event for a file that was deleted before fully written', async () => {
const testPath = getFixturePath('add.txt');
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await write(testPath, 'hello');
await delay(400);
await fs_unlink(testPath);
Expand All @@ -1592,7 +1592,7 @@ const runTests = (baseopts) => {
await fs_mkdir(options.cwd);

await delay(200);
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);

await delay(400);
await write(testPath, 'hello');
Expand All @@ -1602,7 +1602,7 @@ const runTests = (baseopts) => {
});
it('should still emit initial add events', async () => {
options.ignoreInitial = false;
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
spy.should.have.been.calledWith(EV.ADD);
spy.should.have.been.calledWith(EV.ADD_DIR);
});
Expand All @@ -1614,7 +1614,7 @@ const runTests = (baseopts) => {
await delay();
await write(testPath, 'hello');
await delay();
const spy = await aspy(chokidar_watch(), EV.ALL);
const spy = await aspy(chokidar_watch(currentDir, options), EV.ALL);
await write(testPath, 'edit');
await delay();
await fs_unlink(testPath);
Expand Down Expand Up @@ -1669,7 +1669,7 @@ const runTests = (baseopts) => {
it('should handle unlink that happens while waiting for stat to return', (done) => {
const spy = sinon.spy();
const testPath = getFixturePath('add.txt');
chokidar_watch()
chokidar_watch(currentDir, options)
.on(EV.ALL, spy)
.on(EV.READY, () => {
fs.writeFile(testPath, 'hello', simpleCb);
Expand Down Expand Up @@ -1705,7 +1705,7 @@ const runTests = (baseopts) => {
const expected = {};
expected[sysPath.dirname(currentDir)] = [subdirId.toString()];
expected[currentDir] = ['change.txt', 'unlink.txt'];
const watcher = chokidar_watch();
const watcher = chokidar_watch(currentDir, options);
await waitForWatcher(watcher);
expect(watcher.getWatched()).to.deep.equal(expected);
});
Expand All @@ -1717,7 +1717,7 @@ const runTests = (baseopts) => {
'subdir': []
};
await fs_mkdir(getFixturePath('subdir'), PERM_ARR);
const watcher = chokidar_watch();
const watcher = chokidar_watch(currentDir, options);
await waitForWatcher(watcher);
expect(watcher.getWatched()).to.deep.equal(expected);
});
Expand Down

0 comments on commit 11bf22d

Please sign in to comment.