e22d65eeea
This PR updates `@nx/playwright/plugin` to create non-conflicting outputs for atomized tasks. <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior Outputs from `outputDir` and reporters are the same for each atomized task, which results in missing outputs. ## Expected Behavior All outputs should be captured and cached correctly. ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
436 lines
13 KiB
TypeScript
436 lines
13 KiB
TypeScript
import { CreateNodesContext } from '@nx/devkit';
|
|
import { TempFs } from '@nx/devkit/internal-testing-utils';
|
|
|
|
import { createNodesV2 } from './plugin';
|
|
import { PlaywrightTestConfig } from '@playwright/test';
|
|
|
|
describe('@nx/playwright/plugin', () => {
|
|
let createNodesFunction = createNodesV2[1];
|
|
let context: CreateNodesContext;
|
|
let tempFs: TempFs;
|
|
|
|
beforeEach(async () => {
|
|
tempFs = new TempFs('playwright-plugin');
|
|
await tempFs.createFiles({
|
|
'package.json': '{}',
|
|
'playwright.config.js': 'module.exports = {}',
|
|
});
|
|
|
|
context = {
|
|
nxJsonConfiguration: {
|
|
namedInputs: {
|
|
default: ['{projectRoot}/**/*'],
|
|
production: ['!{projectRoot}/**/*.spec.ts'],
|
|
},
|
|
},
|
|
workspaceRoot: tempFs.tempDir,
|
|
configFiles: [],
|
|
};
|
|
});
|
|
|
|
afterEach(() => {
|
|
// tempFs.cleanup();
|
|
jest.resetModules();
|
|
});
|
|
|
|
it('should create nodes with default playwright configuration', async () => {
|
|
await mockPlaywrightConfig(tempFs, {});
|
|
const results = await createNodesFunction(
|
|
['playwright.config.js'],
|
|
{
|
|
targetName: 'e2e',
|
|
},
|
|
context
|
|
);
|
|
|
|
expect(results).toMatchInlineSnapshot(`
|
|
[
|
|
[
|
|
"playwright.config.js",
|
|
{
|
|
"projects": {
|
|
".": {
|
|
"metadata": {
|
|
"targetGroups": {
|
|
"E2E (CI)": [
|
|
"e2e-ci",
|
|
],
|
|
},
|
|
},
|
|
"root": ".",
|
|
"targets": {
|
|
"e2e": {
|
|
"cache": true,
|
|
"command": "playwright test",
|
|
"inputs": [
|
|
"default",
|
|
"^production",
|
|
{
|
|
"externalDependencies": [
|
|
"@playwright/test",
|
|
],
|
|
},
|
|
],
|
|
"metadata": {
|
|
"description": "Runs Playwright Tests",
|
|
"help": {
|
|
"command": "npx playwright test --help",
|
|
"example": {
|
|
"options": {
|
|
"workers": 1,
|
|
},
|
|
},
|
|
},
|
|
"technologies": [
|
|
"playwright",
|
|
],
|
|
},
|
|
"options": {
|
|
"cwd": "{projectRoot}",
|
|
},
|
|
"outputs": [
|
|
"{projectRoot}/test-results",
|
|
],
|
|
"parallelism": false,
|
|
},
|
|
"e2e-ci": {
|
|
"cache": true,
|
|
"dependsOn": [],
|
|
"executor": "nx:noop",
|
|
"inputs": [
|
|
"default",
|
|
"^production",
|
|
{
|
|
"externalDependencies": [
|
|
"@playwright/test",
|
|
],
|
|
},
|
|
],
|
|
"metadata": {
|
|
"description": "Runs Playwright Tests in CI",
|
|
"help": {
|
|
"command": "npx playwright test --help",
|
|
"example": {
|
|
"options": {
|
|
"workers": 1,
|
|
},
|
|
},
|
|
},
|
|
"nonAtomizedTarget": "e2e",
|
|
"technologies": [
|
|
"playwright",
|
|
],
|
|
},
|
|
"outputs": [
|
|
"{projectRoot}/test-results",
|
|
],
|
|
"parallelism": false,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
],
|
|
]
|
|
`);
|
|
});
|
|
|
|
it('should create nodes with reporters configured', async () => {
|
|
await mockPlaywrightConfig(tempFs, {
|
|
reporter: [
|
|
['list'],
|
|
['json', { outputFile: 'test-results/report.json' }],
|
|
['html', { outputFolder: 'test-results/html' }],
|
|
],
|
|
});
|
|
const results = await createNodesFunction(
|
|
['playwright.config.js'],
|
|
{
|
|
targetName: 'e2e',
|
|
},
|
|
context
|
|
);
|
|
|
|
expect(results).toMatchInlineSnapshot(`
|
|
[
|
|
[
|
|
"playwright.config.js",
|
|
{
|
|
"projects": {
|
|
".": {
|
|
"metadata": {
|
|
"targetGroups": {
|
|
"E2E (CI)": [
|
|
"e2e-ci",
|
|
],
|
|
},
|
|
},
|
|
"root": ".",
|
|
"targets": {
|
|
"e2e": {
|
|
"cache": true,
|
|
"command": "playwright test",
|
|
"inputs": [
|
|
"default",
|
|
"^production",
|
|
{
|
|
"externalDependencies": [
|
|
"@playwright/test",
|
|
],
|
|
},
|
|
],
|
|
"metadata": {
|
|
"description": "Runs Playwright Tests",
|
|
"help": {
|
|
"command": "npx playwright test --help",
|
|
"example": {
|
|
"options": {
|
|
"workers": 1,
|
|
},
|
|
},
|
|
},
|
|
"technologies": [
|
|
"playwright",
|
|
],
|
|
},
|
|
"options": {
|
|
"cwd": "{projectRoot}",
|
|
},
|
|
"outputs": [
|
|
"{projectRoot}/test-results",
|
|
"{projectRoot}/playwright-report",
|
|
"{projectRoot}/test-results/report.json",
|
|
"{projectRoot}/test-results/html",
|
|
],
|
|
"parallelism": false,
|
|
},
|
|
"e2e-ci": {
|
|
"cache": true,
|
|
"dependsOn": [],
|
|
"executor": "nx:noop",
|
|
"inputs": [
|
|
"default",
|
|
"^production",
|
|
{
|
|
"externalDependencies": [
|
|
"@playwright/test",
|
|
],
|
|
},
|
|
],
|
|
"metadata": {
|
|
"description": "Runs Playwright Tests in CI",
|
|
"help": {
|
|
"command": "npx playwright test --help",
|
|
"example": {
|
|
"options": {
|
|
"workers": 1,
|
|
},
|
|
},
|
|
},
|
|
"nonAtomizedTarget": "e2e",
|
|
"technologies": [
|
|
"playwright",
|
|
],
|
|
},
|
|
"outputs": [
|
|
"{projectRoot}/test-results",
|
|
"{projectRoot}/playwright-report",
|
|
"{projectRoot}/test-results/report.json",
|
|
"{projectRoot}/test-results/html",
|
|
],
|
|
"parallelism": false,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
],
|
|
]
|
|
`);
|
|
});
|
|
|
|
it('should create nodes for distributed CI', async () => {
|
|
await mockPlaywrightConfig(
|
|
tempFs,
|
|
`module.exports = {
|
|
testDir: 'tests',
|
|
testIgnore: [/.*skip.*/, '**/ignored/**'],
|
|
reporter: [
|
|
['html', { outputFolder: 'test-results/html' }],
|
|
],
|
|
}`
|
|
);
|
|
await tempFs.createFiles({
|
|
'tests/run-me.spec.ts': '',
|
|
'tests/run-me-2.spec.ts': '',
|
|
'tests/skip-me.spec.ts': '',
|
|
'tests/ignored/run-me.spec.ts': '',
|
|
'not-tests/run-me.spec.ts': '',
|
|
});
|
|
|
|
const results = await createNodesFunction(
|
|
['playwright.config.js'],
|
|
{
|
|
targetName: 'e2e',
|
|
ciTargetName: 'e2e-ci',
|
|
},
|
|
context
|
|
);
|
|
const project = results[0][1].projects['.'];
|
|
const { targets } = project;
|
|
expect(project.metadata.targetGroups).toMatchInlineSnapshot(`
|
|
{
|
|
"E2E (CI)": [
|
|
"e2e-ci--tests/run-me-2.spec.ts",
|
|
"e2e-ci--tests/run-me.spec.ts",
|
|
"e2e-ci",
|
|
],
|
|
}
|
|
`);
|
|
expect(targets['e2e-ci']).toMatchInlineSnapshot(`
|
|
{
|
|
"cache": true,
|
|
"dependsOn": [
|
|
{
|
|
"params": "forward",
|
|
"projects": "self",
|
|
"target": "e2e-ci--tests/run-me-2.spec.ts",
|
|
},
|
|
{
|
|
"params": "forward",
|
|
"projects": "self",
|
|
"target": "e2e-ci--tests/run-me.spec.ts",
|
|
},
|
|
],
|
|
"executor": "nx:noop",
|
|
"inputs": [
|
|
"default",
|
|
"^production",
|
|
{
|
|
"externalDependencies": [
|
|
"@playwright/test",
|
|
],
|
|
},
|
|
],
|
|
"metadata": {
|
|
"description": "Runs Playwright Tests in CI",
|
|
"help": {
|
|
"command": "npx playwright test --help",
|
|
"example": {
|
|
"options": {
|
|
"workers": 1,
|
|
},
|
|
},
|
|
},
|
|
"nonAtomizedTarget": "e2e",
|
|
"technologies": [
|
|
"playwright",
|
|
],
|
|
},
|
|
"outputs": [
|
|
"{projectRoot}/test-results",
|
|
"{projectRoot}/test-results/html",
|
|
],
|
|
"parallelism": false,
|
|
}
|
|
`);
|
|
expect(targets['e2e-ci--tests/run-me.spec.ts']).toMatchInlineSnapshot(`
|
|
{
|
|
"cache": true,
|
|
"command": "playwright test tests/run-me.spec.ts --output=test-results/tests-run-me-spec-ts",
|
|
"inputs": [
|
|
"default",
|
|
"^production",
|
|
{
|
|
"externalDependencies": [
|
|
"@playwright/test",
|
|
],
|
|
},
|
|
],
|
|
"metadata": {
|
|
"description": "Runs Playwright Tests in tests/run-me.spec.ts in CI",
|
|
"help": {
|
|
"command": "npx playwright test --help",
|
|
"example": {
|
|
"options": {
|
|
"workers": 1,
|
|
},
|
|
},
|
|
},
|
|
"technologies": [
|
|
"playwright",
|
|
],
|
|
},
|
|
"options": {
|
|
"cwd": "{projectRoot}",
|
|
"env": {
|
|
"PLAYWRIGHT_HTML_OUTPUT_DIR": "test-results/html/tests-run-me-spec-ts",
|
|
"PLAYWRIGHT_HTML_REPORT": "test-results/html/tests-run-me-spec-ts",
|
|
},
|
|
},
|
|
"outputs": [
|
|
"{projectRoot}/test-results/tests-run-me-spec-ts",
|
|
"{projectRoot}/test-results/html/tests-run-me-spec-ts",
|
|
],
|
|
"parallelism": false,
|
|
}
|
|
`);
|
|
expect(targets['e2e-ci--tests/run-me-2.spec.ts']).toMatchInlineSnapshot(`
|
|
{
|
|
"cache": true,
|
|
"command": "playwright test tests/run-me-2.spec.ts --output=test-results/tests-run-me-2-spec-ts",
|
|
"inputs": [
|
|
"default",
|
|
"^production",
|
|
{
|
|
"externalDependencies": [
|
|
"@playwright/test",
|
|
],
|
|
},
|
|
],
|
|
"metadata": {
|
|
"description": "Runs Playwright Tests in tests/run-me-2.spec.ts in CI",
|
|
"help": {
|
|
"command": "npx playwright test --help",
|
|
"example": {
|
|
"options": {
|
|
"workers": 1,
|
|
},
|
|
},
|
|
},
|
|
"technologies": [
|
|
"playwright",
|
|
],
|
|
},
|
|
"options": {
|
|
"cwd": "{projectRoot}",
|
|
"env": {
|
|
"PLAYWRIGHT_HTML_OUTPUT_DIR": "test-results/html/tests-run-me-2-spec-ts",
|
|
"PLAYWRIGHT_HTML_REPORT": "test-results/html/tests-run-me-2-spec-ts",
|
|
},
|
|
},
|
|
"outputs": [
|
|
"{projectRoot}/test-results/tests-run-me-2-spec-ts",
|
|
"{projectRoot}/test-results/html/tests-run-me-2-spec-ts",
|
|
],
|
|
"parallelism": false,
|
|
}
|
|
`);
|
|
expect(targets['e2e-ci--tests/skip-me.spec.ts']).not.toBeDefined();
|
|
expect(targets['e2e-ci--tests/ignored/run-me.spec.ts']).not.toBeDefined();
|
|
expect(targets['e2e-ci--not-tests/run-me.spec.ts']).not.toBeDefined();
|
|
});
|
|
});
|
|
|
|
async function mockPlaywrightConfig(
|
|
tempFs: TempFs,
|
|
config: PlaywrightTestConfig | string
|
|
) {
|
|
await tempFs.writeFile(
|
|
'playwright.config.js',
|
|
typeof config === 'string'
|
|
? config
|
|
: `module.exports = ${JSON.stringify(config)}`
|
|
);
|
|
}
|