## Allure Python Testing Utilities
[](https://pypi.python.org/pypi/allure-python-commons-test)
[](https://pypi.python.org/pypi/allure-python-commons-test)
> The package contains pyhamcrest matchers to assert the Allure results. They
> come in handy when you need to test an Allure adapter.
[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")
- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org)
- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates
- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action
---
## The matchers library
Here is the list of available matchers. Refer to [https://github.com/allure-framework/allure-python/tree/master/tests](https://github.com/allure-framework/allure-python/tree/master/tests) for usage examples.
|Module|Matcher|Check|
|------|-------|-----|
|container|`has_container`|The report contains a container that matches all the provided matchers.|
|container|`has_same_container`|The report contains a container that has all the specified tests as its children|
|container|`has_before`|The container has a before fixture with the specified name that matches all the provided matchers|
|container|`has_after`|The container has an after fixture with the specified name that matches all the provided matchers|
|content|`csv_equivalent`|The string (typically, an attachment's content) contains a CSV document that is equvalent to the provided one|
|label|`has_label`|The test contains a label with the specified name and (optionaly) the value|
|label|`has_severity`|The test has the specified severity label|
|label|`has_epic`|The test has the specified epic label|
|label|`has_feature`|The test has the specified feature label|
|label|`has_story`|The test has the specified story label|
|label|`has_tag`|The test has the specified tag label|
|label|`has_package`|The test has the specified package label|
|label|`has_suite`|The test has the specified suite label|
|label|`has_parent_suite`|The test has the specified parentSuite label|
|label|`has_sub_suite`|The test has the specified subSuite label|
|report|`has_test_case`|The report contains a test whose fullName ends, or name starts with the specified name. Additionally, the test must match all the provided matchers|
|report|`has_only_testcases`|Each test of the report matches at least one of the provided matchers|
|report|`has_only_n_test_cases`|Same as `has_test_case` but also checks if the number of matched tests is equal to the expected one|
|result|`has_title`|The test has an expected name|
|result|`has_description`|The test has a description that matches all the provided matchers|
|result|`has_description_html`|The test has a descriptionHtml that matches all the provided matchers|
|result|`has_step`|The test or step has a step with the specified name that matches all the provided matchers|
|result|`has_parameter`|The test or step has a parameter with the specified name whose value matches the provided matchers|
|result|`doesnt_have_parameter`|The test or step doesn't have a parameter with the specified name|
|result|`has_link`|The test has a link with the expected url, type (if provided) and name (if provided)|
|result|`has_issue_link`|The test has an issue link with the expected url and name (if provided)|
|result|`has_test_case_link`|The test has an issue link with the expected url and name (if provided)|
|result|`has_attachment`|The test or step has an attachment with the expected name and type.|
|result|`has_attachment_with_content`|The test or step has an attachment with the expected name and type. In addition, the content must match the provided matcher.|
|result|`with_id`|The test or container has the expected uuid|
|result|`with_status`|The test or step has the expected status|
|result|`has_status_details`|The status details of the test or step matches all the provided matchers|
|result|`with_message_contains`|The status details' message contains the provided text|
|result|`with_trace_contains`|The status details' trace contains the provided text|
|result|`with_excluded`|The parameter is excluded from the historyId calculation|
|result|`with_mode`|The parameter has the specified mode|
|result|`has_history_id`|The test has historyId|
Raw data
{
"_id": null,
"home_page": "https://allurereport.org/",
"name": "allure-python-commons-test",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "allure reporting testing matchers",
"author": "Qameta Software Inc., Stanislav Seliverstov",
"author_email": "sseliverstov@qameta.io",
"download_url": "https://files.pythonhosted.org/packages/f6/3f/0eb43a4a88ce4683ca2d451d00887d8f780f39ac915fcd18562f057e9ab0/allure-python-commons-test-2.13.5.tar.gz",
"platform": null,
"description": "## Allure Python Testing Utilities\n\n[](https://pypi.python.org/pypi/allure-python-commons-test)\n[](https://pypi.python.org/pypi/allure-python-commons-test)\n\n> The package contains pyhamcrest matchers to assert the Allure results. They\n> come in handy when you need to test an Allure adapter.\n\n[<img src=\"https://allurereport.org/public/img/allure-report.svg\" height=\"85px\" alt=\"Allure Report logo\" align=\"right\" />](https://allurereport.org \"Allure Report\")\n\n- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org)\n- \ud83d\udcda [Documentation](https://allurereport.org/docs/) \u2013 discover official documentation for Allure Report\n- \u2753 [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) \u2013 get help from the team and community\n- \ud83d\udce2 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) \u2013 stay updated with our latest news and updates\n- \ud83d\udcac [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) \u2013 engage in casual conversations, share insights and ideas with the community\n- \ud83d\udda5\ufe0f [Live Demo](https://demo.allurereport.org/) \u2014 explore a live example of Allure Report in action\n\n---\n\n## The matchers library\n\nHere is the list of available matchers. Refer to [https://github.com/allure-framework/allure-python/tree/master/tests](https://github.com/allure-framework/allure-python/tree/master/tests) for usage examples.\n\n|Module|Matcher|Check|\n|------|-------|-----|\n|container|`has_container`|The report contains a container that matches all the provided matchers.|\n|container|`has_same_container`|The report contains a container that has all the specified tests as its children|\n|container|`has_before`|The container has a before fixture with the specified name that matches all the provided matchers|\n|container|`has_after`|The container has an after fixture with the specified name that matches all the provided matchers|\n|content|`csv_equivalent`|The string (typically, an attachment's content) contains a CSV document that is equvalent to the provided one|\n|label|`has_label`|The test contains a label with the specified name and (optionaly) the value|\n|label|`has_severity`|The test has the specified severity label|\n|label|`has_epic`|The test has the specified epic label|\n|label|`has_feature`|The test has the specified feature label|\n|label|`has_story`|The test has the specified story label|\n|label|`has_tag`|The test has the specified tag label|\n|label|`has_package`|The test has the specified package label|\n|label|`has_suite`|The test has the specified suite label|\n|label|`has_parent_suite`|The test has the specified parentSuite label|\n|label|`has_sub_suite`|The test has the specified subSuite label|\n|report|`has_test_case`|The report contains a test whose fullName ends, or name starts with the specified name. Additionally, the test must match all the provided matchers|\n|report|`has_only_testcases`|Each test of the report matches at least one of the provided matchers|\n|report|`has_only_n_test_cases`|Same as `has_test_case` but also checks if the number of matched tests is equal to the expected one|\n|result|`has_title`|The test has an expected name|\n|result|`has_description`|The test has a description that matches all the provided matchers|\n|result|`has_description_html`|The test has a descriptionHtml that matches all the provided matchers|\n|result|`has_step`|The test or step has a step with the specified name that matches all the provided matchers|\n|result|`has_parameter`|The test or step has a parameter with the specified name whose value matches the provided matchers|\n|result|`doesnt_have_parameter`|The test or step doesn't have a parameter with the specified name|\n|result|`has_link`|The test has a link with the expected url, type (if provided) and name (if provided)|\n|result|`has_issue_link`|The test has an issue link with the expected url and name (if provided)|\n|result|`has_test_case_link`|The test has an issue link with the expected url and name (if provided)|\n|result|`has_attachment`|The test or step has an attachment with the expected name and type.|\n|result|`has_attachment_with_content`|The test or step has an attachment with the expected name and type. In addition, the content must match the provided matcher.|\n|result|`with_id`|The test or container has the expected uuid|\n|result|`with_status`|The test or step has the expected status|\n|result|`has_status_details`|The status details of the test or step matches all the provided matchers|\n|result|`with_message_contains`|The status details' message contains the provided text|\n|result|`with_trace_contains`|The status details' trace contains the provided text|\n|result|`with_excluded`|The parameter is excluded from the historyId calculation|\n|result|`with_mode`|The parameter has the specified mode|\n|result|`has_history_id`|The test has historyId|\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A collection of PyHamcrest matchers to test Allure adapters for Python test frameworks",
"version": "2.13.5",
"project_urls": {
"Homepage": "https://allurereport.org/",
"Source": "https://github.com/allure-framework/allure-python"
},
"split_keywords": [
"allure",
"reporting",
"testing",
"matchers"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d83e63f6f28fd65b7588ab8106244629f1ec957629e4bef6015d69b64220110d",
"md5": "958c4ac1b9dd004a3beb80e82f7bcf23",
"sha256": "dbfdf27749520de30f556668768626f77747418aca1bc44b2dc96dac1ff849e1"
},
"downloads": -1,
"filename": "allure_python_commons_test-2.13.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "958c4ac1b9dd004a3beb80e82f7bcf23",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8258,
"upload_time": "2024-04-01T16:50:56",
"upload_time_iso_8601": "2024-04-01T16:50:56.647280Z",
"url": "https://files.pythonhosted.org/packages/d8/3e/63f6f28fd65b7588ab8106244629f1ec957629e4bef6015d69b64220110d/allure_python_commons_test-2.13.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f63f0eb43a4a88ce4683ca2d451d00887d8f780f39ac915fcd18562f057e9ab0",
"md5": "122291ec6027a033d9d37d26694a039a",
"sha256": "a5690b55f06b2c485d86e4c4f792b76aaae1118db0132a39b91cee242de78231"
},
"downloads": -1,
"filename": "allure-python-commons-test-2.13.5.tar.gz",
"has_sig": false,
"md5_digest": "122291ec6027a033d9d37d26694a039a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6731,
"upload_time": "2024-04-01T16:50:58",
"upload_time_iso_8601": "2024-04-01T16:50:58.417343Z",
"url": "https://files.pythonhosted.org/packages/f6/3f/0eb43a4a88ce4683ca2d451d00887d8f780f39ac915fcd18562f057e9ab0/allure-python-commons-test-2.13.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 16:50:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "allure-framework",
"github_project": "allure-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "allure-python-commons-test"
}
JSON
