phpspec-code-coverage

, _(*1)

[phpspec-code-coverage]0 is a PhpSpec extension that generates Code Coverage reports for PhpSpec tests., _(*2)

Generating Code Coverage reports allows you to to analyze which parts of your codebase are tested and how well. However, Code Coverage alone should NOT be used as a single metric defining how good your tests are., _(*3)

Note! This is a maintained fork of henrikbjorn/phpspec-code-coverage package with compatible version numbers for stable releases., _(*4)

Requirements

PHP 5.6+ or PHP 7+
Xdebug or phpdbg extension enabled (PHP 7+ is required for code generation to work with phpdbg).
PhpSpec v3 or v4

Change Log

Please see CHANGELOG.md for information on recent changes., _(*5)

Install

Install this package as a development dependency in your project:, _(*6)

$ composer require --dev leanphp/phpspec-code-coverage

Enable extension by editing phpspec.yml of your project:, _(*7)

``` yaml extensions: LeanPHP\PhpSpec\CodeCoverage\CodeCoverageExtension: ~, _(*8)

This will sufficient to enable Code Coverage generation by using defaults
provided by the extension. This extension supports various [configuration
options](#Configuration Options). For a fully annotated example configuration
file check [Configuration section](#Configuration).

## Usage

If you execute `phpspec run` command, you will see code coverage generated in `coverage` directory (in `html` format):

$ bin/phpspec run

### Running with phpdbg

This extension now supports [phpdbg][4], which results in faster execution when
using more recent versions of PHP. Run `phpspec` via [phpdbg][4]:

$ phpdbg -qrr phpspec run

**Note!** PHP 7+ is required for code generation to work with [phpdbg][4].

## Configuration

You can see fully annotated `phpspec.yml` example file below, which can be used
as a starting point to further customize the defaults of the extension. The
configuration file below has all of the [Configuration Options](#Configuration
Options).

```yaml
# phpspec.yml
# ...
extensions:
# ... other extensions ...
# leanphp/phpspec-code-coverage
LeanPHP\PhpSpec\CodeCoverage\CodeCoverageExtension:
# Specify a list of formats in which code coverage report should be
# generated.
# Default: [html]
format:
- text
- html
#- clover
#- php
#
# Specify output file/directory where code coverage report will be
# generated. You can configure different output file/directory per
# enabled format.
# Default: coverage
output:
html: coverage
#clover: coverage.xml
#php: coverage.php
#
# Should uncovered files be included in the reports?
# Default: true
#show_uncovered_files: true
#
# Set lower upper bound for code coverage
# Default: 35
#lower_upper_bound: 35
#
# Set high lower bound for code coverage
# Default: 70
#high_lower_bound: 70
#
# Whilelist directories for which code generation should be done
# Default: [src, lib]
#
whitelist:
- src
- lib
#
# Whiltelist files for which code generation should be done
# Default: empty
#whilelist_files:
#- app/bootstrap.php
#- web/index.php
#
# Blacklist directories for which code generation should NOT be done
#blacklist:
#- src/legacy
#
# Blacklist files for which code generation should NOT be done
#blacklist_files:
#- lib/bootstrap.php

Configuration Options

format (optional) a list of formats in which code coverage should be generated. Can be one or many of: clover, php, text, html (default html) Note: When using clover format option, you have to configure specific output file for the clover format (see below).
output (optional) sets an output file/directory where specific code coverage format will be generated. If you configure multiple formats, takes a hash of format:output (e.g. clover:coverage.xml) (default coverage)
show_uncovered_files (optional) for including uncovered files in coverage reports (default true)
lower_upper_bound (optional) sets lower upper bound for code coverage (default 35).
high_lower_bound (optional) sets high lower bound for code coverage (default 70)
whitelist takes an array of directories to whitelist (default: lib, src).
whitelist_files takes an array of files to whitelist (default: none).
blacklist takes an array of directories to blacklist (default: test, vendor, spec)
blacklist_files takes an array of files to blacklist