skipper-playwright 0.1.0__tar.gz

skipper_playwright-0.1.0/.gitignore

@@ -0,0 +1,50 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+.Python
+*.egg-info/
+dist/
+build/
+*.egg
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# uv
+.uv/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+
+# Type checking
+.mypy_cache/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Temp files
+*.tmp
+/tmp/
+
+# Credentials (never commit)
+service-account-skipper-bot.json
+*.json.bak
+
+# Environment
+.env
+.env.local
+
+# macOS
+.DS_Store

skipper_playwright-0.1.0/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.4
+Name: skipper-playwright
+Version: 0.1.0
+Summary: Playwright integration for Skipper test-gating via Google Spreadsheet
+Project-URL: Homepage, https://github.com/get-skipper/skipper-python
+Project-URL: Repository, https://github.com/get-skipper/skipper-python
+License: MIT
+Keywords: google-sheets,playwright,skipper,test-gating,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Requires-Dist: pytest>=7.0
+Requires-Dist: skipper-core>=0.1.0
+Description-Content-Type: text/markdown
+
+# skipper-playwright
+
+Playwright integration for [Skipper](https://github.com/get-skipper/skipper-python) test-gating via Google Spreadsheet.
+
+## Installation
+
+```bash
+pip install skipper-playwright playwright
+playwright install
+```
+
+## Setup
+
+Inherit from `SkipperSyncTest` instead of writing plain test functions:
+
+```python
+from skipper_playwright import SkipperSyncTest
+from skipper_core import SkipperConfig, FileCredentials
+from playwright.sync_api import Page
+
+class LoginTests(SkipperSyncTest):
+    skipper_config = SkipperConfig(
+        spreadsheet_id="YOUR_SPREADSHEET_ID",
+        credentials=FileCredentials("./service-account-skipper-bot.json"),
+        sheet_name="skipper-python",
+    )
+
+    def test_login(self, page: Page):
+        page.goto("https://example.com")
+        ...
+```
+
+## Test ID Format
+
+`tests/test_login.py > ClassName > test_method_name`
+
+See the [root README](../../README.md) for full documentation.

skipper_playwright-0.1.0/README.md

@@ -0,0 +1,37 @@
+# skipper-playwright
+
+Playwright integration for [Skipper](https://github.com/get-skipper/skipper-python) test-gating via Google Spreadsheet.
+
+## Installation
+
+```bash
+pip install skipper-playwright playwright
+playwright install
+```
+
+## Setup
+
+Inherit from `SkipperSyncTest` instead of writing plain test functions:
+
+```python
+from skipper_playwright import SkipperSyncTest
+from skipper_core import SkipperConfig, FileCredentials
+from playwright.sync_api import Page
+
+class LoginTests(SkipperSyncTest):
+    skipper_config = SkipperConfig(
+        spreadsheet_id="YOUR_SPREADSHEET_ID",
+        credentials=FileCredentials("./service-account-skipper-bot.json"),
+        sheet_name="skipper-python",
+    )
+
+    def test_login(self, page: Page):
+        page.goto("https://example.com")
+        ...
+```
+
+## Test ID Format
+
+`tests/test_login.py > ClassName > test_method_name`
+
+See the [root README](../../README.md) for full documentation.

skipper_playwright-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "skipper-playwright"
+version = "0.1.0"
+description = "Playwright integration for Skipper test-gating via Google Spreadsheet"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.10"
+keywords = ["testing", "test-gating", "google-sheets", "skipper", "playwright"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Testing",
+]
+dependencies = [
+    "skipper-core>=0.1.0",
+    "pytest>=7.0",
+]
+
+[tool.uv.sources]
+skipper-core = { workspace = true }
+
+[project.urls]
+Homepage = "https://github.com/get-skipper/skipper-python"
+Repository = "https://github.com/get-skipper/skipper-python"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/skipper_playwright"]

skipper_playwright-0.1.0/src/skipper_playwright/__init__.py

@@ -0,0 +1,5 @@
+"""skipper-playwright — Playwright integration for Skipper test-gating."""
+
+from .test import SkipperSyncTest
+
+__all__ = ["SkipperSyncTest"]

skipper_playwright-0.1.0/src/skipper_playwright/test.py

@@ -0,0 +1,112 @@
+"""skipper-playwright — Playwright base class for Skipper test-gating."""
+
+from __future__ import annotations
+
+import inspect
+import os
+import threading
+from typing import Any
+
+import pytest
+from skipper_core import (
+    CacheManager,
+    SkipperConfig,
+    SkipperResolver,
+    build_test_id,
+    mode_from_env,
+)
+from skipper_core.writer import SheetsWriter
+
+_cache_manager = CacheManager()
+
+
+class SkipperSyncTest:
+    """Base class for synchronous Playwright tests (pytest-playwright style).
+
+    Inherit from this class instead of using raw pytest functions to get
+    automatic test-gating. Set ``skipper_config`` as a class attribute.
+
+    Example::
+
+        from playwright.sync_api import Page
+
+        class LoginTests(SkipperSyncTest):
+            skipper_config = SkipperConfig(
+                spreadsheet_id="YOUR_SPREADSHEET_ID",
+                credentials=FileCredentials("./service-account-skipper-bot.json"),
+                sheet_name="skipper-python",
+            )
+
+            def test_login(self, page: Page):
+                ...
+    """
+
+    skipper_config: SkipperConfig  # set by subclass
+
+    _skipper_resolver: SkipperResolver | None = None
+    _skipper_cache_dir: str | None = None
+    _skipper_discovered: list[str]
+    _skipper_lock: threading.Lock
+
+    @classmethod
+    def setup_class(cls) -> None:
+        cls._skipper_discovered = []
+        cls._skipper_lock = threading.Lock()
+
+        cfg = getattr(cls, "skipper_config", None)
+        if cfg is None:
+            return
+
+        cache_file = os.getenv("SKIPPER_CACHE_FILE")
+        if cache_file:
+            data = _cache_manager.read_resolver_cache(cache_file)
+            cls._skipper_resolver = SkipperResolver.from_marshal_cache(data)
+            return
+
+        resolver = SkipperResolver(cfg)
+        resolver.initialize()
+        cls._skipper_resolver = resolver
+
+        data = resolver.marshal_cache()
+        cache_dir = _cache_manager.write_resolver_cache(data)
+        cls._skipper_cache_dir = cache_dir
+        os.environ["SKIPPER_CACHE_FILE"] = os.path.join(cache_dir, "cache.json")
+        os.environ["SKIPPER_DISCOVERED_DIR"] = cache_dir
+
+    @classmethod
+    def teardown_class(cls) -> None:
+        try:
+            cfg = getattr(cls, "skipper_config", None)
+            if cfg is not None and mode_from_env().value == "sync":
+                with cls._skipper_lock:
+                    ids = list(cls._skipper_discovered)
+
+                if cls._skipper_cache_dir:
+                    _cache_manager.write_discovered_ids(cls._skipper_cache_dir, ids)
+                    all_ids = _cache_manager.merge_discovered_ids(cls._skipper_cache_dir)
+                else:
+                    all_ids = ids
+
+                writer = SheetsWriter(cfg)
+                writer.sync(all_ids)
+        finally:
+            if cls._skipper_cache_dir:
+                _cache_manager.cleanup(cls._skipper_cache_dir)
+                cls._skipper_cache_dir = None
+
+    def setup_method(self, method: Any) -> None:
+        if self._skipper_resolver is None:
+            return
+
+        file_path = inspect.getfile(type(self))
+        test_id = build_test_id(file_path, [type(self).__name__, method.__name__])
+
+        with self._skipper_lock:
+            self._skipper_discovered.append(test_id)
+
+        if not self._skipper_resolver.is_test_enabled(test_id):
+            until = self._skipper_resolver.get_disabled_until(test_id)
+            msg = "[skipper] Test disabled"
+            if until is not None:
+                msg += f" until {until.strftime('%Y-%m-%d')}"
+            pytest.skip(msg)