josdem / playwright-workshop

Playwright capabilities workshop

Playwright Workshop

This is a getting started project with Playwright

Requirements

• NodeJS version v18.16.0

Note: I recommed to use NVM to manage NodeJS versions

To build the project

npm install

To format the project

npx prettier --write .

To run the project

npx playwright test

To see integrated reports

npx playwright show-report

To see deployed reports

• You can deploy generated reports using a SSK key: playwright-report
• For more information go here

If you want to generate Allure Reports

• Install allure command line: npm install -g allure-commandline --save-dev
• Execute this command: allure generate && allure serve -h localhost

playwright-workshop's Issues

Add Allure custom tags

As a user, I want to add a custom tag to the Allure Report,so that I can add links to the report

Acceptance Criteria

• I am able to see tags in Allure report.

Add custom tags

As a user, I want to add custom tags to the test cases so that I can store link a test with a GitHub issue

Acceptance Criteria

• I am able to add a custom tag in the test
• I can see a link in the test to the GitHub issue

Generate Allure report using Playwright

As a user I would like to generate an Allure report so that I can have another alternative for end-to-end report testing

Acceptance Criteria

• I generate Allure report structure
• I have a PR with the code implementation

Upload an artifact to a NGIX server

Todo
As a user, I want to deploy an artifact to a NGIX so that I can have full control on the artifact files

Acceptance Criteria

• An artifact from GitHub actions is uploaded to an NGINX server
• I updated the project documentation

Resources
https://philo.dev/how-to-use-github-actions-build-matrix-to-deploy-artifacts-to-multiple-servers/

Add prettier to format code

Todo
As a user, I want to add prettier to the project, so that I can format the code

Acceptance Criteria

• I am able to format code using prettier command
• I am able to see prettier command in the readme file

References
https://prettier.io/

Set testing data in a properties file

Todo
As a user, I want to read testing data from external files, so that I can avoid hardcoding those values in specs files

Acceptance Criteria

• I am able to set URL target value in a configuration / properties file
• I am able to import those values in specs files

Load playwright reports from GitHub actions

Todo
As a user, I want to see generated Playwright reports as part of the GitHub actions workflow, so that I can see the results from the execution

Acceptance Criteria
I have a link where I can see Playwright reports

References
https://github.com/marketplace/actions/html-preview

Integrate Applitools

Todo
As a user, I want to add Applitools configuration to the end-to-end test cases so that I can implement visual validation.

Acceptance Criteria

• Able to see Vetlog screenshots in Applitools dashboard
• Add Applitools configuration and execution information

Add GitHub actions

Todo

As a user, I would like to add GitHub actions configuration so that I can execute tests in every push.

Acceptance Criteria

• I am able to see GitHub actions files
• I am able to run test cases using GitHub actions

References
https://docs.github.com/en/actions/quickstart

Integrate Allure reports

Todo
As a user, I want to integrate Allure reports to the repository so that I can generate reports from executions

Acceptance Criteria

• I am able to generate Allure reports
• I am able to maintain trends in executions

References
https://allure-framework.github.io/allure-demo/5/