PHPUnit VS PHP Mess Detector

PHPUnit is the de facto standard for PHP unit testing. It provides a framework for writing and running tests, helping developers quickly discover and fix errors. PHPUnit encourages developers to write testable code and adopt a test-driven development approach, resulting in higher-quality code and reduced chances of errors in production.

Before updating Api Platform, you should make sure that your Api Platform routes are fully covered by tests. You can define integration tests with PHPUnit, Behat or Pest, depending on the tool you’re most comfortable with.

PHP popular tools for testing: PHPUnit

PHPUnit: PHPUnit is a programmer-oriented testing framework for PHP. It is an instance of the xUnit architecture for unit testing frameworks. Extensions/tools: brianium/paratest: Parallel testing for PHPUnit johnkary/phpunit-speedtrap: Reports on slow-running tests in your PHPUnit test suite. robiningelbrecht/phpunit-pretty-print: Better PHPUnit CLI output with Collision roave/no-leaks: PHPUnit Plugin for detecting Memory Leaks in code and tests

We want to start migrating to Attributes because of the announcement made here that in PHPUnit 12 support for metadata in docblocks will be removed: https://github.com/sebastianbergmann/phpunit/issues/4502

PHPUnit: PHPUnit PHPUnit is a testing framework for PHP. It enables developers to write unit tests, integration tests, and functional tests to verify the correctness of their code. It offers a wide range of assertions, test runners, and mocking capabilities. Documentation: Explore PHPUnit's capabilities and learn how to write effective tests in the official documentation: PHPUnit Repository

I really like how Pest PHP formats and outputs test results, but I still prefer to use PHPUnit. Luckily there's Collision. This package is designed to give you beautiful error reporting when interacting with your app through the command line.

Finally we install the command line version of php (no web server is needed for this project), composer which is a package management system for PHP and PHP Unit, the testing framework of PHP.

I've been developing my own symfony bundle and I would like to share with you how I'm driving continuos integration to execute my unit tests. For testing purposes I'm using phpunit and for continous integration i've choosen github actions.

PHPUnit is a unit testing framework for PHP included with Laravel and can be used to test your application's code. It provides a set of assertions and functions for testing your code and can be used to run automated tests.

PHPMD - PHP Mess Detector: PHPMD is a spin-off project of PHP Depend and aims to be a PHP equivalent of the well known Java tool PMD. PHPMD can be seen as an user friendly frontend application for the raw metrics stream measured by PHP Depend.

PHPMD Mess Detector: PHP Mess Detector PHP Mess Detector identifies potential problems and "code smells" in PHP code. It detects complex code, unused variables, duplicated code blocks, and other issues that may indicate poor code quality. It helps developers refactor and clean up their codebase. Documentation: To explore PHP Mess Detector and understand its usage, refer to the official repository: PHP Mess Detector Repository

While you're at it, also include code-style checkers like phpcs, phpmd and/or php-cs-fixer

Mess detector

name: Symfony 5 Tests on: push: branches: - main - dev pull_request: jobs: symfony: name: Symfony 5.0 (PHP ${{ matrix.php-versions }}) # https://hub.docker.com/_/ubuntu/ runs-on: ubuntu-latest strategy: fail-fast: true matrix: php-versions: ['7.4'] steps: # https://github.com/actions/checkout (official) - name: Checkout uses: actions/checkout@v2 # https://github.com/shivammathur/setup-php (community) - name: Setup PHP, extensions and composer with shivammathur/setup-php uses: shivammathur/setup-php@verbose with: php-version: ${{ matrix.php-versions }} extensions: mbstring, xml, ctype, iconv, intl, pdo_sqlite, dom, filter, gd, iconv, json, mbstring, pdo # Composer - name: Get composer cache directory id: composer-cache run: echo "::set-output name=dir::$(composer config cache-files-dir)" # https://help.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows - name: Cache composer dependencies uses: actions/cache@v1 with: path: ${{ steps.composer-cache.outputs.dir }} key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }} restore-keys: ${{ runner.os }}-composer- - name: Install Composer dependencies run: composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader # https://github.com/sensiolabs/security-checker - name: Security check installed dependencies uses: symfonycorp/security-checker-action@v2 # https://github.com/chekalsky/phpcs-action (community) - name: Check PSR12 code style (PHP_CodeSniffer) uses: chekalsky/[email protected] with: enable_warnings: true installed_paths: '${{ github.workspace }}/vendor/squizlabs/php_codesniffer' phpcs_bin_path: './vendor/bin/phpcs src --ignore="Migrations/"' # https://github.com/phpmd/phpmd # - name: Analyses PHP Code (PHP Mess Detector) # run: vendor/bin/phpmd src,tests text .phpmd-ruleset.xml # https://github.com/phpstan/phpstan - name: Analyse PHP Code (PHPStan) run: vendor/bin/phpstan analyse src - name: Cache node_modules uses: actions/cache@v1 id: yarn-cache-node-modules with: path: node_modules key: ${{ runner.os }}-yarn-cache-node-modules-${{ hashFiles('**/yarn.lock') }} restore-keys: | ${{ runner.os }}-yarn-cache-node-modules- - name: Yarn install if: steps.yarn-cache-node-modules.outputs.cache-hit != 'true' run: yarn install - name: Yarn build run: yarn run encore production - name: Archive production artifacts uses: actions/upload-artifact@v1 with: name: build path: public/build # Symfony - name: Check the Symfony console run: | php bin/console -V php bin/console about # Tests - name: Run unit and functional tests run: | php bin/phpunit --stop-on-failure # - name: Run Behat/Mink tests # run: | # php vendor/bin/behat

PHP Mess Detector is a multi-faceted static analysis PHP Tool based on PHP Depend. The kind of problems detected by PHPMD are divided into 5 main categories:

PHPMD