Tests, code quality and code style
==================================

Local development
-----------------

Follow the procedure described in the :ref:`Configuration` page to setup a local
development environment.

Workflow
--------

Every time changes are introduced into the library, `Github Actions`_
run the tests written with `Behat`_.

The code style is based on `PSR-12`_ plus a set of custom rules.
Find more about the code style in use in the package `drupol/php-conventions`_.

A PHP quality tool, Grumphp_, is used to orchestrate all these tasks at each commit
on the local machine, but also on the continuous integration tools.

To run the whole tests tasks locally, do

.. code-block:: bash

    ./vendor/bin/grumphp run

Here's an example of output that shows all the tasks that are setup in Grumphp
and that will check your project.

.. code-block:: bash

    ./vendor/bin/grumphp run
    GrumPHP is sniffing your code!
    Running task  1/13: License... ✔
    Running task  2/13: composer_require_checker... ✔
    Running task  3/13: composer... ✔
    Running task  4/13: ComposerNormalize... ✔
    Running task  5/13: YamlLint... ✔
    Running task  6/13: JsonLint... ✔
    Running task  7/13: PhpLint... ✔
    Running task  8/13: TwigCs... ✔
    Running task  9/13: PhpCsFixer... ✔
    Running task 10/13: Phpcs... ✔
    Running task 11/13: PhpStan... ✔
    Running task 12/13: Psalm... ✔
    Running task 13/13: Behat... ✔

.. _PSR-12: https://www.php-fig.org/psr/psr-12/
.. _drupol/php-conventions: https://github.com/drupol/php-conventions
.. _Github Actions: https://github.com/ecphp/eu-login-api-authentication-bundle/actions
.. _Behat: http://www.behat.org/
.. _PHPInfection: https://github.com/infection/infection
.. _Grumphp: https://github.com/phpro/grumphp
.. _environment: https://symfony.com/doc/current/configuration.html#configuration-environments
.. _official Symfony documentation: https://symfony.com/doc/current/configuration.html
.. _EU Login: https://ecas.ec.europa.eu/cas/