Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stopsopa/playwright-research


https://github.com/stopsopa/playwright-research

Last synced: 22 days ago
JSON representation

Awesome Lists containing this project

README 

        
# build custom image



[docker/README.md](docker/README.md)



# known issue



if you would like to test self signed cert https link on the host machine then read more about --add-host=local.something.dev.com:host-gateway flag:

https://medium.com/@TimvanBaarsen/how-to-connect-to-the-docker-host-from-inside-a-docker-container-112b4c71bc66

g(medium.com Tim van Baarsen How to connect to the Docker host from inside a Docker container?)



```

/bin/bash playwright.sh --target docker --nohost -- --add-host=local.something.dev.com:host-gateway -v "$(pwd)/.env.local:/code/.env" -- test/e2e/product-create.e2e.js

```



# What is purpose of this repository?



The idea behind this repository is to create single point of execution to run playwright tests in most portable way possible across different scenarios:



    1) run all tests locally against your local server to have all test "blink" in front of your eyes



    2) run all tests locally against your local server in headless mode



    3) run all tests locally against any remote server to have all test "blink" in front of your eyes



    4) run all tests locally in docker against your local server in headless mode



    5) run all tests locally in docker against any remote server in headless mode



    6) and so on



...to make it hassle free, to make developers to focus on coding and tests and not to think how things should be configured for each above case to make them work.    

Testing tools should be always simply ready to use, more work dev will have around that, less tests he will write.



Additionally



    a) all above should be done by executing single line of code



    b) command should return proper exit code



    c) filtering tests to run single directory or single test.spec file



    d) injecting env vars one by one or via injecting different .env file (or both)



    e) it should have place to configure what should be mounted for tests to "docker run -v ..." if executed in docker mode



    f) if tests executed in docker, version of docker image should be determined by extracting version of "[playwright](https://www.npmjs.com/package/playwright)" library from local package.json



    g) if tests executed in docker command should return the final docker run command executed



    h) it should provide way to control all arguments of "docker run" command



    i) it should provide way to control all arguments of "playwrite run" command



    j) it should run tests in headless mode by default if executed in docker



    k) it should run tests in headed mode by default if executed on local machine



    l) should allow you to choose one browser to run tests against from playwright.config.js



    m) command also should be usable in pipelines



To achieve all above there is few "things" needed:

- playwright.sh file

- playwright-docker-defaults.sh file (can be generated with defaults by playwright.sh)

- playwright.sh will require [playwright browser installed globally](https://playwright.dev/docs/intro#installing-playwright) for local executing

- playwright.sh will require to have "[playwright](https://www.npmjs.com/package/playwright)" and "[@playwright/test](https://www.npmjs.com/package/@playwright/test)" installed in local package.json dependencies (both in the same version)

- you need to have some tests (by default in "tests" directory)

- you also have to have playwright.config.js (obviously)



Here are examples how to achieve each point from above requirements:



# 1



```



/bin/bash playwright.sh



```



Just running script with no params should execute tests locally and make them blink in front of your eyes.



(Obviously you have to have your server running)



# 2



```



/bin/bash playwright.sh --headless



```



read "/bin/bash playwright.sh -h" for details



# doc



- [Expect](https://jestjs.io/docs/expect) also [Assertions doc page](https://playwright.dev/docs/test-assertions) and [Playwright test doc page](https://playwright.dev/docs/api/class-test)

- [Debugging selector](https://playwright.dev/docs/inspector#debugging-selectors)

- [Trace on retry](https://playwright.dev/docs/trace-viewer#recording-a-trace)

- [Record session an reuse it](https://playwright.dev/docs/codegen#preserve-authenticated-state) Also for [API testing](https://playwright.dev/docs/test-api-testing#reusing-authentication-state). See also [Intercepting with Route](https://playwright.dev/docs/api/class-route)

- [Codegen](https://playwright.dev/docs/codegen) [Non standard context](https://playwright.dev/docs/codegen#record-using-custom-setup)

- [Skip test - conditions](https://playwright.dev/docs/test-annotations#conditionally-skip-a-group-of-tests)

- [Emulate geolocation](https://playwright.dev/docs/codegen#emulate-geolocation-language-and-timezone)

- [slowMo](https://playwright.dev/docs/debug#run-in-headed-mode)

- [as a lib](as-a-lib.js) -> [from](https://playwright.dev/docs/api/class-page#page-event-request-failed) also [Playwright Library doc page](https://playwright.dev/docs/api/class-playwright)



# cmd

- https://playwright.dev/docs/intro#command-line



# watch mode

https://github.com/microsoft/playwright/issues/7035



# some extra doc pages

- [Listening to console](https://playwright.dev/docs/api/class-consolemessage) and native PW [logger](https://playwright.dev/docs/api/class-logger)

- File [Download](https://playwright.dev/docs/api/class-download) and [Upload](https://playwright.dev/docs/api/class-filechooser)

- [Interacting with element](https://playwright.dev/docs/api/class-elementhandle)

- [Keyboard](https://playwright.dev/docs/api/class-keyboard)



# last read doc page

https://playwright.dev/docs/intro



# todo

- [x] integrate with GH Actions

- [x] build some example tests

- [x] make docker image version package.json '@playwright/test' driven



# DEV NOTES



```



node server.js

# make sure to have .env file

/bin/bash playwright.sh 



```