index.rst

CodeCoverageExtension

The Code Coverage extension allows you to collect local and/or remote code coverage.

Use this extension to find dead code in your application, or unused/obsolete contexts or step definitions.

Installation

This extension requires:

• Behat 2.4+
• Mink 1.4+

Through Composer

1. Set dependencies in your composer.json:

{
    "require": {
        ...
        "vipsoft/code-coverage-extension": "*"
    }
}

2. Install/update your vendors:

$ curl http://getcomposer.org/installer | php
$ php composer.phar install

Through PHAR

Download the .phar archive:

• code_coverage_extension.phar

Configuration

Activate extension in your behat.yml and define your routes for remote code coverage collection (relative to Mink's base URL):

# behat.yml
default:
  # ...
  extensions:
    VIPSoft\CodeCoverageExtension\Extension:
      auth:       ~
      create:
        method:   POST
        path:     /
      read:
        method:   GET
        path:     /
      delete:
        method:   DELETE
        path:     /
      drivers:
        - remote
        - local
      filter:     ~
      report:
        format:   html
        options:
          target: /tmp/report

Settings

If HTTP Authentication is required, use:

# behat.yml
default:
  # ...
  extensions:
    VIPSoft\CodeCoverageExtension\Extension:
      auth:
        user:     your_user
        password: your_password
      ...

There are two code coverage driver services. The "local" driver will collect code coverage from the PHP instance running Behat. The "remote" driver will collect code coverage for the Symfony 2 application under test on a remote web server.

The report "directory" determines where the extension will write the code coverage report.

Other choices for report "format" include "clover", "crap4j", "php", "text", and "xml". The "options" vary and correspond to the __construct() and process() arguments of the underlying PHP_CodeCoverage report class.

The default "filter" includes everything / excludes nothing. Using a PHPUnit configuration as an example:

<filter>
    <whitelist addUncoveredFilesFromWhitelist="true">
        <directory suffix=".php">src</directory>
        <exclude>
            <directory>src/*/*/Tests</directory>
        </exclude>
    </whitelist>
</filter>

would be configured in YAML as:

filter:
    whitelist:
      addUncoveredFilesFromWhitelist: true
      include:
        directories:
          'src':
            suffix: .php
      exclude:
        directories:
          'src/*/*/Tests': ~

Limitations

Multiple web servers (e.g., clusters or distributed testing environments) are not currently supported because the Code Coverage Bundle uses a SQLite database.

Source

Github

Copyright

Copyright (c) 2013 Anthon Pang. See LICENSE for details.

Contributors

• Anthon Pang (robocoder)
• Others