paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 14 Packages Projects Releases Wiki Activity

backend-plugin-manager: migrate plugin-scanner tests to avoid mock-fs

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-10-05 15:06:42 +02:00
parent ff205d4a57
commit bbe138fa44
1 changed files with 204 additions and 289 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/backend-plugin-manager/src/scanner/plugin-scanner.test.ts
+204 -289
View File
@@ -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 */