Playwright Pytest Framework

This sample framework is designed to facilitate automated testing of web applications using Playwright in combination with pytest. It provides a robust structure for writing and executing tests efficiently.

Features

• Cross-browser Testing: Run tests on multiple browsers including Chromium, Firefox, and WebKit.
• Headless Mode: Easily run tests in headless mode for CI/CD integration.
• Event Listeners: Attach various event listeners to capture and log console messages, requests, responses, and clicks during tests.
• Dynamic Configuration: Use command-line options to customize test execution without modifying the code.
• Screenshot Capture: Automatically capture screenshots on test failures and embed them in the HTML report.
• Logging: Integrated logging for better tracking of test execution.

Table of Contents

• Requirements
• Installation
• Usage
• Command Line Options
• Environments
• Linting

Requirements

• Python 3.12 or higher
• Playwright
• Pytest

Installation

1. Clone the repository:

   git clone https://github.com/dmberezovskyii/playwrite-pytest-framework.git
   cd playwrite-pytest-framework
    poetry shell
   poetry install

Command Line Options

The framework supports several command-line options to customize the test execution:

--env: Specify the environment (default: dev)
--browser-type: Choose the browser type (chromium, firefox, webkit, default: chromium)
--headless: Run tests in headless mode (default: False)
--devtools: Open the browser with devtools (default: False)
--proxy: Set a proxy server address (e.g., http://proxy-server:port)
--listeners: Comma-separated list of event listeners to attach (options: console, request, response, click)
--slow-mo: Slow down operations by the specified milliseconds (default: 0)

Environments

We utilize Dynaconf for settings management. Dynaconf is a powerful and flexible tool that supports multiple file formats (TOML, YAML, JSON, INI, and Python). It allows for easy management of multi-environment configurations and supports environment variables to override existing settings, including support for .env files:

• the settings are defined in the config.py file.

• to switch between environments, set the variable ENV_FOR_PW in your .env file. For example, to use the development environment, set:

     ENV_FOR_PW=dev
  

• provided three possible environments:

  • dev.yaml: Configuration for the development environment.
  • prod.yaml: Configuration for the production environment.
  • settings.yaml: Default configuration if ENV_FOR_PW=dev is not specified.

Linting

Local: Ruff Lint Configuration

The linting configuration defines rules that dictate the checks performed. Customize these rules to suit your project's coding style and requirements.

1. Create external tools to run linting.
2. Set the working directory to:

   $ProjectFileDir$
   

3. Specify the program:

   path to your ruff installed /bin/ruff 
   example/Users/.../Library/Caches/pypoetry/virtualenvs/playwrite-OiGSFyl3-py3.12/bin/ruff
   

4. Provide the arguments:

   $FilePathRelativeToProjectRoot$ --config .ruff.toml