Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

cherry-pick(#23582): docs: enhance UI mode docs (#23604)

Browse source 
This PR cherry-picks the following commits:

- 42ad9e71cb

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
This commit is contained in:
Playwright Service 2023-06-08 12:53:06 -07:00 committed by GitHub
parent 3e94abe1d9
commit f28d156039
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/src/test-ui-mode-js.md
View file

@ -82,12 +82,22 @@ Next to the name of each test in the sidebar you will find an eye icon. Clicking
![watch mode in ui mode](https://user-images.githubusercontent.com/13063165/234304918-dd0fb6d5-bfb1-4182-8c55-33cd3da5f83e.png)
### Github CodeSpaces support
### Docker & GitHub Codespaces
To run UI mode inside Github CodeSpaces, run the following:
For Docker and GitHub Codespaces environments, you can run UI mode in the browser. In order for an endpoint to be accessible outside of the container, it needs to be bound to the `0.0.0.0` interface:
```bash
npx playwright test --ui-port=0
npx playwright test --ui-host=0.0.0.0
```
After that, the UI mode will be automatically available to you in a separate browser tab, thanks to the [CodeSpaces automatic port forwarding](https://docs.github.com/en/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace#about-forwarded-ports).
In the case of GitHub Codespaces, the port gets [forwarded automatically](https://docs.github.com/en/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace#about-forwarded-ports), so you can open UI mode in the browser by clicking on the link in the terminal.
To have a static port, you can pass the `--ui-port` flag:
```bash
npx playwright test --ui-port=8080 --ui-host=0.0.0.0
```
:::note
Be aware that when specifying the `--ui-host=0.0.0.0` flag, UI Mode with your traces, the passwords and secrets is accessible from other machines inside your network. In the case of GitHub Codespaces, the ports are only accessible from your account by default.
:::