allure-codeception-plugin/allure-codeception-plugin

A fork of the Codeception adapater for Allure report.

0.0.1 2021-06-25 00:53 UTC

Requires

• php: >=5.6
• allure-framework/allure-php-api: ~1.2.1
• codeception/codeception: ^2.3|^3.0|^4.0
• symfony/filesystem: >=2.6
• symfony/finder: >=2.6

Apache-2.0

• Madan Kapoor

README

This is an fork of the offical Codeception adapter for Allure Framework present at https://github.com/allure-framework/allure-codeception. The main purpose is to support multiple types of tests like BDD and Cest.

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.

Example project

Example project is located at: https://github.com/allure-examples/allure-codeception-example

Installation and Usage

In order to use this adapter you need to add a new dependency to your composer.json file:

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

To enable this adapter in Codeception tests simply put it in "enabled" extensions section of codeception.yml:

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.

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.

ignoredAnnotations is used to define extra custom annotations to ignore. It is empty by default.

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

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.

Main features

See respective PHPUnit section.