From a666d7b2f53d874687e4a25dac26bc1479c37cfb Mon Sep 17 00:00:00 2001
From: Muhammed Mustafa <mustafa@nocodb.com>
Date: Fri, 11 Nov 2022 16:49:47 +0530
Subject: [PATCH] fix(test): Improved playwright README

---
 packages/nc-gui/tests/playwright/README.md | 41 ++++++++++++++++------
 1 file changed, 31 insertions(+), 10 deletions(-)

diff --git a/packages/nc-gui/tests/playwright/README.md b/packages/nc-gui/tests/playwright/README.md
index 898578e204..6a2585b9d0 100644
--- a/packages/nc-gui/tests/playwright/README.md
+++ b/packages/nc-gui/tests/playwright/README.md
@@ -14,7 +14,7 @@ npx playwright install chromium --with-deps
 Start the backend test server (in `packages/nocodb` folder):
 
 ```bash
-npm run watch:run:playwright:quick
+npm run watch:run:playwright
 ```
 
 Start the frontend test server (in `packages/nc-gui` folder):
@@ -29,10 +29,33 @@ NUXT_PAGE_TRANSITION_DISABLE=true npm run dev
 
 For selecting db type, rename `.env.example` to `.env` and set `E2E_DEV_DB_TYPE` to  `sqlite`(default), `mysql` or `pg`.
 
+headless mode(without opening browser):
+
 ```bash
 npm run test
 ```
 
+with browser:
+
+```bash
+npm run test:debug
+```
+
+</br>
+</br>
+
+For setting up mysql:
+
+```bash
+docker-compose -f ./packages/nc-gui/tests/playwright/scripts/docker-compose-mysql-playwright.yml  up -d
+```
+
+For setting up postgres:
+
+```bash
+docker-compose -f ./packages/nc-gui/tests/playwright/scripts/docker-compose-playwright-pg.yml 
+```
+
 ### Running individual tests
 
 Add `.only` to the test you want to run:
@@ -55,25 +78,23 @@ In Webstorm, you can use the `test-debug` run action to run the tests.
 
 Add `.only` to the test you want to run. This will open the test in a chromium session and you can also add break points.
 
-i.e `test.only('should login', async ({ page }) => {`
-
 ### VSCode
 
-In VSCode, use this [https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chromium](extension).
+In VSCode, use this [extension](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright).
 
 It will have run button beside each test in the file.
 
-### Page Objects
+## Page Objects
 
-Page object is a class which has methods to interact with a page/component. Methods should be thin and should not do a whole lot. They should also be reusable.
+- Page object is a class which has methods to interact with a page/component. Methods should be thin and should not do a whole lot. They should also be reusable.
 
-All the action methods i.e click of a page object is also responsible for waiting till the action is completed. This can be done by waiting on an API call or some ui change.
+- All the action methods i.e click of a page object is also responsible for waiting till the action is completed. This can be done by waiting on an API call or some ui change.
 
-Do not add any logic to the tests. Instead, create a page object for the page you are testing.
+- Do not add any logic to the tests. Instead, create a page object for the page you are testing.
 All the selection, UI actions and assertions should be in the page object.
 
 Page objects should be in `packages/nc-gui/tests/playwright/pages` folder.
 
-### Verify if tests are not flaky
+## Verify if tests are not flaky
 
-Add `.only` to the added test and run `npm run test:repeat`. This will run the test multiple times and should show if the test is flaky.
+Add `.only` to the added tests and run `npm run test:repeat`. This will run the test multiple times and should show if the test is flaky.