n8n-enterprise-unlocked/packages/testing/playwright/test-workflows/setup-workflow-tests.ts

import { execFile } from 'child_process';
import { promises as fsPromises } from 'fs';
import path from 'path';
import { promisify } from 'util';

// Only run the file once, so we don't run it multiple times
const execFileAsync = promisify(execFile);

const CREDENTIALS_FILE_NAME = 'credentials.json';
const WORKFLOWS_DIR_NAME = 'workflows';

const ASSETS_SOURCE_PATH = path.join(__dirname, '../../../../assets');
const PDF_SOURCE_DIR = path.join(__dirname, 'testData', 'pdfs');

const BASE_TMP_DIR = '/tmp';
const TMP_PDF_DEST_DIR = path.join(BASE_TMP_DIR, 'testData', 'pdfs');

/**
 * Executes an n8n CLI command, providing robust error handling and logging.
 * @param command The n8n CLI subcommand (e.g., 'import:credentials').
 * @param args Arguments specific to the subcommand.
 * @param options Options for `child_process.execFile`. `cwd` is typically required.
 * @returns A promise that resolves with the stdout of the command, or rejects on error.
 */
async function runN8nCliCommand(command: string, args: string[], options: { cwd: string }) {
	const n8nExecutablePath = '../../../cli/bin/n8n';
	console.log(`Executing n8n command: n8n ${command} ${args.join(' ')}`);
	await execFileAsync(n8nExecutablePath, [command, ...args], options);
}

/**
 * Recursively copies files and directories from a source path to a destination path.
 * If the source is a directory, it creates the destination directory and copies its contents.
 * If the source is a file, it copies the file.
 * Handles cases where the source path does not exist gracefully.
 * @param sourcePath The path to the source file or directory.
 * @param destinationPath The path where the file(s) or directory should be copied.
 */
async function copyAsset(sourcePath: string, destinationPath: string): Promise<void> {
	try {
		const stats = await fsPromises.stat(sourcePath);

		if (stats.isDirectory()) {
			await fsPromises.mkdir(destinationPath, { recursive: true });
			const items = await fsPromises.readdir(sourcePath);
			await Promise.all(
				items.map((item) =>
					copyAsset(path.join(sourcePath, item), path.join(destinationPath, item)),
				),
			);
			console.log(`📁 Directory copied: ${sourcePath} to ${destinationPath}`);
		} else if (stats.isFile()) {
			await fsPromises.copyFile(sourcePath, destinationPath);
			console.log(`📄 File copied: ${sourcePath} to ${destinationPath}`);
		}
	} catch (error: unknown) {
		if (error instanceof Error && 'code' in error && error.code === 'ENOENT') {
			console.warn(`⚠️ Warning: Source asset not found at ${sourcePath}. Skipping copy.`);
		} else {
			console.error(
				`❌ Error copying asset from ${sourcePath} to ${destinationPath}: ${error instanceof Error ? error.message : String(error)}`,
			);
			throw error;
		}
	}
}

/**
 * Sets up the n8n test environment by importing credentials and workflows,
 * and copying necessary test data/assets.
 * This function is designed to be used as a global setup hook in testing frameworks.
 */
export async function globalWorkflowSetup(): Promise<void> {
	console.log('\n--- 🚀 Starting n8n workflow test environment setup ---\n');

	try {
		console.log('📥 Importing test credentials...');
		await runN8nCliCommand('import:credentials', ['--input', CREDENTIALS_FILE_NAME], {
			cwd: __dirname,
		});

		console.log('📥 Importing test workflows...');
		await runN8nCliCommand('import:workflow', ['--separate', '--input', WORKFLOWS_DIR_NAME], {
			cwd: __dirname,
		});

		console.log('📁 Copying test assets...');

		await fsPromises.mkdir(BASE_TMP_DIR, { recursive: true });

		await copyAsset(
			path.join(ASSETS_SOURCE_PATH, 'n8n-logo.png'),
			path.join(BASE_TMP_DIR, 'n8n-logo.png'),
		);
		await copyAsset(
			path.join(ASSETS_SOURCE_PATH, 'n8n-screenshot.png'),
			path.join(BASE_TMP_DIR, 'n8n-screenshot.png'),
		);

		await copyAsset(PDF_SOURCE_DIR, TMP_PDF_DEST_DIR);

		console.log('\n--- ✅ n8n workflow test environment setup complete! ---\n');
	} catch (error: unknown) {
		console.error('\n--- ❌ n8n workflow test environment setup failed! ---\n', error);
		process.exit(1);
	}
}

if (require.main === module) {
	globalWorkflowSetup().catch((error) => {
		console.error('Setup failed:', error);
		process.exit(1);
	});
}