allure-framework/allure-codeception

A Codeception adapter for Allure report.

Allure Codeception Adapter

, _(*1)

This is an official Codeception adapter for Allure Framework., _(*2)

What is this for?

The 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 on how to generate report., _(*3)

Example project

Example project is located at: https://github.com/allure-examples/allure-codeception-example, _(*4)

Installation and Usage

In order to use this adapter you need to add a new dependency to your composer.json file:, _(*5)

{
    "require": {
        "php": ">=5.4.0",
        "allure-framework/allure-codeception": ">=1.1.0"
    }
}

To enable this adapter in Codeception tests simply put it in "enabled" extensions section of codeception.yml:, _(*6)

extensions:
    enabled:
        - Yandex\Allure\Codeception\AllureCodeception
    config:
        Yandex\Allure\Codeception\AllureCodeception:
            deletePreviousResults: false
            outputDirectory: allure-results
            ignoredAnnotations:
                - env
                - dataprovider

deletePreviousResults will clear all .xml files from output directory (this behavior may change to complete cleanup later). It is set to false by default., _(*7)

outputDirectory is used to store Allure results and will be calculated relatively to Codeception output directory (also known as paths: log in codeception.yml) unless you specify an absolute path. You can traverse up using .. as usual. outputDirectory defaults to allure-results., _(*8)

ignoredAnnotations is used to define extra custom annotations to ignore. It is empty by default., _(*9)

To generate report from your favourite terminal, install allure-cli and run following command (assuming you're in project root and using default configuration):, _(*10)

allure generate --report-version 1.4.5 --report-path tests/_output/allure-report -- tests/_output/allure-results

Report will be generated in tests/_output/allure-report., _(*11)

Main features

See respective PHPUnit section., _(*12)