pull:初次提交

n8n-n8n-1.109.2/packages/nodes-base/test/globalSetup.ts

@@ -0,0 +1,9 @@
+import nock from 'nock';
+
+export default async () => {
+	nock.disableNetConnect();
+
+	nock.emitter.on('no match', (req) => {
+		console.error('No mock for network request: ', req);
+	});
+};

n8n-n8n-1.109.2/packages/nodes-base/test/nodes/Helpers.ts

@@ -0,0 +1,29 @@
+import get from 'lodash/get';
+import { constructExecutionMetaData } from 'n8n-core';
+import type { IDataObject, IExecuteFunctions, IGetNodeParameterOptions, INode } from 'n8n-workflow';
+
+export const createMockExecuteFunction = <T = IExecuteFunctions>(
+	nodeParameters: IDataObject,
+	nodeMock: INode,
+	continueBool = false,
+) =>
+	({
+		getNodeParameter(
+			parameterName: string,
+			_itemIndex: number,
+			fallbackValue?: IDataObject,
+			options?: IGetNodeParameterOptions,
+		) {
+			const parameter = options?.extractValue ? `${parameterName}.value` : parameterName;
+			return get(nodeParameters, parameter, fallbackValue);
+		},
+		getNode() {
+			return nodeMock;
+		},
+		continueOnFail() {
+			return continueBool;
+		},
+		helpers: {
+			constructExecutionMetaData,
+		},
+	}) as unknown as T;

n8n-n8n-1.109.2/packages/nodes-base/test/nodes/TriggerHelpers.ts

@@ -0,0 +1,274 @@
+import type * as express from 'express';
+import { type IncomingHttpHeaders } from 'http';
+import { mock } from 'jest-mock-extended';
+import get from 'lodash/get';
+import merge from 'lodash/merge';
+import set from 'lodash/set';
+import { PollContext, returnJsonArray } from 'n8n-core';
+import type { InstanceSettings, ExecutionLifecycleHooks } from 'n8n-core';
+import { ScheduledTaskManager } from 'n8n-core/dist/execution-engine/scheduled-task-manager';
+import {
+	createDeferredPromise,
+	type IBinaryData,
+	type ICredentialDataDecryptedObject,
+	type IDataObject,
+	type IHttpRequestOptions,
+	type INode,
+	type INodeType,
+	type INodeTypes,
+	type ITriggerFunctions,
+	type IWebhookFunctions,
+	type IWorkflowExecuteAdditionalData,
+	type NodeTypeAndVersion,
+	type VersionedNodeType,
+	type Workflow,
+	type CronContext,
+	type Cron,
+} from 'n8n-workflow';
+
+const logger = mock({
+	scoped: jest.fn().mockReturnValue(
+		mock({
+			debug: jest.fn(),
+			info: jest.fn(),
+			warn: jest.fn(),
+			error: jest.fn(),
+		}),
+	),
+});
+
+type MockDeepPartial<T> = Parameters<typeof mock<T>>[0];
+
+type TestTriggerNodeOptions = {
+	mode?: 'manual' | 'trigger';
+	node?: MockDeepPartial<INode>;
+	timezone?: string;
+	workflowStaticData?: IDataObject;
+	credential?: ICredentialDataDecryptedObject;
+	helpers?: Partial<ITriggerFunctions['helpers']>;
+};
+
+type TestWebhookTriggerNodeOptions = TestTriggerNodeOptions & {
+	webhookName?: string;
+	request?: MockDeepPartial<express.Request>;
+	bodyData?: IDataObject;
+	childNodes?: NodeTypeAndVersion[];
+	workflow?: Workflow;
+	headerData?: IncomingHttpHeaders;
+};
+
+type TestPollingTriggerNodeOptions = TestTriggerNodeOptions & {};
+
+function getNodeVersion(Trigger: new () => VersionedNodeType, version?: number) {
+	const instance = new Trigger();
+	return instance.nodeVersions[version ?? instance.currentVersion];
+}
+
+export async function testTriggerNode(
+	Trigger: (new () => INodeType) | INodeType,
+	options: TestTriggerNodeOptions = {},
+) {
+	const trigger = 'description' in Trigger ? Trigger : new Trigger();
+	const emit: jest.MockedFunction<ITriggerFunctions['emit']> = jest.fn();
+
+	const timezone = options.timezone ?? 'Europe/Berlin';
+	const version = trigger.description.version;
+	const node = merge(
+		{
+			type: trigger.description.name,
+			name: trigger.description.defaults.name ?? `Test Node (${trigger.description.name})`,
+			typeVersion: typeof version === 'number' ? version : version.at(-1),
+		} satisfies Partial<INode>,
+		options.node,
+	) as INode;
+	const workflow = mock<Workflow>({ timezone: options.timezone ?? 'Europe/Berlin' });
+
+	const scheduledTaskManager = new ScheduledTaskManager(
+		mock<InstanceSettings>(),
+		logger as any,
+		mock(),
+		mock(),
+	);
+	const helpers = mock<ITriggerFunctions['helpers']>({
+		createDeferredPromise,
+		returnJsonArray,
+		registerCron: (cron: Cron, onTick) => {
+			const ctx: CronContext = {
+				expression: cron.expression,
+				recurrence: cron.recurrence,
+				nodeId: node.id,
+				workflowId: workflow.id,
+				timezone: workflow.timezone,
+			};
+			scheduledTaskManager.registerCron(ctx, onTick);
+		},
+	});
+
+	const triggerFunctions = mock<ITriggerFunctions>({
+		helpers,
+		emit,
+		getTimezone: () => timezone,
+		getNode: () => node,
+		getCredentials: async <T extends object = ICredentialDataDecryptedObject>() =>
+			(options.credential ?? {}) as T,
+		getMode: () => options.mode ?? 'trigger',
+		getWorkflowStaticData: () => options.workflowStaticData ?? {},
+		getNodeParameter: (parameterName, fallback) => get(node.parameters, parameterName) ?? fallback,
+	});
+
+	const response = await trigger.trigger?.call(triggerFunctions);
+
+	if (options.mode === 'manual') {
+		expect(response?.manualTriggerFunction).toBeInstanceOf(Function);
+		await response?.manualTriggerFunction?.();
+	}
+
+	return {
+		close: jest.fn(response?.closeFunction),
+		emit,
+	};
+}
+
+export async function testVersionedWebhookTriggerNode(
+	Trigger: new () => VersionedNodeType,
+	version?: number,
+	options: TestWebhookTriggerNodeOptions = {},
+) {
+	return await testWebhookTriggerNode(getNodeVersion(Trigger, version), options);
+}
+
+export async function testWebhookTriggerNode(
+	Trigger: (new () => INodeType) | INodeType,
+	options: TestWebhookTriggerNodeOptions = {},
+) {
+	const trigger = 'description' in Trigger ? Trigger : new Trigger();
+
+	const timezone = options.timezone ?? 'Europe/Berlin';
+	const version = trigger.description.version;
+	const node = merge(
+		{
+			id: options.node?.id ?? '1',
+			type: trigger.description.name,
+			name: trigger.description.defaults.name ?? `Test Node (${trigger.description.name})`,
+			typeVersion: typeof version === 'number' ? version : version.at(-1),
+		} satisfies Partial<INode>,
+		options.node,
+	) as INode;
+	const workflow = mock<Workflow>({ timezone: options.timezone ?? 'Europe/Berlin' });
+
+	const scheduledTaskManager = new ScheduledTaskManager(
+		mock<InstanceSettings>(),
+		logger as any,
+		mock(),
+		mock(),
+	);
+	const helpers = mock<ITriggerFunctions['helpers']>({
+		returnJsonArray,
+		registerCron: (cron: Cron, onTick) => {
+			const ctx: CronContext = {
+				expression: cron.expression,
+				recurrence: cron.recurrence,
+				nodeId: node.id,
+				workflowId: workflow.id,
+				timezone: workflow.timezone,
+			};
+			scheduledTaskManager.registerCron(ctx, onTick);
+		},
+		prepareBinaryData: options.helpers?.prepareBinaryData ?? jest.fn(),
+	});
+
+	const request = mock<express.Request>({
+		method: 'GET',
+		...options.request,
+	});
+	const response = mock<express.Response>({ status: jest.fn(() => mock<express.Response>()) });
+	const webhookFunctions = mock<IWebhookFunctions>({
+		helpers,
+		nodeHelpers: {
+			copyBinaryFile: jest.fn(async () => mock<IBinaryData>()),
+		},
+		getTimezone: () => timezone,
+		getNode: () => node,
+		getMode: () => options.mode ?? 'trigger',
+		getInstanceId: () => 'instanceId',
+		getBodyData: () => options.bodyData ?? {},
+		getHeaderData: () => options.headerData ?? {},
+		getInputConnectionData: async () => ({}),
+		getNodeWebhookUrl: (name) => `/test-webhook-url/${name}`,
+		getParamsData: () => ({}),
+		getQueryData: () => ({}),
+		getRequestObject: () => request,
+		getResponseObject: () => response,
+		getWorkflow: () => options.workflow ?? mock<Workflow>(),
+		getWebhookName: () => options.webhookName ?? 'default',
+		getWorkflowStaticData: () => options.workflowStaticData ?? {},
+		getNodeParameter: (parameterName, fallback) => get(node.parameters, parameterName) ?? fallback,
+		getChildNodes: () => options.childNodes ?? [],
+		getCredentials: async <T extends object = ICredentialDataDecryptedObject>() =>
+			(options.credential ?? {}) as T,
+	});
+
+	const responseData = await trigger.webhook?.call(webhookFunctions);
+
+	return {
+		responseData,
+		response: webhookFunctions.getResponseObject(),
+	};
+}
+
+export async function testPollingTriggerNode(
+	Trigger: (new () => INodeType) | INodeType,
+	options: TestPollingTriggerNodeOptions = {},
+) {
+	const trigger = 'description' in Trigger ? Trigger : new Trigger();
+
+	const timezone = options.timezone ?? 'Europe/Berlin';
+	const version = trigger.description.version;
+	const node = merge(
+		{
+			type: trigger.description.name,
+			name: trigger.description.defaults.name ?? `Test Node (${trigger.description.name})`,
+			typeVersion: typeof version === 'number' ? version : version.at(-1),
+			credentials: {},
+		} satisfies Partial<INode>,
+		options.node,
+	) as INode;
+	const workflow = mock<Workflow>({
+		timezone,
+		nodeTypes: mock<INodeTypes>({
+			getByNameAndVersion: () => mock<INodeType>({ description: trigger.description }),
+		}),
+		getStaticData: () => options.workflowStaticData ?? {},
+	});
+	const mode = options.mode ?? 'trigger';
+
+	const pollContext = new PollContext(
+		workflow,
+		node,
+		mock<IWorkflowExecuteAdditionalData>({
+			currentNodeParameters: node.parameters,
+			credentialsHelper: mock<IWorkflowExecuteAdditionalData['credentialsHelper']>({
+				getParentTypes: () => [],
+				authenticate: async (_creds, _type, options) => {
+					set(options, 'headers.authorization', 'mockAuth');
+					return options as IHttpRequestOptions;
+				},
+			}),
+			hooks: mock<ExecutionLifecycleHooks>(),
+		}),
+		mode,
+		'init',
+	);
+
+	pollContext.getNode = () => node;
+	pollContext.getCredentials = async <T extends object = ICredentialDataDecryptedObject>() =>
+		(options.credential ?? {}) as T;
+	pollContext.getNodeParameter = (parameterName, fallback) =>
+		get(node.parameters, parameterName) ?? fallback;
+
+	const response = await trigger.poll?.call(pollContext);
+
+	return {
+		response,
+	};
+}

n8n-n8n-1.109.2/packages/nodes-base/test/setup.ts

@@ -0,0 +1,7 @@
+import 'reflect-metadata';
+
+// Disable task runners until we have fixed the "run test workflows" test
+// to mock the Code Node execution
+process.env.N8N_RUNNERS_ENABLED = 'false';
+process.env.N8N_ENFORCE_SETTINGS_FILE_PERMISSIONS = 'false';
+process.env.N8N_VERSION = '0.0.0-test';