csspin-python 2.0.0__py3-none-any.whl

csspin_python/playwright.py

@@ -0,0 +1,126 @@
+# -*- mode: python; coding: utf-8 -*-
+#
+# Copyright (C) 2024 CONTACT Software GmbH
+# https://www.contact-software.com/
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Module implementing the playwright plugin for spin"""
+
+from csspin import Path, Verbosity, config, die, option, setenv, sh, task
+
+defaults = config(
+    browsers_path="{spin.data}/playwright_browsers",
+    browsers=["chromium"],
+    coverage=False,
+    coverage_opts=[
+        "--cov-reset",
+        "--cov",
+        "--cov-report=term",
+        "--cov-report=html",
+        "--cov-report=xml:{playwright.coverage_report}",
+    ],
+    coverage_report="python-playwright-coverage.xml",
+    opts=["-m", "e2e"],
+    tests=["cs", "tests"],  # Strong convention @CONTACT
+    test_report="playwright.xml",
+    requires=config(
+        spin=[
+            "csspin_python.debugpy",
+            "csspin_python.python",
+            "csspin_python.pytest",
+        ],
+        python=[
+            "pytest-base-url",
+            "pytest-playwright",
+        ],
+    ),
+)
+
+
+@task(when="cept")
+def playwright(  # pylint: disable=too-many-arguments,too-many-positional-arguments
+    cfg,
+    instance: option(
+        "-i",  # noqa: F821
+        "--instance",  # noqa: F821
+        default=None,
+        help="Directory of the CONTACT Elements instance.",  # noqa: F722
+    ),
+    coverage: option(
+        "-c",  # noqa: F821
+        "--coverage",  # noqa: F821
+        is_flag=True,
+        help="Run the tests while collecting coverage.",  # noqa: F722
+    ),
+    debug: option(
+        "--debug", is_flag=True, help="Start debug server."  # noqa: F722,F821
+    ),
+    with_test_report: option(
+        "--with-test-report",  # noqa: F722
+        is_flag=True,
+        help="Create a test execution report.",  # noqa: F722
+    ),
+    args,
+):
+    """Run the playwright tests with pytest."""
+    setenv(
+        PLAYWRIGHT_BROWSERS_PATH=cfg.playwright.browsers_path,
+        PACKAGE_NAME=cfg.spin.project_name,
+    )
+
+    opts = cfg.playwright.opts
+    if cfg.verbosity == Verbosity.QUIET:
+        opts.append("-q")
+    if with_test_report and cfg.playwright.test_report:
+        opts.append(f"--junitxml={cfg.playwright.test_report}")
+    if coverage or cfg.playwright.coverage:
+        opts.extend(cfg.playwright.coverage_opts)
+        setenv(PLAYWRIGHT_COVERAGE=1)
+
+    for browser in cfg.playwright.browsers:
+        opts.extend(["--browser", browser])
+
+    if debug:
+        cmd = f"debugpy {' '.join(cfg.debugpy.opts)} -m pytest".split()
+    else:
+        cmd = ["pytest"]
+
+    # Run the browser download again, so that changes for
+    # cfg.playwright.browsers don't require a new provision call. If the
+    # browsers are already present it's more or less a noop.
+    _download_playwright_browsers(cfg)
+
+    if cfg.loaded.get("csspin_ce.mkinstance"):
+        if not (
+            inst := Path(instance or cfg.mkinstance.base.instance_location).absolute()
+        ).is_dir():
+            die(f"Cannot find CE instance '{inst}'.")
+
+        setenv(CADDOK_BASE=inst)
+        sh(*cmd, *opts, *args, *cfg.playwright.tests)
+    else:
+        sh(*cmd, *opts, *args, *cfg.playwright.tests)
+
+
+def _download_playwright_browsers(cfg):
+    """Let playwright install the browsers"""
+    sh(
+        f"playwright install {' '.join(cfg.playwright.browsers)}",
+        env={"PLAYWRIGHT_BROWSERS_PATH": cfg.playwright.browsers_path},
+    )
+
+
+def provision(cfg):
+    """Install playwright browsers during provisioning"""
+    _download_playwright_browsers(cfg)

csspin_python/playwright_schema.yaml

@@ -0,0 +1,33 @@
+# -*- mode: yaml; coding: utf-8 -*-
+#
+# Schema for the playwright plugin for spin
+
+playwright:
+    type: object
+    help: |
+        The pytest plugin provides the full pytest experience for spin.
+    properties:
+        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.
+        coverage:
+            type: bool
+            help: Enable or disable code coverage analysis.
+        coverage_opts:
+            type: list
+            help: Additional options for the coverage run.
+        coverage_report:
+            type: str
+            help: File to write the coverage report to.
+        opts:
+            type: list
+            help: Additional options for the pytest command.
+        test_report:
+            type: path
+            help: Path to write the test report to.
+        tests:
+            type: list
+            help: List of test files or directories to include.

csspin_python/pytest.py

@@ -0,0 +1,97 @@
+# -*- mode: python; coding: utf-8 -*-
+#
+# Copyright (C) 2022 CONTACT Software GmbH
+# https://www.contact-software.com/
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Module implementing the pytest plugin for spin"""
+
+
+from csspin import Path, Verbosity, config, die, option, setenv, sh, task
+
+defaults = config(
+    coverage=False,
+    coverage_opts=[
+        "--cov-reset",
+        "--cov",
+        "--cov-report=term",
+        "--cov-report=html",
+        "--cov-report=xml:{pytest.coverage_report}",
+    ],
+    coverage_report="python-pytest-coverage.xml",
+    opts=[],
+    tests=["cs", "tests"],  # Strong convention @CONTACT
+    test_report="pytest.xml",
+    requires=config(
+        spin=[
+            "csspin_python.debugpy",
+            "csspin_python.python",
+        ],
+        python=[
+            "debugpy",
+            "pytest",
+            "pytest-cov",
+        ],
+    ),
+)
+
+
+@task(when="test")
+def pytest(  # pylint: disable=too-many-arguments,too-many-positional-arguments
+    cfg,
+    instance: option(
+        "-i",  # noqa: F821
+        "--instance",  # noqa: F821
+        default=None,
+        help="Directory of the CONTACT Elements instance.",  # noqa: F722
+    ),
+    coverage: option(
+        "-c",  # noqa: F821
+        "--coverage",  # noqa: F821
+        is_flag=True,
+        help="Run the tests while collecting coverage.",  # noqa: F722
+    ),
+    debug: option(
+        "--debug", is_flag=True, help="Start debug server."  # noqa: F722,F821
+    ),
+    with_test_report: option(
+        "--with-test-report",  # noqa: F722
+        is_flag=True,
+        help="Create a test execution report.",  # noqa: F722
+    ),
+    args,
+):
+    """Run the 'pytest' command."""
+    opts = cfg.pytest.opts
+    if cfg.verbosity == Verbosity.QUIET:
+        opts.append("-q")
+    if with_test_report and cfg.pytest.test_report:
+        opts.append(f"--junitxml={cfg.pytest.test_report}")
+    if coverage or cfg.pytest.coverage:
+        opts.extend(cfg.pytest.coverage_opts)
+    if debug:
+        cmd = f"debugpy {' '.join(cfg.debugpy.opts)} -m pytest".split()
+    else:
+        cmd = ["pytest"]
+
+    if cfg.loaded.get("csspin_ce.mkinstance"):
+        if not (
+            inst := Path(instance or cfg.mkinstance.base.instance_location).absolute()
+        ).is_dir():
+            die(f"Cannot find CE instance '{inst}'.")
+
+        setenv(CADDOK_BASE=inst)
+        sh(*cmd, *opts, *args, *cfg.pytest.tests)
+    else:
+        sh(*cmd, *opts, *args, *cfg.pytest.tests)

csspin_python/pytest_schema.yaml

@@ -0,0 +1,27 @@
+# -*- mode: yaml; coding: utf-8 -*-
+#
+# Schema for the pytest plugin for spin
+
+pytest:
+    type: object
+    help: |
+        The pytest plugin provides the full pytest experience for spin.
+    properties:
+        coverage:
+            type: bool
+            help: Enable or disable code coverage analysis.
+        opts:
+            type: list
+            help: Additional options for the pytest command.
+        test_report:
+            type: path
+            help: Path to write the test report to.
+        coverage_opts:
+            type: list
+            help: Additional options for the coverage run.
+        coverage_report:
+            type: str
+            help: File to write the coverage report to.
+        tests:
+            type: list
+            help: List of test files or directories to include.