| Name | openapi-qase-suite-generator JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | None |
| Summary | Generate Qase test suites from OpenAPI specs |
| upload_time | 2024-11-29 10:08:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Petra Barus 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 |
qase
openapi
testsuite
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
requests
PyYAML
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# openapi-qase-suite-generator
This script generates a Qase suite from an OpenAPI spec YAML file.
This is useful for keeping the consistency between the API and the test cases. In my company we use Qase for API testing.
For every Operation (Endpoint + Method) we create a new Qase suite. Every suite contains testcases for the given operation,
whether it is Unit Test or API Test, manual or automated.
Consistency naming for the test cases and the Operations is a good practice for maintenance.
For example, the following OpenAPI spec contains 3 operations:
```
paths:
/api/v1/users:
get:
operationId: ApiV1UsersGet
description: Get all available users
post:
operationId: ApiV1UsersPost
description: Create a new user
/api/v1/users/{id}:
get:
operationId: ApiV1UsersIdGet
description: Get a user by ID
```
This script will generate 3 suites:
- Suite: ApiV1UsersGet under directory "api", "v1", "users"
- Suite: ApiV1UsersPost under directory "api", "v1", "users"
- Suite: ApiV1UsersIdGet under directory "api", "v1", "users", "{id}"
The tester can add test cases to the generated suites.
The script will generate a new Qase suite only if it does not exist yet.
Usage:
```
openapi_qase_suite_generator \
--api-definition <path-to-openapi-spec> \
--qase-api-token <qase-api-token> \
--qase-project-id <qase-project-id> \
--qase-root-suite-id <qase-root-suite-id>
```
Where:
- <path-to-openapi-spec> is the path to the OpenAPI spec YAML file
- <qase-api-token> is the Qase API token
- <qase-project-id> is the Qase project ID
- <qase-root-suite-id> is the Qase root suite ID
Raw data
{
"_id": null,
"home_page": null,
"name": "openapi-qase-suite-generator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "qase, openapi, testsuite",
"author": null,
"author_email": "Example Author <author@example.com>",
"download_url": "https://files.pythonhosted.org/packages/14/09/f3d6ad5113d7da0693654d6acb61ed8a48f2196410504185c474a504fd88/openapi_qase_suite_generator-1.0.4.tar.gz",
"platform": null,
"description": "# openapi-qase-suite-generator\n\nThis script generates a Qase suite from an OpenAPI spec YAML file.\nThis is useful for keeping the consistency between the API and the test cases. In my company we use Qase for API testing.\nFor every Operation (Endpoint + Method) we create a new Qase suite. Every suite contains testcases for the given operation,\nwhether it is Unit Test or API Test, manual or automated.\nConsistency naming for the test cases and the Operations is a good practice for maintenance.\n\nFor example, the following OpenAPI spec contains 3 operations:\n```\npaths:\n /api/v1/users:\n get:\n operationId: ApiV1UsersGet\n description: Get all available users\n post:\n operationId: ApiV1UsersPost\n description: Create a new user\n /api/v1/users/{id}:\n get:\n operationId: ApiV1UsersIdGet\n description: Get a user by ID\n```\n\nThis script will generate 3 suites:\n- Suite: ApiV1UsersGet under directory \"api\", \"v1\", \"users\"\n- Suite: ApiV1UsersPost under directory \"api\", \"v1\", \"users\"\n- Suite: ApiV1UsersIdGet under directory \"api\", \"v1\", \"users\", \"{id}\"\n\nThe tester can add test cases to the generated suites.\nThe script will generate a new Qase suite only if it does not exist yet.\n\nUsage:\n```\n openapi_qase_suite_generator \\\n --api-definition <path-to-openapi-spec> \\\n --qase-api-token <qase-api-token> \\\n --qase-project-id <qase-project-id> \\\n --qase-root-suite-id <qase-root-suite-id>\n```\nWhere:\n- <path-to-openapi-spec> is the path to the OpenAPI spec YAML file\n- <qase-api-token> is the Qase API token\n- <qase-project-id> is the Qase project ID\n- <qase-root-suite-id> is the Qase root suite ID\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Petra Barus 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. ",
"summary": "Generate Qase test suites from OpenAPI specs",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/petrabarus/openapi_qase_suite_generator",
"Issues": "https://github.com/petrabarus/openapi_qase_suite_generator/issues"
},
"split_keywords": [
"qase",
" openapi",
" testsuite"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e8614a8251f115eb0b69039a0e4bd357625007c68f462e8b9deaf7788123024",
"md5": "c9b8f3c8da544ad6a604e14c1084ff6f",
"sha256": "56d6f2600234815ff513bf192bd55a58e04fd9be59c6e1b1c1c6ff9678e970a4"
},
"downloads": -1,
"filename": "openapi_qase_suite_generator-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c9b8f3c8da544ad6a604e14c1084ff6f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7991,
"upload_time": "2024-11-29T10:08:35",
"upload_time_iso_8601": "2024-11-29T10:08:35.725155Z",
"url": "https://files.pythonhosted.org/packages/9e/86/14a8251f115eb0b69039a0e4bd357625007c68f462e8b9deaf7788123024/openapi_qase_suite_generator-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1409f3d6ad5113d7da0693654d6acb61ed8a48f2196410504185c474a504fd88",
"md5": "5c6a87a428ede9c7b1ce3d066c63d71f",
"sha256": "eed1122520c8b5f427fd9362befffbc7b0274170dff101a3d7bcaf6ed1229a8e"
},
"downloads": -1,
"filename": "openapi_qase_suite_generator-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "5c6a87a428ede9c7b1ce3d066c63d71f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8665,
"upload_time": "2024-11-29T10:08:37",
"upload_time_iso_8601": "2024-11-29T10:08:37.384597Z",
"url": "https://files.pythonhosted.org/packages/14/09/f3d6ad5113d7da0693654d6acb61ed8a48f2196410504185c474a504fd88/openapi_qase_suite_generator-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-29 10:08:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "petrabarus",
"github_project": "openapi_qase_suite_generator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"==",
"6.0.1"
]
]
}
],
"lcname": "openapi-qase-suite-generator"
}
