Merge pull request #20423 from backstage/rugvip/no-mocks-man
backend-plugin-manager: refactor tests to avoid mock-fs
This commit is contained in:
@@ -55,7 +55,6 @@
|
||||
"@backstage/backend-test-utils": "workspace:^",
|
||||
"@backstage/cli": "workspace:^",
|
||||
"@backstage/config-loader": "workspace:^",
|
||||
"mock-fs": "^5.2.0",
|
||||
"wait-for-expect": "^3.0.2"
|
||||
},
|
||||
"files": [
|
||||
|
||||
@@ -20,10 +20,9 @@ import {
|
||||
coreServices,
|
||||
createServiceFactory,
|
||||
} from '@backstage/backend-plugin-api';
|
||||
import mockFs, { directory, symlink } from 'mock-fs';
|
||||
import * as path from 'path';
|
||||
import * as url from 'url';
|
||||
|
||||
import fs from 'fs';
|
||||
import {
|
||||
BackendDynamicPlugin,
|
||||
BaseDynamicPlugin,
|
||||
@@ -43,11 +42,13 @@ import { ConfigSources } from '@backstage/config-loader';
|
||||
import { Logs, MockedLogger, LogContent } from '../__testUtils__/testUtils';
|
||||
import { PluginScanner } from '../scanner/plugin-scanner';
|
||||
import { findPaths } from '@backstage/cli-common';
|
||||
import { createMockDirectory } from '@backstage/backend-test-utils';
|
||||
|
||||
describe('backend-plugin-manager', () => {
|
||||
const mockDir = createMockDirectory();
|
||||
|
||||
describe('loadPlugins', () => {
|
||||
afterEach(() => {
|
||||
mockFs.restore();
|
||||
jest.resetModules();
|
||||
});
|
||||
|
||||
@@ -56,7 +57,7 @@ describe('backend-plugin-manager', () => {
|
||||
packageManifest: ScannedPluginManifest;
|
||||
indexFile?: {
|
||||
retativePath: string[];
|
||||
content?: string;
|
||||
content: string;
|
||||
};
|
||||
expectedLogs?(location: URL): {
|
||||
errors?: LogContent[];
|
||||
@@ -354,17 +355,13 @@ describe('backend-plugin-manager', () => {
|
||||
},
|
||||
])('$name', async (tc: TestCase): Promise<void> => {
|
||||
const plugin: ScannedPluginPackage = {
|
||||
location: url.pathToFileURL(
|
||||
path.resolve(`/node_modules/jest-tests/${randomUUID()}`),
|
||||
),
|
||||
location: url.pathToFileURL(mockDir.resolve(randomUUID())),
|
||||
manifest: tc.packageManifest,
|
||||
};
|
||||
|
||||
const mockedFiles = {
|
||||
[path.join(url.fileURLToPath(plugin.location), 'package.json')]:
|
||||
mockFs.file({
|
||||
content: JSON.stringify(plugin),
|
||||
}),
|
||||
JSON.stringify(plugin),
|
||||
};
|
||||
if (tc.indexFile) {
|
||||
mockedFiles[
|
||||
@@ -372,11 +369,9 @@ describe('backend-plugin-manager', () => {
|
||||
url.fileURLToPath(plugin.location),
|
||||
...tc.indexFile.retativePath,
|
||||
)
|
||||
] = mockFs.file({
|
||||
content: tc.indexFile.content,
|
||||
});
|
||||
] = tc.indexFile.content;
|
||||
}
|
||||
mockFs(mockedFiles);
|
||||
mockDir.setContent(mockedFiles);
|
||||
|
||||
const logger = new MockedLogger();
|
||||
const pluginManager = new (PluginManager as any)(logger, [plugin], {
|
||||
@@ -440,8 +435,11 @@ describe('backend-plugin-manager', () => {
|
||||
});
|
||||
|
||||
describe('dynamicPluginsServiceFactory', () => {
|
||||
const otherMockDir = createMockDirectory();
|
||||
|
||||
afterEach(() => {
|
||||
mockFs.restore();
|
||||
mockDir.clear();
|
||||
otherMockDir.clear();
|
||||
jest.resetModules();
|
||||
});
|
||||
|
||||
@@ -449,15 +447,20 @@ describe('backend-plugin-manager', () => {
|
||||
const logger = new MockedLogger();
|
||||
const rootLogger = new MockedLogger();
|
||||
|
||||
mockFs({
|
||||
[findPaths(__dirname).resolveTargetRoot('package.json')]: mockFs.load(
|
||||
mockDir.setContent({
|
||||
'package.json': fs.readFileSync(
|
||||
findPaths(__dirname).resolveTargetRoot('package.json'),
|
||||
),
|
||||
'/somewhere/dynamic-plugins-root/a-dynamic-plugin': symlink({
|
||||
path: '/somewhere-else/a-dynamic-plugin',
|
||||
}),
|
||||
'/somewhere-else/a-dynamic-plugin': directory({}),
|
||||
'dynamic-plugins-root': {},
|
||||
});
|
||||
otherMockDir.setContent({
|
||||
'a-dynamic-plugin': {},
|
||||
});
|
||||
|
||||
fs.symlinkSync(
|
||||
otherMockDir.resolve('a-dynamic-plugin'),
|
||||
mockDir.resolve('dynamic-plugins-root/a-dynamic-plugin'),
|
||||
);
|
||||
|
||||
const fromConfigSpier = jest.spyOn(PluginManager, 'fromConfig');
|
||||
const applyConfigSpier = jest
|
||||
@@ -468,7 +471,7 @@ describe('backend-plugin-manager', () => {
|
||||
.mockImplementation(async () => [
|
||||
{
|
||||
location: url.pathToFileURL(
|
||||
path.resolve('/somewhere/dynamic-plugins-root/a-dynamic-plugin'),
|
||||
mockDir.resolve('dynamic-plugins-root/a-dynamic-plugin'),
|
||||
),
|
||||
manifest: {
|
||||
name: 'test',
|
||||
@@ -533,11 +536,11 @@ describe('backend-plugin-manager', () => {
|
||||
expect(scanRootSpier).toHaveBeenCalled();
|
||||
expect(mockedModuleLoader.bootstrap).toHaveBeenCalledWith(
|
||||
findPaths(__dirname).targetRoot,
|
||||
[path.resolve('/somewhere-else/a-dynamic-plugin')],
|
||||
[fs.realpathSync(otherMockDir.resolve('a-dynamic-plugin'))],
|
||||
);
|
||||
expect(mockedModuleLoader.load).toHaveBeenCalledWith(
|
||||
path.resolve(
|
||||
'/somewhere/dynamic-plugins-root/a-dynamic-plugin/dist/index.cjs.js',
|
||||
mockDir.resolve(
|
||||
'dynamic-plugins-root/a-dynamic-plugin/dist/index.cjs.js',
|
||||
),
|
||||
);
|
||||
});
|
||||
|
||||
@@ -15,13 +15,16 @@
|
||||
*/
|
||||
|
||||
import { PluginScanner } from './plugin-scanner';
|
||||
import mockFs from 'mock-fs';
|
||||
import { JsonObject } from '@backstage/types';
|
||||
import { Logs, MockedLogger } from '../__testUtils__/testUtils';
|
||||
import { ConfigReader } from '@backstage/config';
|
||||
import path from 'path';
|
||||
import fs from 'fs';
|
||||
import * as url from 'url';
|
||||
import { ScannedPluginPackage } from './types';
|
||||
import { createMockDirectory } from '@backstage/backend-test-utils';
|
||||
|
||||
const mockDir = createMockDirectory();
|
||||
|
||||
describe('plugin-scanner', () => {
|
||||
const env = process.env;
|
||||
@@ -30,7 +33,7 @@ describe('plugin-scanner', () => {
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
mockFs.restore();
|
||||
mockDir.clear();
|
||||
process.env = env;
|
||||
});
|
||||
|
||||
@@ -61,85 +64,77 @@ describe('plugin-scanner', () => {
|
||||
},
|
||||
{
|
||||
name: 'valid config with relative root directory path',
|
||||
backstageRoot: '/backstageRoot',
|
||||
backstageRoot: mockDir.resolve('backstageRoot'),
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory(),
|
||||
},
|
||||
}),
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {},
|
||||
},
|
||||
},
|
||||
config: {
|
||||
dynamicPlugins: {
|
||||
rootDirectory: 'dist-dynamic',
|
||||
},
|
||||
},
|
||||
expectedRootDirectory: path.resolve('/backstageRoot/dist-dynamic'),
|
||||
expectedRootDirectory: mockDir.resolve('backstageRoot/dist-dynamic'),
|
||||
},
|
||||
{
|
||||
name: 'valid config with absolute root directory path inside the backstage root',
|
||||
backstageRoot: '/backstageRoot',
|
||||
backstageRoot: mockDir.resolve('backstageRoot'),
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory(),
|
||||
},
|
||||
}),
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {},
|
||||
},
|
||||
},
|
||||
config: {
|
||||
dynamicPlugins: {
|
||||
rootDirectory: '/backstageRoot/dist-dynamic',
|
||||
rootDirectory: mockDir.resolve('backstageRoot/dist-dynamic'),
|
||||
},
|
||||
},
|
||||
expectedRootDirectory: path.resolve('/backstageRoot/dist-dynamic'),
|
||||
expectedRootDirectory: mockDir.resolve('backstageRoot/dist-dynamic'),
|
||||
},
|
||||
{
|
||||
name: 'valid config with absolute root directory path outside the backstage root',
|
||||
backstageRoot: '/backstageRoot',
|
||||
backstageRoot: mockDir.resolve('backstageRoot'),
|
||||
fileSystem: {
|
||||
'/somewhere': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory(),
|
||||
},
|
||||
}),
|
||||
somewhere: {
|
||||
'dist-dynamic': {},
|
||||
},
|
||||
},
|
||||
config: {
|
||||
dynamicPlugins: {
|
||||
rootDirectory: '/somewhere/dist-dynamic',
|
||||
rootDirectory: mockDir.resolve('somewhere/dist-dynamic'),
|
||||
},
|
||||
},
|
||||
expectedError: `Dynamic plugins under '${path.resolve(
|
||||
'/somewhere/dist-dynamic',
|
||||
)}' cannot access backstage modules in '${path.resolve(
|
||||
'/backstageRoot/node_modules',
|
||||
expectedError: `Dynamic plugins under '${mockDir.resolve(
|
||||
'somewhere/dist-dynamic',
|
||||
)}' cannot access backstage modules in '${mockDir.resolve(
|
||||
'backstageRoot/node_modules',
|
||||
)}'.
|
||||
Please add '${path.resolve(
|
||||
'/backstageRoot/node_modules',
|
||||
Please add '${mockDir.resolve(
|
||||
'backstageRoot/node_modules',
|
||||
)}' to the 'NODE_PATH' when running the backstage backend.`,
|
||||
},
|
||||
{
|
||||
name: 'valid config with absolute root directory path outside the backstage root but with backstage root included in NODE_PATH',
|
||||
backstageRoot: '/backstageRoot',
|
||||
backstageRoot: mockDir.resolve('backstageRoot'),
|
||||
fileSystem: {
|
||||
'/somewhere': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory(),
|
||||
},
|
||||
}),
|
||||
somewhere: {
|
||||
'dist-dynamic': {},
|
||||
},
|
||||
},
|
||||
config: {
|
||||
dynamicPlugins: {
|
||||
rootDirectory: '/somewhere/dist-dynamic',
|
||||
rootDirectory: mockDir.resolve('somewhere/dist-dynamic'),
|
||||
},
|
||||
},
|
||||
environment: {
|
||||
NODE_PATH: `${path.resolve('/somewhere-else')}${
|
||||
NODE_PATH: `${mockDir.resolve('somewhere-else')}${
|
||||
path.delimiter
|
||||
}${path.resolve('/backstageRoot', 'node_modules')}${
|
||||
}${mockDir.resolve('backstageRoot', 'node_modules')}${
|
||||
path.delimiter
|
||||
}${path.resolve('anywhere-else')}`,
|
||||
}${mockDir.resolve('anywhere-else')}`,
|
||||
},
|
||||
expectedRootDirectory: path.resolve('/somewhere/dist-dynamic'),
|
||||
expectedRootDirectory: mockDir.resolve('somewhere/dist-dynamic'),
|
||||
},
|
||||
{
|
||||
name: 'invalid config: dynamicPlugins not an object',
|
||||
@@ -186,13 +181,11 @@ Please add '${path.resolve(
|
||||
},
|
||||
{
|
||||
name: 'valid config pointing to a file instead of a directory',
|
||||
backstageRoot: '/backstageRoot',
|
||||
backstageRoot: mockDir.resolve('backstageRoot'),
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.file(),
|
||||
},
|
||||
}),
|
||||
backstageRoot: {
|
||||
'dist-dynamic': '',
|
||||
},
|
||||
},
|
||||
config: {
|
||||
dynamicPlugins: {
|
||||
@@ -218,7 +211,7 @@ Please add '${path.resolve(
|
||||
);
|
||||
}
|
||||
if (tc.fileSystem) {
|
||||
mockFs(tc.fileSystem);
|
||||
mockDir.setContent(tc.fileSystem);
|
||||
}
|
||||
if (tc.expectedError) {
|
||||
/* eslint-disable-next-line jest/no-conditional-expect */
|
||||
@@ -241,6 +234,7 @@ Please add '${path.resolve(
|
||||
name: string;
|
||||
preferAlpha?: boolean;
|
||||
fileSystem?: any;
|
||||
symlinks?: { source: string; target: string }[];
|
||||
expectedLogs?: Logs;
|
||||
expectedPluginPackages?: ScannedPluginPackage[];
|
||||
expectedError?: string;
|
||||
@@ -261,31 +255,23 @@ Please add '${path.resolve(
|
||||
{
|
||||
name: 'manifest found in directory',
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin': mockFs.directory({
|
||||
items: {
|
||||
'package.json': mockFs.file({
|
||||
content: JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
}),
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {
|
||||
'test-backend-plugin': {
|
||||
'package.json': JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
},
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
expectedPluginPackages: [
|
||||
{
|
||||
location: url.pathToFileURL(
|
||||
path.resolve('/backstageRoot/dist-dynamic/test-backend-plugin'),
|
||||
mockDir.resolve('backstageRoot/dist-dynamic/test-backend-plugin'),
|
||||
),
|
||||
manifest: {
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
@@ -299,38 +285,34 @@ Please add '${path.resolve(
|
||||
{
|
||||
name: 'backend plugin found in symlink',
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin': mockFs.symlink({
|
||||
path: '/somewhere-else/test-backend-plugin-target',
|
||||
}),
|
||||
},
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {},
|
||||
},
|
||||
'somewhere-else': {
|
||||
'test-backend-plugin-target': {
|
||||
'package.json': JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
},
|
||||
}),
|
||||
'/somewhere-else': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin-target': mockFs.directory({
|
||||
items: {
|
||||
'package.json': mockFs.file({
|
||||
content: JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
symlinks: [
|
||||
{
|
||||
source: mockDir.resolve(
|
||||
'backstageRoot/dist-dynamic/test-backend-plugin',
|
||||
),
|
||||
target: mockDir.resolve(
|
||||
'somewhere-else/test-backend-plugin-target',
|
||||
),
|
||||
},
|
||||
],
|
||||
expectedPluginPackages: [
|
||||
{
|
||||
location: url.pathToFileURL(
|
||||
path.resolve('/backstageRoot/dist-dynamic/test-backend-plugin'),
|
||||
mockDir.resolve('backstageRoot/dist-dynamic/test-backend-plugin'),
|
||||
),
|
||||
manifest: {
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
@@ -344,22 +326,18 @@ Please add '${path.resolve(
|
||||
{
|
||||
name: 'ignored folder child: not a directory',
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin': mockFs.file({}),
|
||||
},
|
||||
}),
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {
|
||||
'test-backend-plugin': '',
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
expectedPluginPackages: [],
|
||||
expectedLogs: {
|
||||
infos: [
|
||||
{
|
||||
message: `skipping '${path.resolve(
|
||||
'/backstageRoot/dist-dynamic/test-backend-plugin',
|
||||
message: `skipping '${mockDir.resolve(
|
||||
'backstageRoot/dist-dynamic/test-backend-plugin',
|
||||
)}' since it is not a directory`,
|
||||
},
|
||||
],
|
||||
@@ -368,29 +346,29 @@ Please add '${path.resolve(
|
||||
{
|
||||
name: 'ignored folder child symlink: target is not a directory',
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin': mockFs.symlink({
|
||||
path: '/somewhere-else/test-backend-plugin-target',
|
||||
}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
}),
|
||||
'/somewhere-else': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin-target': mockFs.file({}),
|
||||
},
|
||||
}),
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {},
|
||||
},
|
||||
'somewhere-else': {
|
||||
'test-backend-plugin-target': '',
|
||||
},
|
||||
},
|
||||
symlinks: [
|
||||
{
|
||||
source: mockDir.resolve(
|
||||
'backstageRoot/dist-dynamic/test-backend-plugin',
|
||||
),
|
||||
target: mockDir.resolve(
|
||||
'somewhere-else/test-backend-plugin-target',
|
||||
),
|
||||
},
|
||||
],
|
||||
expectedPluginPackages: [],
|
||||
expectedLogs: {
|
||||
infos: [
|
||||
{
|
||||
message: `skipping '${path.resolve(
|
||||
'/backstageRoot/dist-dynamic/test-backend-plugin',
|
||||
message: `skipping '${mockDir.resolve(
|
||||
'backstageRoot/dist-dynamic/test-backend-plugin',
|
||||
)}' since it is not a directory`,
|
||||
},
|
||||
],
|
||||
@@ -400,42 +378,30 @@ Please add '${path.resolve(
|
||||
name: 'alpha manifest available but not preferred',
|
||||
preferAlpha: false,
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin': mockFs.directory({
|
||||
items: {
|
||||
'package.json': mockFs.file({
|
||||
content: JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
}),
|
||||
alpha: mockFs.directory({
|
||||
items: {
|
||||
'package.json': mockFs.file({
|
||||
content: JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: '../dist/alpha.cjs.js',
|
||||
}),
|
||||
}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {
|
||||
'test-backend-plugin': {
|
||||
'package.json': JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
alpha: {
|
||||
'package.json': JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: '../dist/alpha.cjs.js',
|
||||
}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
expectedPluginPackages: [
|
||||
{
|
||||
location: url.pathToFileURL(
|
||||
path.resolve('/backstageRoot/dist-dynamic/test-backend-plugin'),
|
||||
mockDir.resolve('backstageRoot/dist-dynamic/test-backend-plugin'),
|
||||
),
|
||||
manifest: {
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
@@ -450,43 +416,31 @@ Please add '${path.resolve(
|
||||
name: 'alpha manifest preferred and found in directory',
|
||||
preferAlpha: true,
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin': mockFs.directory({
|
||||
items: {
|
||||
'package.json': mockFs.file({
|
||||
content: JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
}),
|
||||
alpha: mockFs.directory({
|
||||
items: {
|
||||
'package.json': mockFs.file({
|
||||
content: JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: '../dist/alpha.cjs.js',
|
||||
}),
|
||||
}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {
|
||||
'test-backend-plugin': {
|
||||
'package.json': JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
alpha: {
|
||||
'package.json': JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: '../dist/alpha.cjs.js',
|
||||
}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
expectedPluginPackages: [
|
||||
{
|
||||
location: url.pathToFileURL(
|
||||
path.resolve(
|
||||
'/backstageRoot/dist-dynamic/test-backend-plugin/alpha',
|
||||
mockDir.resolve(
|
||||
'backstageRoot/dist-dynamic/test-backend-plugin/alpha',
|
||||
),
|
||||
),
|
||||
manifest: {
|
||||
@@ -502,32 +456,24 @@ Please add '${path.resolve(
|
||||
name: 'alpha manifest preferred but skipped because not a directory',
|
||||
preferAlpha: true,
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin': mockFs.directory({
|
||||
items: {
|
||||
'package.json': mockFs.file({
|
||||
content: JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
}),
|
||||
alpha: mockFs.file({}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
}),
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {
|
||||
'test-backend-plugin': {
|
||||
'package.json': JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
alpha: '',
|
||||
},
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
expectedPluginPackages: [
|
||||
{
|
||||
location: url.pathToFileURL(
|
||||
path.resolve('/backstageRoot/dist-dynamic/test-backend-plugin'),
|
||||
mockDir.resolve('backstageRoot/dist-dynamic/test-backend-plugin'),
|
||||
),
|
||||
manifest: {
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
@@ -540,8 +486,8 @@ Please add '${path.resolve(
|
||||
expectedLogs: {
|
||||
warns: [
|
||||
{
|
||||
message: `skipping '${path.resolve(
|
||||
'/backstageRoot/dist-dynamic/test-backend-plugin/alpha',
|
||||
message: `skipping '${mockDir.resolve(
|
||||
'backstageRoot/dist-dynamic/test-backend-plugin/alpha',
|
||||
)}' since it is not a directory`,
|
||||
},
|
||||
],
|
||||
@@ -551,40 +497,28 @@ Please add '${path.resolve(
|
||||
name: 'invalid alpha package.json',
|
||||
preferAlpha: true,
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin': mockFs.directory({
|
||||
items: {
|
||||
'package.json': mockFs.file({
|
||||
content: JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
}),
|
||||
alpha: mockFs.directory({
|
||||
items: {
|
||||
'package.json': mockFs.file({
|
||||
content: "invalid json content, 1, '",
|
||||
}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
}),
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {
|
||||
'test-backend-plugin': {
|
||||
'package.json': JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
alpha: {
|
||||
'package.json': "invalid json content, 1, '",
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
expectedPluginPackages: [],
|
||||
expectedLogs: {
|
||||
errors: [
|
||||
{
|
||||
message: `failed to load dynamic plugin manifest from '${path.resolve(
|
||||
'/backstageRoot/dist-dynamic/test-backend-plugin/alpha',
|
||||
message: `failed to load dynamic plugin manifest from '${mockDir.resolve(
|
||||
'backstageRoot/dist-dynamic/test-backend-plugin/alpha',
|
||||
)}'`,
|
||||
meta: {
|
||||
name: 'SyntaxError',
|
||||
@@ -597,28 +531,20 @@ Please add '${path.resolve(
|
||||
{
|
||||
name: 'invalid package.json',
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin': mockFs.directory({
|
||||
items: {
|
||||
'package.json': mockFs.file({
|
||||
content: "invalid json content, 1, '",
|
||||
}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
}),
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {
|
||||
'test-backend-plugin': {
|
||||
'package.json': "invalid json content, 1, '",
|
||||
},
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
expectedPluginPackages: [],
|
||||
expectedLogs: {
|
||||
errors: [
|
||||
{
|
||||
message: `failed to load dynamic plugin manifest from '${path.resolve(
|
||||
'/backstageRoot/dist-dynamic/test-backend-plugin',
|
||||
message: `failed to load dynamic plugin manifest from '${mockDir.resolve(
|
||||
'backstageRoot/dist-dynamic/test-backend-plugin',
|
||||
)}'`,
|
||||
meta: {
|
||||
name: 'SyntaxError',
|
||||
@@ -631,32 +557,24 @@ Please add '${path.resolve(
|
||||
{
|
||||
name: 'missing backstage role in package.json',
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin': mockFs.directory({
|
||||
items: {
|
||||
'package.json': mockFs.file({
|
||||
content: JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
}),
|
||||
}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
}),
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {
|
||||
'test-backend-plugin': {
|
||||
'package.json': JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
main: 'dist/index.cjs.js',
|
||||
}),
|
||||
},
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
expectedPluginPackages: [],
|
||||
expectedLogs: {
|
||||
errors: [
|
||||
{
|
||||
message: `failed to load dynamic plugin manifest from '${path.resolve(
|
||||
'/backstageRoot/dist-dynamic/test-backend-plugin',
|
||||
message: `failed to load dynamic plugin manifest from '${mockDir.resolve(
|
||||
'backstageRoot/dist-dynamic/test-backend-plugin',
|
||||
)}'`,
|
||||
meta: {
|
||||
name: 'Error',
|
||||
@@ -669,32 +587,24 @@ Please add '${path.resolve(
|
||||
{
|
||||
name: 'missing main field in package.json',
|
||||
fileSystem: {
|
||||
'/backstageRoot': mockFs.directory({
|
||||
items: {
|
||||
'dist-dynamic': mockFs.directory({
|
||||
items: {
|
||||
'test-backend-plugin': mockFs.directory({
|
||||
items: {
|
||||
'package.json': mockFs.file({
|
||||
content: JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
}),
|
||||
},
|
||||
}),
|
||||
},
|
||||
}),
|
||||
backstageRoot: {
|
||||
'dist-dynamic': {
|
||||
'test-backend-plugin': {
|
||||
'package.json': JSON.stringify({
|
||||
name: 'test-backend-plugin-dynamic',
|
||||
version: '0.0.0',
|
||||
backstage: { role: 'backend-plugin' },
|
||||
}),
|
||||
},
|
||||
},
|
||||
}),
|
||||
},
|
||||
},
|
||||
expectedPluginPackages: [],
|
||||
expectedLogs: {
|
||||
errors: [
|
||||
{
|
||||
message: `failed to load dynamic plugin manifest from '${path.resolve(
|
||||
'/backstageRoot/dist-dynamic/test-backend-plugin',
|
||||
message: `failed to load dynamic plugin manifest from '${mockDir.resolve(
|
||||
'backstageRoot/dist-dynamic/test-backend-plugin',
|
||||
)}'`,
|
||||
meta: {
|
||||
name: 'Error',
|
||||
@@ -706,7 +616,7 @@ Please add '${path.resolve(
|
||||
},
|
||||
])('$name', async (tc: TestCase): Promise<void> => {
|
||||
const logger = new MockedLogger();
|
||||
const backstageRoot = '/backstageRoot';
|
||||
const backstageRoot = mockDir.resolve('backstageRoot');
|
||||
async function toTest(): Promise<ScannedPluginPackage[]> {
|
||||
const pluginScanner = new PluginScanner(
|
||||
new ConfigReader(
|
||||
@@ -725,7 +635,12 @@ Please add '${path.resolve(
|
||||
return await pluginScanner.scanRoot();
|
||||
}
|
||||
if (tc.fileSystem) {
|
||||
mockFs(tc.fileSystem);
|
||||
mockDir.setContent(tc.fileSystem);
|
||||
}
|
||||
if (tc.symlinks) {
|
||||
for (const { source, target } of tc.symlinks) {
|
||||
fs.symlinkSync(target, source);
|
||||
}
|
||||
}
|
||||
if (tc.expectedError) {
|
||||
/* eslint-disable-next-line jest/no-conditional-expect */
|
||||
|
||||
Reference in New Issue
Block a user