Add <whitelist /> to the phpunit.xml.dist to support code coverage

[mcspronko]

No description provided.

[underser]

Hi @mcspronko ,
could you please describe where phpunit.xml.dist is located in the repository?
and what adding should resolve?

[mcspronko]

Hi @underser
The phpunit.xml.dist can be located under the individual extension in the repository e.g. card, card-gateway directory. Once the file added, the node should be added and the list of extension related directories e.g. "Setup", "Gateway" etc. should be listed.

In this way, we can run a code coverage tool and get the test coverage report.

Let me know if you have questions.

[underser]

@mcspronko thank for quick response
So for card-gateway it should be something like this:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.1/phpunit.xsd"
         colors="true"
         backupGlobals="false"
        >

    <testsuite name="Liqpay gateway tests">
        <directory suffix="Test.php">Test/Integration</directory>
    </testsuite>

    <php>
        <ini name="date.timezone" value="America/Los_Angeles"/>
        <ini name="xdebug.max_nesting_level" value="200"/>
    </php>

    <filter>
        <whitelist addUncoveredFilesFromWhiteList="true">
            <directory suffix=".php">../*</directory>
            <exclude>
                <directory>../admin</directory>
                <directory>../api</directory>
                <directory>../cart-admin</directory>
                // List of all directories in root
            </exclude>
        </whitelist>
    </filter>
</phpunit>

btw, it still doesn't clear for me:

1. How to test this on local?
2. What coverage report you want to get from this in the feature? I guess that this is for something like Travis, no?

[mcspronko]

Hi @underser, yes, however a phpunit.xml.dist file should be created for each Magento 2 extension/directory. Meaning, the card-gateway should have its own phpunit.xml.dist and the whitelist configuration should only relate to card-gateway directory and so on.

You can test it locally by running the command inside card-gateway directory:

vendor/bin/phpunit Test --coverage-text=coverage_report.txt