Refactor navigation URL resolution for Keycloak, Nextcloud, and OpenProject pages

- Introduced `resolveNavigationUrl` method in base page classes to standardize URL resolution.
- Updated Keycloak and Nextcloud page classes to utilize the new method.
- Enhanced OpenProject page classes to resolve URLs based on environment variables and configuration.
- Added utility functions `resolveServiceNavigationUrl` and `resolveServiceOrigin` for improved URL handling in `url-helpers.ts`.
- Updated environment variable handling in the E2E PullPreview workflow to include new URLs.

Author: Ihor-Khomenko

.github/workflows/e2e-pullpreview.yml

@@ -330,6 +330,8 @@ jobs:
             echo "OPENPROJECT_HOST=${preview_host}"
             echo "NEXTCLOUD_HOST=nextcloud.${preview_host}"
             echo "KEYCLOAK_HOST=keycloak.${preview_host}"
+            echo "OPENPROJECT_URL=${preview_url}"
+            echo "NEXTCLOUD_URL=${nextcloud_url}"
             echo "E2E_ENV=pullpreview"
           } >> "$GITHUB_ENV"
 

pageobjects/base/BasePage.ts

@@ -48,13 +48,21 @@ export abstract class BasePage {
    * Navigate to the page URL
    */
   async navigateTo(): Promise<void> {
-    const url = process.env[this.getUrlEnvVar()] || this.locators.url;
+    const url = this.resolveNavigationUrl();
     logDebug('[PAGE NAVIGATION] Navigating to:', url);
     await this.page.goto(url, { waitUntil: 'domcontentloaded' });
     logDebug('[PAGE NAVIGATION] Current URL:', this.page.url());
     logDebug('[PAGE NAVIGATION] Page title:', await this.page.title());
   }
 
+  /**
+   * Resolved start URL for this page. Domain base pages override to honor *_HOST and testConfig.
+   */
+  protected resolveNavigationUrl(): string {
+    const key = this.getUrlEnvVar();
+    return (key && process.env[key]) || this.locators.url;
+  }
+
   /**
    * Get the environment variable name for the URL
    * Override in subclasses if needed

pageobjects/keycloak/KeycloakBasePage.ts

@@ -1,5 +1,7 @@
 import { Page } from '@playwright/test';
 import { BasePage } from '../base/BasePage';
+import { testConfig } from '../../utils/config';
+import { resolveServiceNavigationUrl } from '../../utils/url-helpers';
 
 export abstract class KeycloakBasePage extends BasePage {
   constructor(page: Page) {
@@ -10,8 +12,22 @@ export abstract class KeycloakBasePage extends BasePage {
     return 'KEYCLOAK_URL';
   }
 
+  protected resolveNavigationUrl(): string {
+    return resolveServiceNavigationUrl(
+      process.env.KEYCLOAK_URL,
+      process.env.KEYCLOAK_HOST,
+      testConfig.keycloak.host,
+      this.locators.url,
+    );
+  }
+
   protected get baseUrl(): string {
-    return process.env.KEYCLOAK_URL || this.locators.url;
+    return resolveServiceNavigationUrl(
+      process.env.KEYCLOAK_URL,
+      process.env.KEYCLOAK_HOST,
+      testConfig.keycloak.host,
+      this.locators.url,
+    );
   }
 }
 

pageobjects/keycloak/KeycloakLoginPage.ts

@@ -4,7 +4,11 @@ import { ADMIN_USER } from '../../utils/test-users';
 import { testConfig } from '../../utils/config';
 import { escapeForRegex, resolveHostname } from '../../utils/url-helpers';
 
-const keycloakHost = resolveHostname(process.env.KEYCLOAK_URL) || resolveHostname(testConfig.keycloak.host) || 'keycloak.test';
+const keycloakHost =
+  resolveHostname(process.env.KEYCLOAK_URL) ||
+  resolveHostname(process.env.KEYCLOAK_HOST) ||
+  resolveHostname(testConfig.keycloak.host) ||
+  'keycloak.test';
 const keycloakHostPattern = new RegExp(`.*${escapeForRegex(keycloakHost)}.*`);
 
 export class KeycloakLoginPage extends KeycloakBasePage {

pageobjects/nextcloud/NextcloudBasePage.ts

@@ -1,5 +1,7 @@
 import { Page } from '@playwright/test';
 import { BasePage } from '../base/BasePage';
+import { testConfig } from '../../utils/config';
+import { resolveServiceNavigationUrl } from '../../utils/url-helpers';
 
 export abstract class NextcloudBasePage extends BasePage {
   constructor(page: Page) {
@@ -10,8 +12,22 @@ export abstract class NextcloudBasePage extends BasePage {
     return 'NEXTCLOUD_URL';
   }
 
+  protected resolveNavigationUrl(): string {
+    return resolveServiceNavigationUrl(
+      process.env.NEXTCLOUD_URL,
+      process.env.NEXTCLOUD_HOST,
+      testConfig.nextcloud.host,
+      this.locators.url,
+    );
+  }
+
   protected get baseUrl(): string {
-    return process.env.NEXTCLOUD_URL || this.locators.url;
+    return resolveServiceNavigationUrl(
+      process.env.NEXTCLOUD_URL,
+      process.env.NEXTCLOUD_HOST,
+      testConfig.nextcloud.host,
+      this.locators.url,
+    );
   }
 }
 

pageobjects/openproject/OpenProjectBasePage.ts

@@ -1,9 +1,13 @@
 import { Page } from '@playwright/test';
 import { BasePage } from '../base/BasePage';
 import { testConfig } from '../../utils/config';
-import { escapeForRegex, resolveHostname } from '../../utils/url-helpers';
+import { escapeForRegex, resolveHostname, resolveServiceNavigationUrl, resolveServiceOrigin } from '../../utils/url-helpers';
 
-const openProjectHost = resolveHostname(process.env.OPENPROJECT_URL) || resolveHostname(testConfig.openproject.host) || 'openproject.test';
+const openProjectHost =
+  resolveHostname(process.env.OPENPROJECT_URL) ||
+  resolveHostname(process.env.OPENPROJECT_HOST) ||
+  resolveHostname(testConfig.openproject.host) ||
+  'openproject.test';
 const openProjectHostPattern = new RegExp(`.*${escapeForRegex(openProjectHost)}.*`);
 
 export abstract class OpenProjectBasePage extends BasePage {
@@ -15,8 +19,22 @@ export abstract class OpenProjectBasePage extends BasePage {
     return 'OPENPROJECT_URL';
   }
 
+  protected resolveNavigationUrl(): string {
+    return resolveServiceNavigationUrl(
+      process.env.OPENPROJECT_URL,
+      process.env.OPENPROJECT_HOST,
+      testConfig.openproject.host,
+      this.locators.url,
+    );
+  }
+
   protected get baseUrl(): string {
-    return process.env.OPENPROJECT_URL || this.locators.url.replace('/login', '');
+    return resolveServiceOrigin(
+      process.env.OPENPROJECT_URL,
+      process.env.OPENPROJECT_HOST,
+      testConfig.openproject.host,
+      this.locators.url,
+    );
   }
 
   // URL path constants

pageobjects/openproject/OpenProjectLoginPage.ts

@@ -6,7 +6,11 @@ import { OP_ADMIN_USER } from '../../utils/test-users';
 import { testConfig } from '../../utils/config';
 import { escapeForRegex, resolveHostname } from '../../utils/url-helpers';
 
-const keycloakHost = resolveHostname(process.env.KEYCLOAK_URL) || resolveHostname(testConfig.keycloak.host) || 'keycloak.test';
+const keycloakHost =
+  resolveHostname(process.env.KEYCLOAK_URL) ||
+  resolveHostname(process.env.KEYCLOAK_HOST) ||
+  resolveHostname(testConfig.keycloak.host) ||
+  'keycloak.test';
 const keycloakHostPattern = new RegExp(`.*${escapeForRegex(keycloakHost)}.*`);
 
 export class OpenProjectLoginPage extends OpenProjectBasePage {

utils/url-helpers.ts

@@ -16,3 +16,62 @@ export function resolveHostname(value?: string): string {
     return value;
   }
 }
+
+/**
+ * Resolve the URL used for `page.goto` for a service: prefer full URL env, then build from
+ * host env / config host using pathname + search from the locator default, else locator default.
+ */
+export function resolveServiceNavigationUrl(
+  fullUrlEnv: string | undefined,
+  hostEnv: string | undefined,
+  configHost: string,
+  locatorDefaultFullUrl: string,
+): string {
+  const full = fullUrlEnv?.trim();
+  if (full) {
+    try {
+      const u = new URL(full);
+      const loc = new URL(locatorDefaultFullUrl);
+      if ((u.pathname === '/' || u.pathname === '') && loc.pathname && loc.pathname !== '/') {
+        return `${u.origin}${loc.pathname}${loc.search}`;
+      }
+      return full;
+    } catch {
+      return full;
+    }
+  }
+
+  const hostLike = (hostEnv || configHost || '').trim();
+  if (!hostLike) return locatorDefaultFullUrl;
+
+  let origin: string;
+  try {
+    const withProto = hostLike.includes('://') ? hostLike : `https://${hostLike}`;
+    const u = new URL(withProto);
+    origin = `${u.protocol}//${u.host}`;
+  } catch {
+    return locatorDefaultFullUrl;
+  }
+
+  try {
+    const loc = new URL(locatorDefaultFullUrl);
+    return `${origin}${loc.pathname}${loc.search}`;
+  } catch {
+    return `${origin}/`;
+  }
+}
+
+/** Site origin for building path-based URLs (e.g. OpenProject base without `/login`). */
+export function resolveServiceOrigin(
+  fullUrlEnv: string | undefined,
+  hostEnv: string | undefined,
+  configHost: string,
+  locatorDefaultFullUrl: string,
+): string {
+  const nav = resolveServiceNavigationUrl(fullUrlEnv, hostEnv, configHost, locatorDefaultFullUrl);
+  try {
+    return new URL(nav).origin;
+  } catch {
+    return nav;
+  }
+}