BehatHtmlFormatterPlugin: A PHP repository from fonsecas72

BehatHtmlFormatterPlugin

Behat 3 extension for generating HTML reports from your test results.

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.ymlfile

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:

Install with composer:

$ composer require --dev emuse/behat-html-formatter

Install using `composer.json`

Add BehatHtmlFormatterPlugin to the list of dependencies inside your composer.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:

$ composer install --dev --prefer-dist

You can read more about Composer on its official webpage.

Basic usage

Activate the extension by specifying its class in your behat.yml:

# behat.yml
default:
  suites:
    ... # 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

Configuration

output_path - The location where Behat will save the HTML reports. The path defined here is relative to %paths.base% and, when omitted, will be default set to the same path.
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.

Issue Submission

When you need additional support or you discover something strange, feel free to Create a new issue.

License and Authors

Authors: https://github.com/dutchiexl/BehatHtmlFormatterPlugin/contributors

fonsecas72/BehatHtmlFormatterPlugin