Skip to content

Commit

Permalink
CI: FilePoly unit tests (#1091)
Browse files Browse the repository at this point in the history
  • Loading branch information
@emmercm
emmercm committed Apr 12, 2024
1 parent 362f98d commit 94f8da2
Showing 1 changed file with 206 additions and 7 deletions.
213 changes: 206 additions & 7 deletions test/polyfill/filePoly.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import fs from 'node:fs';
import path from 'node:path';

import Constants from '../../src/constants.js';
Expand All @@ -24,7 +25,6 @@ describe('fileOfSize', () => {

test.each([1, 42, 226, 1337, 8_675_309])('should create a file of size: %s', async (size) => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));
await expect(fsPoly.exists(tempFile)).resolves.toEqual(false);

try {
const file = await filePoly.fileOfSize(tempFile, 'r', size);
Expand All @@ -37,30 +37,229 @@ describe('fileOfSize', () => {
});
});

describe('getSize', () => {
const filesWithSizes = [
[path.join('test', 'fixtures', 'roms', 'raw', 'empty.rom'), 0],
[path.join('test', 'fixtures', 'roms', 'raw', 'fizzbuzz.nes'), 9],
[path.join('test', 'fixtures', 'roms', 'raw', 'foobar.lnx'), 7],
[path.join('test', 'fixtures', 'roms', 'raw', 'loremipsum.rom'), 11],
] satisfies [string, number][];

test.each(filesWithSizes)('should get size of raw file: %s', async (filePath, expectedSize) => {
const file = await filePoly.fileFrom(filePath, 'r');
try {
expect(file.getSize()).toEqual(expectedSize);
} finally {
await file.close();
}
});

test.each(filesWithSizes)('should get size of symlinked file: %s', async (filePath, expectedSize) => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));
await fsPoly.copyDir(filePath, tempFile);
const tempSymlink = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'symlink'));
await fsPoly.symlink(path.resolve(tempFile), tempSymlink);

const file = await filePoly.fileFrom(tempSymlink, 'r');
try {
expect(file.getSize()).toEqual(expectedSize);
} finally {
await file.close();
await fsPoly.rm(tempSymlink);
await fsPoly.rm(tempFile);
}
});

test.each(filesWithSizes)('should get size of hard linked file: %s', async (filePath, expectedSize) => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));
await fsPoly.copyDir(filePath, tempFile);
const tempLink = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'link'));
await fsPoly.hardlink(path.resolve(tempFile), tempLink);

const file = await filePoly.fileFrom(tempLink, 'r');
try {
expect(file.getSize()).toEqual(expectedSize);
} finally {
await file.close();
await fsPoly.rm(tempLink);
await fsPoly.rm(tempFile);
}
});
});

describe('readNext', () => {
it('should read from the beginning', async () => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));
await fs.promises.writeFile(tempFile, 'ABCDEF0123456789');

const file = await filePoly.fileFrom(tempFile, 'r');
try {
await expect(file.readNext(2)).resolves.toEqual(Buffer.from('AB'));
await expect(file.readNext(3)).resolves.toEqual(Buffer.from('CDE'));
await expect(file.readNext(4)).resolves.toEqual(Buffer.from('F012'));
} finally {
await file.close();
await fsPoly.rm(tempFile);
}
});

it('should respect seek', async () => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));
await fs.promises.writeFile(tempFile, 'ABCDEF0123456789');

const file = await filePoly.fileFrom(tempFile, 'r');
try {
await expect(file.readNext(2)).resolves.toEqual(Buffer.from('AB'));
await expect(file.readNext(3)).resolves.toEqual(Buffer.from('CDE'));
file.seek(0);
await expect(file.readNext(4)).resolves.toEqual(Buffer.from('ABCD'));
} finally {
await file.close();
await fsPoly.rm(tempFile);
}
});

it('should respect skipNext', async () => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));
await fs.promises.writeFile(tempFile, 'ABCDEF0123456789');

const file = await filePoly.fileFrom(tempFile, 'r');
try {
await expect(file.readNext(2)).resolves.toEqual(Buffer.from('AB'));
await expect(file.readNext(3)).resolves.toEqual(Buffer.from('CDE'));
file.skipNext(4);
await expect(file.readNext(5)).resolves.toEqual(Buffer.from('34567'));
} finally {
await file.close();
await fsPoly.rm(tempFile);
}
});
});

describe('readAt', () => {
it('should read a small file', async () => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));
await expect(fsPoly.exists(tempFile)).resolves.toEqual(false);

const file = await filePoly.fileOfSize(tempFile, 'r', Constants.MAX_MEMORY_FILE_SIZE - 1);
try {
const file = await filePoly.fileOfSize(tempFile, 'r', Constants.MAX_MEMORY_FILE_SIZE - 1);
await expect(file.readAt(0, 16)).resolves.toEqual(Buffer.alloc(16));
await file.close();
} finally {
await file.close();
await fsPoly.rm(tempFile);
}
});

it('should read a large file', async () => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));
await expect(fsPoly.exists(tempFile)).resolves.toEqual(false);

const file = await filePoly.fileOfSize(tempFile, 'r', Constants.MAX_MEMORY_FILE_SIZE + 1);
try {
const file = await filePoly.fileOfSize(tempFile, 'r', Constants.MAX_MEMORY_FILE_SIZE + 1);
await expect(file.readAt(0, 16)).resolves.toEqual(Buffer.alloc(16));
await file.close();
} finally {
await file.close();
await fsPoly.rm(tempFile);
}
});
});

describe('write', () => {
describe('file mode: r', () => {
it('should throw on write', async () => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));

try {
const file = await filePoly.fileOfSize(tempFile, 'r', 16);
await expect(file.write(Buffer.from('ABCDEF01'))).rejects.toThrow();
await file.close();

const contents = await fs.promises.readFile(tempFile);
expect(contents).toEqual(Buffer.from('\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'));
} finally {
await fsPoly.rm(tempFile);
}
});
});

describe.each(['r+', 'a'])('file mode: %s', (openMode) => {
it('should overwrite contents', async () => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));

try {
const file = await filePoly.fileOfSize(tempFile, openMode, 16);
await file.write(Buffer.from('ABCDEF01'));
await file.close();

const contents = await fs.promises.readFile(tempFile);
expect(contents).toEqual(Buffer.from('ABCDEF01\x00\x00\x00\x00\x00\x00\x00\x00'));
} finally {
await fsPoly.rm(tempFile);
}
});

it('should extend the file size', async () => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));

try {
const file = await filePoly.fileOfSize(tempFile, openMode, 4);
await file.write(Buffer.from('ABCDEF01'));
await file.close();

const contents = await fs.promises.readFile(tempFile);
expect(contents).toEqual(Buffer.from('ABCDEF01'));
} finally {
await fsPoly.rm(tempFile);
}
});
});
});

describe('writeAt', () => {
describe('file mode: r', () => {
it('should throw on write', async () => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));

try {
const file = await filePoly.fileOfSize(tempFile, 'r', 16);
await expect(file.writeAt(Buffer.from('ABCDEF01'), 4)).rejects.toThrow();
await file.close();

const contents = await fs.promises.readFile(tempFile);
expect(contents).toEqual(Buffer.from('\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'));
} finally {
await fsPoly.rm(tempFile);
}
});
});

describe.each(['r+', 'a'])('file mode: %s', (openMode) => {
it('should overwrite contents', async () => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));

try {
const file = await filePoly.fileOfSize(tempFile, openMode, 16);
await file.writeAt(Buffer.from('ABCDEF01'), 6);
await file.close();

const contents = await fs.promises.readFile(tempFile);
expect(contents).toEqual(Buffer.from('\x00\x00\x00\x00\x00\x00ABCDEF01\x00\x00'));
} finally {
await fsPoly.rm(tempFile);
}
});

it('should extend the file size', async () => {
const tempFile = await fsPoly.mktemp(path.join(Constants.GLOBAL_TEMP_DIR, 'file'));

try {
const file = await filePoly.fileOfSize(tempFile, openMode, 4);
await file.writeAt(Buffer.from('ABCDEF01'), 6);
await file.close();

const contents = await fs.promises.readFile(tempFile);
expect(contents).toEqual(Buffer.from('\x00\x00\x00\x00\x00\x00ABCDEF01'));
} finally {
await fsPoly.rm(tempFile);
}
});
});
});

0 comments on commit 94f8da2

Please sign in to comment.