{"id":19041869,"url":"https://github.com/allure-framework/allure-behat","last_synced_at":"2025-04-15T03:54:02.182Z","repository":{"id":13996506,"uuid":"75605821","full_name":"allure-framework/allure-behat","owner":"allure-framework","description":"Allure Adapter for Behat framework","archived":false,"fork":false,"pushed_at":"2024-03-22T11:23:41.000Z","size":50,"stargazers_count":13,"open_issues_count":9,"forks_count":24,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-11T14:30:16.504Z","etag":null,"topics":["allure","behat","reporting"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/allure-framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2016-12-05T08:47:35.000Z","updated_at":"2024-06-18T22:12:12.000Z","dependencies_parsed_at":"2023-12-15T20:07:58.237Z","dependency_job_id":"4038eae2-c8a3-466c-baa7-07237f11c659","html_url":"https://github.com/allure-framework/allure-behat","commit_stats":{"total_commits":35,"total_committers":6,"mean_commits":5.833333333333333,"dds":0.5428571428571429,"last_synced_commit":"ed087e336a88910fa56d5cece6283fd69ba6b530"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fallure-behat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fallure-behat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fallure-behat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fallure-behat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/allure-framework","download_url":"https://codeload.github.com/allure-framework/allure-behat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248758433,"owners_count":21156957,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["allure","behat","reporting"],"created_at":"2024-11-08T22:32:58.388Z","updated_at":"2025-04-15T03:54:02.163Z","avatar_url":"https://github.com/allure-framework.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Allure Behat Adapter\n\nThis is a [Behat](http://behat.org/en/latest/) extension with Formatter that produces report data for [Allure Report](https://allurereport.org/) test\nreporting tool.\n\n## Installation\n\nTo install using [Composer](https://getcomposer.org/) simply add `\"allure-framework/allure-behat\"` to `composer.json`:\n\n    ...\n    \"require\": {\n    ...\n        \"allure-framework/allure-behat\": \"~2.0.0\",\n    ...\n    },\n    ...\n\n## Usage\n\nTo enable this extension in [Behat](http://behat.org/en/latest/), add it to `extensions` section of your ```behat.yml``` file\nTo use Allure formatter, add `allure` to your list of formatters in `name`\n\n```yml\n  formatters:\n    pretty: true\n    allure:\n      output_path: %paths.base%/build/allure\n  extensions:\n    Allure\\Behat\\AllureFormatterExtension:\n      severity_key: \"severity:\"\n      ignored_tags: \"tag_ignore\"\n      issue_tag_prefix: \"JIRA:\"\n      test_id_tag_prefix: \"BUG:\"\n```\n\nHere:\n - `output_path` - defines the output dir for report XML data. Default is `./allure-results`\n - `ignored_tags` - either a comma separated string or valid yaml array of Scenario tags to be ignored in reports\n - `severity_key` - tag with this prefix will be interpreted (if possible) to define the Scenario severity level\n in reports (by default it's `normal`).\n - `issue_tag_prefix` - tag with this prefix will be interpreted as Issue marker and will generate issue tracking system\n link for test case\n - `test_id_tag_prefix` - tag with this prefix will be interpreted as Test Case Id marker and will generate TMS link for\n test case\n\n\n### Use attachment support\nTo have attachments in allure report - make sure your behat runs tests with [Mink](https://github.com/minkphp/Mink)\n\nAllure can handle exception thrown in your Context if that exception is instance of `ArtifactExceptionInterface`\nand get screenshots path from it.\n\n\n### How does it work?\n\nBehat has the following test structure:\n```\nIt has Features described in separate feature files\n        Each Feature contains Scenarios\n            Each scenario contains Steps\n```\n\nAllure has a bit different hierarchy:\n\n```\n    Each report contains Test Suites\n        A Test Suite contains Test Cases\n            Every Test Case can contain one or more Steps\n```\nOn the other hand, Allure also supports grouping Test Cases by Feature, by Story or by Severity level.\n\nBehat Allure formatter does the following mapping:\n\n* Behat Test Run -\u003e Allure Test Suite\n* Gherkin Scenario (and every single Example in Scenario Outline, too) -\u003e Allure Test Case\n* Gherkin Step -\u003e Allure Test Step\n\nBehat Scenarios are annotated with it's feature title and description to be grouped into Allure Feature.\n\nBehat also has tags and they are also can be used in Allure reports:\n\n* If a tag appears in ignored_tags configuration parameter, then it will be ignored and will not appear on Allure report\n* If a tag starts with severity_tag_prefix, then formatter will try to interpret it's affixed part as one of the possible\n[Allure Severity Levels](https://github.com/allure-framework/allure-php-adapter-api/blob/master/src/Yandex/Allure/Adapter/Model/SeverityLevel.php)\n* If a tag starts with test_id_tag_prefix, then formatter will interpret it's affixed part as\nTest Case Id for your TMS\n* In all other cases tag will be parsed as Allure Story annotation\n\n### Contribution?\nFeel free to open PR with changes but before pls make sure you pass tests\n`./vendor/behat/behat/bin/behat`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallure-framework%2Fallure-behat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallure-framework%2Fallure-behat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallure-framework%2Fallure-behat/lists"}