csspin-python 2.1.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

csspin_python/behave.py

@@ -20,7 +20,7 @@
 
 import contextlib
 import sys
-from typing import Generator
+from typing import Generator, Iterable
 
 from csspin import config, die, info, option, rmtree, setenv, sh, task, writetext
 from csspin.tree import ConfigTree
@@ -67,16 +67,16 @@ def configure(cfg: ConfigTree) -> None:
         cfg.behave.opts.append("--tags=~windows")
 
 
-def create_coverage_pth(cfg: ConfigTree) -> str:  # pylint: disable=unused-argument
+def create_coverage_pth(cfg: ConfigTree) -> Path:  # pylint: disable=unused-argument
     """Creating the coverage path file and returning its path"""
-    coverage_pth_path = cfg.python.site_packages / "coverage.pth"
+    coverage_pth_path: Path = cfg.python.site_packages / "coverage.pth"
     info(f"Create {coverage_pth_path}")
     writetext(coverage_pth_path, "import coverage; coverage.process_startup()")
     return coverage_pth_path
 
 
 @contextlib.contextmanager
-def with_coverage(cfg: ConfigTree) -> Generator:
+def with_coverage(cfg: ConfigTree) -> Generator[None, None, None]:
     """Context-manager enabling to run coverage"""
     coverage_pth = ""
     try:
@@ -95,28 +95,28 @@ def with_coverage(cfg: ConfigTree) -> Generator:
 
 @task(when="cept")
 def behave(  # pylint: disable=too-many-arguments,too-many-positional-arguments
-    cfg,
-    instance: option(
+    cfg: ConfigTree,
+    instance: option(  # type: ignore[valid-type]
         "-i",  # noqa: F821
         "--instance",  # noqa: F821
         help="Directory of the CONTACT Elements instance.",  # noqa: F722
     ),
-    coverage: option(
+    coverage: option(  # type: ignore[valid-type]
         "-c",  # noqa: F821
         "--coverage",  # noqa: F821
         is_flag=True,
         help="Run the tests while collecting coverage.",  # noqa: F722
     ),
-    debug: option(
+    debug: option(  # type: ignore[valid-type]
         "--debug", is_flag=True, help="Start debug server."  # noqa: F722,F821
     ),
-    with_test_report: option(
+    with_test_report: option(  # type: ignore[valid-type]
         "--with-test-report",  # noqa: F722
         is_flag=True,
         help="Create a test execution report.",  # noqa: F722
     ),
-    args,
-):
+    args: Iterable[str],
+) -> None:
     """Run Gherkin tests using behave."""
     # pylint: disable=missing-function-docstring
     coverage_enabled = coverage or cfg.behave.coverage

csspin_python/devpi.py

@@ -18,7 +18,10 @@
 """Module implementing the devpi plugin for spin"""
 
 
+from typing import Iterable
+
 from csspin import Command, config, die, exists, readyaml, setenv, sh, task
+from csspin.tree import ConfigTree
 
 defaults = config(
     formats=["bdist_wheel"],
@@ -34,13 +37,13 @@ defaults = config(
 )
 
 
-def init(cfg):  # pylint: disable=unused-argument
+def init(cfg: ConfigTree) -> None:  # pylint: disable=unused-argument
     """Sets some environment variables"""
     setenv(DEVPI_VENV="{python.venv}", DEVPI_CLIENTDIR="{spin.spin_dir}/devpi")
 
 
 @task("devpi:upload")
-def upload(cfg):
+def upload(cfg: ConfigTree) -> None:
     """Upload project wheel to a package server."""
     if not cfg.devpi.user:
         die("devpi.user is required!")
@@ -68,7 +71,7 @@ def upload(cfg):
 
 
 @task()
-def devpi(cfg, args):
+def devpi(cfg: ConfigTree, args: Iterable[str]) -> None:
     """Run the 'devpi' command inside the project's virtual environment.
 
     All command line arguments are simply passed through to 'devpi'.

csspin_python/playwright.py

@@ -17,7 +17,10 @@
 
 """Module implementing the playwright plugin for spin"""
 
-from csspin import Path, Verbosity, config, die, option, setenv, sh, task
+from typing import Iterable
+
+from csspin import Path, Verbosity, config, die, option, setenv, sh, task, warn
+from csspin.tree import ConfigTree
 
 defaults = config(
     browsers_path="{spin.data}/playwright_browsers",
@@ -50,30 +53,40 @@ defaults = config(
 
 @task(when="cept")
 def playwright(  # pylint: disable=too-many-arguments,too-many-positional-arguments
-    cfg,
-    instance: option(
+    cfg: ConfigTree,
+    instance: option(  # type: ignore[valid-type]
         "-i",  # noqa: F821
         "--instance",  # noqa: F821
         default=None,
         help="Directory of the CONTACT Elements instance.",  # noqa: F722
     ),
-    coverage: option(
+    coverage: option(  # type: ignore[valid-type]
         "-c",  # noqa: F821
         "--coverage",  # noqa: F821
         is_flag=True,
         help="Run the tests while collecting coverage.",  # noqa: F722
     ),
-    debug: option(
+    debug: option(  # type: ignore[valid-type]
         "--debug", is_flag=True, help="Start debug server."  # noqa: F722,F821
     ),
-    with_test_report: option(
+    with_test_report: option(  # type: ignore[valid-type]
         "--with-test-report",  # noqa: F722
         is_flag=True,
         help="Create a test execution report.",  # noqa: F722
     ),
-    args,
-):
+    args: Iterable[str],
+) -> None:
     """Run the playwright tests with pytest."""
+    if cfg.pytest.playwright.enabled:
+        # This prevents the playwright tests from being run twice.
+        warn(
+            (
+                "The 'playwright' task has been skipped, as the playwright tests"
+                " are already being run by the csspin_python.pytest plugin."
+                " Please stop using the csspin_python.playwright plugin."
+            )
+        )
+        return
     setenv(
         PLAYWRIGHT_BROWSERS_PATH=cfg.playwright.browsers_path,
         PACKAGE_NAME=cfg.spin.project_name,
@@ -113,7 +126,7 @@ def playwright(  # pylint: disable=too-many-arguments,too-many-positional-argume
         sh(*cmd, *opts, *args, *cfg.playwright.tests)
 
 
-def _download_playwright_browsers(cfg):
+def _download_playwright_browsers(cfg: ConfigTree) -> None:
     """Let playwright install the browsers"""
     sh(
         f"playwright install {' '.join(cfg.playwright.browsers)}",
@@ -121,6 +134,17 @@ def _download_playwright_browsers(cfg):
     )
 
 
-def provision(cfg):
+def finalize_provision(cfg: ConfigTree) -> None:
     """Install playwright browsers during provisioning"""
     _download_playwright_browsers(cfg)
+
+
+def init(cfg: ConfigTree) -> None:  # pylint: disable=unused-argument
+    """Show deprecation notice in every spin call"""
+    warn(
+        (
+            "The csspin_python.playwright plugin will be removed with the next major release."
+            " Please use csspin_python.pytest with the 'pytest.playwright.enabled=True' setting"
+            " instead and stop using the csspin_python.playwright plugin."
+        )
+    )

csspin_python/playwright_schema.yaml

@@ -5,7 +5,9 @@
 playwright:
     type: object
     help: |
-        The pytest plugin provides the full pytest experience for spin.
+        The pytest plugin provides the full pytest experience for spin. This
+        plugin is deprecated, use the pytest plugin with the
+        'pytest.playwright.enabled=true' setting instead.
     properties:
         browsers_path:
             type: path

csspin_python/pytest.py

@@ -18,7 +18,10 @@
 """Module implementing the pytest plugin for spin"""
 
 
-from csspin import Path, Verbosity, config, die, option, setenv, sh, task
+from typing import Iterable
+
+from csspin import Path, Verbosity, config, die, interpolate1, option, setenv, sh, task
+from csspin.tree import ConfigTree
 
 defaults = config(
     coverage=False,
@@ -33,6 +36,11 @@ defaults = config(
     opts=[],
     tests=["cs", "tests"],  # Strong convention @CONTACT
     test_report="pytest.xml",
+    playwright=config(
+        enabled=False,
+        browsers_path="{spin.data}/playwright_browsers",
+        browsers=["chromium"],
+    ),
     requires=config(
         spin=[
             "csspin_python.debugpy",
@@ -47,31 +55,49 @@ defaults = config(
 )
 
 
+def _install_playwright_browsers(cfg: ConfigTree) -> None:
+    """Let playwright install the browsers"""
+    sh(
+        f"playwright install {' '.join(cfg.pytest.playwright.browsers)}",
+        env={"PLAYWRIGHT_BROWSERS_PATH": cfg.pytest.playwright.browsers_path},
+    )
+
+
+def configure(cfg: ConfigTree) -> None:
+    if interpolate1(cfg.pytest.playwright.enabled).lower() == "true":
+        cfg.pytest.requires.python.extend(["pytest-base-url", "pytest-playwright"])
+
+
+def provision(cfg: ConfigTree) -> None:
+    if cfg.pytest.playwright.enabled:
+        _install_playwright_browsers(cfg)
+
+
 @task(when="test")
 def pytest(  # pylint: disable=too-many-arguments,too-many-positional-arguments
-    cfg,
-    instance: option(
+    cfg: ConfigTree,
+    instance: option(  # type: ignore[valid-type]
         "-i",  # noqa: F821
         "--instance",  # noqa: F821
         default=None,
         help="Directory of the CONTACT Elements instance.",  # noqa: F722
     ),
-    coverage: option(
+    coverage: option(  # type: ignore[valid-type]
         "-c",  # noqa: F821
         "--coverage",  # noqa: F821
         is_flag=True,
         help="Run the tests while collecting coverage.",  # noqa: F722
     ),
-    debug: option(
+    debug: option(  # type: ignore[valid-type]
         "--debug", is_flag=True, help="Start debug server."  # noqa: F722,F821
     ),
-    with_test_report: option(
+    with_test_report: option(  # type: ignore[valid-type]
         "--with-test-report",  # noqa: F722
         is_flag=True,
         help="Create a test execution report.",  # noqa: F722
     ),
-    args,
-):
+    args: Iterable[str],
+) -> None:
     """Run the 'pytest' command."""
     opts = cfg.pytest.opts
     if cfg.verbosity == Verbosity.QUIET:
@@ -85,6 +111,20 @@ def pytest(  # pylint: disable=too-many-arguments,too-many-positional-arguments
     else:
         cmd = ["pytest"]
 
+    if cfg.pytest.playwright.enabled:
+        setenv(
+            PLAYWRIGHT_BROWSERS_PATH=cfg.pytest.playwright.browsers_path,
+            PACKAGE_NAME=cfg.spin.project_name,
+        )
+        for browser in cfg.pytest.playwright.browsers:
+            opts.extend(["--browser", browser])
+        # Run the browser download again, so that changes for
+        # cfg.pytest.playwright.browsers don't require a new provision call. If the
+        # browsers are already present it's more or less a noop.
+        _install_playwright_browsers(cfg)
+        if coverage or cfg.pytest.coverage:
+            setenv(PLAYWRIGHT_COVERAGE=1)
+
     if cfg.loaded.get("csspin_ce.mkinstance"):
         if not (
             inst := Path(instance or cfg.mkinstance.base.instance_location).absolute()

csspin_python/pytest_schema.yaml

@@ -25,3 +25,22 @@ pytest:
         tests:
             type: list
             help: List of test files or directories to include.
+        playwright:
+            type: object
+            help: |
+                Settings necessary to also run playwright tests with the pytest
+                plugin.
+            properties:
+                enabled:
+                    type: bool
+                    help: |
+                        Should the pytest-playwright plugin be installed and
+                        initialized.
+                browsers_path:
+                    type: path
+                    help: Path for playwright to install the browsers.
+                browsers:
+                    type: list
+                    help: |
+                        The browsers to install and to use for running the
+                        playwright tests.