allure-framework/allure-php-api

Allure PHP commons

1.5.0 2024-01-08 17:40 UTC

Requires

• php: >=7.1.3
• doctrine/annotations: 1.*
• jms/serializer: ^1 | ^2 | ^3
• ramsey/uuid: ^3 | ^4
• symfony/mime: ^4.3 | ^5

Requires (Dev)

• phpunit/phpunit: ^7 | ^8 | ^9

Apache-2.0

• Ivan Krutov

• php
• api
• report
• allure

README

This project is in Maintenance mode. The new version of PHP API is available https://github.com/allure-framework/allure-php-commons2 .

This repository contains PHP API for Allure framework. The main idea is to reuse this API when creating adapters for different test frameworks.

Getting started

In order to use this API you simply need to add the following to composer.json:

{
    "require": {
        "php": ">=5.4.0",
        "allure-framework/allure-php-api": "~1.0.0"
    }
}

Basic usage idiom is to fire an event like the following:

Allure::lifecycle()->fire(new TestCaseFinishedEvent());

Events

The following events are available right now:

• AddAttachmentEvent
• AddParameterEvent
• ClearStepStorageEvent
• ClearTestCaseStorageEvent
• RemoveAttachmentsEvent
• StepCanceledEvent
• StepEvent
• StepFailedEvent
• StepFinishedEvent
• StepStartedEvent
• TestCaseBrokenEvent
• TestCaseCanceledEvent
• TestCaseEvent
• TestCaseFailedEvent
• TestCaseFinishedEvent
• TestCasePendingEvent
• TestCaseStartedEvent
• TestCaseStatusChangedEvent
• TestSuiteEvent
• TestSuiteFinishedEvent
• TestSuiteStartedEvent

Usage examples

See allure-phpunit project.