- Test Automation - Accelerating Playwright TypeScript Tests with Parallel Execution in GitHub Actions and Allure Reporting
- Test Automation - How to Use Dynamic Base URLs with Playwright TypeScript in GitHub Actions
- Test Automation - How To Attach Public IP Address to Allure Report using Playwright TypeScript Auto Fixtures
- Test Automation - Data-Driven Testing (DDT) with Playwright TypeScript Using Excel
- Test Automation - Efficient Element Selection with Playwright Typescript using Test IDs
- Test Automation - Optimizing Playwright Test Reports: Automating Allure Results Merging with GitHub Actions
- Test Automation – Unleashing the Power of AI with Playwright and TypeScript
- Guarding the Guards: Building a Pre-Merge Quality Gate for Your TypeScript Automation Framework
- Your CI/CD Pipeline Is a Lie: The Case for On-Demand Environments as the Real Quality Gate
| Tool | Description |
|---|---|
| @types/node | TypeScript definitions for Node.js |
| allure-playwright | Allure framework integration for Playwright Test framework |
| dotenv | Loads environment variables from a .env file into process.env |
| husky | Git hooks for enforcing rules in commits and push events |
| lint-staged | Run linters on git staged files |
| Playwright | A framework for Web Testing and Automation |
| TypeScript | A typed superset of JavaScript |
| xlsx | Library to parse and write Excel files |
| Biome | A toolchain for web projects, aimed to provide developer tools for verifying code and boosting productivity. |
For the best development experience, we recommend installing the Biome IntelliJ plugin.
git clone https://github.com/nirtal85/playwright-typescript-example.git
cd playwright-typescript-examplecorepack enable
pnpm installplaywright install --with-depsCreate a .env file in the project root directory to securely store project secrets and configuration variables. This file will be used to define key-value pairs for various parameters required by the project. Add the following properties to the .env file:
| Parameter | Description | Example Value |
|---|---|---|
| DOMAIN | Current execution environment (e.g., DEV, CANARY, PROD). Defaults to DEV. | "DEV" |
| BASE_URL | The base URL for the application | "https://example.com" |
| MAILINATOR_API_KEY | API Key for Mailinator service | "your_mailinator_api_key" |
| MAILINATOR_DOMAIN | Domain name for Mailinator | "your_mailinator_domain" |
| LD_TOKEN | LaunchDarkly API access token. | "api-xxxxxxxxxxxxxxxxxxxx" |
These variables are required if using the VisualTrackerService.
| Parameter | Description | Example Value |
|---|---|---|
| VRT_APIURL | Visual Regression Tracker API URL | "https://vrt.example.com/api" |
| VRT_PROJECT | Visual Regression Tracker Project ID | "project_id" |
| VRT_CIBUILDID | Visual Regression Tracker Build Number | "build_number" |
| VRT_BRANCHNAME | Visual Regression Tracker Branch Name | "main" |
| VRT_APIKEY | Visual Regression Tracker API Key | "your_api_key" |
These variables are required if using the DatabaseService.
| Parameter | Description | Example Value |
|---|---|---|
| DB_HOST | Hostname or IP address of the MySQL database server. | "db.dev.example.com" |
| DB_PORT | Port number for the MySQL database server (optional). | 3306 |
| DB_USER | Username for connecting to the database. | "your_db_user" |
| DB_PASSWORD | Password for the database user. | "your_secret_db_password" |
| DB_DATABASE | Default database/schema name to use (optional). | "my_application_schema" |
These variables are required if using the SftpService.
| Parameter | Description | Example Value |
|---|---|---|
| SFTP_HOST | Hostname or IP for SFTP server. | "sftp.example.com" |
| SFTP_USER | Username for SFTP connection. | "sftp_user" |
| SFTP_PASSWORD | Password for SFTP user. | "sftp_password_secret" |
These items are required if using the SecureApiService for mutual TLS (mTLS) authentication.
-
Client Certificate Files:
- Place your client certificate file named
cert.pemin the./resources/certificate/directory. - Place your corresponding private key file named
private-key.pemin the./resources/certificate/directory.
- Place your client certificate file named
-
Bearer Token Environment Variable:
- Add the following variable to your
.envfile:
Parameter Description Example Value BEARER The Bearer token for API Authorization header. "your_very_long_bearer_token" - Add the following variable to your
Run all tests:
playwright testRun tests via UI mode:
playwright test --uiFollow the instructions here to install Scoop.
Run the following command to install Allure using Scoop:
scoop install allurebrew install allureallure serve allure-resultsView allure results via Github pages
playwright test --helpIf you find this project helpful, you can support my work by buying me a coffee: