Initial commit: Playwright Python E2E tests for Bistro Delivery

Migrated from TypeScript Playwright to Python using pytest-playwright.
6 test cases (BD-022, BD-023, BD-026, BD-038, BD-052, BD-055) with
Page Object Model, Pydantic validation, and QA Sphere integration.

Author: AndrianBdn

.env.example

@@ -0,0 +1,7 @@
+DEMO_BASE_URL='https://hypersequent.github.io/bistro/'
+
+# QAS_TOKEN=<QA Sphere API Token>
+# Get your token in QA Sphere -> Settings -> API Keys
+
+# QAS_URL=<QA Sphere Company URL>
+# Example: https://qasdemo.eu2.qasphere.com

.github/workflows/playwright.yml

@@ -0,0 +1,56 @@
+name: Playwright Tests
+
+permissions:
+  contents: read
+  checks: write
+  id-token: write
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: bistro-e2e-python
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Install Playwright browsers
+        run: playwright install --with-deps
+
+      - name: Create .env file
+        run: echo "DEMO_BASE_URL=https://hypersequent.github.io/bistro/" > .env
+
+      - name: Run Playwright tests
+        run: pytest --browser chromium -v
+
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-results
+          path: bistro-e2e-python/test-results/
+
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: junit-results
+          path: bistro-e2e-python/junit-results/
+
+      - name: Publish JUnit Report
+        uses: mikepenz/action-junit-report@v4
+        if: always()
+        with:
+          report_paths: "bistro-e2e-python/junit-results/*.xml"

.gitignore

@@ -0,0 +1,15 @@
+.DS_Store
+__pycache__/
+*.pyc
+.pytest_cache/
+test-results/
+junit-results/
+.env
+.env.*
+!.env.example
+.venv/
+*.egg-info/
+dist/
+build/
+.ruff_cache/
+.qaspherecli

.python-version

@@ -0,0 +1 @@
+3.13

README.md

@@ -0,0 +1,85 @@
+# E2E Tests for Bistro Delivery (Python)
+
+This repository contains end-to-end tests for [Bistro Delivery](https://github.com/hypersequent/bistro), implemented using [Playwright for Python](https://playwright.dev/python/) with pytest.
+
+Prerequisites: Python 3.13+
+
+## Getting Started
+
+1. Clone the repository:
+
+   ```bash
+   git clone git@github.com:Hypersequent/bistro-e2e-python.git
+   cd bistro-e2e-python
+   ```
+
+2. Create and activate a virtual environment:
+
+   ```bash
+   python3 -m venv .venv
+   source .venv/bin/activate
+   ```
+
+3. Install dependencies:
+
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+4. Install Playwright browsers:
+
+   ```bash
+   playwright install --with-deps
+   ```
+
+## Running Tests
+
+### Basic Test Execution
+
+```bash
+pytest --browser chromium -v    # Run tests in Chromium
+pytest --browser chromium -v --headed  # Run tests in headed mode
+```
+
+### Upload testing results to QA Sphere
+
+1. Add your QA Sphere credentials to a `.qaspherecli` file or `.env`:
+
+   ```bash
+   QAS_TOKEN=<QA Sphere API Token>
+   # Get your token in QA Sphere -> Settings -> API Keys
+
+   QAS_URL=<QA Sphere Company URL>
+   # Example: https://qasdemo.eu2.qasphere.com
+   ```
+
+2. Upload results:
+
+   ```bash
+   npx qas-cli junit-upload --project-code BD --attachments junit-results/results.xml
+   ```
+
+## Additional Commands
+
+Different browsers:
+
+```bash
+pytest --browser chromium -v    # Run tests in Chromium
+pytest --browser firefox -v     # Run tests in Firefox
+pytest --browser webkit -v      # Run tests in WebKit
+```
+
+Linting and formatting:
+
+```bash
+ruff check tests/ utils/        # Check for lint errors
+ruff format tests/ utils/        # Format code
+```
+
+## License
+
+This project is licensed under the 0BSD License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+Maintained by [Hypersequent](https://github.com/Hypersequent)

pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "bistro-e2e-python"
+version = "1.0.0"
+description = "E2E tests for Bistro Delivery using Playwright for Python"
+requires-python = ">=3.13"
+dependencies = [
+    "playwright>=1.50",
+    "pytest>=8.0",
+    "pytest-playwright>=0.7",
+    "pydantic>=2.12",
+    "faker>=33.0",
+    "python-dotenv>=1.0",
+]
+
+[dependency-groups]
+dev = [
+    "ruff>=0.9",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = [
+    "--screenshot=on",
+    "--tracing=retain-on-failure",
+    "--junitxml=junit-results/results.xml",
+]
+
+[tool.ruff]
+target-version = "py313"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "W"]

tests/__init__.py

@@ -0,0 +1,44 @@
+import os
+import re
+
+import pytest
+from dotenv import load_dotenv
+
+load_dotenv()
+
+# Map test function names to QA Sphere-friendly display names with BD-XXX markers.
+# qas-cli matches markers in the format PROJECT-SEQUENCE (e.g. BD-023).
+_QAS_NAMES: dict[str, str] = {
+    "test_bd023_cart_operations": "BD-023: Cart operations",
+    "test_bd022_order_with_cash_payment": "BD-022: Order with cash payment",
+    "test_bd055_about_page_content": "BD-055: About page content",
+    "test_bd026_navbar_navigation_state": "BD-026: Navbar navigation state",
+    "test_bd038_menu_tabs_and_products": "BD-038: Menu tabs and products",
+    "test_bd052_welcome_banner": "BD-052: Welcome banner",
+}
+
+
+def pytest_itemcollected(item: pytest.Item) -> None:
+    """Rewrite test node IDs so JUnit XML contains QA Sphere markers (BD-XXX)."""
+    # item.name looks like "test_bd023_cart_operations[chromium]"
+    base_name = re.sub(r"\[.*\]$", "", item.name)
+    if base_name in _QAS_NAMES:
+        suffix = item.name[len(base_name) :]  # e.g. "[chromium]"
+        item._nodeid = item._nodeid.replace(item.name, _QAS_NAMES[base_name] + suffix)
+        item.name = _QAS_NAMES[base_name] + suffix
+
+
+@pytest.fixture(scope="session")
+def demo_base_url() -> str:
+    url = os.getenv("DEMO_BASE_URL", "https://hypersequent.github.io/bistro/")
+    return url.rstrip("/")
+
+
+@pytest.fixture()
+def browser_context_args(browser_context_args: dict) -> dict:
+    return {**browser_context_args, "java_script_enabled": True}
+
+
+@pytest.fixture(scope="session")
+def browser_type_launch_args(browser_type_launch_args: dict) -> dict:
+    return {**browser_type_launch_args}

tests/conftest.py

@@ -0,0 +1,31 @@
+from playwright.sync_api import Page
+
+
+class About:
+    def __init__(self, page: Page, base_url: str) -> None:
+        self.page = page
+        self.base_url = base_url
+        self.heading = page.locator("h1")
+        self.body = page.locator("article")
+        self.navbar_items = page.locator("nav ul > li")
+
+    def goto(self) -> None:
+        self.page.goto(self.base_url + "/about")
+
+    def get_heading(self) -> str:
+        return self.heading.inner_text().strip()
+
+    def get_body(self) -> str:
+        return self.body.inner_text().strip()
+
+    def get_navbar_items(self) -> list[dict]:
+        items = self.navbar_items.all()
+        assert len(items) == 3
+
+        result = []
+        for item in items:
+            text = item.inner_text().strip()
+            cls = item.get_attribute("class") or ""
+            is_active = "active" in cls
+            result.append({"text": text, "isActive": is_active})
+        return result