ezsystems/allure-php-api

PHP API for Allure adapter

Package info

github.com/ezsystems/allure-php-commons

Homepage

pkg:composer/ezsystems/allure-php-api

Statistics

Installs: 431 967

Dependents: 10

Suggesters: 0

Stars: 13

v3.3.0 2022-01-04 10:46 UTC

Requires

Suggests

None

Provides

None

Conflicts

None

Replaces

None

Apache-2.0 95da12c5cfaaf333c3a002bf7062e26023c5fbcd

phpapireportallure


README

This repository contains PHP API for Allure framework with eZ Systems modifications for newer JMS Serializer. 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 || ^7.1.3",
 "ezsystems/allure-php-api": "~3.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.