tenzir-test 0.12.0__tar.gz → 0.13.0__tar.gz

{tenzir_test-0.12.0 → tenzir_test-0.13.0}/PKG-INFO

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

tenzir_test-0.13.0/changelog/config.yaml

@@ -0,0 +1,4 @@
+id: tenzir-test
+name: Tenzir Test
+description: A testing framework for the Tenzir ecosystem
+repository: tenzir/test

tenzir_test-0.13.0/changelog/releases/v0.11.0/entries/01-expose-tenzir-test-as-a-library.md

@@ -0,0 +1,27 @@
+---
+title: Expose tenzir-test as a library
+type: feature
+authors:
+- mavam
+- codex
+created: 2025-11-04
+---
+
+The test framework now exposes its harness as a reusable Python library,
+returning structured execution results instead of exiting the process. Callers
+can import the new `execute` helper and receive an `ExecutionResult` with
+project summaries, exit codes, and failure details for downstream automation.
+
+Example:
+
+```python
+from pathlib import Path
+
+from tenzir_test import ExecutionResult, execute
+
+result: ExecutionResult = execute(tests=[Path("tests/pipeline.tql")])
+if result.exit_code:
+    raise SystemExit(result.exit_code)
+for project in result.project_results:
+    print(project.selection.root, project.summary.total)
+```

tenzir_test-0.13.0/changelog/releases/v0.11.0/manifest.yaml

@@ -0,0 +1,4 @@
+created: 2025-11-04
+title: Tenzir Test v0.11.0
+intro: >-
+  Expose tenzir-test as a reusable Python library.

tenzir_test-0.13.0/changelog/releases/v0.11.0/notes.md

@@ -0,0 +1,23 @@
+Expose tenzir-test as a reusable Python library.
+
+## 🚀 Features
+
+### Expose tenzir-test as a library
+
+The test framework now exposes its harness as a reusable Python library, returning structured execution results instead of exiting the process. Callers can import the new `execute` helper and receive an `ExecutionResult` with project summaries, exit codes, and failure details for downstream automation.
+
+Example:
+
+```python
+from pathlib import Path
+
+from tenzir_test import ExecutionResult, execute
+
+result: ExecutionResult = execute(tests=[Path("tests/pipeline.tql")])
+if result.exit_code:
+    raise SystemExit(result.exit_code)
+for project in result.project_results:
+    print(project.selection.root, project.summary.total)
+```
+
+*By @mavam and @codex.*

tenzir_test-0.13.0/changelog/releases/v0.12.0/entries/01-honor-no-color-for-python-api-consumers.md

@@ -0,0 +1,16 @@
+---
+title: Add configurable color output control
+type: feature
+authors:
+  - codex
+  - mavam
+created: 2025-11-05
+---
+
+We default library consumers to plain output, keep the CLI smart about ANSI usage, and honour `NO_COLOR` across every helper while locking the behaviour down with tests.
+
+When you `import tenzir_test.run`, the harness now emits unstyled text so CI logs stay machine-readable. You can still opt back into colours via `run.set_color_mode(run.ColorMode.ALWAYS)` or let auto-detection pick the best option.
+
+Running `tenzir-test` in a terminal still shows coloured summaries, but redirecting stdout—or exporting `NO_COLOR=1`—forces the palette to plain text, covering diff hunks, failure trees, retry banners, and runner diagnostics.
+
+A single palette helper now drives every glyph and symbol, and pytest coverage exercises CLI, library, and `NO_COLOR` modes to catch regressions immediately.

tenzir_test-0.13.0/changelog/releases/v0.12.0/manifest.yaml

@@ -0,0 +1,4 @@
+created: 2025-11-05
+title: Tenzir Test 0.12.0
+intro: >-
+  Minor release with improved NO_COLOR handling.

tenzir_test-0.13.0/changelog/releases/v0.12.0/notes.md

@@ -0,0 +1,17 @@
+Minor release with improved NO_COLOR handling.
+
+## 🚀 Features
+
+### Add configurable color output control
+
+We switched library consumers to plain output by default and added full `NO_COLOR` support, keeping ANSI colors only where they enhance the interactive experience.
+
+When you `import tenzir_test.run` directly, the harness now emits unstyled text by default—perfect for log parsers, CI systems, and automation scripts that expect machine-readable output. If you need colors back, call `run.set_color_mode(run.ColorMode.ALWAYS)` to force ANSI sequences on, or use `run.ColorMode.AUTO` to let the harness detect terminal capabilities.
+
+The `tenzir-test` CLI continues to auto-detect your terminal and renders colors when you run tests interactively. Redirect stdout to a file or pipe, and it automatically switches to plain mode. Set `NO_COLOR=1` in your environment, and every output—failure trees, diff hunks, retry banners—strips its color codes.
+
+All palette logic now lives in a single helper that colorizes checkmarks, crosses, diff lines, and progress indicators consistently. This unification means `run.print_diff(...)` respects your color mode choice everywhere, whether you invoke it from the CLI or from library code.
+
+We added pytest coverage for all three modes—CLI with colors, library without colors, and `NO_COLOR=1` forcing plain output—so future changes won't break the contract.
+
+*By @codex and @mavam.*

tenzir_test-0.13.0/changelog/releases/v0.13.0/entries/01-improve-diagnostics-when-tenzir-node-fails-to-start.md

@@ -0,0 +1,12 @@
+---
+title: Improve diagnostics when Tenzir Node fails to start
+type: change
+authors:
+- Alainx277
+- claude
+prs:
+- 2
+created: 2025-12-02
+---
+
+The `node` fixture now reports the exit code and stderr output when `tenzir-node` fails to start, making it easier to diagnose startup failures. Previously, the error message provided no context about why the node failed to produce an endpoint.

tenzir_test-0.13.0/changelog/releases/v0.13.0/entries/01-library-mode-and-package-dirs.md

@@ -0,0 +1,32 @@
+---
+title: Library mode and extra packages
+type: feature
+authors:
+- codex
+- mavam
+prs:
+- 4
+created: 2025-12-02
+---
+
+Explicit package loading for tests: use `--package-dirs` (repeatable, accepts
+comma-separated lists) to point the harness at package directories. The same
+flag is passed to the Tenzir binaries, and it merges with any `package-dirs:`
+declared in directory `test.yaml` files. Entries are normalized and
+de-duplicated, then exported via `TENZIR_PACKAGE_DIRS` for fixtures.
+
+The test configuration uses the same spelling: add
+
+```yaml
+package-dirs:
+  - ../shared-packages
+  - /opt/tenzir/packages/foo
+```
+
+to a directory `test.yaml` when you want those packages available for the tests
+below it.
+
+Example: `uvx tenzir-test --package-dirs example-library example-library`
+loads both `foo` and `bar` packages so their operators can cross-import. The
+example-library `test.yaml` files demonstrate the config-based approach if you
+prefer not to pass the `--package-dirs` flag.

tenzir_test-0.13.0/changelog/releases/v0.13.0/manifest.yaml

@@ -0,0 +1,4 @@
+created: 2025-12-03
+title: Tenzir Test v0.13.0
+intro: >-
+  This release adds `--package-dirs` support and improves startup diagnostics.

tenzir_test-0.13.0/changelog/releases/v0.13.0/notes.md

@@ -0,0 +1,29 @@
+This release adds `--package-dirs` support and improves startup diagnostics.
+
+## 🚀 Features
+
+### Library mode and extra packages
+
+Explicit package loading for tests: use `--package-dirs` (repeatable, accepts comma-separated lists) to point the harness at package directories. The same flag is passed to the Tenzir binaries, and it merges with any `package-dirs:` declared in directory `test.yaml` files. Entries are normalized and de-duplicated, then exported via `TENZIR_PACKAGE_DIRS` for fixtures.
+
+The test configuration uses the same spelling: add
+
+```yaml
+package-dirs:
+  - ../shared-packages
+  - /opt/tenzir/packages/foo
+```
+
+to a directory `test.yaml` when you want those packages available for the tests below it.
+
+Example: `uvx tenzir-test --package-dirs example-library example-library` loads both `foo` and `bar` packages so their operators can cross-import. The example-library `test.yaml` files demonstrate the config-based approach if you prefer not to pass the `--package-dirs` flag.
+
+*By @codex and @mavam in [#4](https://github.com/tenzir/test/pull/4).*
+
+## 🔧 Changes
+
+### Improve diagnostics when Tenzir Node fails to start
+
+The `node` fixture now reports the exit code and stderr output when `tenzir-node` fails to start, making it easier to diagnose startup failures. Previously, the error message provided no context about why the node failed to produce an endpoint.
+
+*By @Alainx277 and @claude in [#2](https://github.com/tenzir/test/pull/2).*

tenzir_test-0.13.0/example-library/README.md

@@ -0,0 +1,43 @@
+# Example Library
+
+This directory contains two sibling packages, `foo` and `bar`, to demonstrate
+explicit package loading. Point `tenzir-test` at the directory and add
+`--package-dirs example-library` so both packages are visible to every test:
+
+```sh
+uvx tenzir-test --package-dirs example-library example-library
+```
+
+## Layout
+
+```
+example-library/
+├── foo/
+│   ├── package.yaml
+│   ├── test.yaml
+│   ├── operators/
+│   │   └── increment.tql
+│   └── tests/
+│       ├── use-bar.tql
+│       └── use-bar.txt
+└── bar/
+    ├── package.yaml
+    ├── test.yaml
+    ├── operators/
+    │   └── double.tql
+    └── tests/
+        ├── use-foo.tql
+        └── use-foo.txt
+```
+
+## Cross-package usage
+
+- `foo/tests/use-bar.tql` calls `bar::double`.
+- `bar/tests/use-foo.tql` calls `foo::increment`.
+
+Because `--package-dirs` points at the library, both packages are visible to
+every test without additional flags.
+
+You can also pin package discovery in a directory `test.yaml` by setting
+`package-dirs:` there. This example keeps the entries commented so the CLI
+flag remains the primary, explicit mechanism.

tenzir_test-0.13.0/example-library/bar/operators/double.tql

@@ -0,0 +1 @@
+x = x * 2

tenzir_test-0.13.0/example-library/bar/package.yaml

@@ -0,0 +1,4 @@
+id: bar
+name: Bar Package
+description: |
+  Demonstrates a library package that consumes operators from a sibling package.

tenzir_test-0.13.0/example-library/bar/test.yaml

@@ -0,0 +1,2 @@
+#package-dirs:
+#  - ..

tenzir_test-0.13.0/example-library/bar/tests/use-foo.tql

@@ -0,0 +1,2 @@
+from {x: 42}
+foo::increment

tenzir_test-0.13.0/example-library/bar/tests/use-foo.txt

@@ -0,0 +1,3 @@
+{
+  x: 43,
+}

tenzir_test-0.13.0/example-library/foo/operators/increment.tql

@@ -0,0 +1 @@
+x = x + 1

tenzir_test-0.13.0/example-library/foo/package.yaml

@@ -0,0 +1,4 @@
+id: foo
+name: Foo Package
+description: |
+  Demonstrates a library package that provides an operator used by sibling packages.

tenzir_test-0.13.0/example-library/foo/test.yaml

@@ -0,0 +1,2 @@
+#package-dirs:
+#  - ..

tenzir_test-0.13.0/example-library/foo/tests/use-bar.tql

@@ -0,0 +1,2 @@
+from {x: 42}
+bar::double

tenzir_test-0.13.0/example-library/foo/tests/use-bar.txt

@@ -0,0 +1,3 @@
+{
+  x: 84,
+}

tenzir_test-0.13.0/example-package/operators/deeply/nested/twist.tql

@@ -0,0 +1,7 @@
+---
+description: |
+  This operator performs a simple transformation on the input data.
+---
+
+where x > 0
+set x = x + 1

tenzir_test-0.13.0/example-package/operators/filter.tql

@@ -0,0 +1 @@
+where actor == "admin"

tenzir_test-0.13.0/example-package/operators/parse.tql

@@ -0,0 +1,2 @@
+// Parse our sample.log.
+read_grok r"(?<timestamp>\d{4}-\d{2}-\d{2}) \[(?<actor>\w+)\] %{GREEDYDATA:message}"

tenzir_test-0.13.0/example-package/package.yaml

@@ -0,0 +1,29 @@
+# The package ID defines the top-level module name. For example, placing a
+# user-defined operator `foo` in operators/foo.tql makes it callable via
+# `example::foo`.
+#
+# If you do not specify an ID, the directory name of this package.yaml will be
+# used as the ID. Package installation fails if the ID or directory name
+# contains invalid characters. Allowed characters are alphanumeric and
+# underscore, e.g., `my-package` is invalid but `my_package` is okay.
+id: example
+
+# The name should be a short, human-readable description of the package.
+name: Example Package
+
+# The description should provide a brief overview of the package's purpose and
+# functionality. Markdown is supported.
+description: |
+  This is an example package that demonstrates how to write tests for Tenzir
+  packages.
+
+# Contexts live inside a node. The test harness passes --package-dirs to the node
+# fixture, making contexts also available in the fixture. The harness also
+# passes --package-dirs to the Tenzir running that invokes the the `tenzir`
+# binary. In this case the context configuration gets ignored.
+contexts:
+  ctx:
+    type: lookup-table
+    description: |
+      An example context that gets installed by the test framework when the
+      harness passes --package-dirs to the node fixture.

tenzir_test-0.13.0/example-package/tests/context/01-context-list.tql

@@ -0,0 +1,2 @@
+// Show our example context that ships with the package.
+context::list

tenzir_test-0.13.0/example-package/tests/context/01-context-list.txt

@@ -0,0 +1,5 @@
+{
+  num_entries: 0,
+  name: "ctx",
+  configured: true,
+}

tenzir_test-0.13.0/example-package/tests/context/02-context-update.tql

@@ -0,0 +1,4 @@
+from {x: 42, y: "foo"},
+     {x: 43, y: "bar"},
+     {x: 44, y: "baz"}
+context::update "ctx", key=x, value=y

tenzir_test-0.13.0/example-package/tests/context/03-context-inspect.tql

@@ -0,0 +1 @@
+context::inspect "ctx"

tenzir_test-0.13.0/example-package/tests/context/test.yaml

@@ -0,0 +1,2 @@
+suite: context
+fixtures: [node]

tenzir_test-0.13.0/example-package/tests/inputs/sample.log

@@ -0,0 +1,12 @@
+2025-09-23 [root] All your base are belong to us
+2025-09-24 [user] System takeover initiated by root user
+2025-09-25 [admin] Security breach detected in main database
+2025-09-26 [root] Access privileges escalated successfully
+2025-09-27 [system] Firewall rules modified by unauthorized user
+2025-09-28 [user] Connection established to remote server
+2025-09-29 [root] Database backup corrupted during transfer
+2025-09-30 [admin] Emergency protocols activated
+2025-10-01 [system] Network traffic redirected to external host
+2025-10-02 [root] All security measures have been bypassed
+2025-10-03 [user] Mission accomplished - standing by for orders
+2025-10-04 [admin] System shutdown imminent

tenzir_test-0.13.0/example-package/tests/ops.tql

@@ -0,0 +1,4 @@
+from_file f"{env("TENZIR_INPUTS")}/sample.log" {
+  example::parse
+}
+example::filter

tenzir_test-0.13.0/example-package/tests/ops.txt

@@ -0,0 +1,15 @@
+{
+  timestamp: 2025-09-25T00:00:00Z,
+  actor: "admin",
+  message: "Security breach detected in main database",
+}
+{
+  timestamp: 2025-09-30T00:00:00Z,
+  actor: "admin",
+  message: "Emergency protocols activated",
+}
+{
+  timestamp: 2025-10-04T00:00:00Z,
+  actor: "admin",
+  message: "System shutdown imminent",
+}

tenzir_test-0.13.0/example-package/tests/twist.tql

@@ -0,0 +1,4 @@
+from {}
+repeat 5
+enumerate x
+example::deeply::nested::twist

tenzir_test-0.13.0/example-package/tests/twist.txt

@@ -0,0 +1,12 @@
+{
+  x: 2,
+}
+{
+  x: 3,
+}
+{
+  x: 4,
+}
+{
+  x: 5,
+}

tenzir_test-0.13.0/example-project/tests/context/03-context-inspect.txt

@@ -0,0 +1,12 @@
+{
+  key: 42,
+  value: "foo",
+}
+{
+  key: 44,
+  value: "baz",
+}
+{
+  key: 43,
+  value: "bar",
+}

tenzir_test-0.13.0/example-satellite/README.md

@@ -0,0 +1,27 @@
+# Example Satellite Project
+
+This companion project demonstrates how a satellite can reuse runners and
+fixtures from the root `example-project` while adding its own customizations.
+
+## Layout
+
+```
+example-satellite/
+├── fixtures.py
+└── tests/
+    ├── hex/reuse.{xxd,txt}
+    └── satellite/marker.{sh,txt}
+```
+
+- `fixtures.py` registers the `satellite_marker` fixture that the shell test
+  consumes.
+- `tests/hex/reuse.xxd` exercises the `xxd` runner exported by the root project;
+  no additional runners are needed in the satellite.
+- `tests/satellite/marker.sh` verifies that the local fixture is loaded when the
+  satellite participates in a multi-project run.
+
+Run the example together with the main project:
+
+```sh
+uvx tenzir-test --root example-project example-satellite
+```

tenzir_test-0.13.0/example-satellite/fixtures.py

@@ -0,0 +1,14 @@
+"""Fixtures defined by the example satellite project."""
+
+from __future__ import annotations
+
+from typing import Iterator
+
+from tenzir_test import fixture
+
+
+@fixture(name="satellite_marker")
+def satellite_marker_fixture() -> Iterator[dict[str, str]]:
+    """Expose a marker so tests can assert fixture inheritance works."""
+
+    yield {"SATELLITE_MARKER": "example-satellite"}

tenzir_test-0.13.0/example-satellite/inputs/input.txt

@@ -0,0 +1 @@
+hello world

tenzir_test-0.13.0/example-satellite/tests/hex/reuse.txt

@@ -0,0 +1,2 @@
+00000000: 53 61 74 65 6c 6c 69 74 65 20 72 75 6e 6e 65 72  Satellite runner
+00000010: 20 72 65 75 73 65 21 0a                           reuse!.

tenzir_test-0.13.0/example-satellite/tests/hex/reuse.xxd

@@ -0,0 +1 @@
+Satellite runner reuse!

tenzir_test-0.13.0/example-satellite/tests/satellite/input.sh

@@ -0,0 +1,2 @@
+printf "Inputs are in ${TENZIR_INPUTS}\n"
+cat ${TENZIR_INPUTS}/input.txt

tenzir_test-0.13.0/example-satellite/tests/satellite/input.txt

@@ -0,0 +1,2 @@
+Inputs are in inputs
+hello world

tenzir_test-0.13.0/example-satellite/tests/satellite/marker.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+set -eu
+
+printf '%s\n' "satellite fixture: ${SATELLITE_MARKER:-<missing>}"

tenzir_test-0.13.0/example-satellite/tests/satellite/marker.txt

@@ -0,0 +1 @@
+satellite fixture: example-satellite

tenzir_test-0.13.0/example-satellite/tests/satellite/test.yaml

@@ -0,0 +1,3 @@
+timeout: 5
+fixtures:
+  - satellite_marker

{tenzir_test-0.12.0 → tenzir_test-0.13.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tenzir-test"
-version = "0.12.0"
+version = "0.13.0"
 description = "Reusable test execution framework extracted from the Tenzir repository."
 readme = "README.md"
 requires-python = ">=3.12"
@@ -48,14 +48,17 @@ packages = ["src/tenzir_test"]
 
 [tool.hatch.build.targets.sdist]
 include = [
-  "/src/**/*",
-  "/tests",
-  "/example-project",
-  "/scripts",
-  "/README.md",
-  "/CHANGELOG.md",
   "/LICENSE",
+  "/README.md",
+  "/changelog",
+  "/example-library",
+  "/example-package",
+  "/example-project",
+  "/example-satellite",
   "/pyproject.toml",
+  "/scripts",
+  "/src/**/*",
+  "/tests",
 ]
 exclude = [
   "*.pyc",

{tenzir_test-0.12.0 → tenzir_test-0.13.0}/src/tenzir_test/cli.py

@@ -51,6 +51,15 @@ def _normalize_exit_code(value: object) -> int:
     type=click.Path(path_type=Path, dir_okay=False, writable=False, resolve_path=False),
     help="Path to the tenzir-node executable.",
 )
+@click.option(
+    "package_dirs",
+    "--package-dirs",
+    multiple=True,
+    help=(
+        "Comma-separated list of package directories to load (repeatable). "
+        "These only control package visibility; test selection still follows the usual --root/args."
+    ),
+)
 @click.argument(
     "tests",
     nargs=-1,
@@ -137,6 +146,7 @@ def cli(
     root: Path | None,
     tenzir_binary: Path | None,
     tenzir_node_binary: Path | None,
+    package_dirs: tuple[str, ...],
     tests: tuple[Path, ...],
     update: bool,
     debug: bool,
@@ -155,6 +165,14 @@ def cli(
 ) -> int:
     """Execute tenzir-test scenarios."""
 
+    package_paths: list[Path] = []
+    for entry in package_dirs:
+        for piece in entry.split(","):
+            piece = piece.strip()
+            if not piece:
+                continue
+            package_paths.append(Path(piece))
+
     jobs_source = ctx.get_parameter_source("jobs")
     jobs_overridden = jobs_source is not click.core.ParameterSource.DEFAULT
 
@@ -163,6 +181,7 @@ def cli(
             root=root,
             tenzir_binary=tenzir_binary,
             tenzir_node_binary=tenzir_node_binary,
+            package_dirs=package_paths,
             tests=list(tests),
             update=update,
             debug=debug,

{tenzir_test-0.12.0 → tenzir_test-0.13.0}/src/tenzir_test/config.py

@@ -41,7 +41,7 @@ def discover_settings(
 ) -> Settings:
     """Produce harness settings by combining CLI overrides with environment defaults."""
 
-    environment = dict(env or os.environ)
+    environment = dict(os.environ if env is None else env)
 
     chosen_root = root or environment.get("TENZIR_TEST_ROOT") or Path.cwd()
     root_path = Path(chosen_root).resolve()