Skip to content

Commit

Permalink
test: remove mocks from system (faker-js#303)
Browse files Browse the repository at this point in the history
  • Loading branch information
@prisis @demipel8
prisis authored and demipel8 committed Mar 11, 2022
1 parent 9eec7e3 commit c57bd7c
Showing 1 changed file with 245 additions and 54 deletions.
299 changes: 245 additions & 54 deletions test/system.spec.ts
View file
Original file line number Diff line number Diff line change
@@ -1,74 +1,265 @@
import { describe, expect, it, vi } from 'vitest';
import { afterEach, describe, expect, it } from 'vitest';
import validator from 'validator';
import { faker } from '../dist/cjs';

describe('system', () => {
describe('directoryPath()', () => {
it('returns unix fs directory full path', () => {
const spy_random_words = vi
.spyOn(faker.random, 'words')
.mockReturnValue('24/7');
// TODO @prisis 2022-01-31: Add multiple seed based expectations.
const seededRuns = [
{
seed: 42,
expectations: {
fileName: 'mobile_application.wad',
commonFileName: 'mobile_application.gif',
mimeType: 'application/vnd.marlin.drm.license+xml',
commonFileType: 'audio',
commonFileExt: 'png',
fileType: 'image',
fileExt: 'chm',
directoryPath: '/opt/bin',
// TODO @prisis 2022-01-25: add a parameter to have the possibility to have one or two ext on file.
filePath: '/opt/bin/directives_multi_byte_table.p10.m21',
semver: '3.7.9',
},
},
{
seed: 1337,
expectations: {
fileName: 'delaware.vcg',
commonFileName: 'delaware.wav',
mimeType: 'application/vnd.dxr',
commonFileType: 'audio',
commonFileExt: 'wav',
fileType: 'font',
fileExt: 'gxt',
directoryPath: '/Library',
// TODO @prisis 2022-01-25: add a parameter to have the possibility to have one or two ext on file.
filePath: '/Library/bike_kiribati.kpr.ez3',
semver: '2.5.1',
},
},
{
seed: 1211,
expectations: {
fileName: 'turnpike_cross_platform_handcrafted.mka',
commonFileName: 'turnpike_cross_platform_handcrafted.mp4v',
mimeType: 'text/vnd.fmi.flexstor',
commonFileType: 'application',
commonFileExt: 'htm',
fileType: 'x-shader',
fileExt: 'opml',
directoryPath: '/var/log',
// TODO @prisis 2022-01-25: add a parameter to have the possibility to have one or two ext on file.
filePath: '/var/log/forward_frozen.swf.fcdt',
semver: '9.4.8',
},
},
];

const directoryPath = faker.system.directoryPath();
const NON_SEEDED_BASED_RUN = 5;

expect(
directoryPath.indexOf('/'),
'generated directoryPath should start with /'
).toBe(0);
const functionNames = [
'commonFileExt',
'commonFileName',
'commonFileType',
'directoryPath',
'fileExt',
'fileName',
'filePath',
'fileType',
'mimeType',
'semver',
];

spy_random_words.mockRestore();
});
describe('system', () => {
afterEach(() => {
faker.locale = 'en';
});

describe('filePath()', () => {
it('returns unix fs file full path', () => {
const spy_random_words = vi
.spyOn(faker.random, 'words')
.mockReturnValue('24/7');
for (const { seed, expectations } of seededRuns) {
describe(`seed: ${seed}`, () => {
for (const functionName of functionNames) {
it(`${functionName}()`, () => {
faker.seed(seed);

const filePath = faker.system.filePath();
const actual = faker.system[functionName]();
expect(actual).toEqual(expectations[functionName]);
});
}
});
}

expect(
filePath.indexOf('/'),
'generated filePath should start with /'
).toBe(0);
// Create and log-back the seed for debug purposes
faker.seed(Math.ceil(Math.random() * 1_000_000_000));

spy_random_words.mockRestore();
});
});
describe(`random seeded tests for seed ${faker.seedValue}`, () => {
for (let i = 1; i <= NON_SEEDED_BASED_RUN; i++) {
describe('commonFileExt()', () => {
it('should return common file types', () => {
const fileExt = faker.system.commonFileExt();
const extList = [
'pdf',
'mpeg',
'wav',
'png',
'jpeg',
'gif',
'mp4v',
'mpeg',
'htm',
'm2a',
'mp4',
'mpg',
];

describe('fileName()', () => {
it('returns filenames without system path separators', () => {
const spy_random_words = vi
.spyOn(faker.random, 'words')
.mockReturnValue('24/7');
expect(
extList,
`generated common file ext should be one of [${extList.join(
','
)}]. Got "${fileExt}".`
).include(fileExt);
});
});

const fileName = faker.system.fileName();
describe('commonFileName()', () => {
it('should return common file name without system path separators', () => {
const commonFileName = faker.system.commonFileName();

expect(
fileName.indexOf('/'),
'generated fileNames should not have path separators'
).toBe(-1);
expect(
commonFileName,
'generated common file name should not have path separators'
).not.toContain('/');
});

spy_random_words.mockRestore();
});
});
it('should return common file name with ext on the end', () => {
const fileName = faker.system.commonFileName();

describe('commonFileName()', () => {
it('returns filenames without system path separators', () => {
const spy_random_words = vi
.spyOn(faker.random, 'words')
.mockReturnValue('24/7');
expect(
fileName,
'generated common file name should have a extension'
).toContain('.');
});

const fileName =
// @ts-expect-error
faker.system.commonFileName();
it('should return common file name with given ext', () => {
const fileName = faker.system.commonFileName('txt');

expect(
fileName.indexOf('/'),
'generated commonFileNames should not have path separators'
).toBe(-1);
expect(
fileName,
'generated common file name should not have path separators'
).not.toContain('/');
expect(
fileName,
'generated common file name should have given ext'
).toContain('txt');
});
});

spy_random_words.mockRestore();
});
describe('commonFileType()', () => {
it('should return common file types', () => {
const fileType = faker.system.commonFileType();
const fileTypes = ['application', 'audio', 'image', 'text', 'video'];

expect(
fileTypes,
`generated common file type should contain one of [${fileTypes.join(
','
)}]. Got "${fileType}".`
).toContain(fileType);
});
});

describe('directoryPath()', () => {
it('should return unix fs directory full path', () => {
const directoryPath = faker.system.directoryPath();

expect(
directoryPath.startsWith('/'),
'generated directoryPath should start with /'
).toBeTruthy();
});
});

describe('fileExt()', () => {
it('should return file ext', () => {
const fileExt = faker.system.fileExt();

expect(
fileExt.length,
'generated fileExt should start with ."'
).toBeGreaterThan(1);
});

it('should return file ext based on mimeType', () => {
const fileExt = faker.system.fileExt('text/plain');
const extList = [
'txt',
'text',
'conf',
'def',
'list',
'log',
'in',
'ini',
];

expect(
extList,
`generated common file ext should be one of [${extList.join(
','
)}]. Got "${fileExt}".`
).include(fileExt);
});
});

describe('fileName()', () => {
it('should return filenames without system path separators', () => {
const fileName = faker.system.fileName();

expect(
fileName.startsWith('/'),
'generated fileNames should not have path separators'
).toBeFalsy();
});

it('should return filenames with ext on the end', () => {
const fileName = faker.system.fileName();

expect(
fileName,
'generated fileNames should have an extension'
).toContain('.');
});
});

describe('filePath()', () => {
it('should return unix fs file full path', () => {
const filePath = faker.system.filePath();

expect(
filePath.startsWith('/'),
'generated filePath should start with /'
).toBeTruthy();
// TODO @prisis 2022-01-26: Add test to validate if the path has ext on the end.
});
});

describe('mimeType()', () => {
it('should return mime types', () => {
const mimeType = faker.system.mimeType();

expect(
mimeType,
`generated mime types should be valid mime types.`
).satisfy(validator.isMimeType);
});
});

describe('semver()', () => {
it('should return semver', () => {
expect(
faker.system.semver(),
`generated semver, first number should be between 0 and 9.`
).satisfy(validator.isSemVer);
});
});
}
});
});

0 comments on commit c57bd7c

Please sign in to comment.