generator-jhipster-playwright 1.0.0

package/generators/cypress/templates/src/test/javascript/cypress/support/index.ts.ejs

@@ -0,0 +1,3 @@
+// Playwright support index
+// Playwright tests import helpers directly — no global registration needed.
+export {};

package/generators/cypress/templates/src/test/javascript/cypress/support/management.ts.ejs

@@ -0,0 +1,12 @@
+/**
+ * Playwright management helpers
+ * Translated from Cypress management.ts (v9)
+ *
+ * Source: ZERO EJS variables — pure static translation.
+ */
+import type { APIRequestContext } from '@playwright/test';
+
+export async function getManagementInfo(request: APIRequestContext): Promise<any> {
+  const response = await request.get('/management/info');
+  return response.json();
+}

package/generators/cypress/templates/src/test/javascript/cypress/support/navbar.ts.ejs

@@ -0,0 +1,54 @@
+/**
+ * Playwright navbar helpers
+ * Translated from Cypress navbar.ts (v9)
+ *
+ * Source: ZERO EJS variables — pure static translation.
+ */
+import { expect, type Locator, type Page } from '@playwright/test';
+import {
+  navbarSelector,
+  adminMenuSelector,
+  accountMenuSelector,
+  registerItemSelector,
+  loginItemSelector,
+  logoutItemSelector,
+  settingsItemSelector,
+  passwordItemSelector,
+  entityItemSelector,
+} from './commands';
+
+async function clickDropdownItem(menu: Locator, item: string): Promise<void> {
+  await expect(menu).toBeVisible();
+  await menu.click();
+  const itemLocator = menu.locator(item);
+  await expect(itemLocator).toBeVisible();
+  await itemLocator.click();
+}
+
+export async function clickOnLoginItem(page: Page): Promise<void> {
+  await clickDropdownItem(page.locator(navbarSelector).locator(accountMenuSelector), loginItemSelector);
+}
+
+export async function clickOnLogoutItem(page: Page): Promise<void> {
+  await clickDropdownItem(page.locator(navbarSelector).locator(accountMenuSelector), logoutItemSelector);
+}
+
+export async function clickOnRegisterItem(page: Page): Promise<void> {
+  await clickDropdownItem(page.locator(navbarSelector).locator(accountMenuSelector), registerItemSelector);
+}
+
+export async function clickOnSettingsItem(page: Page): Promise<void> {
+  await clickDropdownItem(page.locator(navbarSelector).locator(accountMenuSelector), settingsItemSelector);
+}
+
+export async function clickOnPasswordItem(page: Page): Promise<void> {
+  await clickDropdownItem(page.locator(navbarSelector).locator(accountMenuSelector), passwordItemSelector);
+}
+
+export async function clickOnAdminMenuItem(page: Page, item: string): Promise<void> {
+  await clickDropdownItem(page.locator(navbarSelector).locator(adminMenuSelector), `.dropdown-item[href="/${item}"]`);
+}
+
+export async function clickOnEntityMenuItem(page: Page, entityName: string): Promise<void> {
+  await clickDropdownItem(page.locator(navbarSelector).locator(entityItemSelector), `.dropdown-item[href="/${entityName}"]`);
+}

package/generators/cypress/templates/src/test/javascript/cypress/support/oauth2.ts.ejs

@@ -0,0 +1,64 @@
+/**
+ * Playwright OAuth2 support helpers
+ * Translated from Cypress oauth2.ts
+ *
+ * This module handles OAuth2/Keycloak authentication flows.
+ */
+import type { Page, APIRequestContext } from '@playwright/test';
+
+export interface OAuth2Data {
+  accessToken: string;
+  idToken: string;
+}
+
+/**
+ * Initiate OAuth2 login flow and return tokens.
+ * Translates the Cypress OAuth2 command chain:
+ *   1. GET /oauth2/authorization/oidc (follow redirects to Keycloak)
+ *   2. Parse the Keycloak login form
+ *   3. POST credentials to Keycloak
+ *   4. Follow redirects back to the app
+ */
+export async function oauth2Login(
+  page: Page,
+  username: string,
+  password: string,
+): Promise<void> {
+  // Navigate to the OAuth2 login endpoint
+  await page.goto('/oauth2/authorization/oidc');
+
+  // Wait for Keycloak login form
+  await page.waitForSelector('#kc-form-login', { timeout: 15000 });
+
+  // Fill in credentials
+  await page.locator('#username').fill(username);
+  await page.locator('#password').fill(password);
+
+  // Submit the form
+  await page.locator('#kc-login').click();
+
+  // Wait for redirect back to the app
+  await page.waitForURL('**/', { timeout: 15000 });
+}
+
+/**
+ * Get OAuth2 tokens from the current session.
+ */
+export async function getOAuth2Data(request: APIRequestContext): Promise<OAuth2Data | null> {
+  const response = await request.get('/api/account', { failOnStatusCode: false });
+  if (response.ok()) {
+    return {
+      accessToken: '',
+      idToken: '',
+    };
+  }
+  return null;
+}
+
+/**
+ * Logout from OAuth2/Keycloak session.
+ */
+export async function oauth2Logout(page: Page): Promise<void> {
+  await page.goto('/api/logout');
+  await page.waitForURL('**/', { timeout: 15000 });
+}

package/generators/cypress/templates/src/test/javascript/cypress/tsconfig.json.ejs

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "types": ["node"]
+  },
+  "include": ["**/*.ts"]
+}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "generator-jhipster-playwright",
+  "version": "1.0.0",
+  "description": "JHipster Playwright E2E blueprint - replaces Cypress with Playwright for end-to-end testing",
+  "keywords": [
+    "yeoman-generator",
+    "jhipster-blueprint",
+    "jhipster-9"
+  ],
+  "homepage": "https://github.com/sreeshanth-soma/generator-jhipster-playwright",
+  "bugs": "https://github.com/sreeshanth-soma/generator-jhipster-playwright/issues",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/sreeshanth-soma/generator-jhipster-playwright.git"
+  },
+  "license": "Apache-2.0",
+  "type": "module",
+  "bin": {
+    "jhipster-playwright": "cli/cli.cjs"
+  },
+  "files": [
+    "cli",
+    "generators",
+    "!**/__*",
+    "!**/*.snap",
+    "!**/*.spec.?(c|m)js"
+  ],
+  "scripts": {
+    "lint": "eslint .",
+    "smoke": "node --check cli/cli.cjs && node --check generators/cypress/command.js && node --check generators/cypress/files.js && node --check generators/cypress/generator.js && node --check generators/cypress/index.js && node --input-type=module -e \"await import('./generators/cypress/index.js'); await import('./generators/cypress/generator.js'); await import('./generators/cypress/files.js'); await import('./generators/cypress/command.js');\"",
+    "test": "npm run lint && npm run smoke"
+  },
+  "dependencies": {
+    "generator-jhipster": "9.0.0"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.58.2",
+    "eslint": "9.39.2",
+    "yeoman-test": ">=8.2.0"
+  },
+  "engines": {
+    "generator-jhipster": "9.0.0",
+    "node": ">= 22"
+  }
+}