aware-test-runner

Name	aware-test-runner JSON
Version	0.1.2 JSON
	download
home_page	None
Summary	Unified test runner for the Aware platform with OSS-ready packaging.
upload_time	2025-10-31 06:04:10
maintainer	None
docs_url	None
author	Aware OSS Team
requires_python	>=3.10
license	MIT License Copyright (c) 2025 Aware Network 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.
keywords	automation aware ci manifests testing
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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

```bash
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:

```bash
aware-tests --manifest oss --stable
```

Discover available suites:

```bash
aware-tests --list
```

Execute a focused set and forward options to pytest:

```bash
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:

```yaml
- 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_tests` still works but emits a notice
  pointing to `aware_test_runner`.

Bug reports and suggestions are welcome via issues in `aware-network/aware`.

## License

Distributed under the MIT License. See `LICENSE` for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "aware-test-runner",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "automation, aware, ci, manifests, testing",
    "author": "Aware OSS Team",
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "# aware-test-runner\n\n`aware-test-runner` packages the manifest-driven test orchestration we use across the\nAware platform. It exposes a tiny CLI (`aware-tests`) that mirrors our CI layout so\ncontributors can run the same curated suites locally or inside automation.\n\nThe project ships with an **OSS manifest** that exercises the open-source surface.\nInternal manifests live alongside the package and can be layered on top when the\nmonorepo is present.\n\n## Key capabilities\n\n- Declarative manifests (`stable.json`, `runtime.json`) that describe suites,\n  marks, and pytest flags.\n- CLI helpers to list suites, execute a subset, or hand over execution to pytest.\n- Environment variable overrides so CI can provide a different manifest directory\n  without modifying the command line.\n- Ready-to-extend extras (e.g. `internal`, `flutter`) for optional dependencies.\n\n## Installation\n\n```bash\npip install aware-test-runner\n```\n\nRequires Python 3.10+. The package works with both `pip` and `uv`. Extras will land\nonce the internal split for our larger matrix is stabilised.\n\n## Quick start\n\nRun the OSS stable suites:\n\n```bash\naware-tests --manifest oss --stable\n```\n\nDiscover available suites:\n\n```bash\naware-tests --list\n```\n\nExecute a focused set and forward options to pytest:\n\n```bash\naware-tests --suites kernel -- -k \"smoke and not slow\" --maxfail=1\n```\n\n## Manifest selection\n\nManifests can be controlled through identifiers, paths, or environment variables.\n\n| Mechanism | Example |\n| --- | --- |\n| Named manifest | `aware-tests --manifest internal` |\n| Manifest file | `aware-tests --manifest-file configs/manifests/internal/stable.json` |\n| Directory search path | `AWARE_TEST_RUNNER_MANIFEST_DIRS=/tmp/manifests:$PWD/configs` |\n| Explicit identifier (env) | `AWARE_TEST_RUNNER_MANIFEST=runtime` |\n| Override file (env) | `AWARE_TEST_RUNNER_MANIFEST_FILE=/tmp/runtime.json` |\n\nEach manifest can inherit from another via an `extends` field, allowing the internal\nconfiguration to re-use the OSS baseline.\n\n## CI usage\n\nAdd a job that configures the manifest directory and runs the stable matrix:\n\n```yaml\n- name: Run OSS suites\n  run: |\n    export AWARE_TEST_RUNNER_MANIFEST_DIRS=$GITHUB_WORKSPACE/tools/test-runner/configs/manifests\n    aware-tests --manifest oss --stable --no-warnings\n```\n\nFor larger installations we recommend pinning the manifest alongside the workspace\nso agents and humans see the exact same suite definitions.\n\n## Roadmap\n\n- Publish optional extras for internal-only dependencies.\n- Ship pre-built manifest bundles targeting different providers (CI, Studio, SDK).\n- Expose a Python API for embedding manifests inside other orchestration layers.\n\n## Support\n\n- OSS quickstart: this README.\n- Release automation: tracked under\n  `docs/projects/aware-developer-tools/tasks/aware-test-runner-tooling/`.\n- Legacy compatibility: importing `aware_tests` still works but emits a notice\n  pointing to `aware_test_runner`.\n\nBug reports and suggestions are welcome via issues in `aware-network/aware`.\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for details.\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 Aware Network\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.",
    "summary": "Unified test runner for the Aware platform with OSS-ready packaging.",
    "version": "0.1.2",
    "project_urls": {
        "Changelog": "https://github.com/aware-network/aware-sdk/tree/main/tools/test-runner/CHANGELOG.md",
        "Documentation": "https://github.com/aware-network/aware-sdk/tree/main/tools/test-runner/README.md",
        "Homepage": "https://pypi.org/project/aware-test-runner/",
        "Issues": "https://github.com/aware-network/aware-sdk/issues",
        "Source": "https://github.com/aware-network/aware-sdk"
    },
    "split_keywords": [
        "automation",
        " aware",
        " ci",
        " manifests",
        " testing"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "fc96c6c77c2ff7225aa2c927d3e045f2dfee33c3b6d05775a1e9443ea37d45b6",
                "md5": "3ced1e0f36e05fce8324463bd92846f5",
                "sha256": "fc10827743b7e127a178465915d65b13cbd233a7775dae932a87975533461405"
            },
            "downloads": -1,
            "filename": "aware_test_runner-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3ced1e0f36e05fce8324463bd92846f5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 26379,
            "upload_time": "2025-10-31T06:04:10",
            "upload_time_iso_8601": "2025-10-31T06:04:10.716601Z",
            "url": "https://files.pythonhosted.org/packages/fc/96/c6c77c2ff7225aa2c927d3e045f2dfee33c3b6d05775a1e9443ea37d45b6/aware_test_runner-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-31 06:04:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "aware-network",
    "github_project": "aware-sdk",
    "github_not_found": true,
    "lcname": "aware-test-runner"
}