Output PHPUnit Code Coverage with CircleCI 2.0

#docker #circleci #circleci20 #phpunit

This article was originally published on bmf-tech.com.

Overview

Output PHPUnit code coverage with CircleCI 2.0

Environment

CircleCI 2.0
docker
docker-compose
PHPUnit 6.x
PHP 7.2.x

Steps

Adjust phpunit.xml Settings

Specify the source you want to include in the coverage.

    <filter>
        <whitelist processUncoveredFilesFromWhitelist="true">
            <directory suffix=".php">./app</directory>
            <exclude>
                <directory>./app/Providers</directory>
                <directory>./app/Exceptions</directory>
                <directory>./app/Http/Middleware</directory>
                <directory>./app/Providers</directory>
                <file>./app/Console/Kernel.php</file>
                <file>./app/Http/Kernel.php</file>
                <file>./app/Http/Controllers/Controller.php</file>
            </exclude>
        </whitelist>
    </filter>

Write it like this.
phpunit.xml

<?xml version="1.0" encoding="UTF-8"?>
<phpunit
    backupGlobals="false"
    backupStaticAttributes="false"
    bootstrap="bootstrap/autoload.php"
    colors="true"
    convertErrorsToExceptions="true"
    convertNoticesToExceptions="true"
    convertWarningsToExceptions="true"
    processIsolation="false"
    stopOnFailure="false">
    <testsuites>
        <testsuite name="Application Test Suite">
            <directory suffix="Test.php">./tests</directory>
        </testsuite>
    </testsuites>
    <filter>
        <whitelist processUncoveredFilesFromWhitelist="true">
            <directory suffix=".php">./app</directory>
            <exclude>
                <directory>./app/Providers</directory>
                <directory>./app/Exceptions</directory>
                <directory>./app/Http/Middleware</directory>
                <directory>./app/Providers</directory>
                <file>./app/Console/Kernel.php</file>
                <file>./app/Http/Kernel.php</file>
                <file>./app/Http/Controllers/Controller.php</file>
            </exclude>
        </whitelist>
    </filter>
    <php>
        <env name="APP_ENV" value="testing"/>
        <env name="DB_CONNECTION" value="mysql_test"/>
    </php>
</phpunit>

Output the Coverage Report

It is said to be faster than using xdebug, so use phpdbg to create an HTML format coverage report. Due to memory shortage on CI, I specified a memory limit.

phpdbg -qrr vendor/bin/phpunit -d memory_limit=512M --coverage-html /tmp/artifacts"

Adjust ./circleci/config.yml

To view the coverage report from artifacts after running tests on CircleCI, use store_artifacts to upload the coverage report to artifacts.

Since tests are conducted on docker, it was necessary to mount the coverage report source on both the host and docker sides. It might be a quick fix, but I tried executing it by copying files using the docker cp command.

.circleci/config.yml

version: 2
jobs:
  build:
    machine: true
    steps:
        - checkout
        - run:
            name: Create a artifacts directory
            command: mkdir -p /tmp/artifacts
        - run:
            name: core-app - Run tests and create a code coverage report
            command: docker exec -it rubel_php /bin/sh -c "cd core-app/ && phpdbg -qrr vendor/bin/phpunit -d memory_limit=512M --coverage-html /tmp/artifacts"
        - run:
            name: Copy the coverage report to host directory
            command: docker cp rubel_php:/tmp/artifacts /tmp
        - store_artifacts:
            path: /tmp/artifacts

Thoughts

I was able to output the coverage, so I would like to try integrating with various web services (like codacy or coverall). I spent a lot of time not realizing that file mounting was necessary...

DEV Community