github/directus
1
1
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-04-25 03:00:53 -04:00
Code Issues Packages Projects Releases Wiki Activity

Unit tests for get-extensions.ts (#8470)

Browse Source 
* root removed

* get extensions passing, 95% coverage

* removed root

* fixed root on listExtensionsChildren
This commit is contained in:
Jay Cammarano
2021-10-01 11:01:33 -04:00
committed by GitHub
parent e493639a48
commit 2be2c36dc2
5 changed files with 141 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/shared/src/utils/node/generate-extensions-entry.test.ts
View File

@@ -5,18 +5,14 @@ import { Extension } from '../../types/extensions';
describe('generateExtensionsEntry', () => {
const type = APP_EXTENSION_TYPES[4];
it('returns an extension entrypoint exporting all extensions with a type that matches the provided type', () => {
const mockExtension = [
{ path: './extensions', name: 'mockExtension', type: 'panel', local: true, root: true },
] as Extension[];
const mockExtension = [{ path: './extensions', name: 'mockExtension', type: 'panel', local: true }] as Extension[];
expect(generateExtensionsEntry(type, mockExtension)).toBe(
`import e0 from './extensions';
export default [e0];`
);
});
it('returns an empty extension entrypoint if there is no extension with the provided type', () => {
const mockExtension = [
{ path: './extensions', name: 'mockExtension', type: 'pack', local: true, root: true },
] as Extension[];
const mockExtension = [{ path: './extensions', name: 'mockExtension', type: 'pack', local: true }] as Extension[];
expect(generateExtensionsEntry(type, mockExtension)).toBe(`export default [];`);
});
});

137
packages/shared/src/utils/node/get-extensions.test.ts Normal file
View File

@@ -0,0 +1,137 @@
import { EXTENSION_PACKAGE_TYPES, EXTENSION_TYPES } from '../../constants/extensions';
import { getLocalExtensions, getPackageExtensions } from './get-extensions';
import { SynchrounousResult, dirSync } from 'tmp';
import { ensureDirSync, writeJsonSync } from 'fs-extra';
describe('getPackageExtensions', () => {
let rootPackageDir: SynchrounousResult;
let noPackageDir: SynchrounousResult;
beforeEach(() => {
noPackageDir = dirSync({ prefix: './' } as any);
rootPackageDir = dirSync({ unsafeCleanup: true, tmpdir: './' } as any);
});
afterEach(() => {
noPackageDir.removeCallback();
rootPackageDir.removeCallback();
});
it('throws an error when no package.json is found', async () => {
const error = async () => await getPackageExtensions(noPackageDir.name, EXTENSION_PACKAGE_TYPES);
expect(error).rejects.toThrow(`Current folder does not contain a package.json file`);
});
it('returns an array of extensions based on package.json', async () => {
const childPackage = dirSync({ tmpdir: rootPackageDir.name } as any);
writeJsonSync(`${childPackage.name}/package.json`, {
name: `${childPackage.name}`,
dependencies: {
'directus-extension-test': '0.1',
},
});
ensureDirSync(`${childPackage.name}/directus-extension-test/`);
writeJsonSync(`${childPackage.name}/directus-extension-test/package.json`, {
name: 'test',
version: '0.1',
dependencies: {},
'directus:extension': { type: 'pack', path: './', source: 'test', host: 'localhost', hidden: true },
});
expect(await getPackageExtensions(childPackage.name, EXTENSION_PACKAGE_TYPES)).toStrictEqual([
{
children: [],
host: 'localhost',
local: false,
name: 'directus-extension-test',
path: childPackage.name + '/directus-extension-test',
type: 'pack',
version: '0.1',
},
]);
});
it('returns an error when validateExtensionManifest fails', async () => {
const errorPackage = dirSync({ unsafeCleanup: true, tmpdir: rootPackageDir.name } as any);
expect(getPackageExtensions(errorPackage.name, EXTENSION_PACKAGE_TYPES)).rejects.toThrowError(
`Current folder does not contain a package.json file`
);
});
it('returns an error when validateExtensionManifest fails', async () => {
const typePackage = dirSync({ unsafeCleanup: true, tmpdir: rootPackageDir.name } as any);
writeJsonSync(`${typePackage.name}/package.json`, {
name: `${typePackage.name}`,
dependencies: {
'directus-extension-type': '0.1',
},
});
ensureDirSync(`${typePackage.name}/node_modules/directus-extension-type/`);
writeJsonSync(`${typePackage.name}/node_modules/directus-extension-type/package.json`, {
name: 'test',
version: '0.1',
dependencies: {},
'directus:extension': { type: 'interface', path: './', source: 'test', host: 'localhost', hidden: true },
});
expect(await getPackageExtensions(typePackage.name, EXTENSION_PACKAGE_TYPES)).toStrictEqual([
{
host: 'localhost',
entrypoint: './',
local: false,
name: 'directus-extension-type',
path: typePackage.name + '/node_modules/directus-extension-type',
type: 'interface',
version: '0.1',
},
]);
});
});
describe('getLocalExtensions', () => {
let rootLocalPackage: SynchrounousResult;
beforeEach(() => {
rootLocalPackage = dirSync({ unsafeCleanup: true, tmpdir: './' } as any);
});
afterEach(() => {
rootLocalPackage.removeCallback();
});
it(`throws an error when the extension folder can not be opened`, async () => {
expect(async () => {
await getLocalExtensions(rootLocalPackage.name, EXTENSION_TYPES);
}).rejects.toThrowError(`Extension folder "${rootLocalPackage.name}/interfaces" couldn't be opened`);
});
it(`returns an array of local extensions`, async () => {
const extensionPackages: any = [];
writeJsonSync(`${rootLocalPackage.name}/package.json`, {
name: 'test',
version: '0.1',
dependencies: {},
});
EXTENSION_TYPES.forEach((type) => {
ensureDirSync(`${rootLocalPackage.name}/${type}s/`);
writeJsonSync(`${rootLocalPackage.name}/${type}s/package.json`, {
name: `${rootLocalPackage.name}-${type}`,
dependencies: {
'directus-extension-test': '0.1',
},
});
ensureDirSync(`${rootLocalPackage.name}/${type}s/directus-extension-test`);
extensionPackages.push({
entrypoint: 'index.js',
local: true,
name: 'directus-extension-test',
path: `${rootLocalPackage.name}/${type}s/directus-extension-test`,
type: type,
});
});
expect(await getLocalExtensions(rootLocalPackage.name, EXTENSION_TYPES)).toStrictEqual(extensionPackages);
});
});

7
packages/shared/src/utils/node/get-extensions.ts
View File

@@ -18,9 +18,9 @@ export async function getPackageExtensions(root: string, types: readonly Extensi
const extensionNames = Object.keys(pkg.dependencies ?? {}).filter((dep) => EXTENSION_NAME_REGEX.test(dep));
return listExtensionsChildren(extensionNames);
return listExtensionsChildren(extensionNames, root);
async function listExtensionsChildren(extensionNames: string[], root?: string) {
async function listExtensionsChildren(extensionNames: string[], root: string) {
const extensions: Extension[] = [];
for (const extensionName of extensionNames) {
@@ -45,7 +45,6 @@ export async function getPackageExtensions(root: string, types: readonly Extensi
host: extensionManifest[EXTENSION_PKG_KEY].host,
children: extensionChildren,
local: false,
root: root === undefined,
};
extensions.push(extension);
@@ -59,7 +58,6 @@ export async function getPackageExtensions(root: string, types: readonly Extensi
entrypoint: extensionManifest[EXTENSION_PKG_KEY].path,
host: extensionManifest[EXTENSION_PKG_KEY].host,
local: false,
root: root === undefined,
});
}
}
@@ -88,7 +86,6 @@ export async function getLocalExtensions(root: string, types: readonly Extension
type: extensionType,
entrypoint: 'index.js',
local: true,
root: true,
});
}
} catch {