Skip to content

Commit 2189443

Browse files
ChristopherPHolderChristopherPHolder
committed
fix(workspace): migrate e2e test
1 parent adbed43 commit 2189443

25 files changed

+1341
-1410
lines changed

‎e2e/cli-e2e/mocks/user-flows/minimal.uf.ts

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
export default {
2+
flowOptions: {
3+
name: 'DUMMY FLOW'
4+
},
5+
interactions: async (ctx: Record<string, any>): Promise<void> => {
6+
const { flow, collectOptions } = ctx;
7+
const { url } = collectOptions;
8+
await flow.navigate(url);
9+
},
10+
};

‎e2e/cli-e2e/project.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"e2e": {
1515
"executor": "@nx/vite:test",
1616
"options": {
17-
"config": "e2e/cli-e2e/vite.config.e2e.ts"
17+
"config": "e2e/cli-e2e/vite.config.e2e.mts"
1818
}
1919
}
2020
},

‎e2e/cli-e2e/setup.e2e.ts

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
import { afterAll, beforeAll, beforeEach, afterEach } from 'vitest';
2+
3+
import { cpSync, mkdirSync, rmSync, writeFileSync } from 'node:fs';
4+
import { join, normalize, sep } from 'node:path';
5+
6+
import { CliTest, E2E_DIR, normalizePath } from './utils/setup';
7+
import { spawn } from 'node:child_process';
8+
9+
const ANSI_ESCAPE_REGEX = /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g;
10+
11+
beforeAll(({name}) => {
12+
mkdirSync(join(E2E_DIR, normalizePath(name)), { recursive: true });
13+
});
14+
15+
beforeEach<CliTest>((ctx) => {
16+
ctx.root = join(E2E_DIR, normalizePath(join(ctx.task.suite.name, ctx.task.name)));
17+
18+
ctx.setupFns = {
19+
setupRcJson: (rc: {}, rcName= `.user-flowrc.json`) => {
20+
writeFileSync(
21+
join(ctx.root, rcName),
22+
JSON.stringify(rc, null, 4),
23+
{ encoding: 'utf8' }
24+
);
25+
},
26+
setupUserFlows: (mockUserFlow: string, userFlowDir = 'user-flows') => {
27+
cpSync(mockUserFlow, join(ctx.root, userFlowDir, normalize(mockUserFlow).split(sep).at(-1)))
28+
}
29+
}
30+
31+
mkdirSync(ctx.root, { recursive: true });
32+
});
33+
34+
export type CliProcessResult = {
35+
stdout: string;
36+
stderr: string;
37+
code: number | null;
38+
}
39+
40+
beforeEach<CliTest>((ctx) => {
41+
ctx.cli = {} as any;
42+
ctx.cli.stdout = '';
43+
ctx.cli.stderr = '';
44+
ctx.cli.code = null;
45+
46+
47+
ctx.cli.run = (command: string, args: string[] = []) => new Promise<CliProcessResult>((resolve) => {
48+
const process = spawn(command, args, { stdio: 'pipe', shell: true, cwd: ctx.root });
49+
50+
setTimeout(() => {
51+
process.stdout.on('data', (data) => {
52+
const stdout = String(data).replace(ANSI_ESCAPE_REGEX, '');
53+
54+
if (ctx.cli.verbose) {
55+
console.log(stdout)
56+
}
57+
58+
ctx.cli.stdout += String(data).replace(ANSI_ESCAPE_REGEX, '');
59+
});
60+
61+
62+
process.stderr.on('data', (data) => {
63+
const stderr = String(data).replace(ANSI_ESCAPE_REGEX, '');
64+
65+
if (ctx.cli.verbose) {
66+
console.log(stderr)
67+
}
68+
69+
ctx.cli.stderr += String(data).replace(ANSI_ESCAPE_REGEX, '');
70+
71+
});
72+
73+
74+
process.on('close', code => {
75+
ctx.cli.code = code;
76+
resolve({
77+
stdout: ctx.cli.stdout,
78+
stderr: ctx.cli.stderr,
79+
code: ctx.cli.code
80+
});
81+
});
82+
}, 0);
83+
});
84+
85+
ctx.cli.waitForStdout = (expectedStdout: string) => {
86+
return new Promise((resolve) => {
87+
88+
process.stdout.on('data', (data) => {
89+
const stdout = String(data).replace(ANSI_ESCAPE_REGEX, '');
90+
if (stdout.includes(expectedStdout)) {
91+
resolve();
92+
}
93+
});
94+
})
95+
};
96+
})
97+
98+
99+
afterEach<CliTest>((ctx) => {
100+
rmSync(ctx.root, { recursive: true });
101+
})
102+
103+
afterAll(({name}) => {
104+
rmSync(join(E2E_DIR, normalizePath(name)), { recursive: true });
105+
});

‎e2e/cli-e2e/tests/__snapshots__/help.e2e.test.ts.snap

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ exports[`user-flow help > should print global help 1`] = `
66
Run a set of user flows and save the result
77
88
Commands:
9-
cli.js assert Assert audit budgets
109
cli.js init Setup .user-flowrc.json
1110
cli.js collect Run a set of user flows and save the result
1211
cli.js Run a set of user flows and save the result [default]
12+
cli.js assert Setup .user-flowrc.json
1313
1414
Options:
1515
--version Show version number [boolean]

‎e2e/cli-e2e/tests/assert.e2e.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { describe, expect, it } from 'vitest';
22
import { executeProcess } from '@code-pushup/utils';
33

4-
describe('user-flow assert', () => {
4+
describe.skip('user-flow assert', () => {
55
it('should run test', async () => {
66
const { code, stdout, stderr } = await executeProcess({
77
command: 'echo',

‎e2e/cli-e2e/tests/collect/dry-run.e2e.test.ts

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import { describe, expect, it } from 'vitest';
2+
3+
import { CliTest, DEFAULT_RC, USER_FLOW_MOCKS } from '../../utils/setup';
4+
5+
describe.skip('collect --dry-run', () => {
6+
7+
it<CliTest>('should run user-flow', async ({ cli, setupFns }) => {
8+
setupFns.setupRcJson(DEFAULT_RC);
9+
setupFns.setupUserFlows(USER_FLOW_MOCKS.MINIMAL);
10+
11+
const { code, stdout, stderr } = await cli.run('user-flow', ['collect', '--dry-run']);
12+
13+
expect(stderr).toBe('');
14+
expect(stdout).toBe('');
15+
expect(code).toBe(0);
16+
});
17+
});
18+
19+
describe.skip('collect --dry-run --verbose', () => {
20+
21+
it<CliTest>('should run user-flow and log', async ({ cli, setupFns }) => {
22+
setupFns.setupRcJson(DEFAULT_RC);
23+
setupFns.setupUserFlows(USER_FLOW_MOCKS.MINIMAL);
24+
25+
const { code, stdout, stderr } = await cli.run('user-flow', ['collect', '--dry-run', '--verbose']);
26+
27+
expect(stderr).toBe('');
28+
expect(stdout).not.toBe('');
29+
expect(code).toBe(0);
30+
});
31+
});

‎e2e/cli-e2e/tests/collect/format.e2e.test.ts

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
import { describe, it, expect } from 'vitest';
2+
import { readdirSync, readFileSync } from 'node:fs';
3+
import { join } from 'node:path';
4+
5+
import { CliTest, DEFAULT_RC, USER_FLOW_MOCKS } from '../../utils/setup';
6+
7+
const DUMMY_USER_FLOW_NAME = 'DUMMY FLOW';
8+
9+
describe('collect format', () => {
10+
['html', 'json', 'md'].forEach((format) => {
11+
it<CliTest>(`should save the results as a ${format} file`, async ({root, setupFns, cli}) => {
12+
13+
setupFns.setupRcJson(getRcWithFormat([format]));
14+
setupFns.setupUserFlows(USER_FLOW_MOCKS.MINIMAL);
15+
16+
const { code, stderr } = await cli.run('user-flow', ['collect']);
17+
18+
expect(stderr).toBe('');
19+
expect(code).toBe(0);
20+
21+
const resultFileNames = getResultFile(root);
22+
expect(resultFileNames).toHaveLength(1);
23+
expect(resultFileNames[0].endsWith(`.${format}`)).toBeTruthy();
24+
25+
const content = getResultContent(root, resultFileNames[0]);
26+
expect(isValidFormatedResult(format, content));
27+
});
28+
});
29+
30+
it<CliTest>('should print results to stdout', async ({ setupFns, cli }) => {
31+
setupFns.setupRcJson(getRcWithFormat(['stdout']));
32+
setupFns.setupUserFlows(USER_FLOW_MOCKS.MINIMAL);
33+
34+
const { code, stdout, stderr } = await cli.run('user-flow', ['collect']);
35+
36+
expect(stdout).toContain(`| Gather Mode | Performance | Accessibility | Best Practices | Seo | Pwa |`)
37+
expect(stdout).toContain(DUMMY_USER_FLOW_NAME);
38+
expect(stderr).toBe('');
39+
expect(code).toBe(0);
40+
});
41+
42+
it<CliTest>('should save the results as a HTML, JSON and Markdown files and print to stdout', async ({ root, setupFns, cli }) => {
43+
setupFns.setupRcJson(getRcWithFormat(['html', 'json', 'md', 'stdout']));
44+
setupFns.setupUserFlows(USER_FLOW_MOCKS.MINIMAL);
45+
46+
const { code, stdout, stderr } = await cli.run('user-flow', ['collect']);
47+
48+
const resultFileNames = getResultFile(root);
49+
expect(resultFileNames).toHaveLength(3);
50+
51+
resultFileNames.forEach((fileName) => {
52+
const content = getResultContent(root, fileName);
53+
const format = fileName.split('.').at(-1)!;
54+
expect(isValidFormatedResult(format, content)).toBeTruthy();
55+
});
56+
57+
expect(stdout).toContain(`| Gather Mode | Performance | Accessibility | Best Practices | Seo | Pwa |`)
58+
expect(stdout).toContain(DUMMY_USER_FLOW_NAME);
59+
expect(stderr).toBe('');
60+
expect(code).toBe(0);
61+
})
62+
});
63+
64+
65+
function isValidFormatedResult(format: string, result: string) {
66+
const isValidFile = {
67+
'html': (report: string) => report.includes(DUMMY_USER_FLOW_NAME),
68+
'json': (report: string) => !!(JSON.parse(report)?.name || '').includes(DUMMY_USER_FLOW_NAME),
69+
'md': (report: string) => report.includes(`| Gather Mode | Performance | Accessibility | Best Practices | Seo | Pwa |`)
70+
};
71+
// @ts-ignore
72+
return isValidFile[format](result);
73+
}
74+
75+
function getRcWithFormat(format: string[]) {
76+
const RC = structuredClone(DEFAULT_RC);
77+
RC.persist.format = format;
78+
return RC;
79+
}
80+
81+
function getResultFile(dir: string): string[] {
82+
return readdirSync(join(dir, DEFAULT_RC.persist.outPath))
83+
}
84+
85+
function getResultContent(dir: string, name: string): string {
86+
return readFileSync(join(dir, DEFAULT_RC.persist.outPath, name), { encoding: 'utf8' });
87+
}

‎e2e/cli-e2e/tests/collect/ufPath.e2e.test.ts

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
import { describe, expect, it } from 'vitest';
2+
import { mkdirSync } from 'node:fs';
3+
4+
import { CliTest, DEFAULT_RC } from '../../utils/setup';
5+
import { join } from 'node:path';
6+
7+
describe.skip('collect ufPath', () => {
8+
9+
it<CliTest>('should throw if no user-flows directory does not exist', async ({ cli, setupFns }) => {
10+
setupFns.setupRcJson(DEFAULT_RC)
11+
12+
const { code, stderr} = await cli.run('user-flow', ['collect']);
13+
14+
expect(code).toBe(1);
15+
expect(stderr).toContain('Error: ufPath: user-flows is neither a file nor a directory');
16+
});
17+
18+
it<CliTest>('should throw if no user-flow is found in ufPath', async ({ root, cli, setupFns }) => {
19+
setupFns.setupRcJson(DEFAULT_RC)
20+
mkdirSync(join(root, DEFAULT_RC.collect.ufPath), { recursive: true });
21+
22+
const { code, stderr, stdout } = await cli.run('user-flow', ['collect']);
23+
24+
expect(code).toBe(1);
25+
expect(stderr).toContain(`No user flows found in ${DEFAULT_RC.collect.ufPath}`);
26+
});
27+
})

‎e2e/cli-e2e/tests/help.e2e.test.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
import { describe, expect, it } from 'vitest';
22
import { executeProcess } from '@code-pushup/utils';
33

4-
describe('user-flow help', () => {
4+
describe.skip('user-flow help', () => {
5+
56
it('should print global help', async () => {
67

78
const { code, stdout, stderr } = await executeProcess({

‎e2e/cli-e2e/utils/setup.ts

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
import { normalize } from 'node:path';
2+
import { ChildProcessWithoutNullStreams } from 'node:child_process';
3+
4+
export const E2E_DIR = 'tmp/e2e';
5+
6+
export const USER_FLOW_MOCKS = {
7+
MINIMAL: 'e2e/cli-e2e/mocks/user-flows/minimal.uf.ts'
8+
} as const;
9+
10+
export const DEFAULT_RC = {
11+
collect: {
12+
url: "https://coffee-cart.netlify.app/",
13+
ufPath: "user-flows",
14+
},
15+
persist: {
16+
outPath: "measures",
17+
format: ["md"]
18+
}
19+
};
20+
21+
export function normalizePath(path: string) {
22+
return normalize(path.replaceAll(' ', '_'))
23+
}
24+
25+
export type CliProcessResult = {
26+
stdout: string;
27+
stderr: string;
28+
code: number | null;
29+
}
30+
31+
export type CliTest = {
32+
root: string;
33+
setupFns: {
34+
setupRcJson: (rc: {}, rcName?: string) => void;
35+
setupUserFlows: (mockUserFlow: string, userFlowDir?: string) => void;
36+
}
37+
cli: {
38+
run: (command: string, args?: string[]) => Promise<CliProcessResult>;
39+
waitForStdout: (stdOut: string) => Promise<void>;
40+
process?: ChildProcessWithoutNullStreams;
41+
verbose: boolean;
42+
stdout: string;
43+
stderr: string;
44+
code: number | null;
45+
}
46+
};

‎e2e/cli-e2e/vite.config.e2e.ts renamed to ‎e2e/cli-e2e/vite.config.e2e.mts

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export default defineConfig({
1010
test: {
1111
globals: true,
1212
reporters: ['basic'],
13-
testTimeout: 120_000,
13+
testTimeout: 30_000,
1414
// alias: tsconfigPathAliases(),
1515
pool: 'threads',
1616
poolOptions: { threads: { singleThread: true } },
@@ -19,6 +19,7 @@ export default defineConfig({
1919
},
2020
environment: 'node',
2121
include: ['tests/**/*.e2e.test.ts'],
22+
setupFiles: ['setup.e2e.ts'],
2223
globalSetup: ['../../global-setup.e2e.ts'],
2324
},
2425
});

‎global-setup.e2e.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ import startLocalRegistry from './tools/scripts/start-local-registry';
33
import stopLocalRegistry from './tools/scripts/stop-local-registry';
44

55
export async function setup() {
6-
console.log('Starting local registry...');
6+
console.log('Setup e2e test');
77
await startLocalRegistry();
88
execSync('npm install -D @push-based/[email protected]');
99
}
1010

1111
export async function teardown() {
12-
console.log('Teardown registry')
12+
console.log('Teardown e2e test')
1313
stopLocalRegistry();
1414
execSync('npm uninstall @push-based/user-flow');
1515
}

0 commit comments

Comments
 (0)