tenzir-test 1.1.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

tenzir_test/cli.py

@@ -11,6 +11,15 @@ import click
 from . import __version__, run as runtime
 
 
+class _UnindentedEpilogCommand(click.Command):
+    """Command that renders the epilog without indentation."""
+
+    def format_epilog(self, ctx: click.Context, formatter: click.HelpFormatter) -> None:
+        if self.epilog:
+            formatter.write_paragraph()
+            formatter.write(self.epilog)
+
+
 def _normalize_exit_code(value: object) -> int:
     """Cast arbitrary exit codes to integers."""
 
@@ -22,7 +31,18 @@ def _normalize_exit_code(value: object) -> int:
 
 
 @click.command(
+    cls=_UnindentedEpilogCommand,
     context_settings={"help_option_names": ["-h", "--help"]},
+    epilog="""\
+Examples:
+  tenzir-test                       Run all tests in the project
+  tenzir-test tests/alerts/         Run all tests in a directory
+  tenzir-test tests/basic.tql       Run a specific test file
+  tenzir-test -u tests/new.tql      Run test and update its baseline
+  tenzir-test -p -k tests/debug/    Debug with output streaming and kept temps
+
+Documentation: https://docs.tenzir.com/reference/test-framework/
+""",
 )
 @click.version_option(
     __version__,
@@ -51,6 +71,7 @@ def _normalize_exit_code(value: object) -> int:
 @click.argument(
     "tests",
     nargs=-1,
+    metavar="[TEST]...",
     type=click.Path(path_type=Path, resolve_path=False),
 )
 @click.option("-u", "--update", is_flag=True, help="Update reference outputs.")
@@ -156,7 +177,17 @@ def cli(
     verbose: bool,
     all_projects: bool,
 ) -> int:
-    """Execute tenzir-test scenarios."""
+    """Execute test scenarios and compare output against baselines.
+
+    Discovers and runs tests under the project root, comparing actual output
+    against reference .txt files. Use --update to regenerate baselines.
+
+    \b
+    TEST paths can be:
+      - Individual test files (e.g., tests/basic.tql)
+      - Directories to run all tests within (e.g., tests/alerts/)
+      - Omitted to run all discovered tests in the project
+    """
 
     package_paths: list[Path] = []
     for entry in package_dirs:

{tenzir_test-1.1.0.dist-info → tenzir_test-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tenzir-test
-Version: 1.1.0
+Version: 1.1.1
 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

{tenzir_test-1.1.0.dist-info → tenzir_test-1.1.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
 tenzir_test/__init__.py,sha256=k7V6Pbjaa8SAy6t4KnaauHTyfnyVEwc1VGtH823MANU,1181
 tenzir_test/_python_runner.py,sha256=ZODuZ6ll21gxBRj34iq-7lOmZOiqzFyu7wnPnS0K648,3130
-tenzir_test/cli.py,sha256=WwddXpkjg3OIT5E54LOobaibDkGH9UvTLzZ9iMKw-qQ,6241
+tenzir_test/cli.py,sha256=RfhHKji02CDG1OQU0_ZpCqyEuAOYJwEEZeDD_hqayHg,7438
 tenzir_test/config.py,sha256=z4ayS62SfOLNwrEgNktVeulyQ2QW4KUlN1KX0Za1NDM,2110
 tenzir_test/packages.py,sha256=cTCQdGjCS1XmuKyiwh0ew-z9tHn6J-xZ6nvBP-hU8bc,948
 tenzir_test/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -21,8 +21,8 @@ tenzir_test/runners/runner.py,sha256=LtlD8huQOSmD7RyYDnKeCuI4Y6vhxGXMKsHA2qgfWN0
 tenzir_test/runners/shell_runner.py,sha256=vWCNTWQGVoatM98jN1UJaVrZJR2oPnqpPUs0-ud7rrc,6185
 tenzir_test/runners/tenzir_runner.py,sha256=464FFYS_mh6l-ehccc-S8cIUO1MxdapwQL5X3PmMkMI,1006
 tenzir_test/runners/tql_runner.py,sha256=2ZLMf3TIKwcOvaOFrVvvhzK-EcWmGOUZxKkbSoByyQA,248
-tenzir_test-1.1.0.dist-info/METADATA,sha256=n9yH11WQuTx4rX0DoK2Qz8alBPZlbBM9GrABHIQ7vsA,3065
-tenzir_test-1.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-tenzir_test-1.1.0.dist-info/entry_points.txt,sha256=l8DJgiEVrjScdTTo613cZ3PKodOmqrUVIbz-3awfV8w,53
-tenzir_test-1.1.0.dist-info/licenses/LICENSE,sha256=ajMbpcBiSTXI8Rr4t17pvowV-On8DktghfZKxY_A22Q,10750
-tenzir_test-1.1.0.dist-info/RECORD,,
+tenzir_test-1.1.1.dist-info/METADATA,sha256=0pKON62eJrS_LulcE-yujdlnzg6v6ZR7Nq79FWUZs3I,3065
+tenzir_test-1.1.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+tenzir_test-1.1.1.dist-info/entry_points.txt,sha256=l8DJgiEVrjScdTTo613cZ3PKodOmqrUVIbz-3awfV8w,53
+tenzir_test-1.1.1.dist-info/licenses/LICENSE,sha256=ajMbpcBiSTXI8Rr4t17pvowV-On8DktghfZKxY_A22Q,10750
+tenzir_test-1.1.1.dist-info/RECORD,,