tenzir-test 0.12.0__py3-none-any.whl

tenzir_test/runners/shell_runner.py

@@ -0,0 +1,158 @@
+from __future__ import annotations
+
+import subprocess
+import sys
+import typing
+from pathlib import Path
+
+from tenzir_test import fixtures as fixture_api
+
+from ._utils import get_run_module
+from .ext_runner import ExtRunner
+
+
+class ShellRunner(ExtRunner):
+    def __init__(self) -> None:
+        super().__init__(name="shell", ext="sh")
+
+    def run(self, test: Path, update: bool, coverage: bool = False) -> bool:
+        del coverage
+        run_mod = get_run_module()
+        test_config = run_mod.parse_test_config(test)
+        passthrough = run_mod.is_passthrough_enabled()
+        inputs_override = typing.cast(str | None, test_config.get("inputs"))
+        env, _config_args = run_mod.get_test_env_and_config_args(test, inputs=inputs_override)
+        fixtures = typing.cast(tuple[str, ...], test_config.get("fixtures", tuple()))
+        timeout = typing.cast(int, test_config["timeout"])
+        expect_error = bool(test_config.get("error", False))
+
+        context_token = fixture_api.push_context(
+            fixture_api.FixtureContext(
+                test=test,
+                config=typing.cast(dict[str, typing.Any], test_config),
+                coverage=False,
+                env=env,
+                config_args=tuple(),
+                tenzir_binary=run_mod.TENZIR_BINARY,
+                tenzir_node_binary=run_mod.TENZIR_NODE_BINARY,
+            )
+        )
+        try:
+            with fixture_api.activate(fixtures) as fixture_env:
+                env.update(fixture_env)
+                run_mod._apply_fixture_env(env, fixtures)
+                shell_bin_dir = run_mod.ROOT / "_shell"
+                shell_path_prefix = shell_bin_dir.as_posix()
+                if env.get("PATH"):
+                    env["PATH"] = f"{shell_path_prefix}:{env['PATH']}"
+                else:
+                    env["PATH"] = shell_path_prefix
+
+                try:
+                    completed = run_mod.run_subprocess(
+                        ["sh", "-eu", str(test)],
+                        env=env,
+                        timeout=timeout,
+                        capture_output=not passthrough,
+                        check=not expect_error,
+                        text=False,
+                        cwd=str(run_mod.ROOT),
+                    )
+                except subprocess.CalledProcessError as exc:
+                    completed = exc  # treat like CompletedProcess for diagnostics
+        finally:
+            fixture_api.pop_context(context_token)
+            run_mod.cleanup_test_tmp_dir(env.get(run_mod.TEST_TMP_ENV_VAR))
+
+        stdout_data = completed.stdout
+        if isinstance(stdout_data, str):
+            stdout_bytes: bytes = stdout_data.encode()
+        else:
+            stdout_bytes = stdout_data or b""
+
+        stderr_data = completed.stderr
+        if isinstance(stderr_data, str):
+            stderr_bytes: bytes = stderr_data.encode()
+        else:
+            stderr_bytes = stderr_data or b""
+
+        good = completed.returncode == 0
+        if expect_error == good:
+            suppressed = run_mod.should_suppress_failure_output()
+            summary_line = run_mod.format_failure_message(
+                f"got unexpected exit code {completed.returncode}"
+            )
+            if passthrough:
+                if not suppressed:
+                    run_mod.report_failure(test, summary_line)
+                return False
+            if suppressed:
+                return False
+
+            with run_mod.stdout_lock:
+                run_mod.fail(test)
+                line_prefix = "│ ".encode()
+                for line in stdout_bytes.splitlines():
+                    sys.stdout.buffer.write(line_prefix + line + b"\n")
+                if stderr_bytes:
+                    sys.stdout.write("├─▶ stderr\n")
+                    detail_prefix = run_mod.DETAIL_COLOR.encode()
+                    reset_bytes = run_mod.RESET_COLOR.encode()
+                    for line in stderr_bytes.splitlines():
+                        sys.stdout.buffer.write(
+                            line_prefix + detail_prefix + line + reset_bytes + b"\n"
+                        )
+                sys.stdout.write(summary_line + "\n")
+            return False
+
+        if passthrough:
+            run_mod.success(test)
+            return True
+
+        root_prefix: bytes = (str(run_mod.ROOT) + "/").encode()
+        stdout_bytes = stdout_bytes.replace(root_prefix, b"")
+
+        stdout_path = test.with_suffix(".txt")
+
+        combined_bytes = stdout_bytes
+        if stderr_bytes:
+            if combined_bytes and not combined_bytes.endswith(b"\n"):
+                combined_bytes += b"\n"
+            combined_bytes += stderr_bytes
+
+        if update:
+            stdout_path.write_bytes(combined_bytes)
+            run_mod.success(test)
+            return True
+
+        if combined_bytes:
+            if not stdout_path.exists():
+                run_mod.report_failure(
+                    test,
+                    run_mod.format_failure_message(f'Failed to find ref file: "{stdout_path}"'),
+                )
+                return False
+            run_mod.log_comparison(test, stdout_path, mode="comparing")
+            expected_stdout = stdout_path.read_bytes()
+            if expected_stdout != combined_bytes:
+                if run_mod.interrupt_requested():
+                    run_mod.report_interrupted_test(test)
+                else:
+                    run_mod.report_failure(test, "")
+                    run_mod.print_diff(expected_stdout, combined_bytes, stdout_path)
+                return False
+        elif stdout_path.exists():
+            expected_stdout = stdout_path.read_bytes()
+            if expected_stdout not in {b"", b"\n"}:
+                if run_mod.interrupt_requested():
+                    run_mod.report_interrupted_test(test)
+                else:
+                    run_mod.report_failure(test, "")
+                    run_mod.print_diff(expected_stdout, b"", stdout_path)
+                return False
+
+        run_mod.success(test)
+        return True
+
+
+__all__ = ["ShellRunner"]

tenzir_test/runners/tenzir_runner.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+import typing
+from pathlib import Path
+
+from ._utils import get_run_module
+from .tql_runner import TqlRunner
+
+
+class TenzirRunner(TqlRunner):
+    def __init__(self) -> None:
+        super().__init__(name="tenzir")
+
+    def run(self, test: Path, update: bool, coverage: bool = False) -> bool | str:
+        run_mod = get_run_module()
+        test_config = run_mod.parse_test_config(test, coverage=coverage)
+        if test_config.get("skip"):
+            return typing.cast(
+                bool | str,
+                run_mod.handle_skip(
+                    str(test_config["skip"]),
+                    test,
+                    update=update,
+                    output_ext=self.output_ext,
+                ),
+            )
+        return bool(
+            run_mod.run_simple_test(
+                test,
+                update=update,
+                output_ext=self.output_ext,
+                coverage=coverage,
+            )
+        )
+
+
+__all__ = ["TenzirRunner"]

tenzir_test/runners/tql_runner.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from .ext_runner import ExtRunner
+
+
+class TqlRunner(ExtRunner):
+    output_ext: str = "txt"
+
+    def __init__(self, *, name: str) -> None:
+        super().__init__(name=name, ext="tql")
+
+
+__all__ = ["TqlRunner"]

tenzir_test-0.12.0.dist-info/METADATA

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: tenzir-test
+Version: 0.12.0
+Summary: Reusable test execution framework extracted from the Tenzir repository.
+Project-URL: Homepage, https://github.com/tenzir/test
+Project-URL: Repository, https://github.com/tenzir/test
+Project-URL: Bug Tracker, https://github.com/tenzir/test/issues
+Project-URL: Documentation, https://docs.tenzir.com
+Author-email: Tenzir <engineering@tenzir.com>
+Maintainer-email: Tenzir Engineering <engineering@tenzir.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: automation,pytest,tenzir,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: click>=8.1
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# 🧪 tenzir-test
+
+`tenzir-test` is the reusable test harness that powers the
+[Tenzir](https://github.com/tenzir/tenzir) project. It discovers test scenarios
+and Python fixtures, prepares the execution environment, and produces artifacts
+you can diff against established baselines.
+
+## ✨ Highlights
+
+- 🔍 Auto-discovers tests, inputs, and configuration across both project and
+  package layouts, including linked satellite projects.
+- 🧩 Supports configurable runners and reusable fixtures so you can tailor how
+  scenarios execute and share setup logic.
+- 🛠️ Provides a `tenzir-test` CLI for orchestrating suites, updating baselines,
+  and inspecting artifacts.
+
+## 📦 Installation
+
+Install the latest release from PyPI with `uvx`—`tenzir-test` requires Python
+3.12 or newer:
+
+```sh
+uvx tenzir-test --help
+```
+
+`uvx` downloads the newest compatible release, runs it in an isolated
+environment, and caches subsequent invocations for fast reuse.
+
+## 📚 Documentation
+
+Consult our [user guide](https://docs.tenzir.com/guides/testing/write-tests)
+for an end-to-end walkthrough of writing tests.
+
+We also provide a dense [reference](https://docs.tenzir.com/reference/test) that
+explains concepts, configuration, multi-project execution, and CLI details.
+
+## 🧑‍💻 Development
+
+Contributor workflows, quality gates, and release procedures live in
+[`DEVELOPMENT.md`](DEVELOPMENT.md). Follow that guide when you work on the
+project locally.
+
+## 🗞️ Releases
+
+New versions are published to PyPI through trusted publishing when a GitHub
+release is created. Review the latest release notes on GitHub for details about
+what's new.
+
+## 📜 License
+
+`tenzir-test` is available under the Apache License, Version 2.0. See
+[`LICENSE`](LICENSE) for details.

tenzir_test-0.12.0.dist-info/RECORD

@@ -0,0 +1,29 @@
+tenzir_test/__init__.py,sha256=k7V6Pbjaa8SAy6t4KnaauHTyfnyVEwc1VGtH823MANU,1181
+tenzir_test/_python_runner.py,sha256=LmghMIolsNEC2wUyJdv1h_cefOxTxET1IACrw-_hHuY,2900
+tenzir_test/checks.py,sha256=VhZjU1TExqWzA1KcaW1xOGICpqb_G43AezrJIzw09eM,653
+tenzir_test/cli.py,sha256=kDatxC4drfjAKnYIYFQmjhPJX45KYbm03pX44iqFgOk,5967
+tenzir_test/config.py,sha256=q1_VEXuxL-xsGlnooeGvXxx9cMw652UEB9a1mPzZIQs,1680
+tenzir_test/packages.py,sha256=cTCQdGjCS1XmuKyiwh0ew-z9tHn6J-xZ6nvBP-hU8bc,948
+tenzir_test/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tenzir_test/run.py,sha256=LE23W07n6O8TnUnkXJArvfwvLI1HYcIu8WCV4lPW70o,125110
+tenzir_test/engine/__init__.py,sha256=5APwy90YDm7rmL_qCZfToAcfbQthcZ8yV2_ExXKqaqE,110
+tenzir_test/engine/operations.py,sha256=OCYjuMHyMAaay4s08u2Sl7oE-PmgeXumylp7R8GYIH4,950
+tenzir_test/engine/registry.py,sha256=LXCr6TGlv1sR1m1eboTk7SrbS2IVErc3PqUuHxGA2xk,594
+tenzir_test/engine/state.py,sha256=Ez-Q27dL5oNqiJE0A4P2OP0p6i7aYKzH4ZyVWNgEezs,889
+tenzir_test/engine/worker.py,sha256=WwIkx1m_ANNveQjNisy5-qpbUZl_DfDXxVIfdxABKjc,140
+tenzir_test/fixtures/__init__.py,sha256=PdkN334btlqagY-4wAwsCyfhHE8kd_RLNoVM_ULii_I,18384
+tenzir_test/fixtures/node.py,sha256=rLEzNff78r048KZmOanzGBCNg-OuJu9lQoKgGCArths,8197
+tenzir_test/runners/__init__.py,sha256=M3p-TsDp231Dy58miDb467bA1kLYzgpa0pqVr_KP1ro,4616
+tenzir_test/runners/_utils.py,sha256=BWv7UEPGa01l4tGTCg5i_22NblIyRw8vjk_5NIf1x_c,467
+tenzir_test/runners/custom_python_fixture_runner.py,sha256=uXbSf18xTttf51k2EbjWf8AqN2R7TfpfSCkLyU5HJx4,7284
+tenzir_test/runners/diff_runner.py,sha256=ah1hr1vvD6BON2PZz61mxwioRFIzHFuaAbJ0DjDSqG4,5151
+tenzir_test/runners/ext_runner.py,sha256=sKL9Mw_ksVVBWnrdIJR2WS5ueVnLKuNYYWZ22FTZIPo,730
+tenzir_test/runners/runner.py,sha256=LtlD8huQOSmD7RyYDnKeCuI4Y6vhxGXMKsHA2qgfWN0,989
+tenzir_test/runners/shell_runner.py,sha256=OuofgHeZN2FaO6xRI3uyqstLBymc6rmWC4HAnSn91AE,6068
+tenzir_test/runners/tenzir_runner.py,sha256=464FFYS_mh6l-ehccc-S8cIUO1MxdapwQL5X3PmMkMI,1006
+tenzir_test/runners/tql_runner.py,sha256=2ZLMf3TIKwcOvaOFrVvvhzK-EcWmGOUZxKkbSoByyQA,248
+tenzir_test-0.12.0.dist-info/METADATA,sha256=VjTW82AKGkRswsZB-0w5wsCWY7MPIrIzZEREINlgZrI,3008
+tenzir_test-0.12.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+tenzir_test-0.12.0.dist-info/entry_points.txt,sha256=q0eD9RQ_9eMPYvFNpBElo55HQYeaPgLfe9YhLsNwl10,93
+tenzir_test-0.12.0.dist-info/licenses/LICENSE,sha256=ajMbpcBiSTXI8Rr4t17pvowV-On8DktghfZKxY_A22Q,10750
+tenzir_test-0.12.0.dist-info/RECORD,,

tenzir_test-0.12.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

tenzir_test-0.12.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+check-release = tenzir_test.checks:main
+tenzir-test = tenzir_test.cli:main

tenzir_test-0.12.0.dist-info/licenses/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 Tenzir
+
+   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.