npe_gerber/test/index.test.js

/* eslint-disable */
const path = require('path');
const fs = require('fs-extra');
const Readable = require('stream').Readable;
const { ImageGenerator } = require('../index.js');
require('../index.js');

const testGerber = 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 folderConfig = {
  tmpDir: path.join(__dirname, 'tmp'),
  imgDir: path.join(__dirname, 'tmp'),
};
const noTempConfig = {
  tmpDir: emptyFolder,
  imgDir: path.join(__dirname, 'tmp'),
};
const tmpNotExist = {
  tmpDir: path.join(__dirname, 'layers', 'InvalidFolderName'),
  imgDir: path.join(__dirname, 'tmp'),
};
const tmpBadPerms = {
  tmpDir: path.join(__dirname, 'badPerms'),
  imgDir: path.join(__dirname, 'tmp'),
};
const noImageConfig = {
  tmpDir: path.join(__dirname, 'tmp'),
  imgDir: emptyFolder,
};
const imgConfig = {
  resizeWidth: 600,
  density: 1000,
  compLevel: 1,
};
const layerNames = [
  'CAMOutputs/DrillFiles/drills.xln',
  'CAMOutputs/GerberFiles/copper_top.gbr',
  'CAMOutputs/GerberFiles/silkscreen_top.gbr',
  'CAMOutputs/GerberFiles/soldermask_top.gbr',
  'CAMOutputs/GerberFiles/solderpaste_top.gbr',
  'CAMOutputs/GerberFiles/profile.gbr',
];

const fileProc = new ImageGenerator(folderConfig, imgConfig, layerNames);
const fileProcNoTemp = new ImageGenerator(noTempConfig, imgConfig, layerNames);
const fileProcNoImage = new ImageGenerator(
  noImageConfig,
  imgConfig,
  layerNames,
);

/**************
 * Tests
 ***************/

// Test constructor
describe('Creating an ImageGenerator object', () => {
  test('should create a valid object when passed the correct files and configuration', () => {
    const imgGen = new ImageGenerator(folderConfig, imgConfig);
    expect(imgGen).toBeInstanceOf(ImageGenerator);
    // Image processing configuration
    expect(imgGen.imgConfig.resizeWidth).toBe(600);
    expect(imgGen.imgConfig.density).toBe(1000);
    expect(imgGen.imgConfig.compLevel).toBe(1);
    // Folders
    expect(imgGen.tmpDir).toBe(path.join(__dirname, 'tmp'));
    expect(imgGen.imgDir).toBe(path.join(__dirname, 'tmp'));
  });
});

// test('Create ImageGenerator object with the passed in config values', () => {
//   const imgGen = new ImageGenerator(folderConfig, imgConfig);
//   expect(imgGen).toBeInstanceOf(ImageGenerator);
//   // Image processing configuration
//   expect(imgGen.imgConfig.resizeWidth).toBe(600);
//   expect(imgGen.imgConfig.density).toBe(1000);
//   expect(imgGen.imgConfig.compLevel).toBe(1);
//   // Folders
//   expect(imgGen.tmpDir).toBe(path.join(__dirname, 'tmp'));
//   expect(imgGen.imgDir).toBe(path.join(__dirname, 'tmp'));
// });

// Test invalid folders passed to constructor
test('Create ImageGenerator object with invalid tmp folder', () => {
  expect(() => {
    new ImageGenerator(tmpNotExist, imgConfig);
  }).toThrow();
});
//TODO invalid image

// Test invalid folder permissions
test('Try tmp folder with bad permissions', () => {
  expect(() => {
    new ImageGenerator(tmpBadPerms, imgConfig);
  }).toThrow();
});

// getLayers
test('Promise of an array of layers from a given folder', () => {
  expect.assertions(1);
  return ImageGenerator.getLayers(testLayers, layerNames).then((data) => {
    expect(data).toEqual(
      expect.arrayContaining([
        expect.objectContaining({
          filename: expect.any(String),
          gerber: expect.any(fs.ReadStream),
        }),
      ]),
    );
  });
});

test('Non-existent folder should reject promise with error', () => {
  expect.assertions(1);
  return expect(
    ImageGenerator.getLayers('./invalid_folder', layerNames),
  ).rejects.toThrow(new Error('Layers folder does not exist.'));
});

test('Folder with incorrect number of layers should reject promise with error', () => {
  expect.assertions(1);
  return expect(
    ImageGenerator.getLayers(emptyFolder, layerNames),
  ).rejects.toThrow(new Error('Layer not found.'));
});

// extractArchive
test('Non-existent archive should throw an error', () => {
  expect(() =>
    ImageGenerator.extractArchive('invalid.zip', folderConfig.tmpDir).toThrow(
      Error,
    ),
  );
});

test('Temp dir not existing should throw an error', () => {
  expect(() =>
    ImageGenerator.extractArchive(testGerber, './invalid_dir').toThrow(Error),
  );
});

test('Should extract archive and resolve with the number of files extracted', () => {
  expect(() =>
    ImageGenerator.extractArchive(testGerber, folderConfig.tmpDir).toBe(12),
  );
});

// gerberToImage
test('Temp dir not existing should throw an error', () => {
  expect(() =>
    fileProcNoTemp
      .gerberToImage(testGerber)
      .toThrow(new Error('Temporary folder does not exist.')),
  );
});

test('Output dir not existing should throw an error', () => {
  expect(() =>
    fileProcNoImage
      .gerberToImage(testGerber)
      .toThrow(new Error('Output folder does not exist.')),
  );
});

test('Invalid archive file should throw an error', () => {
  expect(() =>
    fileProc
      .gerberToImage('invalid.zip')
      .toThrow(new Error('Archive does not exist.')),
  );
});

test('Archive with incomplete set of layers should throw an error', () => {
  expect(() => fileProc.gerberToImage(incompleteGerber).toThrow(Error));
});

test('Gerber archive should resolve promise and return a filename of an image', () => {
  expect.assertions(1);
  return expect(fileProc.gerberToImage(testGerber)).resolves.toEqual(
    expect.stringContaining('Arduino-Pro-Mini.png'),
  );
});

// gerberToStream
test('Gerber archive should resolve promise and return a png stream', () => {
  expect.assertions(1);
  return expect(fileProc.gerberToStream(testGerber)).resolves.toBeInstanceOf(
    Readable,
  );
});