Behat 3 extension for generating HTML reports from your test results., (*1)
Twig report
, (*2)
Behat 2 report
, (*3)
How?
- The tool can be installed easily with composer.
- Defining the formatter in the
behat.yml file
- Modifying the settings in the
behat.ymlfile
Installation
Prerequisites
This extension requires:, (*4)
- 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:, (*5)
Install with composer:
$ composer require --dev samnela/behat-html-formatter
Install using composer.json
Add BehatHtmlFormatterPlugin to the list of dependencies inside your composer.json., (*6)
{
"require": {
"behat/behat": "3.*@stable",
"samnela/behat-html-formatter": "0.1.*",
},
"minimum-stability": "dev",
"config": {
"bin-dir": "bin/"
}
}
Then simply install it with composer:, (*7)
$ composer install --dev --prefer-dist
You can read more about Composer on its official webpage., (*8)
Basic usage
Activate the extension by specifying its class in your behat.yml:, (*9)
# behat.yml
default:
suites:
... # All your awesome suites come here
formatters:
html:
output_path: %paths.base%/build/html/behat
extensions:
Samnela\BehatHTMLFormatter\BehatHTMLFormatterExtension:
name: html
renderer: Twig,Behat2
file_name: index
print_args: true
print_outp: true
loop_break: true
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., (*10)
Currently png is the only supported image format., (*11)
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:, (*12)
results/html/assets/screenshots/{{feature_name}}/{{scenario_name}}.png, (*13)
The feature_name and scenario_name variables will need to be the relevant item names without spaces., (*14)
Below is an example of FeatureContext methods which will produce an image file in the above format:, (*15)
/**
* @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, (*16)
Issue Submission
When you need additional support or you discover something strange, feel free to Create a new issue., (*17)
License and Authors
This plugin under the MIT license, (*18)
this is a fork from https://github.com/dutchiexl/BehatHtmlFormatterPlugin, (*19)
Wallogit.com
