https://github.com/dutchiexl/BehatHtmlFormatterPlugin
This is a behat plugin to generate HTML reports
https://github.com/dutchiexl/BehatHtmlFormatterPlugin
Last synced: 4 months ago
JSON representation
This is a behat plugin to generate HTML reports
- Host: GitHub
- URL: https://github.com/dutchiexl/BehatHtmlFormatterPlugin
- Owner: dutchiexl
- License: mit
- Created: 2015-01-06T10:36:52.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-12-12T14:41:51.000Z (about 1 year ago)
- Last Synced: 2024-05-15T21:32:07.135Z (9 months ago)
- Language: PHP
- Size: 240 KB
- Stars: 111
- Watchers: 18
- Forks: 117
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## BehatHtmlFormatterPlugin
Behat 3 extension for generating HTML reports from your test results.
[](https://packagist.org/packages/emuse/behat-html-formatter) [](https://packagist.org/packages/emuse/behat-html-formatter) [](https://packagist.org/packages/emuse/behat-html-formatter) [](https://packagist.org/packages/emuse/behat-html-formatter)
### Twig report
### Behat 2 report
## How?
* The tool can be installed easily with composer.
* Defining the formatter in the `behat.yml` file
* Modifying the settings in the `behat.yml`file
## Installation
### Prerequisites
This extension requires:
* PHP 5.3.x or higher
* Behat 3.x or higher
### Through composer
The easiest way to keep your suite updated is to use [Composer](http://getcomposer.org>):
#### Install with composer:
```bash
$ composer require --dev emuse/behat-html-formatter
```
#### Install using `composer.json`
Add BehatHtmlFormatterPlugin to the list of dependencies inside your `composer.json`.
```json
{
"require": {
"behat/behat": "3.*@stable",
"emuse/behat-html-formatter": "0.1.*",
},
"minimum-stability": "dev",
"config": {
"bin-dir": "bin/"
}
}
```
Then simply install it with composer:
```bash
$ composer install --dev --prefer-dist
```
You can read more about Composer on its [official webpage](http://getcomposer.org).
## Basic usage
Activate the extension by specifying its class in your `behat.yml`:
```json
# behat.yml
default:
suites:
default:
contexts:
- emuse\BehatHTMLFormatter\Context\ScreenshotContext:
screenshotDir: build/html/behat/assets/screenshots
... # All your awesome suites come here
formatters:
html:
output_path: %paths.base%/build/html/behat
extensions:
emuse\BehatHTMLFormatter\BehatHTMLFormatterExtension:
name: html
renderer: Twig,Behat2
file_name: index
print_args: true
print_outp: true
loop_break: true
```
### Command line options
Add the following to your behat command to print a report:
`behat --format html --out MYDIRECTORY`
Setting the format to html will output the various reports that you configure below (Behat2, Twig, Minimal, etc.)
You also need to specify the output directory for the reports as MYDIRECTORY.
## Configuration
### Formatter configuration
* `output_path` - The location where Behat will save the HTML reports. Use `%paths.base%` to build the full path.
### Extension configuration
* `renderer` - The engine that Behat will use for rendering, thus the types of report format Behat should output (multiple report formats are allowed, separate them by commas). Allowed values are:
* *Behat2* for generating HTML reports like they were generated in Behat 2.
* *Twig* A new and more modern format based on Twig.
* *Minimal* An ultra minimal HTML output.
* `file_name` - (Optional) Behat will use a fixed filename and overwrite the same file after each build. By default, Behat will create a new HTML file using a random name (*"renderer name"*_*"date hour"*).
* `print_args` - (Optional) If set to `true`, Behat will add all arguments for each step to the report. (E.g. Tables).
* `print_outp` - (Optional) If set to `true`, Behat will add the output of each step to the report. (E.g. Exceptions).
* `loop_break` - (Optional) If set to `true`, Behat will add a separating break line after each execution when printing Scenario Outlines.
## Screenshot
The facility exists to embed a screenshot into test failures.
Currently png is the only supported image format.
In order to embed a screenshot, you will need to take a screenshot using your favourite webdriver and store it in the following filepath format:
results/html/assets/screenshots/{{feature_name}}/{{scenario_name}}.png
The feature_name and scenario_name variables will need to be the relevant item names without spaces.
Below is an example of FeatureContext methods which will produce an image file in the above format:
```php
/**
* @BeforeScenario
*
* @param BeforeScenarioScope $scope
*
*/
public function setUpTestEnvironment($scope)
{
$this->currentScenario = $scope->getScenario();
}
/**
* @AfterStep
*
* @param AfterStepScope $scope
*/
public function afterStep($scope)
{
//if test has failed, and is not an api test, get screenshot
if(!$scope->getTestResult()->isPassed())
{
//create filename string
$featureFolder = preg_replace('/\W/', '', $scope->getFeature()->getTitle());
$scenarioName = $this->currentScenario->getTitle();
$fileName = preg_replace('/\W/', '', $scenarioName) . '.png';
//create screenshots directory if it doesn't exist
if (!file_exists('results/html/assets/screenshots/' . $featureFolder)) {
mkdir('results/html/assets/screenshots/' . $featureFolder);
}
//take screenshot and save as the previously defined filename
$this->driver->takeScreenshot('results/html/assets/screenshots/' . $featureFolder . '/' . $fileName);
// For Selenium2 Driver you can use:
// file_put_contents('results/html/assets/screenshots/' . $featureFolder . '/' . $fileName, $this->getSession()->getDriver()->getScreenshot());
}
}
```
Note that the currentScenario variable will need to be at class level and generated in the @BeforeScenario method as Behat does not currently support obtaining the current Scenario in the @AfterStep method, where the screenshot is generated
## Issue Submission
When you need additional support or you discover something *strange*, feel free to [Create a new issue](https://github.com/dutchiexl/BehatHtmlFormatterPlugin/issues/new).
## License and Authors
Authors: https://github.com/dutchiexl/BehatHtmlFormatterPlugin/contributors