Skip to content

Commit

Permalink
fix(testing): make the default react playwright test to pass (#18559)
Browse files Browse the repository at this point in the history
  • Loading branch information
xiongemi authored Aug 11, 2023
1 parent c785871 commit 107a753
Show file tree
Hide file tree
Showing 10 changed files with 51 additions and 12 deletions.
18 changes: 17 additions & 1 deletion e2e/next/src/next-appdir.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ describe('Next.js App Router', () => {
const appName = uniq('app');
const jsLib = uniq('tslib');

runCLI(`generate @nx/next:app ${appName} --e2eTestRunner=playwright`);
runCLI(
`generate @nx/next:app ${appName} --e2eTestRunner=playwright --appDir=true`
);
runCLI(`generate @nx/js:lib ${jsLib} --no-interactive`);

updateFile(
Expand All @@ -40,6 +42,20 @@ describe('Next.js App Router', () => {
`
);

updateFile(
`apps/${appName}-e2e/src/example.spec.ts`,
`
import { test, expect } from '@playwright/test';
test('has ${jsLib}', async ({ page }) => {
await page.goto('/');
// Expect h1 to contain a substring.
expect(await page.locator('p').innerText()).toContain('${jsLib}');
});
`
);

await checkApp(appName, {
checkUnitTest: false,
checkLint: true,
Expand Down
20 changes: 16 additions & 4 deletions e2e/playwright/src/playwright.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,16 @@ import {
uniq,
runCLI,
ensurePlaywrightBrowsersInstallation,
getPackageManagerCommand,
getSelectedPackageManager,
} from '@nx/e2e/utils';

const TEN_MINS_MS = 600_000;
describe('Playwright E2E Test runner', () => {
const pmc = getPackageManagerCommand({
packageManager: getSelectedPackageManager(),
});

beforeAll(() => {
newProject({ name: uniq('playwright') });
});
Expand All @@ -17,8 +23,12 @@ describe('Playwright E2E Test runner', () => {
it(
'should test and lint example app',
() => {
runCLI(`g @nx/js:lib demo-e2e --unitTestRunner none --bundler none`);
runCLI(`g @nx/playwright:configuration --project demo-e2e`);
runCLI(
`g @nx/web:app demo-e2e --unitTestRunner=none --bundler=vite --e2eTestRunner=none --style=css --no-interactive`
);
runCLI(
`g @nx/playwright:configuration --project demo-e2e --webServerCommand="${pmc.runNx} serve demo-e2e" --webServerAddress="http://localhost:4200"`
);
ensurePlaywrightBrowsersInstallation();

const e2eResults = runCLI(`e2e demo-e2e`);
Expand All @@ -34,9 +44,11 @@ describe('Playwright E2E Test runner', () => {
'should test and lint example app with js',
() => {
runCLI(
`g @nx/js:lib demo-js-e2e --unitTestRunner none --bundler none --js`
`g @nx/web:app demo-js-e2e --unitTestRunner=none --bundler=vite --e2eTestRunner=none --style=css --no-interactive`
);
runCLI(
`g @nx/playwright:configuration --project demo-js-e2e --js --webServerCommand="${pmc.runNx} serve demo-e2e" --webServerAddress="http://localhost:4200"`
);
runCLI(`g @nx/playwright:configuration --project demo-js-e2e --js`);
ensurePlaywrightBrowsersInstallation();

const e2eResults = runCLI(`e2e demo-js-e2e`);
Expand Down
1 change: 0 additions & 1 deletion e2e/web/src/web.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import {
ensurePlaywrightBrowsersInstallation,
isNotWindows,
killPorts,
listFiles,
newProject,
readFile,
rmDist,
Expand Down
8 changes: 7 additions & 1 deletion packages/playwright/src/executors/playwright/playwright.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,12 @@ export async function playwrightExecutor(

const args = createArgs(options);
const p = runPlaywright(args, context.root);
p.stdout.on('data', (message) => {
process.stdout.write(message);
});
p.stderr.on('data', (message) => {
process.stderr.write(message);
});

return new Promise<{ success: boolean }>((resolve) => {
p.on('close', (code) => {
Expand Down Expand Up @@ -117,7 +123,7 @@ function runPlaywright(args: string[], cwd: string) {
const cli = require.resolve('@playwright/test/cli');

return fork(cli, ['test', ...args], {
stdio: 'inherit',
stdio: ['pipe', 'pipe', 'pipe', 'ipc'],
cwd,
});
} catch (e) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Rename or remove the existing e2e target.`);
projectConfig.targets ??= {};
projectConfig.targets.e2e = {
executor: '@nx/playwright:playwright',
outputs: [`dist/.playwright/${projectConfig.root}`],
outputs: [`{workspaceRoot}/dist/.playwright/${projectConfig.root}`],
options: {
config: `${projectConfig.root}/playwright.config.${
options.js ? 'js' : 'ts'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ import { test, expect } from '@playwright/test';
test('has title', async ({ page }) => {
await page.goto('/');

// Expect a title "to contain" a substring.
await expect(page).toHaveTitle(/Welcome/);
// Expect h1 to contain a substring.
expect(await page.locator('h1').innerText()).toContain('Welcome');
});
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const baseURL = process.env['BASE_URL'] || '<% if(webServerAddress) {%><%= webSe
* See https://playwright.dev/docs/test-configuration.
*/
export default defineConfig({
...nxE2EPreset(__filename, { testDir: './<>' }),
...nxE2EPreset(__filename, { testDir: './<%= directory %>' }),
/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
use: {
baseURL,
Expand Down
1 change: 1 addition & 0 deletions packages/react/src/generators/application/lib/add-e2e.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ export async function addE2e(
webServerCommand: `${getPackageManagerCommand().exec} nx serve ${
options.name
}`,
webServerAddress: 'http://localhost:4200',
});
case 'none':
default:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ describe('app', () => {
"config": "apps/cool-app-e2e/playwright.config.ts",
},
"outputs": [
"dist/.playwright/apps/cool-app-e2e",
"{workspaceRoot}/dist/.playwright/apps/cool-app-e2e",
],
}
`);
Expand Down
5 changes: 5 additions & 0 deletions packages/web/src/generators/application/application.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
formatFiles,
generateFiles,
GeneratorCallback,
getPackageManagerCommand,
getWorkspaceLayout,
joinPathFragments,
names,
Expand Down Expand Up @@ -288,6 +289,10 @@ export async function applicationGenerator(host: Tree, schema: Schema) {
js: false,
linter: options.linter,
setParserOptionsProject: options.setParserOptionsProject,
webServerCommand: `${getPackageManagerCommand().exec} nx serve ${
options.name
}`,
webServerAddress: 'http://localhost:4200',
});
tasks.push(playwrightTask);
}
Expand Down

1 comment on commit 107a753

@vercel
Copy link

@vercel vercel bot commented on 107a753 Aug 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-git-master-nrwl.vercel.app
nx.dev
nx-dev-nrwl.vercel.app
nx-five.vercel.app

Please sign in to comment.