Unified test runner for the Aware platform with OSS-ready packaging.
Project description
aware-test-runner
aware-test-runner packages the manifest-driven test orchestration we use across the
Aware platform. It exposes a tiny CLI (aware-tests) that mirrors our CI layout so
contributors can run the same curated suites locally or inside automation.
The project ships with an OSS manifest that exercises the open-source surface. Internal manifests live alongside the package and can be layered on top when the monorepo is present.
Key capabilities
- Declarative manifests (
stable.json,runtime.json) that describe suites, marks, and pytest flags. - CLI helpers to list suites, execute a subset, or hand over execution to pytest.
- Environment variable overrides so CI can provide a different manifest directory without modifying the command line.
- Ready-to-extend extras (e.g.
internal,flutter) for optional dependencies.
Installation
pip install aware-test-runner
Requires Python 3.10+. The package works with both pip and uv. Extras will land
once the internal split for our larger matrix is stabilised.
Quick start
Run the OSS stable suites:
aware-tests --manifest oss --stable
Discover available suites:
aware-tests --list
Execute a focused set and forward options to pytest:
aware-tests --suites kernel -- -k "smoke and not slow" --maxfail=1
Manifest selection
Manifests can be controlled through identifiers, paths, or environment variables.
| Mechanism | Example |
|---|---|
| Named manifest | aware-tests --manifest internal |
| Manifest file | aware-tests --manifest-file configs/manifests/internal/stable.json |
| Directory search path | AWARE_TEST_RUNNER_MANIFEST_DIRS=/tmp/manifests:$PWD/configs |
| Explicit identifier (env) | AWARE_TEST_RUNNER_MANIFEST=runtime |
| Override file (env) | AWARE_TEST_RUNNER_MANIFEST_FILE=/tmp/runtime.json |
Each manifest can inherit from another via an extends field, allowing the internal
configuration to re-use the OSS baseline.
CI usage
Add a job that configures the manifest directory and runs the stable matrix:
- name: Run OSS suites
run: |
export AWARE_TEST_RUNNER_MANIFEST_DIRS=$GITHUB_WORKSPACE/tools/test-runner/configs/manifests
aware-tests --manifest oss --stable --no-warnings
For larger installations we recommend pinning the manifest alongside the workspace so agents and humans see the exact same suite definitions.
Roadmap
- Publish optional extras for internal-only dependencies.
- Ship pre-built manifest bundles targeting different providers (CI, Studio, SDK).
- Expose a Python API for embedding manifests inside other orchestration layers.
Support
- OSS quickstart: this README.
- Release automation: tracked under
docs/projects/aware-developer-tools/tasks/aware-test-runner-tooling/. - Legacy compatibility: importing
aware_testsstill works but emits a notice pointing toaware_test_runner.
Bug reports and suggestions are welcome via issues in aware-network/aware.
License
Distributed under the MIT License. See LICENSE for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aware_test_runner-0.1.4-py3-none-any.whl.
File metadata
- Download URL: aware_test_runner-0.1.4-py3-none-any.whl
- Upload date:
- Size: 26.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ace0ce2d69e85a49c26d6b8f71cbc55a336949797e553425ffd76b70f73f8a21
|
|
| MD5 |
ee2c84c2641b6924f9ae9fe1e5070b95
|
|
| BLAKE2b-256 |
256a4a31105f92a2dea3eb0f9426a5f0d63a60223c05bc9a29cf29ff0100ed9a
|
Provenance
The following attestation bundles were made for aware_test_runner-0.1.4-py3-none-any.whl:
Publisher:
publish-aware-test-runner.yml on aware-network/aware
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aware_test_runner-0.1.4-py3-none-any.whl -
Subject digest:
ace0ce2d69e85a49c26d6b8f71cbc55a336949797e553425ffd76b70f73f8a21 - Sigstore transparency entry: 665138689
- Sigstore integration time:
-
Permalink:
aware-network/aware@b9e198b88f14f77d067b4a440a2d7e7aa97d0d05 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/aware-network
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-aware-test-runner.yml@b9e198b88f14f77d067b4a440a2d7e7aa97d0d05 -
Trigger Event:
workflow_dispatch
-
Statement type: