{"id":13665233,"url":"https://github.com/allure-framework/allure-codeception","last_synced_at":"2025-04-04T17:07:31.359Z","repository":{"id":17806202,"uuid":"20694400","full_name":"allure-framework/allure-codeception","owner":"allure-framework","description":"Codeception framework adapter for Allure","archived":false,"fork":false,"pushed_at":"2024-07-09T15:56:20.000Z","size":139,"stargazers_count":51,"open_issues_count":3,"forks_count":44,"subscribers_count":13,"default_branch":"main","last_synced_at":"2024-10-30T00:55:06.587Z","etag":null,"topics":["allure","codeception","reporting"],"latest_commit_sha":null,"homepage":"","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,"publiccode":null,"codemeta":null}},"created_at":"2014-06-10T17:21:11.000Z","updated_at":"2024-06-18T22:15:20.000Z","dependencies_parsed_at":"2024-04-19T05:46:00.526Z","dependency_job_id":"f035f292-032b-42a8-9c36-b7a394523de8","html_url":"https://github.com/allure-framework/allure-codeception","commit_stats":{"total_commits":70,"total_committers":27,"mean_commits":"2.5925925925925926","dds":0.8571428571428572,"last_synced_commit":"854320894b5e65952eb0cafd1555e9efb4543350"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fallure-codeception","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fallure-codeception/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fallure-codeception/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fallure-codeception/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/allure-framework","download_url":"https://codeload.github.com/allure-framework/allure-codeception/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247217183,"owners_count":20903009,"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","codeception","reporting"],"created_at":"2024-08-02T06:00:30.133Z","updated_at":"2025-04-04T17:07:31.336Z","avatar_url":"https://github.com/allure-framework.png","language":"PHP","funding_links":[],"categories":["Programming languages and frameworks"],"sub_categories":["PHP"],"readme":"# Allure Codeception Adapter\n\n[![Latest Stable Version](http://poser.pugx.org/allure-framework/allure-codeception/v)](https://packagist.org/packages/allure-framework/allure-codeception)\n[![Build](https://github.com/allure-framework/allure-codeception/actions/workflows/build.yml/badge.svg)](https://github.com/allure-framework/allure-codeception/actions/workflows/build.yml)\n[![Type Coverage](https://shepherd.dev/github/allure-framework/allure-codeception/coverage.svg)](https://shepherd.dev/github/allure-framework/allure-codeception)\n[![Psalm Level](https://shepherd.dev/github/allure-framework/allure-codeception/level.svg)](https://shepherd.dev/github/allure-framework/allure-codeception)\n[![Total Downloads](http://poser.pugx.org/allure-framework/allure-codeception/downloads)](https://packagist.org/packages/allure-framework/allure-codeception)\n[![License](http://poser.pugx.org/allure-framework/allure-codeception/license)](https://packagist.org/packages/allure-framework/allure-codeception)\n\nThis is an official [Codeception](http://codeception.com) adapter for Allure Framework.\n\n## What is this for?\nThe main purpose of this adapter is to accumulate information about your tests and write it out to a set of XML files: one for each test class. This adapter only generates XML files containing information about tests. See [wiki section](https://github.com/allure-framework/allure-core/wiki#generating-report) on how to generate report.\n\n## Example project\nExample project is located at: https://github.com/allure-examples/allure-codeception-example\n\n## Installation and Usage\nIn order to use this adapter you need to add a new dependency to your **composer.json** file:\n```\n{\n    \"require\": {\n\t    \"php\": \"^8\",\n\t    \"allure-framework/allure-codeception\": \"^2\"\n    }\n}\n```\nTo enable this adapter in Codeception tests simply put it in \"enabled\" extensions section of **codeception.yml**:\n```yaml\nextensions:\n    enabled:\n        - Qameta\\Allure\\Codeception\\AllureCodeception\n    config:\n        Qameta\\Allure\\Codeception\\AllureCodeception:\n            outputDirectory: allure-results\n            linkTemplates:\n                issue: https://example.org/issues/%s\n            setupHook: My\\SetupHook\n```\n\n`outputDirectory` is used to store Allure results and will be calculated\nrelatively to Codeception output directory (also known as `paths: log` in\ncodeception.yml) unless you specify an absolute path. You can traverse up using\n`..` as usual. `outputDirectory` defaults to `allure-results`.\n\n`linkTemplates` is used to process links and generate URLs for them. You can put\nhere an `sprintf()`-like template or a name of class to be constructed; such class\nmust implement `Qameta\\Allure\\Setup\\LinkTemplateInterface`.\n\n`setupHook` allows to execute some bootstrapping code during initialization. You can\nput here a name of the class that implements magic `__invoke()` method - and that method\nwill be called. For example, it can be used to ignore unnecessary docblock annotations:\n\n```php\n\u003c?php\n\nnamespace My;\n\nuse Doctrine\\Common\\Annotations\\AnnotationReader;\n\nclass SetupHook\n{\n    public function __invoke(): void\n    {\n        AnnotationReader::addGlobalIgnoredName('annotationToIgnore');\n    }\n}\n```\n\nTo generate report from your favourite terminal,\n[install](https://github.com/allure-framework/allure-cli#installation)\nallure-cli and run following command (assuming you're in project root and using\ndefault configuration):\n\n```bash\nallure generate -o ./build/allure-report ./build/allure-results\n```\n\nReport will be generated in `build/allure-report`.\n\n## Main features\nSee respective [PHPUnit](https://github.com/allure-framework/allure-phpunit#advanced-features) section.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallure-framework%2Fallure-codeception","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallure-framework%2Fallure-codeception","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallure-framework%2Fallure-codeception/lists"}