generator-jhipster-playwright 1.0.0

package/LICENSE

@@ -0,0 +1,176 @@
+Apache License
+Version 2.0, January 2004
+https://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,137 @@
+# generator-jhipster-playwright
+
+> A JHipster blueprint that replaces the generated Cypress end-to-end suite with Playwright.
+
+## Introduction
+
+This is a JHipster blueprint. It overrides the `cypress` sub-generator and writes Playwright files instead of Cypress files for generated applications.
+
+Verified against fresh generated JHipster applications:
+
+- React + JWT: `53 passed`, `0 skipped`
+- Angular + JWT: `59 passed`, `0 failed`, `0 skipped`
+
+## Installation
+
+To install or update this blueprint:
+
+```bash
+npm install -g generator-jhipster-playwright
+```
+
+## Usage
+
+### How to Generate Code
+
+This package exposes a dedicated CLI:
+
+```bash
+jhipster-playwright
+```
+
+It can also be used through the standard JHipster CLI:
+
+```bash
+jhipster --blueprints playwright
+```
+
+For available options, you can run:
+
+```bash
+jhipster-playwright app --help
+```
+
+### Enable the Cypress Test Framework
+
+This blueprint overrides JHipster's `cypress` sub-generator. Upstream JHipster only composes that generator when `testFrameworks` includes `cypress`, so Playwright generation must be triggered with Cypress selected.
+
+Use one of these approaches:
+
+```bash
+jhipster --blueprints playwright --test-frameworks cypress
+jhipster-playwright --test-frameworks cypress
+jhipster jdl app.jdl --blueprints playwright --test-frameworks cypress
+```
+
+You can also express this directly in JDL:
+
+```jdl
+application {
+  config {
+    baseName myApp
+    clientFramework react
+    testFrameworks [cypress]
+  }
+}
+```
+
+### How to Run the Generated Tests
+
+```bash
+jhipster jdl app.jdl --blueprints playwright --test-frameworks cypress --skip-install --force
+```
+
+After generation, install dependencies, install the Playwright browser, start the backend, and run the suite:
+
+```bash
+npm install
+npx playwright install chromium
+./mvnw
+```
+
+In a second terminal:
+
+```bash
+npx playwright test
+```
+
+The generated `playwright.config.ts` starts the frontend dev server automatically. The Spring Boot backend still needs to be running before the tests execute.
+
+### Generated Output
+
+The blueprint writes:
+
+- `playwright.config.ts`
+- Playwright support utilities under `src/test/javascript/playwright/support`
+- Account, administration, and entity specs under `src/test/javascript/playwright/e2e`
+- `@playwright/test` and Playwright npm scripts in the generated application's `package.json`
+
+For Angular applications, the blueprint also adds `@popperjs/core` to the generated app dependencies so the generated frontend has the required Popper peer dependency available.
+
+## Local Development
+
+To work on the blueprint locally:
+
+```bash
+npm install
+npm test
+npm pack --dry-run --cache ./.npm-cache
+```
+
+To exercise the blueprint locally against a generated app, link it first:
+
+```bash
+npm link
+```
+
+Then in the target app directory:
+
+```bash
+npm link generator-jhipster-playwright
+jhipster --blueprints playwright --test-frameworks cypress --skip-install --force
+```
+
+## Updated generator-jhipster
+
+This blueprint currently targets `generator-jhipster` `9.0.0`.
+
+If you want to run it through the standard JHipster CLI, install a compatible JHipster version and use:
+
+```bash
+npm install -g generator-jhipster@9.0.0
+jhipster --blueprints playwright --test-frameworks cypress
+```
+
+## License
+
+Apache 2.0, see [LICENSE](LICENSE).

package/cli/cli.cjs

@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+
+const path = require('path');
+
+const { bin, version } = require('../package.json');
+
+// Get package name to use as namespace.
+// Allows blueprints to be aliased.
+const packagePath = path.dirname(__dirname);
+const packageFolderName = path.basename(packagePath);
+const devBlueprintPath = path.join(packagePath, '.blueprint');
+const blueprint = packageFolderName.startsWith('jhipster-') ? `generator-${packageFolderName}` : packageFolderName;
+
+(async () => {
+  const { runJHipster, done, logger } = await import('generator-jhipster/cli');
+  const executableName = Object.keys(bin)[0];
+
+  runJHipster({
+    executableName,
+    executableVersion: version,
+    defaultCommand: 'app',
+    devBlueprintPath,
+    blueprints: {
+      [blueprint]: version,
+    },
+    printBlueprintLogo: () => {
+      console.log('===================== JHipster Playwright =====================');
+      console.log('');
+    },
+    lookups: [{ packagePaths: [packagePath] }],
+  }).catch(done);
+
+  process.on('unhandledRejection', up => {
+    logger.error('Unhandled promise rejection at:');
+    logger.fatal(up);
+  });
+})();

package/generators/cypress/command.js

@@ -0,0 +1,5 @@
+import { asCommand } from 'generator-jhipster';
+
+export default asCommand({
+  configs: {},
+});

package/generators/cypress/files.js

@@ -0,0 +1,75 @@
+/**
+ * Playwright template file mappings.
+ * Mirrors the Cypress files.ts structure from generator-jhipster v9.
+ *
+ * Pattern from Cypress:
+ *   path: source template directory (relative to templates/)
+ *   renameTo: (ctx, file) => output path in generated app
+ *   templates: ['filename'] — JHipster auto-appends .ejs
+ */
+
+const PLAYWRIGHT_TEMPLATE_SOURCE_DIR = 'src/test/javascript/cypress/';
+
+export const playwrightFiles = {
+  common: [
+    {
+      templates: ['playwright.config.ts'],
+    },
+  ],
+  clientTestFw: [
+    {
+      path: PLAYWRIGHT_TEMPLATE_SOURCE_DIR,
+      renameTo: (ctx, file) => `${ctx.clientTestDir}playwright/${file}`,
+      templates: [
+        'fixtures/integration-test.png',
+        'e2e/administration/administration.spec.ts',
+        'support/commands.ts',
+        'support/navbar.ts',
+        'support/index.ts',
+        'support/entity.ts',
+        'support/management.ts',
+        'tsconfig.json',
+      ],
+    },
+    {
+      condition: generator => !generator.applicationTypeMicroservice,
+      path: PLAYWRIGHT_TEMPLATE_SOURCE_DIR,
+      renameTo: (ctx, file) => `${ctx.clientTestDir}playwright/${file}`,
+      templates: ['e2e/account/logout.spec.ts'],
+    },
+    {
+      condition: generator => !generator.authenticationTypeOauth2,
+      path: PLAYWRIGHT_TEMPLATE_SOURCE_DIR,
+      renameTo: (ctx, file) => `${ctx.clientTestDir}playwright/${file}`,
+      templates: ['e2e/account/login-page.spec.ts'],
+    },
+    {
+      condition: generator => Boolean(generator.generateUserManagement),
+      path: PLAYWRIGHT_TEMPLATE_SOURCE_DIR,
+      renameTo: (ctx, file) => `${ctx.clientTestDir}playwright/${file}`,
+      templates: [
+        'e2e/account/register-page.spec.ts',
+        'e2e/account/settings-page.spec.ts',
+        'e2e/account/password-page.spec.ts',
+        'e2e/account/reset-password-page.spec.ts',
+        'support/account.ts',
+      ],
+    },
+    {
+      condition: generator => generator.authenticationTypeOauth2,
+      path: PLAYWRIGHT_TEMPLATE_SOURCE_DIR,
+      renameTo: (ctx, file) => `${ctx.clientTestDir}playwright/${file}`,
+      templates: ['support/oauth2.ts'],
+    },
+  ],
+};
+
+export const entityPlaywrightFiles = {
+  tests: [
+    {
+      path: PLAYWRIGHT_TEMPLATE_SOURCE_DIR,
+      renameTo: ctx => `${ctx.clientTestDir}playwright/e2e/entity/${ctx.entityFileName}.spec.ts`,
+      templates: ['e2e/entity/_entity_.spec.ts'],
+    },
+  ],
+};

package/generators/cypress/generator.js

@@ -0,0 +1,111 @@
+import BaseApplicationGenerator from 'generator-jhipster/generators/base-application';
+import { createFaker } from 'generator-jhipster/generators/base-application/support';
+import { generateTestEntity } from 'generator-jhipster/generators/client/support';
+
+import { entityPlaywrightFiles, playwrightFiles } from './files.js';
+
+/**
+ * Simple Java-style string hash code (same as JHipster internal stringHashCode).
+ * Used to seed faker for reproducible test data.
+ */
+function stringHashCode(str) {
+  let hash = 0;
+  for (let i = 0; i < str.length; i++) {
+    const char = str.charCodeAt(i);
+    hash = ((hash << 5) - hash) + char;
+    hash |= 0; // Convert to 32-bit integer
+  }
+  return hash;
+}
+
+export default class extends BaseApplicationGenerator {
+  constructor(args, opts, features) {
+    super(args, opts, { ...features, checkBlueprint: true });
+  }
+
+  async beforeQueue() {
+    await this.dependsOnJHipster('bootstrap-application');
+  }
+
+  get [BaseApplicationGenerator.PREPARING]() {
+    return this.asPreparingTaskGroup({
+      setPlaywrightProperties({ application }) {
+        application.playwrightDir = `${application.clientTestDir}playwright/`;
+        // Set Cypress-specific defaults expected by entity template
+        // (normally set by the Cypress generator's PREPARING phase)
+        application.cypressBootstrapEntities ??= true;
+      },
+    });
+  }
+
+  get [BaseApplicationGenerator.POST_PREPARING_EACH_ENTITY]() {
+    return this.asPreparingEachEntityTaskGroup({
+      prepareEntityForTemplates({ entity }) {
+        // Set entity-level defaults expected by entity test template
+        // (normally set by Cypress generator's POST_PREPARING_EACH_ENTITY phase)
+        entity.workaroundEntityCannotBeEmpty ??= false;
+        entity.workaroundInstantReactiveMariaDB ??= false;
+        entity.generateEntityCypress ??= !entity.skipClient || entity.builtInUserManagement;
+      },
+    });
+  }
+
+  get [BaseApplicationGenerator.WRITING]() {
+    return this.asWritingTaskGroup({
+      async writePlaywrightFiles({ application }) {
+        const faker = await createFaker();
+        faker.seed(stringHashCode(application.baseName));
+        const context = { ...application, faker };
+        await this.writeFiles({
+          sections: playwrightFiles,
+          context,
+        });
+      },
+    });
+  }
+
+  get [BaseApplicationGenerator.WRITING_ENTITIES]() {
+    return this.asWritingEntitiesTaskGroup({
+      async writeEntityPlaywrightFiles({ application, entities }) {
+        for (const entity of entities.filter(
+          e => e.generateEntityCypress && !e.builtInUser && !e.embedded && !e.entityClientModelOnly
+        )) {
+          const context = { ...application, ...entity };
+          await this.writeFiles({
+            sections: entityPlaywrightFiles,
+            context,
+          });
+        }
+      },
+    });
+  }
+
+  get [BaseApplicationGenerator.POST_WRITING]() {
+    return this.asPostWritingTaskGroup({
+      addPlaywrightDependencies({ application }) {
+        if (!application.clientFrameworkBuiltIn) return;
+
+        const packageJsonStorage = this.createStorage(
+          this.destinationPath(application.clientRootDir || '', 'package.json'),
+        );
+        const dependencies = packageJsonStorage.createStorage('dependencies');
+        const devDependencies = packageJsonStorage.createStorage('devDependencies');
+        devDependencies.set('@playwright/test', '1.58.2');
+
+        if (application.clientFrameworkAngular) {
+          // ng-bootstrap and Bootstrap both declare Popper as a peer dependency.
+          dependencies.set('@popperjs/core', '^2.11.8');
+        }
+
+        const scriptsStorage = packageJsonStorage.createStorage('scripts');
+        scriptsStorage.set('playwright', 'npx playwright test --ui');
+        scriptsStorage.set('e2e', 'npx playwright test --headed');
+        scriptsStorage.set('e2e:headless', 'npx playwright test');
+      },
+    });
+  }
+
+  generateTestEntity(fields) {
+    return generateTestEntity(fields);
+  }
+}

package/generators/cypress/index.js

@@ -0,0 +1,2 @@
+export { default } from './generator.js';
+export { default as command } from './command.js';

package/generators/cypress/templates/playwright.config.ts.ejs

@@ -0,0 +1,30 @@
+import { defineConfig, devices } from '@playwright/test';
+
+export default defineConfig({
+  testDir: '<%= clientTestDir %>playwright/e2e',
+  fullyParallel: false,
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: process.env.CI ? 1 : 2,
+  reporter: 'html',
+  use: {
+    baseURL: 'http://localhost:<%= devServerPortProxy || devServerPort || gatewayServerPort || serverPort %>/',
+    trace: 'on-first-retry',
+    viewport: { width: 1200, height: 720 },
+  },
+  expect: {
+    timeout: 10_000,
+  },
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+  ],
+  webServer: {
+    command: 'npm run webapp:dev<% if (clientFrameworkAngular) { %> -- --open=false<% } %>',
+    url: 'http://localhost:<%= devServerPortProxy || devServerPort || gatewayServerPort || serverPort %>/',
+    reuseExistingServer: !process.env.CI,
+    timeout: 120_000,
+  },
+});

package/generators/cypress/templates/src/test/javascript/cypress/e2e/account/login-page.spec.ts.ejs

@@ -0,0 +1,83 @@
+<%#
+  Source EJS variables: authenticationTypeSession, clientFrameworkAngular, clientFrameworkReact
+-%>
+import { test, expect } from '@playwright/test';
+import {
+  titleLoginSelector,
+  errorLoginSelector,
+  usernameLoginSelector,
+  passwordLoginSelector,
+  submitLoginSelector,
+  credentials,
+} from '../../support/commands';
+import { clickOnLoginItem } from '../../support/navbar';
+
+test.describe('login page', () => {
+  let username: string;
+  let password: string;
+
+  test.beforeAll(() => {
+    const creds = credentials();
+    username = creds.username;
+    password = creds.password;
+  });
+
+  test.beforeEach(async ({ page }) => {
+    await page.goto('/');
+    await clickOnLoginItem(page);
+  });
+
+  test('greets with signin', async ({ page }) => {
+    await expect(page.locator(titleLoginSelector)).toBeVisible();
+  });
+<%_ if (clientFrameworkAngular) { _%>
+
+  test('greets visiting /login directly', async ({ page }) => {
+    await page.goto('/login');
+    await expect(page.locator(titleLoginSelector)).toBeVisible();
+  });
+<%_ } _%>
+
+  test('requires username', async ({ page }) => {
+    await page.locator(passwordLoginSelector).fill('a-password');
+    await page.locator(submitLoginSelector).click();
+<%_ if (!clientFrameworkReact) { _%>
+    const response = await page.waitForResponse('**/api/<% if (authenticationTypeSession) { %>authentication<% } else { %>authenticate<% } %>');
+    expect(response.status()).toBe(<% if (authenticationTypeSession) { %>401<% } else { %>400<% } %>);
+<%_ } _%>
+    // login page should stay open when login fails
+    await expect(page.locator(titleLoginSelector)).toBeVisible();
+  });
+
+  test('requires password', async ({ page }) => {
+    await page.locator(usernameLoginSelector).fill('a-login');
+    await page.locator(submitLoginSelector).click();
+<%_ if (!clientFrameworkReact) { _%>
+    const response = await page.waitForResponse('**/api/<% if (authenticationTypeSession) { %>authentication<% } else { %>authenticate<% } %>');
+    expect(response.status()).toBe(<% if (authenticationTypeSession) { %>401<% } else { %>400<% } %>);
+    await expect(page.locator(errorLoginSelector)).toBeVisible();
+<%_ } else { _%>
+    // login page should stay open when login fails
+    await expect(page.locator(titleLoginSelector)).toBeVisible();
+<%_ } _%>
+  });
+
+  test('errors when password is incorrect', async ({ page }) => {
+    await page.locator(usernameLoginSelector).fill(username);
+    await page.locator(passwordLoginSelector).fill('bad-password');
+    const responsePromise = page.waitForResponse('**/api/<% if (authenticationTypeSession) { %>authentication<% } else { %>authenticate<% } %>');
+    await page.locator(submitLoginSelector).click();
+    const response = await responsePromise;
+    expect(response.status()).toBe(401);
+    await expect(page.locator(errorLoginSelector)).toBeVisible();
+  });
+
+  test('go to home page when successfully logs in', async ({ page }) => {
+    await page.locator(usernameLoginSelector).fill(username);
+    await page.locator(passwordLoginSelector).fill(password);
+    const responsePromise = page.waitForResponse('**/api/<% if (authenticationTypeSession) { %>authentication<% } else { %>authenticate<% } %>');
+    await page.locator(submitLoginSelector).click();
+    const response = await responsePromise;
+    expect(response.status()).toBe(200);
+  });
+});