mirror of
https://github.com/n8n-io/n8n.git
synced 2026-05-30 16:26:59 +02:00
96 lines
3.8 KiB
JavaScript
96 lines
3.8 KiB
JavaScript
#!/usr/bin/env node
|
|
// Verifies the built n8n image still works for the ways n8n-cloud launches
|
|
// it. The container spec is pulled live from n8n-cloud's helm chart so this
|
|
// test stays in sync with what cloud actually deploys.
|
|
|
|
import { $, echo, chalk, fs, tmpdir } from 'zx';
|
|
import path from 'node:path';
|
|
import { parseAllDocuments } from 'yaml';
|
|
|
|
$.verbose = false;
|
|
process.env.FORCE_COLOR = '1';
|
|
|
|
const IMAGE = process.env.SMOKE_IMAGE || 'n8nio/n8n:local';
|
|
const TIMEOUT = '45s';
|
|
// Matches an n8n runtime image ref (e.g. `n8nio/n8n:2.4.4`, `ghcr.io/n8n-io/n8n@sha256:…`)
|
|
// but not sidecars like `n8nio/runners:…` or controller images that happen to contain "n8n".
|
|
const N8N_IMAGE_REF = /\/n8n(:|@)/;
|
|
// `bin/n8n` short-circuits on `--version` regardless of subcommand
|
|
// (checks process.argv.slice(-1)[0]), so this works for `n8n` and `n8n worker` alike.
|
|
const VERSION_FLAG = '--version';
|
|
const VERSION_OUTPUT = /^\d+\.\d+\.\d+/m;
|
|
const CLOUD = {
|
|
repo: 'n8n-io/n8n-cloud',
|
|
ref: process.env.CLOUD_CHART_REF || 'main',
|
|
// Owned by n8n-cloud — override via env if cloud reorganises. Cross-reference:
|
|
// n8n-cloud:packages/instance-controller/charts/n8napp/{n8n,values-v1.yaml}
|
|
chartPath: process.env.CLOUD_CHART_PATH || 'packages/instance-controller/charts/n8napp/n8n',
|
|
valuesPath:
|
|
process.env.CLOUD_CHART_VALUES ||
|
|
'packages/instance-controller/charts/n8napp/values-v1.yaml',
|
|
};
|
|
|
|
async function fetchCloudInvocations() {
|
|
const dir = await fs.mkdtemp(path.join(tmpdir(), 'n8n-smoke-cloud-'));
|
|
try {
|
|
await $`gh repo clone ${CLOUD.repo} ${dir} -- --depth=1 --branch=${CLOUD.ref} --quiet`;
|
|
const { stdout } = await $({
|
|
cwd: path.join(dir, CLOUD.chartPath),
|
|
})`helm template . --values ${path.join(dir, CLOUD.valuesPath)}`;
|
|
|
|
return parseAllDocuments(stdout)
|
|
.map((d) => d.toJSON())
|
|
.flatMap((doc) => {
|
|
if (!/^(StatefulSet|Deployment)$/.test(doc?.kind ?? '')) return [];
|
|
const pod = doc.spec?.template?.spec ?? {};
|
|
return (pod.containers ?? [])
|
|
.filter((c) => N8N_IMAGE_REF.test(c.image ?? ''))
|
|
.map((c) => ({
|
|
name: `n8n-cloud: ${doc.kind} ${doc.metadata.name} / ${c.name}`,
|
|
user: String(c.securityContext?.runAsUser ?? pod.securityContext?.runAsUser ?? 1000),
|
|
// If the chart sets `command`, override entrypoint; otherwise let the
|
|
// image's ENTRYPOINT run with the args.
|
|
entrypoint: c.command?.[0],
|
|
args: [...(c.command?.slice(1) ?? []), ...(c.args ?? []), VERSION_FLAG],
|
|
}));
|
|
});
|
|
} finally {
|
|
await fs.remove(dir).catch(() => {});
|
|
}
|
|
}
|
|
|
|
async function run({ name, user, entrypoint, args }) {
|
|
const dockerArgs = ['run', '--rm', '--user', `${user}:${user}`];
|
|
if (entrypoint) dockerArgs.push('--entrypoint', entrypoint);
|
|
dockerArgs.push(IMAGE, ...args);
|
|
|
|
try {
|
|
const { stdout } = await $({ timeout: TIMEOUT })`docker ${dockerArgs}`;
|
|
if (!VERSION_OUTPUT.test(stdout)) {
|
|
throw new Error(`unexpected stdout: ${stdout.slice(0, 200)}`);
|
|
}
|
|
echo(chalk.green(`✓ ${name}`));
|
|
return true;
|
|
} catch (err) {
|
|
echo(chalk.red(`✗ ${name}`));
|
|
echo(chalk.dim(` ${(err.stderr ?? err.message ?? '').slice(0, 600)}`));
|
|
return false;
|
|
}
|
|
}
|
|
|
|
const cloud = process.env.SMOKE_SKIP_CLOUD === 'true' ? [] : await fetchCloudInvocations();
|
|
if (process.env.SMOKE_SKIP_CLOUD !== 'true' && cloud.length === 0) {
|
|
echo(chalk.red('Cloud chart rendered no n8n containers — chart structure may have moved.'));
|
|
echo(chalk.dim(' Check CLOUD_CHART_PATH / CLOUD_CHART_VALUES, or run with SMOKE_SKIP_CLOUD=true.'));
|
|
process.exit(1);
|
|
}
|
|
|
|
const invocations = [
|
|
{ name: 'n8n image default entrypoint', user: '1000', entrypoint: null, args: [VERSION_FLAG] },
|
|
...cloud,
|
|
];
|
|
|
|
echo(chalk.bold(`Verifying ${IMAGE} against ${invocations.length} deployment pattern(s)`));
|
|
const ok = (await Promise.all(invocations.map(run))).every(Boolean);
|
|
if (!ok) process.exit(1);
|