pull:初次提交

n8n-n8n-1.109.2/packages/core/test/helpers/index.ts

@@ -0,0 +1,152 @@
+import { readdirSync, readFileSync } from 'fs';
+import { mock } from 'jest-mock-extended';
+import type {
+	IDataObject,
+	IDeferredPromise,
+	INodeType,
+	INodeTypes,
+	IRun,
+	IVersionedNodeType,
+	IWorkflowBase,
+	IWorkflowExecuteAdditionalData,
+	NodeLoadingDetails,
+	WorkflowTestData,
+	INodeTypeData,
+} from 'n8n-workflow';
+import { ApplicationError, NodeHelpers } from 'n8n-workflow';
+import path from 'path';
+
+import { UnrecognizedNodeTypeError } from '@/errors';
+import { ExecutionLifecycleHooks } from '@/execution-engine/execution-lifecycle-hooks';
+
+import { predefinedNodesTypes } from './constants';
+
+const BASE_DIR = path.resolve(__dirname, '../../..');
+
+class NodeTypesClass implements INodeTypes {
+	constructor(private nodeTypes: INodeTypeData) {}
+
+	getByName(nodeType: string): INodeType | IVersionedNodeType {
+		return this.nodeTypes[nodeType].type;
+	}
+
+	getByNameAndVersion(nodeType: string, version?: number): INodeType {
+		return NodeHelpers.getVersionedNodeType(this.nodeTypes[nodeType].type, version);
+	}
+
+	getKnownTypes(): IDataObject {
+		throw new Error('Method not implemented.');
+	}
+}
+
+let nodeTypesInstance: NodeTypesClass | undefined;
+
+export function NodeTypes(nodeTypes: INodeTypeData = predefinedNodesTypes): INodeTypes {
+	if (nodeTypesInstance === undefined || nodeTypes !== undefined) {
+		nodeTypesInstance = new NodeTypesClass(nodeTypes);
+	}
+
+	return nodeTypesInstance;
+}
+
+export function WorkflowExecuteAdditionalData(
+	waitPromise: IDeferredPromise<IRun>,
+): IWorkflowExecuteAdditionalData {
+	const hooks = new ExecutionLifecycleHooks('trigger', '1', mock());
+	hooks.addHandler('workflowExecuteAfter', (fullRunData) => waitPromise.resolve(fullRunData));
+	return mock<IWorkflowExecuteAdditionalData>({
+		hooks,
+		currentNodeExecutionIndex: 0,
+		// Not setting this to undefined would set it to a mock which would trigger
+		// conditions in the WorkflowExecute which only check if a property exists,
+		// e.g. `if (!this.additionalData.restartExecutionId)`. This would for
+		// example skip running the `workflowExecuteBefore` hook in the tests.
+		restartExecutionId: undefined,
+	});
+}
+
+const preparePinData = (pinData: IDataObject) => {
+	const returnData = Object.keys(pinData).reduce(
+		(acc, key) => {
+			const data = pinData[key] as IDataObject[];
+			acc[key] = [data];
+			return acc;
+		},
+		{} as {
+			[key: string]: IDataObject[][];
+		},
+	);
+	return returnData;
+};
+
+const readJsonFileSync = <T>(filePath: string) => JSON.parse(readFileSync(filePath, 'utf-8')) as T;
+
+export function getNodeTypes(testData: WorkflowTestData[] | WorkflowTestData) {
+	if (!Array.isArray(testData)) {
+		testData = [testData];
+	}
+
+	const nodeTypes: INodeTypeData = {};
+
+	const nodes = [...new Set(testData.flatMap((data) => data.input.workflowData.nodes))];
+
+	const nodeNames = nodes.map((n) => n.type);
+
+	const knownNodes = readJsonFileSync<Record<string, NodeLoadingDetails>>(
+		path.join(BASE_DIR, 'nodes-base/dist/known/nodes.json'),
+	);
+
+	for (const nodeName of nodeNames) {
+		const loadInfo = knownNodes[nodeName.replace('n8n-nodes-base.', '')];
+		if (!loadInfo) {
+			throw new UnrecognizedNodeTypeError('n8n-nodes-base', nodeName);
+		}
+		const sourcePath = loadInfo.sourcePath.replace(/^dist\//, './').replace(/\.js$/, '.ts');
+		const nodeSourcePath = path.join(BASE_DIR, 'nodes-base', sourcePath);
+		const node = new (require(nodeSourcePath)[loadInfo.className])() as INodeType;
+		nodeTypes[nodeName] = {
+			sourcePath: '',
+			type: node,
+		};
+	}
+
+	return nodeTypes;
+}
+
+const getWorkflowFilepaths = (dirname: string, testFolder = 'workflows') => {
+	const workflows: string[] = [];
+
+	const filenames: string[] = readdirSync(`${dirname}${path.sep}${testFolder}`);
+
+	filenames.forEach((file) => {
+		if (file.endsWith('.json')) {
+			workflows.push(path.join(dirname, testFolder, file));
+		}
+	});
+
+	return workflows;
+};
+
+export const workflowToTests = (dirname: string, testFolder = 'workflows') => {
+	const workflowFilepaths: string[] = getWorkflowFilepaths(dirname, testFolder);
+
+	const testCases: WorkflowTestData[] = [];
+
+	for (const filePath of workflowFilepaths) {
+		const description = filePath.replace('.json', '');
+		const workflowData = readJsonFileSync<IWorkflowBase>(filePath);
+		if (workflowData.pinData === undefined) {
+			throw new ApplicationError('Workflow data does not contain pinData');
+		}
+
+		const nodeData = preparePinData(workflowData.pinData);
+
+		delete workflowData.pinData;
+
+		const input = { workflowData };
+		const output = { nodeData };
+
+		testCases.push({ description, input, output });
+	}
+	return testCases;
+};