chore: init

Author: ASaiAnudeep

.github/workflows/test.yaml

@@ -0,0 +1,30 @@
+name: Playwright Pytest Tests
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+    - name: Install dependencies
+      run: |
+        uv sync pyproject.toml
+    - name: Ensure browsers are installed
+      run: python -m playwright install --with-deps
+    - name: Run your tests
+      run: pytest --tracing=retain-on-failure --output=reports --screenshot=only-on-failure --junitxml=reports/junit.xml
+    - run: npx testbeats@latest publish --slack ${{ secrets.SLACK_MVP_URL }} --junit reports/junit.xml --ci-info --chart-test-summary
+      if: always()
+      env:
+        TEST_BEATS_API_KEY: ${{ secrets.TEST_BEATS_API_KEY }}
+        TEST_BEATS_PROJECT: "testbeats/examples"

.gitignore

@@ -0,0 +1,11 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.DS_Store

README.md

@@ -1,2 +1,73 @@
-# example-playwright-pytest-testbeats
-About example repo to showcase integration of playwright and pytest with testbeats
+# Example Playwright Pytest Project with TestBeats Integration
+
+This is an example project demonstrating how to run Playwright tests with Pytest and report results, presumably to TestBeats.
+
+## Setup
+
+1.  **Clone the repository:**
+    ```bash
+    git clone <repository-url>
+    cd <repository-directory>
+    ```
+
+2.  **Create a virtual environment (recommended):**
+    ```bash
+    python -m venv .venv
+    source .venv/bin/activate
+    ```
+
+3.  **Install dependencies:**
+    This project uses `uv` for dependency management.
+    ```bash
+    uv sync pyproject.toml
+    ```
+
+4.  **Install Playwright browsers:**
+    ```bash
+    playwright install
+    ```
+
+## Running Tests
+
+To run the tests, use Pytest:
+
+```bash
+pytest --output=reports --screenshot=only-on-failure --junitxml=reports/junit.xml
+```
+
+This will execute the tests found in files like `test_example.py`.
+
+## Reporting Results to TestBeats
+
+This project is configured to generate a JUnit XML report, which is a common format for test reporting tools like TestBeats.
+
+1.  **Generate JUnit XML report:**
+    Pytest can generate a JUnit XML report using the `--junitxml` flag.
+    ```bash
+    pytest --junitxml=reports/junit.xml
+    ```
+
+    Make sure the `reports` directory exists, or create it:
+    ```bash
+    mkdir -p reports
+    ```
+
+2.  **Upload to TestBeats:**
+    The method for uploading `reports/junit.xml` to TestBeats depends on your specific TestBeats setup. This typically involves:
+    *   Using a TestBeats CLI tool.
+    *   A CI/CD integration that automatically picks up the report.
+
+    Please refer to the TestBeats documentation for the specific command or procedure to upload the JUnit XML file.
+
+    **Example (conceptual - replace with actual TestBeats command):**
+    ```bash
+    npx testbeats@latest publish --slack <slack-webhook-url> --junit reports/junit.xml
+    ```
+
+## Contributing
+
+Please feel free to submit issues and pull requests.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details, which mentions TestBeats.

pyproject.toml

@@ -0,0 +1,10 @@
+[project]
+name = "example-playwright-pytest-testbeats"
+version = "0.1.0"
+description = "Example Playwright Pytest TestBeats"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "playwright>=1.52.0",
+    "pytest-playwright>=0.7.0",
+]

reports/junit.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="utf-8"?>
+<testsuites>
+    <testsuite name="pytest" errors="0" failures="1" skipped="0" tests="3" time="33.708" timestamp="2025-05-14T17:30:52.184166+05:30" hostname="user.local">
+        <testcase classname="test_example" name="test_has_title[chromium]" time="2.138" />
+        <testcase classname="test_example" name="test_get_started_link[chromium]" time="0.807" />
+        <testcase classname="test_example" name="test_unknown_link[chromium]" time="30.650">
+            <failure message="playwright._impl._errors.TimeoutError: Locator.click: Timeout 30000ms exceeded.&#10;Call log:&#10;  - waiting for get_by_role(&quot;link&quot;, name=&quot;Unknow Link&quot;)">page = &lt;Page url='https://playwright.dev/'&gt;
+
+    def test_unknown_link(page: Page):
+        page.goto("https://playwright.dev/")
+
+        # Click the get started link.
+&gt;       page.get_by_role("link", name="Unknow Link").click()
+
+test_example.py:23:
+_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
+.venv/lib/python3.11/site-packages/playwright/sync_api/_generated.py:15512: in click
+    self._sync(
+.venv/lib/python3.11/site-packages/playwright/_impl/_locator.py:160: in click
+    return await self._frame.click(self._selector, strict=True, **params)
+.venv/lib/python3.11/site-packages/playwright/_impl/_frame.py:488: in click
+    await self._channel.send("click", locals_to_params(locals()))
+.venv/lib/python3.11/site-packages/playwright/_impl/_connection.py:61: in send
+    return await self._connection.wrap_api_call(
+_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
+
+self = &lt;playwright._impl._connection.Connection object at 0x104b45390&gt;
+cb = &lt;function Channel.send.&lt;locals&gt;.&lt;lambda&gt; at 0x106a60b80&gt;, is_internal = False
+
+    async def wrap_api_call(
+        self, cb: Callable[[], Any], is_internal: bool = False
+    ) -&gt; Any:
+        if self._api_zone.get():
+            return await cb()
+        task = asyncio.current_task(self._loop)
+        st: List[inspect.FrameInfo] = getattr(task, "__pw_stack__", inspect.stack())
+        parsed_st = _extract_stack_trace_information_from_stack(st, is_internal)
+        self._api_zone.set(parsed_st)
+        try:
+            return await cb()
+        except Exception as error:
+&gt;           raise rewrite_error(error, f"{parsed_st['apiName']}: {error}") from None
+E           playwright._impl._errors.TimeoutError: Locator.click: Timeout 30000ms exceeded.
+E           Call log:
+E             - waiting for get_by_role("link", name="Unknow Link")
+
+.venv/lib/python3.11/site-packages/playwright/_impl/_connection.py:528: TimeoutError
+            </failure>
+        </testcase>
+    </testsuite>
+</testsuites>

reports/test-example-py-test-unknown-link-chromium/test-failed-1.png

@@ -0,0 +1,23 @@
+import re
+from playwright.sync_api import Page, expect
+
+def test_has_title(page: Page):
+    page.goto("https://playwright.dev/")
+
+    # Expect a title "to contain" a substring.
+    expect(page).to_have_title(re.compile("Playwright"))
+
+def test_get_started_link(page: Page):
+    page.goto("https://playwright.dev/")
+
+    # Click the get started link.
+    page.get_by_role("link", name="Get started").click()
+
+    # Expects page to have a heading with the name of Installation.
+    expect(page.get_by_role("heading", name="Installation")).to_be_visible()
+
+def test_unknown_link(page: Page):
+    page.goto("https://playwright.dev/")
+
+    # Click the get started link.
+    page.get_by_role("link", name="Unknow Link").click()