PHPackages                             magento/magento-allure-phpunit - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Testing & Quality](/categories/testing)
4. /
5. magento/magento-allure-phpunit

ActiveLibrary[Testing & Quality](/categories/testing)

magento/magento-allure-phpunit
==============================

Allure PHPUnit integration

3.0.2(1y ago)0312.0k—5.7%2[1 PRs](https://github.com/magento/magento-allure-phpunit/pulls)Apache-2.0PHPPHP ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0

Since Feb 26Pushed 1y ago1 watchersCompare

[ Source](https://github.com/magento/magento-allure-phpunit)[ Packagist](https://packagist.org/packages/magento/magento-allure-phpunit)[ Docs](https://allurereport.org/)[ RSS](/packages/magento-magento-allure-phpunit/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (6)Versions (2)Used By (0)

Allure PHPUnit adapter
======================

[](#allure-phpunit-adapter)

[![Latest Stable Version](https://camo.githubusercontent.com/00a092593f081512b1643e30a3969053e75438c25fe8eece4cf59d4664186dc5/687474703a2f2f706f7365722e707567782e6f72672f616c6c7572652d6672616d65776f726b2f616c6c7572652d706870756e69742f76)](https://packagist.org/packages/allure-framework/allure-phpunit)[![Build](https://github.com/allure-framework/allure-phpunit/actions/workflows/build.yml/badge.svg)](https://github.com/allure-framework/allure-phpunit/actions/workflows/build.yml)[![Type Coverage](https://camo.githubusercontent.com/e481630af151601c33302a81870681187c9de2c1d46b46a03630301ebab60224/68747470733a2f2f73686570686572642e6465762f6769746875622f616c6c7572652d6672616d65776f726b2f616c6c7572652d706870756e69742f636f7665726167652e737667)](https://shepherd.dev/github/allure-framework/allure-phpunit)[![Psalm Level](https://camo.githubusercontent.com/d7cd54b6fca46e07f0c701c31e27a995b02ef1bc1ee8b9279fa56fce61ab0645/68747470733a2f2f73686570686572642e6465762f6769746875622f616c6c7572652d6672616d65776f726b2f616c6c7572652d706870756e69742f6c6576656c2e737667)](https://shepherd.dev/github/allure-framework/allure-phpunit)[![Total Downloads](https://camo.githubusercontent.com/ea6601a273dfc02518d53a3873188d333c919be66bb75885cb5e539887bb1e06/687474703a2f2f706f7365722e707567782e6f72672f616c6c7572652d6672616d65776f726b2f616c6c7572652d706870756e69742f646f776e6c6f616473)](https://packagist.org/packages/allure-framework/allure-phpunit)[![License](https://camo.githubusercontent.com/a4bb5d95e15df10c1e03987a82309bea192d059e2567013ba4d4f3e4d93032c0/687474703a2f2f706f7365722e707567782e6f72672f616c6c7572652d6672616d65776f726b2f616c6c7572652d706870756e69742f6c6963656e7365)](https://packagist.org/packages/allure-framework/allure-phpunit)

This an official PHPUnit adapter for Allure Framework - a flexible, lightweight and multi-language framework for writing self-documenting tests.

Table of Contents
-----------------

[](#table-of-contents)

- [What is this for?](#what-is-this-for)
- [Example Project](#example-project)
- [How to Generate Report](#how-to-generate-report)
- [Installation and Usage](#installation-and-usage)
- [Main Features](#main-features)
    - [Title](#human-readable-test-class-or-test-method-title)
    - [Description](#extended-test-class-or-test-method-description)
    - [Test severity](#set-test-severity)
    - [Test parameters](#specify-test-parameters-information)
    - [Features and Stories](#map-test-classes-and-test-methods-to-features-and-stories)
    - [Attachments](#attach-files-to-report)
    - [Steps](#divide-test-methods-into-steps)

What is this for?
-----------------

[](#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 JSON files: one for each test class. Then you can use a standalone command line tool or a plugin for popular continuous integration systems to generate an HTML page showing your tests in a good form.

Examples
--------

[](#examples)

Please take a look at [these example tests](./test/report/Generate).

How to generate report
----------------------

[](#how-to-generate-report)

This adapter only generates JSON files containing information about tests. See [wiki section](https://docs.qameta.io/allure/#_reporting) on how to generate report.

Installation && Usage
-----------------------------

[](#installation--usage)

**Note:** this adapter supports Allure 2.x.x only.

Supported PHP versions: 8.1-8.3.

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

```
{
    "require": {
	    "php": "^8.1",
	    "allure-framework/allure-phpunit": "^3"
    }
}

```

Then add Allure test listener in **phpunit.xml** file:

```

```

Config is common PHP file that should return an array:

```