pytest-xdocker 0.0.0__tar.gz

pytest_xdocker-0.0.0/LICENSE.rst

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Marc Tardif
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pytest_xdocker-0.0.0/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.1
+Name: pytest-xdocker
+Version: 0.0.0
+Summary: Pytest fixture to run docker across test runs.
+Home-page: https://github.com/cr3/pytest-xdocker
+Author: Marc Tardif
+Requires-Python: >=3.9,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: attrs (>=24.3.0,<25.0.0)
+Requires-Dist: netifaces (>=0.11.0,<0.12.0)
+Requires-Dist: psutil (>=6.1.1,<7.0.0)
+Requires-Dist: pyhamcrest (>=2.1.0,<3.0.0)
+Requires-Dist: pytest (>=7.4.2,<8.0.0)
+Requires-Dist: pytest-cache (>=1.0,<2.0)
+Requires-Dist: pytest-xprocess (>=1.0.2,<2.0.0)
+Project-URL: Repository, https://github.com/cr3/pytest-xdocker
+Description-Content-Type: text/x-rst
+
+pytest-xdocker
+==============
+
+`Pytest <http://pytest.org>`_  fixture to run docker across test runs.
+
+.. image:: https://img.shields.io/badge/license-MIT-blue.svg
+   :target: https://github.com/cr3/pytest-xdocker/blob/master/LICENSE
+   :alt: License
+.. image:: https://img.shields.io/pypi/v/pytest-xdocker.svg
+   :target: https://pypi.python.org/pypi/pytest-xdocker/
+   :alt: PyPI
+.. image:: https://img.shields.io/github/issues-raw/cr3/pytest-xdocker.svg
+   :target: https://github.com/cr3/pytest-xdocker/issues
+   :alt: Issues
+
+Requirements
+------------
+
+You will need the following prerequisites to use pytest-xdocker:
+
+- Python 3.9, 3.10, 3.11, 3.12, 3.13
+
+Installation
+------------
+
+To install pytest-xdocker:
+
+.. code-block:: bash
+
+  $ pip install pytest-xdocker
+
+Usage
+-----
+
+TODO
+
+Resources
+---------
+
+- `Documentation <https://cr3.github.io/pytest-xdocker/>`_
+- `Release Notes <http://github.com/cr3/pytest-xdocker/blob/master/CHANGES.rst>`_
+- `Issue Tracker <http://github.com/cr3/pytest-xdocker/issues>`_
+- `Source Code <http://github.com/cr3/pytest-xdocker/>`_
+- `PyPi <https://pypi.org/project/pytest-xdocker/>`_
+

pytest_xdocker-0.0.0/README.rst

@@ -0,0 +1,44 @@
+pytest-xdocker
+==============
+
+`Pytest <http://pytest.org>`_  fixture to run docker across test runs.
+
+.. image:: https://img.shields.io/badge/license-MIT-blue.svg
+   :target: https://github.com/cr3/pytest-xdocker/blob/master/LICENSE
+   :alt: License
+.. image:: https://img.shields.io/pypi/v/pytest-xdocker.svg
+   :target: https://pypi.python.org/pypi/pytest-xdocker/
+   :alt: PyPI
+.. image:: https://img.shields.io/github/issues-raw/cr3/pytest-xdocker.svg
+   :target: https://github.com/cr3/pytest-xdocker/issues
+   :alt: Issues
+
+Requirements
+------------
+
+You will need the following prerequisites to use pytest-xdocker:
+
+- Python 3.9, 3.10, 3.11, 3.12, 3.13
+
+Installation
+------------
+
+To install pytest-xdocker:
+
+.. code-block:: bash
+
+  $ pip install pytest-xdocker
+
+Usage
+-----
+
+TODO
+
+Resources
+---------
+
+- `Documentation <https://cr3.github.io/pytest-xdocker/>`_
+- `Release Notes <http://github.com/cr3/pytest-xdocker/blob/master/CHANGES.rst>`_
+- `Issue Tracker <http://github.com/cr3/pytest-xdocker/issues>`_
+- `Source Code <http://github.com/cr3/pytest-xdocker/>`_
+- `PyPi <https://pypi.org/project/pytest-xdocker/>`_

pytest_xdocker-0.0.0/pyproject.toml

@@ -0,0 +1,141 @@
+[tool.poetry]
+name = "pytest-xdocker"
+version = "0.0.0"
+description = "Pytest fixture to run docker across test runs."
+authors = ["Marc Tardif"]
+readme = "README.rst"
+repository = "https://github.com/cr3/pytest-xdocker"
+packages = [
+    { include = "pytest_xdocker" },
+]
+
+[tool.poetry.dependencies]
+attrs = "^24.3.0"
+netifaces = "^0.11.0"
+psutil = "^6.1.1"
+pyhamcrest = "^2.1.0"
+python = "^3.9"
+pytest = "^7.4.2"
+pytest-cache = "^1.0"
+pytest-xprocess = "^1.0.2"
+
+[tool.poetry.group.test.dependencies]
+coverage = "^7.2.3"
+pytest-unique = "^0.1.3"
+yarl = "^1.18.3"
+
+[tool.poetry.group.check]
+optional = true
+
+[tool.poetry.group.check.dependencies]
+ruff = "^0.0.265"
+black = "^23.3.0"
+pre-commit = "^3.3.1"
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+sphinx = "^6.1.3"
+sphinxcontrib-log-cabinet = "^1.0.1"
+sphinx-rtd-theme = "^1.2.0"
+
+[tool.poetry.scripts]
+docker-xrun = "pytest_xdocker.docker_xrun:main"
+
+[tool.poetry.plugins."pytest11"]
+docker-xrun = "pytest_xdocker.fixtures"
+
+[tool.poetry.plugins."pytest_unique.unique"]
+ip = "pytest_xdocker.network:unique_ip"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.black]
+line-length = 120
+target-version = ["py39"]
+preview = true
+
+[tool.ruff]
+target-version = "py39"
+line-length = 120
+fix = true
+select = [
+    # flake8-2020
+    "YTT",
+    # flake8-bandit
+    "S",
+    # flake8-bugbear
+    "B",
+    # flake8-builtins
+    "A",
+    # flake8-comprehensions
+    "C4",
+    # flake8-debugger
+    "T10",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+    # mccabe
+    "C90",
+    # pycodestyle
+    "E", "W",
+    # pyflakes
+    "F",
+    # pygrep-hooks
+    "PGH",
+    # pyupgrade
+    "UP",
+    # ruff
+    "RUF",
+    # tryceratops
+    "TRY",
+]
+ignore = [
+    # LineTooLong
+    "E501",
+    # DoNotAssignLambda
+    "E731",
+    # Create your own exception
+    "TRY002",
+    # Avoid specifying long messages outside the exception class
+    "TRY003",
+]
+
+[tool.ruff.per-file-ignores]
+"tests/*" = ["S101"]
+
+# Pytest options:
+#   https://docs.pytest.org/en/6.2.x/reference.html#ini-options-ref
+[tool.pytest.ini_options]
+addopts = [
+    "--doctest-modules",
+    "--doctest-glob=*.rst",
+]
+testpaths = [
+    "pytest_xdocker",
+    "docs",
+    "tests",
+]
+
+# Coverage options:
+#   https://coverage.readthedocs.io/en/latest/config.html
+[tool.coverage.paths]
+source = [
+    "pytest_xdocker",
+    "*/*/site-packages",
+]
+
+[tool.coverage.report]
+fail_under = 90
+show_missing = true
+
+[tool.coverage.run]
+branch = true
+parallel = true
+source = [
+    "pytest_xdocker",
+]

pytest_xdocker-0.0.0/pytest_xdocker/cache.py

@@ -0,0 +1,98 @@
+"""Cache providers."""
+
+import codecs
+import json
+from abc import ABCMeta, abstractmethod
+from pathlib import Path
+
+import attr
+
+
+def cache_encode(data):
+    """Serialize cache payload."""
+    return json.dumps(data).encode("utf-8")
+
+
+def cache_decode(payload):
+    """Deserialize cache payload."""
+    return json.loads(codecs.decode(payload, "utf-8"))
+
+
+class CacheError(Exception):
+    """Raised with an unexpected cache error occurs."""
+
+
+class Cache(metaclass=ABCMeta):
+    """Base class for cache providers."""
+
+    @abstractmethod
+    def get(self, key, default):
+        """Return cached value for the given key or the default."""
+
+    @abstractmethod
+    def set(self, key, value):  # noqa: A003
+        """Save value for the given key."""
+
+
+@attr.s(frozen=True, slots=True)
+class FileCache(Cache):
+    """Lightweight implementation of `pytest.cache`.
+
+    :param path: Base path to cache directory.
+    :param encode: Encoding function, defaults to `cache_encode`
+    :param decode: Decoding function, defaults to `cache_decode`
+    """
+
+    _cachedir = attr.ib(converter=Path)
+    encode = attr.ib(default=cache_encode)
+    decode = attr.ib(default=cache_decode)
+
+    def _get_value_path(self, key):
+        path = self._cachedir / "v" / key
+        path.parent.mkdir(parents=True, exist_ok=True)
+        return path
+
+    def get(self, key, default):
+        """Read from file."""
+        path = self._get_value_path(key)
+        if path.exists():
+            payload = path.read_bytes()
+            return self.decode(payload)
+        else:
+            return default
+
+    def set(self, key, value):  # noqa: A003
+        """Write to file."""
+        path = self._get_value_path(key)
+        payload = self.encode(value)
+        path.write_bytes(payload)
+
+
+@attr.s(frozen=True, slots=True)
+class MemoryCache(Cache):
+    """Memory cache."""
+
+    _memory = attr.ib(default=attr.Factory(dict))
+
+    def get(self, key, default):
+        """Read from dict."""
+        return self._memory.get(key, default)
+
+    def set(self, key, value):  # noqa: A003
+        """Write the value to dict."""
+        self._memory[key] = value
+
+
+@attr.s(frozen=True, slots=True)
+class NullCache(Cache):
+    """Null cache.
+
+    This cache never sets a value and always gets the default value.
+    """
+
+    def get(self, key, default):
+        """Noop."""
+        return default
+
+    def set(self, key, value):  # noqa: A003
+        """Noop."""

pytest_xdocker-0.0.0/pytest_xdocker/command.py

@@ -0,0 +1,176 @@
+"""Module to build shell commands declaratively.
+
+A Command instance can be used to build a shell command:
+
+    >>> command = Command('whoami')
+
+The command can then be executed later:
+
+    >>> lines = command.execute().splitlines()
+    >>> len(lines)
+    1
+"""
+
+import logging
+import os
+import re
+import shutil
+import sys
+from collections.abc import Iterable
+from itertools import chain
+from shlex import quote
+from subprocess import check_output
+
+import attr
+
+
+@attr.s(eq=False, frozen=True, repr=False, slots=True)
+class Command(Iterable):
+    """Manages a shell command."""
+
+    _command = attr.ib(converter=str)
+    _parent = attr.ib(default=iter(()))
+    _positionals = attr.ib(factory=list)
+    _optionals = attr.ib(factory=list)
+
+    def __eq__(self, other):
+        return list(self) == other
+
+    def __ne__(self, other):
+        return not self == other
+
+    def __iter__(self):
+        return chain(
+            self._parent,
+            [self._command],
+            self._optionals,
+            self._positionals,
+        )
+
+    def __repr__(self):
+        cls = self.__class__.__name__
+        args = ", ".join(repr(arg) for arg in self)
+        return f"{cls}([{args}])"
+
+    def __str__(self):
+        return self.to_string()
+
+    def to_string(self, escape=None):
+        """Stringify the command."""
+        if escape is None:
+            escape = quote
+
+        return " ".join(escape(part) for part in self)
+
+    def with_positionals(self, *positionals):
+        """Add positional args."""
+        return attr.evolve(self, positionals=self._positionals + list(positionals))
+
+    def with_optionals(self, *optionals):
+        """Add optional args."""
+        return attr.evolve(self, optionals=self._optionals + list(optionals))
+
+    def reparent(self, parent=None):
+        """Add a wrapping command."""
+        if parent is None:
+            parent = iter(())
+        return attr.evolve(self, parent=parent)
+
+    def execute(self, **kwargs):
+        """Run the command."""
+        logging.info("Executing command: %s", self)
+        kwargs.setdefault("universal_newlines", True)
+        return check_output(self, **kwargs)  # noqa: S603
+
+
+def empty_type():
+    """Option arg for an undefined optional arg."""
+    return args_type(min=0, max=0)
+
+
+def const_type(const):
+    """Option arg for a constant string."""
+    return (const,)
+
+
+def arg_type(arg, **kwargs):
+    """Option type for a single args."""
+    return args_type(arg, min=1, max=1, **kwargs)
+
+
+def args_type(*args, **kwargs):
+    """Option type for multiple args."""
+    options = {
+        "converter": lambda arg: arg,
+        "min": 0,
+        "max": sys.maxsize,
+    }
+    options.update(kwargs)
+
+    if len(args) < options["min"]:
+        raise ValueError(f"Expected at least {options['min']} args, got: {args!r}")
+    if len(args) > options["max"]:
+        raise ValueError(f"Expected at most {options['max']} args, got: {args!r}")
+
+    return tuple(options["converter"](arg) for arg in args)
+
+
+class OptionalArg:
+    """Descriptor for optional arguments.
+
+    :param name: Name of the option.
+    :param type: Optional argument type, defaults to `empty_type`.
+    :param kwargs: Optional keyword arguments passed to the type.
+    """
+
+    def __init__(self, name, type=empty_type, **kwargs):  # noqa: A002
+        """Init."""
+        self._name = name
+        self._type = type
+        self._kwargs = kwargs
+
+    def __get__(self, obj, cls=None):
+        def with_func(*args):
+            values = self._type(*args, **self._kwargs)
+            return obj.with_optionals(self._name, *values)
+
+        return with_func
+
+
+class PositionalArg:
+    """Descriptor for positional arguments.
+
+    :param type: Optional argument type, defaults to `arg_type`.
+    :param kwargs: Optional keyword arguments passed to the type.
+    """
+
+    def __init__(self, type=arg_type, **kwargs):  # noqa: A002
+        """Init."""
+        self._type = type
+        self._kwargs = kwargs
+
+    def __get__(self, obj, cls=None):
+        def with_func(*args):
+            values = self._type(*args, **self._kwargs)
+            return obj.with_positionals(*values)
+
+        return with_func
+
+
+def script_to_command(script, cls=Command):
+    """
+    On Windows, console scripts created as .exe should be called directly
+    and those created as .cmd with Python.
+    """
+    path = shutil.which(script)
+    if path is None:
+        raise OSError(f"Script not found: {script}")
+
+    base, ext = os.path.splitext(path)
+    if re.match(r".cmd", ext, re.IGNORECASE):
+        parent = Command(shutil.which("python"))
+        command = cls(base, parent)
+    else:
+        command = cls(path)
+
+    return command