New tests
This commit is contained in:
Nick Playfair
parent
aa4834ffc0
commit
4642203160
2
.gitignore
vendored
2
.gitignore
vendored
@ -97,4 +97,4 @@ typings/
|
||||
gerber/
|
||||
hello.txt
|
||||
test/tmp/*
|
||||
test/archiveTest
|
||||
test/arduino/*
|
||||
@ -3,46 +3,50 @@ import { readdirSync } from 'node:fs';
|
||||
import { emptyDirSync } from 'fs-extra';
|
||||
import { Readable } from 'node:stream';
|
||||
import { ImageGenerator } from '../src/index';
|
||||
import { tmpdir } from 'node:os';
|
||||
|
||||
const testGerber = path.join(__dirname, 'Arduino-Pro-Mini.zip');
|
||||
//Sample data
|
||||
const arduinoGerber = path.join(__dirname, 'Arduino-Pro-Mini.zip');
|
||||
const incompleteGerber = path.join(__dirname, 'incomplete.zip');
|
||||
const testLayers = path.join(__dirname, 'layers');
|
||||
const emptyFolder = path.join(__dirname, 'layers', 'Empty');
|
||||
const archiveTestFolder = path.join(__dirname, 'archiveTest');
|
||||
|
||||
//Correct folder configuration
|
||||
const folderConfig = {
|
||||
tmpDir: path.join(__dirname, 'tmp'),
|
||||
imgDir: path.join(__dirname, 'tmp'),
|
||||
};
|
||||
const noTempConfig = {
|
||||
tmpDir: emptyFolder,
|
||||
imgDir: path.join(__dirname, 'tmp'),
|
||||
};
|
||||
//Folder configuration with non-existent tmpDir
|
||||
const tmpNotExist = {
|
||||
tmpDir: path.join(__dirname, 'InvalidFolderName'),
|
||||
imgDir: path.join(__dirname, 'tmp'),
|
||||
};
|
||||
//Folder configuration with non-existent imgDir
|
||||
const imgNotExist = {
|
||||
tmpDir: path.join(__dirname, 'tmp'),
|
||||
imgDir: path.join(__dirname, 'InvalidFolderName'),
|
||||
};
|
||||
//Folder configuration with bad permissions on tmpDir
|
||||
const tmpBadPerms = {
|
||||
tmpDir: path.join(__dirname, 'badPerms'),
|
||||
imgDir: path.join(__dirname, 'tmp'),
|
||||
};
|
||||
//Folder configuration with bad permissions on imgDir
|
||||
const imgBadPerms = {
|
||||
tmpDir: path.join(__dirname, 'tmp'),
|
||||
imgDir: path.join(__dirname, 'badPerms'),
|
||||
};
|
||||
const noImageConfig = {
|
||||
//Correct folder configuration
|
||||
const arduinoConfig = {
|
||||
tmpDir: path.join(__dirname, 'tmp'),
|
||||
imgDir: emptyFolder,
|
||||
imgDir: path.join(__dirname, 'arduino'),
|
||||
};
|
||||
|
||||
//Valid image configuration object
|
||||
const imgConfig = {
|
||||
resizeWidth: 600,
|
||||
density: 1000,
|
||||
compLevel: 1,
|
||||
};
|
||||
|
||||
//Valid array of layer names
|
||||
const layerNames = [
|
||||
'CAMOutputs/DrillFiles/drills.xln',
|
||||
'CAMOutputs/GerberFiles/copper_top.gbr',
|
||||
@ -52,23 +56,16 @@ const layerNames = [
|
||||
'CAMOutputs/GerberFiles/profile.gbr',
|
||||
];
|
||||
|
||||
const fileProc = new ImageGenerator(folderConfig, imgConfig, layerNames);
|
||||
|
||||
/**************
|
||||
* Tests
|
||||
***************/
|
||||
//===== Tests =====
|
||||
|
||||
//Setup
|
||||
beforeAll(() => {
|
||||
return emptyDirSync(folderConfig.tmpDir);
|
||||
});
|
||||
|
||||
beforeEach(() => {
|
||||
return emptyDirSync(emptyFolder);
|
||||
});
|
||||
|
||||
// Test constructor
|
||||
describe('Creating an ImageGenerator object', () => {
|
||||
const imgGen = new ImageGenerator(folderConfig, imgConfig);
|
||||
const imgGen = new ImageGenerator(folderConfig, imgConfig, layerNames);
|
||||
test('should create a valid object when passed the correct files and configuration', () => {
|
||||
expect(imgGen).toBeInstanceOf(ImageGenerator);
|
||||
});
|
||||
@ -86,117 +83,66 @@ describe('Creating an ImageGenerator object', () => {
|
||||
expect(imgGen.folderConfig.tmpDir).toBe(path.join(__dirname, 'tmp'));
|
||||
expect(imgGen.folderConfig.imgDir).toBe(path.join(__dirname, 'tmp'));
|
||||
});
|
||||
test('Layers should match layerNames sample array', () => {
|
||||
expect(imgGen.layerNames).toBe(layerNames);
|
||||
});
|
||||
afterAll(() => {
|
||||
return emptyDirSync(folderConfig.tmpDir);
|
||||
});
|
||||
});
|
||||
|
||||
// Testing folder config
|
||||
describe('Passing in', () => {
|
||||
test('a non-existent tmp folder should throw error', () => {
|
||||
//Test invalid folder configs
|
||||
describe('Attempting to create ImageGenerator object with', () => {
|
||||
test('non-existent temp folder should throw error', () => {
|
||||
expect(() => {
|
||||
new ImageGenerator(tmpNotExist, imgConfig);
|
||||
const badGen = new ImageGenerator(tmpNotExist, imgConfig, layerNames);
|
||||
}).toThrow();
|
||||
});
|
||||
test('a tmp folder with invalid permissions should throw error', () => {
|
||||
test('non-existent image folder should throw error', () => {
|
||||
expect(() => {
|
||||
new ImageGenerator(tmpBadPerms, imgConfig);
|
||||
const badGen = new ImageGenerator(imgNotExist, imgConfig, layerNames);
|
||||
}).toThrow();
|
||||
});
|
||||
test('a non-existent img folder should throw error', () => {
|
||||
test('temp folder with bad permissions should throw error', () => {
|
||||
expect(() => {
|
||||
new ImageGenerator(imgNotExist, imgConfig);
|
||||
const badGen = new ImageGenerator(tmpBadPerms, imgConfig, layerNames);
|
||||
}).toThrow();
|
||||
});
|
||||
test('an img folder with invalid permissions should throw error', () => {
|
||||
test('image folder with bad permissions should throw error', () => {
|
||||
expect(() => {
|
||||
new ImageGenerator(imgBadPerms, imgConfig);
|
||||
const badGen = new ImageGenerator(imgBadPerms, imgConfig, layerNames);
|
||||
}).toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
//Layer methods
|
||||
describe('Getting layers', () => {
|
||||
const imgGen = new ImageGenerator(folderConfig, imgConfig);
|
||||
test('should return a promise of array of layers', () => {
|
||||
expect(imgGen.getLayers(testLayers, layerNames)).resolves.toBeInstanceOf(
|
||||
Array,
|
||||
);
|
||||
//Create image from Arduino Gerber
|
||||
describe('Create image from Arduino gerber', () => {
|
||||
beforeAll(() => {
|
||||
return emptyDirSync(path.join(__dirname, 'arduino'));
|
||||
});
|
||||
|
||||
test('should throw error if the layers folder is not valid', () => {
|
||||
expect(() => {
|
||||
imgGen.getLayers('some_invalid_folder', layerNames);
|
||||
}).toThrow();
|
||||
afterEach(() => {
|
||||
return emptyDirSync(path.join(__dirname, 'tmp'));
|
||||
});
|
||||
|
||||
test('should throw error if incorrect number of layers supplied', () => {
|
||||
expect(() => {
|
||||
imgGen.getLayers(emptyFolder, layerNames);
|
||||
}).toThrow();
|
||||
const arduinoGen = new ImageGenerator(arduinoConfig, imgConfig, layerNames);
|
||||
test('should create a valid object when passed the correct files and configuration', () => {
|
||||
expect(arduinoGen).toBeInstanceOf(ImageGenerator);
|
||||
});
|
||||
});
|
||||
|
||||
//Archive methods
|
||||
describe('When extracting an archive', () => {
|
||||
const imgGen = new ImageGenerator(folderConfig, imgConfig);
|
||||
test('a non-existent archive should throw an error', () => {
|
||||
expect(() =>
|
||||
imgGen.extractArchive('invalid.zip', folderConfig.tmpDir),
|
||||
).toThrow();
|
||||
});
|
||||
test('if the temp dir does not exist it should throw an error', () => {
|
||||
expect(() => imgGen.extractArchive(testGerber, 'some_invalid_dir')).toThrow(
|
||||
Error,
|
||||
);
|
||||
});
|
||||
test('it should load the archive and return the number of files extracted', () => {
|
||||
expect(() => {
|
||||
imgGen.testArchive(testGerber, archiveTestFolder);
|
||||
}).not.toThrow();
|
||||
expect(imgGen.testArchive(testGerber, archiveTestFolder)).toEqual(12);
|
||||
});
|
||||
test('it should extract archive and all files should be present', () => {
|
||||
expect(imgGen.testArchive(testGerber, archiveTestFolder)).toEqual(12);
|
||||
imgGen.extractArchive(testGerber, archiveTestFolder);
|
||||
const dirents = readdirSync(archiveTestFolder, {
|
||||
recursive: true,
|
||||
withFileTypes: true,
|
||||
});
|
||||
const numOutputFiles = dirents.filter((dirent) => dirent.isFile());
|
||||
expect(numOutputFiles).toHaveLength(12);
|
||||
});
|
||||
//clear archive
|
||||
afterAll(() => {
|
||||
return emptyDirSync(archiveTestFolder);
|
||||
});
|
||||
});
|
||||
|
||||
//Gerber methods
|
||||
describe('Converting a gerber to an image', () => {
|
||||
beforeEach(() => {
|
||||
return emptyDirSync(emptyFolder);
|
||||
});
|
||||
afterAll(() => {
|
||||
return emptyDirSync(emptyFolder);
|
||||
});
|
||||
|
||||
test('invalid archive file should throw an error', () => {
|
||||
expect(() => fileProc.gerberToImage('invalid.zip')).toThrow();
|
||||
expect(() => arduinoGen.gerberToImage('invalid.zip')).toThrow();
|
||||
});
|
||||
// test('an archive with incomplete set of layers should throw an error', () => {
|
||||
// expect(() => fileProc.gerberToImage(incompleteGerber)).toThrow();
|
||||
// });
|
||||
test('gerber archive should resolve promise and return a filename of an image', () => {
|
||||
test('arduino archive should resolve promise and return a filename of an image', () => {
|
||||
expect.assertions(1);
|
||||
return expect(fileProc.gerberToImage(testGerber)).resolves.toEqual(
|
||||
return expect(arduinoGen.gerberToImage(arduinoGerber)).resolves.toEqual(
|
||||
expect.stringContaining('Arduino-Pro-Mini.png'),
|
||||
);
|
||||
});
|
||||
test('Gerber archive should resolve promise and return a png stream', () => {
|
||||
test('arduino archive should resolve promise and return a png stream', () => {
|
||||
expect.assertions(1);
|
||||
return expect(fileProc.gerberToStream(testGerber)).resolves.toBeInstanceOf(
|
||||
Readable,
|
||||
);
|
||||
return expect(
|
||||
arduinoGen.gerberToStream(arduinoGerber),
|
||||
).resolves.toBeInstanceOf(Readable);
|
||||
});
|
||||
test('incomplete archive file should throw an error', () => {
|
||||
expect(() => arduinoGen.gerberToImage(incompleteGerber)).toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user