Behat PHP code coverage

Introduction

Prérequis

composer require phpunit/php-code-coverage

Mise en contexte

default:
  calls:
    error_reporting: 16383 # E_ALL & ~E_USER_DREPRECATED
  suites:
    default:
      contexts:
        - FeatureContext: { doctrine: "@doctrine" }
        - Behat\MinkExtension\Context\MinkContext
        - Sanpi\Behatch\Context\RestContext
        - Sanpi\Behatch\Context\JsonContext
  extensions:
    Behat\Symfony2Extension:
      kernel:
        env: "test"
        debug: "true"
    Behat\MinkExtension:
      base_url: "http://localhost/"
      sessions:
        default:
          symfony2: ~
    Sanpi\Behatch\Extension: ~

Feature: User
  I need to be able to retrieve, create, update and delete users trough the API.

  # "@createSchema" creates a temporary SQLite database for testing the API
  @createSchema
  Scenario: Create a user
    When I send a "POST" request to "/users" with body:
    """
    {"email": "test@example.com", "name": "Tester"}
    """
    Then the response status code should be 201
    And the response should be in JSON
    And the header "Content-Type" should be equal to "application/ld+json"
    And the JSON should be equal to:
    """
    {
      "@context": "/contexts/User",
      "@id": "/users/1",
      "@type": "http://schema.org/Person",
      "email": "test@example.com",
      "memberOf": null,
      "name": "Tester"
    }
    """

  Scenario: Create a user with invalid email
    When I send a "POST" request to "/users" with body:
    """
    {"email": "test@example", "name": "Tester"}
    """
    Then the response status code should be 400
    And the response should be in JSON
    And the header "Content-Type" should be equal to "application/ld+json"
    And the JSON node "root->hydra:description" should contain "email: This value is not a valid email address."

  Scenario: Get single user
    When I send a "GET" request to "/users/1"
    Then the response status code should be 200
    And the response should be in JSON
    And the header "Content-Type" should be equal to "application/ld+json"
    And the JSON should be equal to:
    """
    {
      "@context": "/contexts/User",
      "@id": "/users/1",
      "@type": "http://schema.org/Person",
      "email": "test@example.com",
      "memberOf": null,
      "name": "Tester"
    }
  """

  Scenario: Get single user not exist
    When I send a "GET" request to "/users/10"
    Then the response status code should be 404
    And the response should be in JSON
    And the header "Content-Type" should be equal to "application/ld+json"
    And the JSON node "root->hydra:description" should be equal to "Not Found"

  @dropSchema
  Scenario: Get user list
    When I send a "GET" request to "/users"
    Then the response status code should be 200
    And the response should be in JSON
    And the header "Content-Type" should be equal to "application/ld+json"
    And the JSON should be equal to:
    """
    {
      "@context": "/contexts/User",
      "@id": "/users",
      "@type": "hydra:PagedCollection",
      "hydra:totalItems": 1,
      "hydra:itemsPerPage": 30,
      "hydra:firstPage": "/users",
      "hydra:lastPage": "/users",
      "hydra:member": [
        {
          "@id": "/users/1",
          "@type": "http://schema.org/Person",
          "email": "test@example.com",
          "memberOf": null,
          "name": "Tester"
        }
      ]
    }
    """

Création du context Behat

<?php

use Behat\Behat\Context\Context;
use Behat\Behat\Hook\Scope\BeforeScenarioScope;

/**
 * Created by PhpStorm.
 * User: elie
 * Date: 01/09/15
 * Time: 11:29
 */
class CoverageContext implements Context
{
    /**
     * @var PHP_CodeCoverage
     */
    private static $coverage;

    /** @BeforeSuite */
    public static function setup()
    {
        $filter = new PHP_CodeCoverage_Filter();
        $filter->addDirectoryToBlacklist(__DIR__ . "/../../vendor");
        $filter->addDirectoryToWhitelist(__DIR__ . "/../../src");
        self::$coverage = new PHP_CodeCoverage(null, $filter);
    }

    /** @AfterSuite */
    public static function tearDown()
    {
        $writer = new PHP_CodeCoverage_Report_HTML();
        $writer->process(self::$coverage, __DIR__ . "/../../app/logs/coverage");
    }

    private function getCoverageKeyFromScope(BeforeScenarioScope $scope)
    {
        $name = $scope->getFeature()->getTitle() . '::' . $scope->getScenario()->getTitle();
        return $name;
    }

    /**
     * @BeforeScenario
     */
    public function startCoverage(BeforeScenarioScope $scope)
    {
        self::$coverage->start($this->getCoverageKeyFromScope($scope));
    }

    /** @AfterScenario */
    public function stopCoverage()
    {
        self::$coverage->stop();
    }
}

// Modifier ces lignes pour ajouter / exclure des dossiers au coverage
$filter->addDirectoryToBlacklist(__DIR__ . "/../../vendor");
$filter->addDirectoryToWhitelist(__DIR__ . "/../../src");

//Modifier cette ligne pour changer le type de sortie générée
$writer = new PHP_CodeCoverage_Report_HTML();
// Modifier cette ligne pour rediriger la sortie du résultat du coverage
$writer->process(self::$coverage, __DIR__ . "/../../app/logs/coverage");

coverage:
  suites:
    default:
      contexts:
        - FeatureContext: { doctrine: "@doctrine" }
        - Behat\MinkExtension\Context\MinkContext
        - Sanpi\Behatch\Context\RestContext
        - Sanpi\Behatch\Context\JsonContext
        - CoverageContext # On rajoute CoverageContext aux contextes déjà existants

Tests

Quelle version de phpunit/php-code-coverage utilisez-vous pour cet article?

Je viens d'inclure `^4.0` et on dirait que le namespace a changé...

Super article, mais il me reste une interrogation:

bin/behat --profile coverage

Comment est definit ce profile dans le fichier de configuration ?