agapsys-tests 0.0.0__py3-none-any.whl

agapsys/tests/__init__.py

@@ -0,0 +1,4 @@
+# Copyright (c) 2026 Leandro José Britto de Oliveira
+# Licensed under the MIT License.
+
+from . import assertions, console, os, time

agapsys/tests/assertions.py

@@ -0,0 +1,71 @@
+
+# Copyright (c) 2026 Leandro José Britto de Oliveira
+# Licensed under the MIT License.
+
+# Copyright (c) 2026 Leandro José Britto de Oliveira
+# Licensed under the MIT License.
+
+from typing import Type, ContextManager
+
+def raises(ex_type: Type[Exception] = Exception, msg: str | None = None, exact: bool = True) -> ContextManager:
+    """
+    Returns a context manager expecting an exception is raised.
+
+    Args:
+        ex_type (Type[Exception], optional):
+            Exception type to be raised. Defaults to `Exception`.
+
+        msg (str | None, optional):
+            Exception message that be detected or `None` is message is not
+            checked. Defaults to `None`.
+
+        exact (bool, optional):
+            When a message is specifed, defines if an exact match is required,
+            otherwise a a check if given messae is present in detected exception
+            message. Defaults to `True`.
+
+    Raises:
+        AssertionError:
+            If either an exception is not detected, its type does not match,
+            or exception message does not match with expected one.
+
+    Returns:
+        ContextManager
+    """
+    isinstance(ex_type, (type(None), type))
+    if ex_type is not None:
+        issubclass(ex_type, Exception)
+        isinstance(msg, (type(None), str))
+        isinstance(exact, bool)
+
+    class RaisesContext:
+        def __init__(self, ex_type: type | None, msg: str | None):
+            self.ex_type = ex_type
+            self.msg = msg
+            self.excinfo = None
+
+        def __enter__(self):
+            return self
+
+        def __exit__(self, exc_type, exc_value, traceback):
+            # No exception raised → fail
+            if exc_type is None:
+                raise AssertionError(f"No exception was raised")
+
+            # An exception was raised. Check type:
+            if self.ex_type is not None and not issubclass(exc_type, self.ex_type):
+                raise AssertionError(f"\nExpected type: {self.ex_type.__name__}\nGiven type: {exc_type.__name__}") from exc_value
+
+            # Correct exception, check message
+            if self.msg is not None:
+                ex_msg = str(exc_value)
+                if exact and msg != ex_msg:
+                    raise AssertionError(f"\nExpected message: {repr(msg)}\nGiven message: {repr(ex_msg)}") from exc_value
+                if not exact and msg is not None and msg not in ex_msg:
+                    raise AssertionError(f"\nNot found: {repr(msg)}\nIn: {repr(ex_msg)}") from exc_value
+
+            # store info and suppress it
+            self.excinfo = (exc_type, exc_value, traceback)
+            return True
+
+    return RaisesContext(ex_type, msg)

agapsys/tests/console.py

@@ -0,0 +1,174 @@
+# Copyright (c) 2026 Leandro José Britto de Oliveira
+# Licensed under the MIT License.
+
+from pytest import fixture
+from typing import Sequence
+
+import sys
+import io
+
+class ConsoleTextOutputStream(io.StringIO):
+    """Console text output stream. """
+
+    def __init__(self, original_stream) -> None:
+        super().__init__()
+        self.__original_stream = original_stream
+
+    def clear(self):
+        """Clear stream data."""
+        self.truncate(0)
+        self.seek(0)
+
+    def dump(self):
+        """
+        Dumps stored data into original (wrapped) stream.
+        """
+        print(self.getvalue(), file=self.__original_stream)
+
+    def __str__(self):
+        return self.getvalue()
+
+    def __repr__(self) -> str:
+        return self.__str__()
+
+    def assert_lines(
+        self,
+        expected_lines: Sequence[str],
+        exact_lines: bool = False,
+        exact_len: bool = True
+    ):
+        """
+        Asserts contained data matches a given sequence of lines.
+
+        Args:
+            expected_lines (Sequence[str]):
+                Expected line sequence.
+
+            exact_lines (bool, optional):
+                Defines if every line should match exactly. Defaults to False.
+
+            exact_len (bool, optional):
+                Defines if the number of contained lines matches with given
+                expected ones. Defaults to True.
+
+        Raises:
+            AssertionError: If test fails.
+        """
+        out = self.getvalue().split('\n')
+        out = out[:-1] if out and out[-1] == "" else out
+
+        if exact_len:
+            match_length = (len(out) == len(expected_lines))
+            min_len = min(len(out), len(expected_lines))
+
+        for i in range(min_len):
+            if exact_lines:
+                assert expected_lines[i] == out[i], f"Difference at line {i + 1}:\nExpected: {repr(expected_lines[i])}\nGiven: {repr(out[i])}"
+            else:
+                assert expected_lines[i] in out[i], f"Substring not found at line {i + 1}:\nSearched: {repr(expected_lines[i])}\nBase: {repr(out[i])}"
+
+        if not match_length:
+            raise AssertionError(f"Unexpected line: {expected_lines[min_len] if len(expected_lines) > min_len else out[min_len]}")
+
+        self.clear()
+
+class ConsoleTextInputStream(io.StringIO):
+    """Console text input stream. """
+    def __init__(self, initial_value: str | None = "", newline: str | None = "\n"):
+        super().__init__(initial_value, newline)
+
+    def set_inputs(self, *inputs):
+        """
+        Sets a sequence of inputs (for each input an implicit newline is added
+        automatically.
+        """
+        self.seek(0)
+        for input in inputs:
+            self.write(f"{input}\n")
+        self.seek(0)
+
+@fixture
+def text_stdout():
+    """
+    Replaces `sys.stdout` by a `ConsoleTextOutputStream upon every test.
+
+    Original stream is restored after test.
+    """
+    old = sys.stdout
+    sys.stdout = ConsoleTextOutputStream(old)
+    try:
+        yield sys.stdout
+    finally:
+        sys.stdout = old
+
+@fixture
+def binary_stdout():
+    """
+    Replaces `sys.stdout` by a byte buffer (`io.BytesIO`) upon every test.
+
+    Original stream is restored after test.
+    """
+    old = sys.stdout
+    sys.stdout = io.BytesIO()
+
+    try:
+        yield sys.stdout
+    finally:
+        sys.stdout = old
+
+@fixture
+def text_stderr():
+    """
+    Replaces `sys.stderr` by a `ConsoleTextOutputStream upon every test.
+
+    Original stream is restored after test.
+    """
+    old = sys.stderr
+    sys.stderr = ConsoleTextOutputStream(old)
+    try:
+        yield sys.stderr
+    finally:
+        sys.stderr = old
+
+@fixture
+def binary_stderr():
+    """
+    Replaces `sys.stderr` by a byte buffer (`io.BytesIO`) upon every test.
+
+    Original stream is restored after test.
+    """
+    old = sys.stderr
+    sys.stderr = io.BytesIO()
+
+    try:
+        yield sys.stderr
+    finally:
+        sys.stderr = old
+
+@fixture
+def text_stdin():
+    """
+    Replaces `sys.stdin` by a `ConsoleTextInputStream upon every test.
+
+    Original stream is restored after test.
+    """
+    old = sys.stdin
+    sys.stdin = ConsoleTextInputStream()
+    try:
+        yield sys.stdin
+    finally:
+        sys.stdin = old
+
+@fixture
+def binary_stdin():
+    """
+    Replaces `sys.stdin` by a byte buffer (`io.BytesIO`) upon every test.
+
+    Original stream is restored after test.
+    """
+    old = sys.stdin
+    sys.stdin = io.BytesIO()
+    try:
+        yield sys.stdin
+    finally:
+        sys.stdin = old

agapsys/tests/os.py

@@ -0,0 +1,71 @@
+# Copyright (c) 2026 Leandro José Britto de Oliveira
+# Licensed under the MIT License.
+
+from pytest import fixture
+
+import os
+import sys
+
+class Argv:
+    """Wrapper for `sys.argv`."""
+    def __init__(self):
+        """Create a wrapper for `sys.argv`."""
+        self.__argv = sys.argv
+        self.set()
+
+    def set(self, *args: str, launcher: str = 'test'):
+        """
+        Sets `sys.argv` args.
+
+        Args:
+            *args (str):
+                Arguments for `sys.argv` starting at index 1.
+
+            launcher (str, optional):
+                Value for `sys.argv[0]`. Defaults to 'test'.
+        """
+        assert isinstance(launcher, str) and launcher
+        self.__argv[:] = [launcher]
+        self.__argv.extend(args)
+
+class Env:
+    """Wrapper for `os.environ`."""
+    def __init__(self):
+        """Create a wrapper for `os.environ`."""
+        self.__env = os.environ
+
+    def set(self, **vars: dict[str, str]):
+        """
+        Sets `os.environ` variables.
+
+        Args:
+            **vars (dict[str, str]):
+                Variables.
+        """
+        assert isinstance(vars, dict)
+        self.__env.clear()
+        for k, v in vars.items():
+            assert isinstance(k, str) and isinstance(v, str)
+            self.__env[k] = v
+
+@fixture
+def env():
+    """
+    Return test-specific environment.
+    """
+    original = os.environ.copy()
+    env = Env()
+    try:
+        yield env
+    finally:
+        os.environ.clear()
+        os.environ.update(original)
+
+@fixture
+def argv():
+    backup = sys.argv.copy()
+    argv = Argv()
+    try:
+        yield argv
+    finally:
+        sys.argv = backup

agapsys/tests/time.py

@@ -0,0 +1,39 @@
+# Copyright (c) 2026 Leandro José Britto de Oliveira
+# Licensed under the MIT License.
+
+from pytest import fixture
+
+import time
+
+class FakePerformanceCounter:
+    def __init__(self) -> None:
+        self.__t = 0.0
+        self.__delay = None
+
+    def set(self, t: float):
+        assert isinstance(t, float)
+        self.__t = t
+        self.__delay = None
+
+    def delay(self, t: float):
+        assert isinstance(t, float) and t > 0.0
+        self.__delay = t
+
+    def __call__(self) -> float:
+        if self.__delay is not None:
+            t = self.__t
+            self.__t += self.__delay
+            self.__delay = None
+            return t
+
+        return self.__t
+
+@fixture
+def perf_counter():
+    backup = time.perf_counter
+    fake = FakePerformanceCounter()
+    time.perf_counter = fake
+    try:
+        yield fake
+    finally:
+        time.perf_counter = backup

agapsys_tests-0.0.0.dist-info/METADATA

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: agapsys-tests
+Version: 0.0.0
+Summary: Common test utilities
+License-Expression: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest>=7.0
+Requires-Dist: agapsys-utils<2.0.0,>=1.0.0
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# agapsys-tests
+
+This project provides testing general purpose utiltities that individually thet do not fit in a dedicated library.
+
+## License
+
+This project is distributed under MIT License. Please see the [LICENSE](LICENSE) file for details on copying and distribution.
+
+## Basic usage
+
+  ```py
+  import agapsys.tests as tests
+
+  # That's it... use the available modules
+  ```

agapsys_tests-0.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+agapsys/tests/__init__.py,sha256=zasd3WW7rgjPISnSxs4_MYlTZuWUqCvpiNh2hBGkrxo,133
+agapsys/tests/assertions.py,sha256=-nY0mhV2W2HvmhgoH2lraeQSoGoROY1nHRsQDkmjyas,2669
+agapsys/tests/console.py,sha256=6DUXKR5jhrVBwGgYNILfj85IECfdGxuDzFZGe1V1n24,4486
+agapsys/tests/os.py,sha256=q-_p8WvzegnSXNrmUK6ITrn1BuBlfnvfQH1AAOAyluU,1631
+agapsys/tests/time.py,sha256=fLpw87fsZUHQsAi3I1II7BKW7mZrnRe8Va9buV_feoo,876
+agapsys_tests-0.0.0.dist-info/licenses/LICENSE,sha256=yr_RkPiAq-n-SY5DlUgGF3NLyKJs7Fma2lNNbUmPSaI,1089
+agapsys_tests-0.0.0.dist-info/METADATA,sha256=VjLXUAjNpIum9fE6LUZAxlJtocYkjMcu7BBGzdJk26c,764
+agapsys_tests-0.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+agapsys_tests-0.0.0.dist-info/top_level.txt,sha256=jQtj8IXrsij7eYU7deXAYNMNiYvMvdhkfjud5AjBtOk,8
+agapsys_tests-0.0.0.dist-info/RECORD,,

agapsys_tests-0.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

agapsys_tests-0.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Leandro José Britto de Oliveira
+
+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.

agapsys_tests-0.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+agapsys