longyi c9405dd336 vendor 5 years ago
..
.github c9405dd336 vendor 5 years ago
src c9405dd336 vendor 5 years ago
test c9405dd336 vendor 5 years ago
.gitignore c9405dd336 vendor 5 years ago
LICENSE c9405dd336 vendor 5 years ago
README.md c9405dd336 vendor 5 years ago
composer.json c9405dd336 vendor 5 years ago
composer.lock c9405dd336 vendor 5 years ago
phpunit.php c9405dd336 vendor 5 years ago
phpunit.xml c9405dd336 vendor 5 years ago

README.md

Allure PHP API

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.