feat: handle running UI tests on localhost

Author: vOrigins

README.md

@@ -26,6 +26,12 @@ Before starting test execution, you need to set environment variables in any con
 
 **TEST_USER_PASSWORD** - The password that will be used by test users.
 
+**PLAYGROUND_BACKEND_HOST** - Only Required for testing on **localhost**. The host that will be used in the test to create a custom server for sending requests. More information can be found at the [link](https://github.com/Netcracker/qubership-apihub/issues/18).
+
+**DEV_PROXY_MODE** - Only Required for testing on **localhost** in dev proxy mode.
+
+`true` - skip tests that cannot be executed in this mode.
+
 ### Optional environment variables:
 **TICKET_SYSTEM_URL** - Base address of the ticket management system. Adds interactivity to links to test cases and issues.
 

src/services/utils/browser.ts

@@ -19,7 +19,8 @@ import { type Credentials, type DownloadedTestFile, ROOT_DOWNLOADS } from '@shar
 import { readFile } from 'fs/promises'
 import { stringifyError } from './errors'
 import path from 'node:path'
-import { BASE_URL } from '@test-setup'
+import { BASE_ORIGIN, BASE_URL, PLAYGROUND_BACKEND_HOST } from '@test-setup'
+import process from 'process'
 
 export const asyncTimeout = async (milliseconds: number): Promise<void> => {
   await new Promise(resolve => setTimeout(resolve, milliseconds))
@@ -55,3 +56,15 @@ export const getDownloadedFile = async (download: Download): Promise<DownloadedT
 export const isLocalHost = (): boolean => {
   return BASE_URL.hostname === 'localhost'
 }
+
+export const isDevProxyMode = (): boolean => {
+  return process.env.DEV_PROXY_MODE === 'true'
+}
+
+export const getPlaygroundCustomServer = (): string => {
+  if (isLocalHost()) {
+    if (!PLAYGROUND_BACKEND_HOST) throw Error(`You run tests on localhost but PLAYGROUND_BACKEND_HOST is ${PLAYGROUND_BACKEND_HOST}`)
+    return `${PLAYGROUND_BACKEND_HOST}/api/v1`
+  }
+  return `${BASE_ORIGIN}/api/v1`
+}

src/test-setup/urls.ts

@@ -23,3 +23,5 @@ export const BASE_ORIGIN = BASE_URL.origin
 const ticketSystemUrl = process.env.TICKET_SYSTEM_URL ? new URL(process.env.TICKET_SYSTEM_URL as string).origin : ''
 
 export const TICKET_BASE_URL = ticketSystemUrl ? `${ticketSystemUrl}/browse/` : ''
+
+export const { PLAYGROUND_BACKEND_HOST } = process.env

src/tests/global-setup.ts

@@ -28,6 +28,8 @@ async function globalSetup(): Promise<void> {
   // Print environment variables
   logEnvVars([
     'BASE_URL',
+    'PLAYGROUND_BACKEND_HOST',
+    'DEV_PROXY_MODE',
     'TICKET_SYSTEM_URL',
     'AUTH',
     'CREATE_TD',

src/tests/portal/04-entity-actions/4.3.2-package-editing-publishing.spec.ts

@@ -66,6 +66,7 @@ test.describe('4.3.2 Package publishing via Portal', () => {
         await expect(configureVersionTab.filesUploader).toBeVisible()
       })
 
+      //Does not support localhost execution
       if (!isLocalHost()) {
         await test.step('Agent option', async () => {
           await portalPage.gotoPackage(testPackage)

src/tests/portal/05-view-details/5.2.1-package-details.spec.ts

@@ -33,6 +33,7 @@ import {
   V_P_PKG_WITHOUT_LABELS_R,
 } from '@test-data/portal'
 import { SYSADMIN } from '@test-data'
+import { isDevProxyMode } from '@services/utils'
 
 test.describe('5.2.1 Package details', () => {
 
@@ -214,6 +215,7 @@ test.describe('5.2.1 Package details', () => {
       annotation: { type: 'Test Case', description: `${TICKET_BASE_URL}TestCase-A-4655` },
     },
     async ({ sysadminPage: page }) => {
+      test.skip(isDevProxyMode(), 'Does not support dev proxy')
 
       const portalPage = new PortalPage(page)
       const { versionPackagePage: versionPage } = portalPage

src/tests/portal/11-operations-details/11.1.1-details-rest-api-package.spec.ts

@@ -32,8 +32,8 @@ import {
   V_P_PKG_OPERATIONS_REST_R,
   V_P_PKG_PLAYGROUND_R,
 } from '@test-data/portal'
-import { BASE_ORIGIN, SEARCH_TIMEOUT, TICKET_BASE_URL } from '@test-setup'
-import { isLocalHost } from '@services/utils'
+import { SEARCH_TIMEOUT, TICKET_BASE_URL } from '@test-setup'
+import { getPlaygroundCustomServer } from '@services/utils'
 
 test.describe('11.1.1 Operations details REST API (Package)', () => {
 
@@ -262,7 +262,6 @@ test.describe('11.1.1 Operations details REST API (Package)', () => {
       const { operationPage } = portalPage
       const accessToken = (await getAuthDataFromPage(page)).token
       const testPackage = P_PK_PGND
-      const testCustomServerHost = isLocalHost() ? 'http://host.docker.internal:8081/api/v1' : `${BASE_ORIGIN}/api/v1`
 
       await portalPage.gotoOperation(versionPlayground, GET_SYSTEM_INFO)
       await operationPage.toolbar.playgroundBtn.click()
@@ -302,7 +301,7 @@ test.describe('11.1.1 Operations details REST API (Package)', () => {
 
         await test.step('Add server 2 and select it', async () => {
           await operationPage.playgroundPanel.serverSlt.addCustomServerBtn.click()
-          await operationPage.playgroundPanel.addServerDialog.urlTxtFld.fill(testCustomServerHost)
+          await operationPage.playgroundPanel.addServerDialog.urlTxtFld.fill(getPlaygroundCustomServer())
           await operationPage.playgroundPanel.addServerDialog.addBtn.click()
           await operationPage.playgroundPanel.serverSlt.click()