https://github.com/allure-framework/allure-php-api
PHP API for Allure Framework
https://github.com/allure-framework/allure-php-api
allure php reporting
Last synced: 9 months ago
JSON representation
PHP API for Allure Framework
- Host: GitHub
- URL: https://github.com/allure-framework/allure-php-api
- Owner: allure-framework
- License: apache-2.0
- Created: 2014-06-02T16:14:49.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-01-08T17:41:20.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T00:55:04.388Z (about 1 year ago)
- Topics: allure, php, reporting
- Language: PHP
- Homepage:
- Size: 149 KB
- Stars: 33
- Watchers: 12
- Forks: 28
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Allure PHP API (maintenance)
This project is in Maintenance mode. The new version of PHP API is available https://github.com/allure-framework/allure-php-commons2 .
[](https://github.com/allure-framework/allure-php-api/actions/workflows/build.yml)
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**:
```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:
```php
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](https://github.com/allure-framework/allure-phpunit) project.