Merge pull request #9 from opf/refactor-remove-unused-dep-exports

#72261 - refactor code

Author: Ihor-Khomenko

.github/workflows/e2e.yml

@@ -103,7 +103,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version-file: .node-version
           cache: npm
 
       - name: Install dependencies

README.md

@@ -4,7 +4,7 @@ Playwright E2E tests for OpenProject, Nextcloud, and Keycloak integration.
 
 ## Requirements
 
-- Docker (for Docker-based runs), or Node.js 18+ and npm (for native runs)
+- Docker (for Docker-based runs), or Node.js (see `.node-version`) and npm for native runs
 - Integration cluster via [opf/integration-qa-helmfile](https://github.com/opf/integration-qa-helmfile)
 
 ## Quick Start
@@ -21,47 +21,7 @@ npm run playwright:install
 E2E_ENV=local npx playwright test
 ```
 
-## Running Tests
-
-### Docker
-
-```bash
-./run-tests.sh                    # local, all tests
-E2E_ENV=edge ./run-tests.sh       # edge environment
-E2E_ENV=stage ./run-tests.sh      # stage environment
-./run-tests.sh --grep @smoke      # filter by tag
-./run-tests.sh --build            # force image rebuild
-./run-tests.sh --no-open-report   # skip opening report in browser after run
-```
-
-Report opens on your machine after the run. Each run writes to `playwright-report/run-YYYY-MM-DD_HH-mm-ss/` (report in `report/`, plus `results.json`, `junit.xml`). Traces/screenshots/videos stay in `test-results/`. Config is mounted so changes to `playwright.config.ts` apply without rebuilding the image; use `--build` only when deps or Dockerfile change.
-
-Credentials and host overrides go in `.env.local` (gitignored, loaded automatically). If `opnc-root-ca.crt` is in the project root it is mounted and used automatically for self-signed CA.
-
-### Native
-
-```bash
-E2E_ENV=local npx playwright test
-E2E_ENV=edge npx playwright test
-E2E_ENV=stage npx playwright test
-npx playwright test --headed
-npx playwright test --workers 4
-npx playwright show-report
-npm run test:e2e:report          # run tests then open report (native)
-```
-
-npm shortcuts: `npm run test:local`, `test:edge`, `test:stage`, `test:docker`, `report:show`.
-
-**Report:** Docker: report opens automatically after `./run-tests.sh` (or open `playwright-report/index.html`). Native: `npm run report:show` serves at http://localhost:9323 (bound to 0.0.0.0).
-
-### Tags
-
-```bash
-npx playwright test --grep @smoke
-npx playwright test --grep "@smoke|@regression"
-```
-
-Tags in use: `@smoke`, `@regression`, `@integration`.
+For more run options (envs, tags, report), see `.cursor/skills/tests/SKILL.md`.
 
 ## Environment Variables
 
@@ -79,4 +39,4 @@ Tags in use: `@smoke`, `@regression`, `@integration`.
 | `E2E_WORKERS` | Worker count | `1` |
 | `SETUP_JOB_CHECK` | Wait for K8s setup-job | `false` |
 
-Put variables in `.env.local` for local runs.
+Put variables in `.env.local` for local runs. Place `opnc-root-ca.crt` in the project root for self-signed CA.

global-setup.ts

@@ -24,27 +24,27 @@ async function globalSetup(config: FullConfig) {
     // Check if setup-job exists
     const exists = await setupJobExists(namespace);
     if (!exists) {
-      logWarn(`⚠️  Setup-job not found in namespace '${namespace}'. Skipping check.`);
+      logWarn(`Setup-job not found in namespace '${namespace}'. Skipping check.`);
       logInfo('   If you are running tests against a pre-deployed environment,');
       logInfo('   set SKIP_SETUP_JOB_CHECK=true to skip this check.');
     } else {
       // Check if already complete
       const isComplete = await isSetupJobComplete(namespace);
       if (isComplete) {
-        logInfo('✓ Setup-job is already completed');
+        logInfo('Setup-job is already completed');
       } else {
         // Wait for setup-job to complete
         try {
           await waitForSetupJobComplete(namespace);
         } catch (error: unknown) {
-          logError('❌ Setup-job check failed:', getErrorMessage(error));
+          logError('Setup-job check failed:', getErrorMessage(error));
           logError('\nTo skip this check, set SKIP_SETUP_JOB_CHECK=true');
           throw error;
         }
       }
     }
   } else {
-    logInfo('⏭️  Skipping setup-job check (enable with SETUP_JOB_CHECK=true)');
+    logInfo('Skipping setup-job check (enable with SETUP_JOB_CHECK=true)');
   }
 
   // Step 2: Detect service versions via API and persist for workers
@@ -101,9 +101,9 @@ async function globalSetup(config: FullConfig) {
   // ── Step 3: Enable direct access grants for Nextcloud WebDAV ────────
   try {
     await ensureKeycloakDirectAccessForNextcloud();
-    logInfo('✓ Keycloak direct access grants enabled for Nextcloud WebDAV');
+    logInfo('Keycloak direct access grants enabled for Nextcloud WebDAV');
   } catch (error: unknown) {
-    logWarn('⚠️  Failed to enable Keycloak direct access grants:', getErrorMessage(error));
+    logWarn('Failed to enable Keycloak direct access grants:', getErrorMessage(error));
     logWarn('   Nextcloud WebDAV operations may fail.');
   }
 }

locators/openproject.json

@@ -219,6 +219,14 @@
     "copyProjectSubmitButton": {
       "by": "locator",
       "value": "button.Button--primary:has-text('Copy')"
+    },
+    "existingFileModalTitle": {
+      "by": "locator",
+      "value": ".spot-modal--header-title:has-text('This file already exists')"
+    },
+    "fileExistsReplaceButton": {
+      "by": "locator",
+      "value": ".spot-modal .spot-action-bar--right .button.-primary:has-text('Replace')"
     }
   }
 }

package.json

@@ -1,38 +1 @@
-{
-  "name": "openproject-e2e",
-  "version": "1.0.0",
-  "description": "E2E tests for OpenProject-Nextcloud-Keycloak integration",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/opf/openproject-e2e.git"
-  },
-  "scripts": {
-    "test": "playwright test",
-    "test:e2e": "playwright test",
-    "test:e2e:report": "playwright test; playwright show-report",
-    "test:e2e:chromium": "playwright test --project=chromium",
-    "test:e2e:firefox": "playwright test --project=firefox",
-    "test:e2e:headed": "PWDEBUG=0 playwright test --headed",
-    "test:e2e:ui": "playwright test --ui",
-    "test:e2e:debug": "playwright test --debug",
-    "test:edge": "E2E_ENV=edge playwright test",
-    "test:stage": "E2E_ENV=stage playwright test",
-    "test:local": "E2E_ENV=local playwright test",
-    "test:docker": "./run-tests.sh",
-    "report:show": "playwright show-report --host 0.0.0.0",
-    "playwright:install": "playwright install --with-deps"
-  },
-  "dependencies": {
-    "dotenv": "^17.2.4",
-    "undici": "^7.21.0",
-    "yaml": "^2.8.2"
-  },
-  "devDependencies": {
-    "@playwright/test": "^1.58.2",
-    "@types/node": "^25.2.3",
-    "ts-node": "^10.9.2"
-  },
-  "overrides": {
-    "diff": "^8.0.3"
-  }
-}
+{"name":"openproject-e2e","version":"1.0.0","description":"E2E tests for OpenProject-Nextcloud-Keycloak integration","repository":{"type":"git","url":"https://github.com/opf/openproject-e2e.git"},"scripts":{"test":"playwright test","test:e2e":"playwright test","test:e2e:report":"playwright test; playwright show-report","test:e2e:headed":"PWDEBUG=0 playwright test --headed","test:e2e:ui":"playwright test --ui","test:e2e:debug":"playwright test --debug","test:edge":"E2E_ENV=edge playwright test","test:stage":"E2E_ENV=stage playwright test","test:local":"E2E_ENV=local playwright test","test:docker":"./run-tests.sh","report:show":"playwright show-report --host 0.0.0.0","playwright:install":"playwright install --with-deps"},"dependencies":{"dotenv":"^17.2.4","undici":"^7.21.0"},"devDependencies":{"@playwright/test":"^1.58.2","@types/node":"^25.2.3","ts-node":"^10.9.2"},"overrides":{"diff":"^8.0.3"}}

pageobjects/base/BasePage.ts

@@ -2,6 +2,7 @@ import { Page, Locator } from '@playwright/test';
 import * as fs from 'fs';
 import * as path from 'path';
 import { resolveLocator, LocatorDescriptor, LocatorMap } from '../../utils/locator-resolver';
+import { logDebug } from '../../utils/logger';
 
 export interface LocatorsFile {
   url: string;
@@ -48,10 +49,10 @@ export abstract class BasePage {
    */
   async navigateTo(): Promise<void> {
     const url = process.env[this.getUrlEnvVar()] || this.locators.url;
-    console.log(`[PAGE NAVIGATION] Navigating to: ${url}`);
+    logDebug('[PAGE NAVIGATION] Navigating to:', url);
     await this.page.goto(url, { waitUntil: 'domcontentloaded' });
-    console.log(`[PAGE NAVIGATION] Current URL: ${this.page.url()}`);
-    console.log(`[PAGE NAVIGATION] Page title: ${await this.page.title()}`);
+    logDebug('[PAGE NAVIGATION] Current URL:', this.page.url());
+    logDebug('[PAGE NAVIGATION] Page title:', await this.page.title());
   }
 
   /**
@@ -71,7 +72,8 @@ export abstract class BasePage {
   }
 
   /**
-   * Take a screenshot
+   * Take a full-page screenshot to the project screenshots/ directory.
+   * For ad-hoc debugging; not used by the test suite.
    */
   async screenshot(filename: string): Promise<void> {
     const projectRoot = path.resolve(__dirname, '../..');

pageobjects/keycloak/KeycloakClientsPage.ts

@@ -1,6 +1,7 @@
 import { Page } from '@playwright/test';
 import { KeycloakBasePage } from './KeycloakBasePage';
 import { getErrorMessage } from '../../utils/error-utils';
+import { logDebug, logError } from '../../utils/logger';
 
 export class KeycloakClientsPage extends KeycloakBasePage {
   constructor(page: Page) {
@@ -20,61 +21,40 @@ export class KeycloakClientsPage extends KeycloakBasePage {
 
   async verifyClientsPresent(): Promise<boolean> {
     try {
-      console.log('[CLIENTS VERIFICATION] Starting client verification...');
-      console.log(`[CLIENTS VERIFICATION] Current URL: ${this.page.url()}`);
-      
-      // Wait for page to be fully loaded
+      logDebug('[CLIENTS VERIFICATION] Starting client verification...');
+      logDebug('[CLIENTS VERIFICATION] Current URL: %s', this.page.url());
       await this.page.waitForLoadState('networkidle', { timeout: 10000 }).catch(() => {});
       await this.page.waitForTimeout(1000);
-      
       const nextcloudClient = this.getLocator('nextcloudClientLink');
       const openprojectClient = this.getLocator('openprojectClientLink');
-      
-      console.log('[CLIENTS VERIFICATION] Waiting for nextcloud client...');
+      logDebug('[CLIENTS VERIFICATION] Waiting for nextcloud client...');
       await nextcloudClient.waitFor({ state: 'visible', timeout: 15000 });
-      console.log('[CLIENTS VERIFICATION] Nextcloud client found');
-      
-      console.log('[CLIENTS VERIFICATION] Waiting for openproject client...');
+      logDebug('[CLIENTS VERIFICATION] Nextcloud client found');
+      logDebug('[CLIENTS VERIFICATION] Waiting for openproject client...');
       await openprojectClient.waitFor({ state: 'visible', timeout: 15000 });
-      console.log('[CLIENTS VERIFICATION] Openproject client found');
-      
-      // Get text content - try multiple ways
+      logDebug('[CLIENTS VERIFICATION] Openproject client found');
       const nextcloudText = await nextcloudClient.textContent();
       const openprojectText = await openprojectClient.textContent();
-      
-      console.log(`[CLIENTS VERIFICATION] Nextcloud text: "${nextcloudText}"`);
-      console.log(`[CLIENTS VERIFICATION] Openproject text: "${openprojectText}"`);
-      
-      // Also try getting text from inner text or from a child element
+      logDebug('[CLIENTS VERIFICATION] Nextcloud text: "%s"', nextcloudText);
+      logDebug('[CLIENTS VERIFICATION] Openproject text: "%s"', openprojectText);
       const nextcloudTextTrimmed = nextcloudText?.trim().toLowerCase();
       const openprojectTextTrimmed = openprojectText?.trim().toLowerCase();
-      
-      // Check if the text contains the expected client names (more flexible)
-      const nextcloudMatch = nextcloudTextTrimmed === 'nextcloud' || 
+      const nextcloudMatch = nextcloudTextTrimmed === 'nextcloud' ||
                             nextcloudTextTrimmed?.includes('nextcloud');
-      const openprojectMatch = openprojectTextTrimmed === 'openproject' || 
+      const openprojectMatch = openprojectTextTrimmed === 'openproject' ||
                               openprojectTextTrimmed?.includes('openproject');
-      
-      console.log(`[CLIENTS VERIFICATION] Nextcloud match: ${nextcloudMatch}`);
-      console.log(`[CLIENTS VERIFICATION] Openproject match: ${openprojectMatch}`);
-      
-      // Alternative: Check if links are visible and contain expected href patterns
+      logDebug('[CLIENTS VERIFICATION] Nextcloud match: %s', nextcloudMatch);
+      logDebug('[CLIENTS VERIFICATION] Openproject match: %s', openprojectMatch);
       const nextcloudHref = await nextcloudClient.getAttribute('href');
       const openprojectHref = await openprojectClient.getAttribute('href');
-      
-      console.log(`[CLIENTS VERIFICATION] Nextcloud href: ${nextcloudHref}`);
-      console.log(`[CLIENTS VERIFICATION] Openproject href: ${openprojectHref}`);
-      
-      const result = (nextcloudMatch || nextcloudHref?.includes('nextcloud')) && 
+      logDebug('[CLIENTS VERIFICATION] Nextcloud href: %s', nextcloudHref);
+      logDebug('[CLIENTS VERIFICATION] Openproject href: %s', openprojectHref);
+      const result = (nextcloudMatch || nextcloudHref?.includes('nextcloud')) &&
                     (openprojectMatch || openprojectHref?.includes('openproject'));
-      
-      console.log(`[CLIENTS VERIFICATION] Final result: ${result}`);
+      logDebug('[CLIENTS VERIFICATION] Final result: %s', result);
       return result;
     } catch (error: unknown) {
-      console.error(
-        '[CLIENTS VERIFICATION] Error verifying clients:',
-        getErrorMessage(error),
-      );
+      logError('[CLIENTS VERIFICATION] Error verifying clients:', getErrorMessage(error));
       // Take a screenshot for debugging
       await this.screenshot('clients-verification-error.png').catch(() => {});
       return false;

pageobjects/keycloak/KeycloakLoginPage.ts

@@ -2,17 +2,7 @@ import { Page } from '@playwright/test';
 import { KeycloakBasePage } from './KeycloakBasePage';
 import { ADMIN_USER } from '../../utils/test-users';
 import { testConfig } from '../../utils/config';
-
-const escapeForRegex = (value: string): string => value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-
-const resolveHostname = (value?: string): string => {
-  if (!value) return '';
-  try {
-    return new URL(value).hostname;
-  } catch {
-    return value;
-  }
-};
+import { escapeForRegex, resolveHostname } from '../../utils/url-helpers';
 
 const keycloakHost = resolveHostname(process.env.KEYCLOAK_URL) || resolveHostname(testConfig.keycloak.host) || 'keycloak.test';
 const keycloakHostPattern = new RegExp(`.*${escapeForRegex(keycloakHost)}.*`);
@@ -65,7 +55,7 @@ export class KeycloakLoginPage extends KeycloakBasePage {
         { timeout: 15000 }
       );
     } catch {
-      await this.page.waitForTimeout(3000);
+      await this.page.waitForLoadState('domcontentloaded', { timeout: 5000 }).catch(() => {});
     }
   }
 }

pageobjects/keycloak/KeycloakRealmsPage.ts

@@ -2,6 +2,7 @@ import { Page } from '@playwright/test';
 import { KeycloakBasePage } from './KeycloakBasePage';
 import { KeycloakClientsPage } from './KeycloakClientsPage';
 import { getErrorMessage } from '../../utils/error-utils';
+import { logDebug, logWarn } from '../../utils/logger';
 
 export class KeycloakRealmsPage extends KeycloakBasePage {
   constructor(page: Page) {
@@ -34,7 +35,7 @@ export class KeycloakRealmsPage extends KeycloakBasePage {
       // Wait a bit for the table to be visible
       const cellCount = await realmCell.count();
       if (cellCount === 0) {
-        console.log(`[REALM CHECK] Realm "${realmName}" cell not found`);
+        logDebug('[REALM CHECK] Realm "%s" cell not found', realmName);
         return false;
       }
 
@@ -43,52 +44,42 @@ export class KeycloakRealmsPage extends KeycloakBasePage {
       const currentRealmBadge = realmCell.locator('span.pf-v5-c-badge.pf-m-read:has-text("Current realm")');
       const badgeCount = await currentRealmBadge.count();
       const isSelected = badgeCount > 0;
-      
-      console.log(`[REALM CHECK] Realm "${realmName}" is ${isSelected ? 'already selected' : 'not selected'}`);
+      logDebug('[REALM CHECK] Realm "%s" is %s', realmName, isSelected ? 'already selected' : 'not selected');
       return isSelected;
     } catch (error: unknown) {
-      console.log(
-        `[REALM CHECK] Could not determine if realm "${realmName}" is selected, assuming not. Error: ${getErrorMessage(error)}`
-      );
+      logDebug('[REALM CHECK] Could not determine if realm "%s" is selected, assuming not. Error:', realmName, getErrorMessage(error));
       return false;
     }
   }
 
   async selectRealm(realmName: string): Promise<void> {
-    console.log(`[REALM SELECTION] Selecting realm: ${realmName}`);
+    logDebug('[REALM SELECTION] Selecting realm: %s', realmName);
     const realmLink = this.page.locator(`a[href='#/${realmName}']`).filter({ hasText: realmName });
     await realmLink.waitFor({ state: 'visible', timeout: 10000 });
-    console.log(`[REALM SELECTION] Realm link found, clicking...`);
+    logDebug('[REALM SELECTION] Realm link found, clicking...');
     await realmLink.click();
-    // Wait for URL to update or realm to be selected
-    await this.page.waitForTimeout(3000); // Increased wait time for realm selection to complete
+    await this.page.waitForTimeout(3000);
     await this.page.waitForLoadState('networkidle', { timeout: 10000 }).catch(() => {});
-    // Additional wait for the badge to appear
     await this.page.waitForTimeout(1000);
-    console.log(`[REALM SELECTION] Realm selection completed`);
+    logDebug('[REALM SELECTION] Realm selection completed');
   }
 
   /**
    * Smart realm selection: checks if the realm is already selected,
    * and only selects it if necessary
    */
   async ensureRealmSelected(realmName: string): Promise<void> {
-    console.log(`[REALM SELECTION] Ensuring realm "${realmName}" is selected...`);
-    
+    logDebug('[REALM SELECTION] Ensuring realm "%s" is selected...', realmName);
     const isSelected = await this.isRealmSelected(realmName);
-    
     if (isSelected) {
-      console.log(`[REALM SELECTION] Realm "${realmName}" is already selected, skipping selection`);
+      logDebug('[REALM SELECTION] Realm "%s" is already selected, skipping selection', realmName);
       return;
     }
-    
-    console.log(`[REALM SELECTION] Realm "${realmName}" is not selected, selecting now...`);
+    logDebug('[REALM SELECTION] Realm "%s" is not selected, selecting now...', realmName);
     await this.selectRealm(realmName);
-    
-    // Verify the realm was selected successfully
     const verifySelected = await this.isRealmSelected(realmName);
     if (!verifySelected) {
-      console.warn(`[REALM SELECTION] Warning: Realm "${realmName}" may not have been selected successfully`);
+      logWarn('[REALM SELECTION] Realm "%s" may not have been selected successfully', realmName);
     }
   }