import type { Dirent, Stats } from 'fs'; import { PassThrough, Readable } from 'stream'; import type { SystemError } from '../../src/util/errors/SystemError'; const portNames = [ // Integration 'Conditions', 'ContentNegotiation', 'DynamicPods', 'ExpiringDataCleanup', 'GlobalQuota', 'Identity', 'LpdHandlerWithAuth', 'LpdHandlerWithoutAuth', 'Middleware', 'N3Patch', 'PermissionTable', 'PodCreation', 'PodQuota', 'RedisLocker', 'RestrictedIdentity', 'SeedingPods', 'ServerFetch', 'SetupMemory', 'SparqlStorage', 'Subdomains', 'WebSocketsProtocol', // Unit 'BaseHttpServerFactory', ] as const; export function getPort(name: typeof portNames[number]): number { const idx = portNames.indexOf(name); // Just in case something doesn't listen to the typings if (idx < 0) { throw new Error(`Unknown port name ${name}`); } return 6000 + idx; } export function describeIf(envFlag: string, name: string, fn: () => void): void { const flag = `TEST_${envFlag.toUpperCase()}`; const enabled = !/^(|0|false)$/iu.test(process.env[flag] ?? ''); // eslint-disable-next-line jest/valid-describe-callback, jest/valid-title, jest/no-disabled-tests return enabled ? describe(name, fn) : describe.skip(name, fn); } /** * This is needed when you want to wait for all promises to resolve. * Also works when using jest.useFakeTimers(). * For more details see the links below * - https://github.com/facebook/jest/issues/2157 * - https://stackoverflow.com/questions/52177631/jest-timer-and-promise-dont-work-well-settimeout-and-async-function */ export async function flushPromises(): Promise { return new Promise(jest.requireActual('timers').setImmediate); } /** * Mocks (some) functions of the fs system library. * It is important that you call `jest.mock('fs');` in your test file before calling this!!! * * This function will return an object of which the `data` field corresponds to the contents of the root folder. * The file system can be "reset" by assigning an empty object (`{}`) to the data field. * * Only files and directories are supported. * Files are stored as strings, directories as objects with the keys corresponding to its contents. * File path `/folder/folder2/file` will correspond to `data['folder']['folder2']['file']`. * This can both be used to check if a file/directory was created, * or to specify in advance certain files on the "file system". * * Data streams will be converted to strings for files by concatenating the contents. * * @param rootFilepath - The name of the root folder in which fs will start. * @param time - The date object to use for time functions (currently only mtime from lstats) */ export function mockFileSystem(rootFilepath?: string, time?: Date): { data: any } { const cache: { data: any } = { data: {}}; rootFilepath = rootFilepath ?? 'folder'; time = time ?? new Date(); // eslint-disable-next-line unicorn/consistent-function-scoping function throwSystemError(code: string): void { const error = new Error('error') as SystemError; error.code = code; error.syscall = 'this exists for isSystemError'; throw error; } function getFolder(path: string): { folder: any; name: string } { let parts = path.slice(rootFilepath!.length).split('/').filter((part): boolean => part.length > 0); if (parts.length === 0) { return { folder: cache, name: 'data' }; } const name = parts.slice(-1)[0]; parts = parts.slice(0, -1); let folder = cache.data; parts.forEach((part): any => { if (typeof folder === 'string') { throwSystemError('ENOTDIR'); } folder = folder[part]; if (!folder) { throwSystemError('ENOENT'); } }); return { folder, name }; } const mockFs = { createReadStream(path: string): any { const { folder, name } = getFolder(path); return Readable.from([ folder[name] ]); }, createWriteStream(path: string): any { const { folder, name } = getFolder(path); folder[name] = ''; const stream = new PassThrough(); stream.on('data', (data): any => { folder[name] += data; }); stream.on('end', (): any => stream.emit('finish')); return stream; }, promises: { async stat(path: string): Promise { return this.lstat(await this.realpath(path)); }, async lstat(path: string): Promise { const { folder, name } = getFolder(path); if (!folder[name]) { throwSystemError('ENOENT'); } return { isFile: (): boolean => typeof folder[name] === 'string', isDirectory: (): boolean => typeof folder[name] === 'object', isSymbolicLink: (): boolean => typeof folder[name] === 'symbol', size: typeof folder[name] === 'string' ? folder[name].length : 4, mtime: time, } as Stats; }, async unlink(path: string): Promise { const { folder, name } = getFolder(path); if (!folder[name]) { throwSystemError('ENOENT'); } if (!(await this.lstat(path)).isFile()) { throwSystemError('EISDIR'); } // eslint-disable-next-line @typescript-eslint/no-dynamic-delete delete folder[name]; }, async symlink(target: string, path: string): Promise { const { folder, name } = getFolder(path); folder[name] = Symbol(target); }, async realpath(path: string): Promise { const { folder, name } = getFolder(path); const entry = folder[name]; return typeof entry === 'symbol' ? entry.description ?? 'invalid' : path; }, async rm(path: string): Promise { const { folder, name } = getFolder(path); if (!folder[name]) { throwSystemError('ENOENT'); } if (Object.keys(folder[name]).length > 0) { throwSystemError('ENOTEMPTY'); } if (!(await this.lstat(path)).isDirectory()) { throwSystemError('ENOTDIR'); } // eslint-disable-next-line @typescript-eslint/no-dynamic-delete delete folder[name]; }, async readdir(path: string): Promise { const { folder, name } = getFolder(path); if (!folder[name]) { throwSystemError('ENOENT'); } return Object.keys(folder[name]); }, async* opendir(path: string): AsyncIterableIterator { const { folder, name } = getFolder(path); if (!folder[name]) { throwSystemError('ENOENT'); } for (const [ child, entry ] of Object.entries(folder[name])) { yield { name: child, isFile: (): boolean => typeof entry === 'string', isDirectory: (): boolean => typeof entry === 'object', isSymbolicLink: (): boolean => typeof entry === 'symbol', } as Dirent; } }, async mkdir(path: string): Promise { const { folder, name } = getFolder(path); if (folder[name]) { throwSystemError('EEXIST'); } folder[name] = {}; }, async readFile(path: string): Promise { const { folder, name } = getFolder(path); if (!folder[name]) { throwSystemError('ENOENT'); } return folder[name]; }, async writeFile(path: string, data: string): Promise { const { folder, name } = getFolder(path); folder[name] = data; }, async rename(path: string, destination: string): Promise { const { folder, name } = getFolder(path); if (!folder[name]) { throwSystemError('ENOENT'); } if (!(await this.lstat(path)).isFile()) { throwSystemError('EISDIR'); } const { folder: folderDest, name: nameDest } = getFolder(destination); folderDest[nameDest] = folder[name]; // eslint-disable-next-line @typescript-eslint/no-dynamic-delete delete folder[name]; }, }, }; const mockFsExtra = { async readJson(path: string): Promise> { const { folder, name } = getFolder(path); if (!folder[name]) { throwSystemError('ENOENT'); } return JSON.parse(folder[name]); }, async writeJson(path: string, json: NodeJS.Dict): Promise { const { folder, name } = getFolder(path); const data = JSON.stringify(json, null, 2); folder[name] = data; }, async ensureDir(path: string): Promise { const { folder, name } = getFolder(path); folder[name] = {}; }, async remove(path: string): Promise { const { folder, name } = getFolder(path); // eslint-disable-next-line @typescript-eslint/no-dynamic-delete delete folder[name]; }, createReadStream(path: string): any { return mockFs.createReadStream(path); }, createWriteStream(path: string): any { return mockFs.createWriteStream(path); }, async realpath(path: string): Promise { return await mockFs.promises.realpath(path); }, async stat(path: string): Promise { return mockFs.promises.lstat(await mockFs.promises.realpath(path)); }, async lstat(path: string): Promise { return mockFs.promises.lstat(path); }, async unlink(path: string): Promise { await mockFs.promises.unlink(path); }, async symlink(target: string, path: string): Promise { await mockFs.promises.symlink(target, path); }, async rm(path: string): Promise { await mockFs.promises.rm(path); }, async readdir(path: string): Promise { return await mockFs.promises.readdir(path); }, async* opendir(path: string): AsyncIterableIterator { for await (const entry of mockFs.promises.opendir(path)) { yield entry; } }, async mkdir(path: string): Promise { await mockFs.promises.mkdir(path); }, async readFile(path: string): Promise { return await mockFs.promises.readFile(path); }, async writeFile(path: string, data: string): Promise { await mockFs.promises.writeFile(path, data); }, async rename(path: string, destination: string): Promise { await mockFs.promises.rename(path, destination); }, }; const fs = jest.requireMock('fs'); Object.assign(fs, mockFs); const fsExtra = jest.requireMock('fs-extra'); Object.assign(fsExtra, mockFsExtra); return cache; }