Static tests

Executing static tests is straightforward. They can be executed in several ways.

Run on all files

To run static tests on all files, navigate to the application root directory and execute the following command:

Copy
bin/magento dev:test:run static
Copied to your clipboard
bin/magento dev:test:run static

Run on a subset of files

To run the static tests on a subset of files, create a new testsuite for phpunit:

1. From the application root directory navigate to dev/tests/static/testsuite/Magento/Test

2. Create a copy of the Php folder on the same directory and rename it to Local

3. Navigate to dev/tests/static/testsuite/Magento/Test/Local/_files/whitelist and open common.txt

4. Replace the contents with the folder of the files that you want to test. For example:

   Copy
   # Format: <componentType=module|library|theme|language|*> <componentName> <globPattern> or simply <globPattern>
   app/code/Magento/CatalogSearch/Model/Search
   Copied to your clipboard
   # Format: <componentType=module|library|theme|language|*> <componentName> <globPattern> or simply <globPattern>
   app/code/Magento/CatalogSearch/Model/Search

5. Create a copy of the dev/tests/static/phpunit.xml.dist file and call it phpunit.xml:

6. Add a new testsuite to the dev/tests/static/phpunit.xml file inside the <testsuites> node:

   Copy
    <testsuites>
        ...
        <testsuite name="Local Test Suite">
            <file>testsuite/Magento/Test/Local/LiveCodeTest.php</file>
        </testsuite>
    </testsuites>
   Copied to your clipboard
    <testsuites>
        ...
        <testsuite name="Local Test Suite">
            <file>testsuite/Magento/Test/Local/LiveCodeTest.php</file>
        </testsuite>
    </testsuites>

7. Navigate to the application root directory and run:

   Copy
   ./vendor/bin/phpunit --testsuite="Local Test Suite" -c dev/tests/static/phpunit.xml
   Copied to your clipboard
   ./vendor/bin/phpunit --testsuite="Local Test Suite" -c dev/tests/static/phpunit.xml

As a result of this process, you can run PHP static tests on a subset of files. It is also possible to run other types of static tests by following the same process with other testsuites.

Last updated 9/11/2023

Was this helpful?

Yes

No