# [Qase TestOps](https://qase.io) Tavern Reporter
[](https://www.apache.org/licenses/LICENSE-2.0)
## Installation
To install the latest version, run:
```sh
pip install pre qase-tavern
```
## Getting started
The Tavern reporter can auto-generate test cases
and suites from your test data.
Test results of subsequent test runs will match the same test cases
as long as their names and file paths don't change.
You can also annotate the tests with the IDs of existing test cases
from Qase.io before executing tests. It's a more reliable way to bind
autotests to test cases, that persists when you rename, move, or
parameterize your tests.
For example:
```yaml
---
test_name: QaseID=1 Test with QaseID success
stages:
- name: Step 1
request:
response:
- name: Step 2
request:
response:
```
To execute Tavern tests and report them to Qase.io, run the command:
```bash
pytest
```
You can try it with the example project at [`examples/tavern`](../examples/tavern/).
## Configuration
Qase Tavern Reporter is configured in multiple ways:
- using a config file `qase.config.json`
- using environment variables
- using command line options
Environment variables override the values given in the config file,
and command line options override both other values.
Configuration options are described in the
[configuration reference](docs/CONFIGURATION.md).
### Example: qase.config.json
```json
{
"mode": "testops",
"fallback": "report",
"testops": {
"project": "YOUR_PROJECT_CODE",
"api": {
"token": "YOUR_API_TOKEN",
"host": "qase.io"
},
"run": {
"title": "Test run title"
},
"batch": {
"size": 100
}
},
"report": {
"driver": "local",
"connection": {
"local": {
"path": "./build/qase-report",
"format": "json"
}
}
},
"environment": "local"
}
```
## Requirements
We maintain the reporter on [LTS versions of Python](https://devguide.python.org/versions/).
`python >= 3.7`
`tavern >= 2.11.0`
<!-- references -->
[auth]: https://developers.qase.io/#authentication
Raw data
{
"_id": null,
"home_page": null,
"name": "qase-tavern",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "qase, tavern, plugin, testops, report, qase reporting, test observability",
"author": null,
"author_email": "Qase Team <support@qase.io>",
"download_url": "https://files.pythonhosted.org/packages/7a/0c/acc1234054caf8c62f68f0132f79de168e0b9f1f0c90c4842f8a5e03bcee/qase_tavern-1.0.0.tar.gz",
"platform": null,
"description": "# [Qase TestOps](https://qase.io) Tavern Reporter\n\n[](https://www.apache.org/licenses/LICENSE-2.0)\n\n## Installation\n\nTo install the latest version, run:\n\n```sh\npip install pre qase-tavern\n```\n\n## Getting started\n\nThe Tavern reporter can auto-generate test cases\nand suites from your test data.\nTest results of subsequent test runs will match the same test cases\nas long as their names and file paths don't change.\n\nYou can also annotate the tests with the IDs of existing test cases\nfrom Qase.io before executing tests. It's a more reliable way to bind\nautotests to test cases, that persists when you rename, move, or\nparameterize your tests.\n\nFor example:\n\n```yaml\n---\ntest_name: QaseID=1 Test with QaseID success\n\nstages:\n - name: Step 1\n request:\n response:\n\n - name: Step 2\n request:\n response:\n```\n\nTo execute Tavern tests and report them to Qase.io, run the command:\n\n```bash\npytest\n```\n\nYou can try it with the example project at [`examples/tavern`](../examples/tavern/).\n\n## Configuration\n\nQase Tavern Reporter is configured in multiple ways:\n\n- using a config file `qase.config.json`\n- using environment variables\n- using command line options\n\nEnvironment variables override the values given in the config file,\nand command line options override both other values.\n\nConfiguration options are described in the\n[configuration reference](docs/CONFIGURATION.md).\n\n### Example: qase.config.json\n\n```json\n{\n \"mode\": \"testops\",\n \"fallback\": \"report\",\n \"testops\": {\n \"project\": \"YOUR_PROJECT_CODE\",\n \"api\": {\n \"token\": \"YOUR_API_TOKEN\",\n \"host\": \"qase.io\"\n },\n \"run\": {\n \"title\": \"Test run title\"\n },\n \"batch\": {\n \"size\": 100\n }\n },\n \"report\": {\n \"driver\": \"local\",\n \"connection\": {\n \"local\": {\n \"path\": \"./build/qase-report\",\n \"format\": \"json\"\n }\n }\n },\n \"environment\": \"local\"\n}\n```\n\n## Requirements\n\nWe maintain the reporter on [LTS versions of Python](https://devguide.python.org/versions/).\n\n`python >= 3.7`\n`tavern >= 2.11.0`\n\n<!-- references -->\n\n[auth]: https://developers.qase.io/#authentication\n",
"bugtrack_url": null,
"license": null,
"summary": "Qase Tavern Plugin for Qase TestOps and Qase Report",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://developers.qase.io",
"Homepage": "https://qase.io",
"Repository": "https://github.com/qase-tms/qase-python/tree/master/qase-tavern"
},
"split_keywords": [
"qase",
" tavern",
" plugin",
" testops",
" report",
" qase reporting",
" test observability"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d2a085168df370c3de76155b04f3f541825baf892752290b286f90cddd397d48",
"md5": "2e02b3da5b672acd081568a474e01b67",
"sha256": "985d2437a5d285b153a55c2b376e8498bd63b07b21b91b76b2f0f81a9f808eb0"
},
"downloads": -1,
"filename": "qase_tavern-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2e02b3da5b672acd081568a474e01b67",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 11533,
"upload_time": "2024-12-05T15:54:02",
"upload_time_iso_8601": "2024-12-05T15:54:02.365987Z",
"url": "https://files.pythonhosted.org/packages/d2/a0/85168df370c3de76155b04f3f541825baf892752290b286f90cddd397d48/qase_tavern-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7a0cacc1234054caf8c62f68f0132f79de168e0b9f1f0c90c4842f8a5e03bcee",
"md5": "45b65adbb02e284cefab2f0ceb24582c",
"sha256": "a3231e369fa66840441b930220867a9d504e725bd74722e38977ed7aea44ca38"
},
"downloads": -1,
"filename": "qase_tavern-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "45b65adbb02e284cefab2f0ceb24582c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12945,
"upload_time": "2024-12-05T15:54:04",
"upload_time_iso_8601": "2024-12-05T15:54:04.404252Z",
"url": "https://files.pythonhosted.org/packages/7a/0c/acc1234054caf8c62f68f0132f79de168e0b9f1f0c90c4842f8a5e03bcee/qase_tavern-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-05 15:54:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qase-tms",
"github_project": "qase-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "qase-tavern"
}
JSON
