chore: merge from feature/improve-localhost-run-test to develop

Author: vOrigins

README.md

@@ -1,6 +1,8 @@
 # APIHUB UI auto-tests
 This project is used to create and run auto-tests, primarily for UI E2E. The framework used is [Playwright](https://playwright.dev/).
 
+[Features of running on a **localhost**](docs/localhost-run.md)
+
 ## Contents
 - [Installation](#installation)
 - [Environment variables](#environment-variables)
@@ -26,7 +28,7 @@ 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).
+**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](docs/localhost-run.md).
 
 **DEV_PROXY_MODE** - Only Required for testing on **localhost** in dev proxy mode.
 

docs/localhost-run.md

@@ -0,0 +1,12 @@
+# Features of running on a localhost
+To test the "Playground" via a localhost, in playwright tests, you need to set a value for the `PLAYGROUND_BACKEND_HOST` environment variable, it will be used in the test to create a custom server for sending requests.
+In case of using Docker Compose, this is `http://host.docker.internal:8081` (protocol + value of the `APIHUB_URL` variable from the [qubership-apihub-backend.env](https://github.com/Netcracker/qubership-apihub/blob/main/docker-compose/qubership-apihub-backend.env) file). Also, you need to add the variable `ALLOWED_HOSTS=host.docker.internal` to the [qubership-apihub-backend.env](https://github.com/Netcracker/qubership-apihub/blob/main/docker-compose/qubership-apihub-backend.env) file.
+
+In case of using docker compose + dev proxy, in addition to the previous settings, in playwright tests, you need to add the variable `DEV_PROXY_MODE=true`, to skip tests that cannot be executed in this mode.
+
+
+|                                               | Live environment | Docker compose                                                                                                                       | Docker compose + dev proxy                                                                                                          |
+| --------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
+| Playground tests                              | ✔️               | ✔️ `ALLOWED_HOSTS=host.docker.internal` - in docker compose<br>`PLAYGROUND_BACKEND_HOST=http://host.docker.internal:8081` - in tests | ✔️ `ALLOWED_HOSTS=host.docker.internal` - in docker compose<br>`PLAYGROUND_BACKEND_HOST=http://host.docker.internal:8081` - in test |
+| Tests with rediretcs to the Agent             | ✔️               | ✔️                                                                                                                                   | ❌ Skipped with `DEV_PROXY_MODE=true` - in tests                                                                                     |
+| Expand/collapse the Package page sidebar test | ✔️               | ✔️                                                                                                                                   | ❌ Skipped with `DEV_PROXY_MODE=true` - in tests                                                                                     |

package-lock.json

@@ -20,7 +20,7 @@ import { getSysInfo } from '@test-data/props'
 import { AgentPage } from '@agent/pages'
 import { PortalPage } from '@portal/pages'
 import { MIDDLE_EXPECT, TICKET_BASE_URL } from '@test-setup'
-import { isLocalHost } from '@services/utils'
+import { isDevProxyMode } from '@services/utils'
 
 test.describe('General', () => {
 
@@ -53,7 +53,7 @@ test.describe('General', () => {
       annotation: { type: 'Test Case', description: `${TICKET_BASE_URL}TestCase-A-4279` },
     },
     async ({ sysadminPage: page }) => {
-      test.skip(isLocalHost(), 'Does not support localhost execution')
+      test.skip(isDevProxyMode(), 'Does not support dev proxy mode')
 
       const portalPage = new PortalPage(page)
       const agentPage = new AgentPage(page)

src/tests/portal/01-general/1.2-general.spec.ts

@@ -41,7 +41,7 @@ import {
   V_P_PKG_EDITING_SEARCH_R,
 } from '@test-data/portal'
 import { PUBLISH_TIMEOUT, TICKET_BASE_URL } from '@test-setup'
-import { isLocalHost } from '@services/utils'
+import { isDevProxyMode } from '@services/utils'
 
 test.describe('4.3.2 Package publishing via Portal', () => {
 
@@ -66,8 +66,8 @@ test.describe('4.3.2 Package publishing via Portal', () => {
         await expect(configureVersionTab.filesUploader).toBeVisible()
       })
 
-      //Does not support localhost execution
-      if (!isLocalHost()) {
+      //Does not support dev proxy mode
+      if (!isDevProxyMode()) {
         await test.step('Agent option', async () => {
           await portalPage.gotoPackage(testPackage)
           await versionPage.howToUploadBtn.click()