Installation de Composer

Le serveur Web de développement est classiquement lancé avec la commande php -S …. La configuration de l'environnement de développement peut alors se faire par variables d'environnement, par exemple avec le script « run-server » qui déclencherait la commande shell Linux suivante :

APP_DIR="$PWD" php -d display_errors -d auto_prepend_file="$PWD/vendor/autoload.php" -S localhost:8080 -t public/

Son équivalent avec l'interpréteur cmd de Windows est alors :

set APP_DIR=%cd%
php -d display_errors -d auto_prepend_file=%cd%\vendor\autoload.php -S localhost:8080 -t public/

Il est impossible de trouver une formulation commune et il est donc indispensable de proposer deux scripts Composer différents. Il vous est donc proposé de créer un répertoire « bin » à la racine de votre projet, dans lequel vous placerez les fichiers de commandes qui seront lancés par les scripts Composer :

• Pour Linux :
  • Fichier « bin/run-server.sh » contenant

    APP_DIR="$PWD" php -d display_errors -d auto_prepend_file="$PWD/vendor/autoload.php" -S localhost:8000 -t public/

  • Script Composer « run-server » donc la formulation complète dans « composer.json » est

            "run-server" : [
                "Composer\\Config::disableProcessTimeout",
                "bin/run-server.sh"
            ],

    Information

    N'oubliez pas de changer les droits des scripts shell Linux pour les rendre exécutables.

• Pour Windows :
  • Fichier « bin\run-server.bat » contenant

    set APP_DIR=%cd%
    php -d display_errors -d auto_prepend_file="%cd%\vendor\autoload.php" -S localhost:8000 -t public/

  • Script Composer « run-server:win » donc la formulation complète dans « composer.json » est

            "run-server:win" : [
                "Composer\\Config::disableProcessTimeout",
                "bin/run-server.bat"
            ],

Codeception dispose de tests d'acceptation qui sont exécutés pour interroger un serveur Web fonctionnel. Il est possible de configurer l'extension « RunProcess » pour qu'elle lance automatiquement un serveur Web dédié avant d'exécuter les tests, cette configuration est alors réalisée dans le fichier de configuration de la suite de tests associée.

Sur le même principe que précédemment, un script sera disponible par système d'exploitation.

• Pour Linux, fichier « bin/run-test-server.sh » contenant

  MYPDO_ENV=test APP_DIR="$PWD" php -d display_errors -d auto_prepend_file="$PWD/vendor/autoload.php" -S localhost:8000 -t public/

• Pour Windows, fichier « bin\run-test-server.bat » contenant

  set MYPDO_ENV=test
  set APP_DIR=%cd%
  php -d display_errors -d auto_prepend_file="%cd%\vendor\autoload.php" -S localhost:8000 -t public/

Le fichier de configuration de la suite de tests est alors unique en exploitant l'astuce qui fait que le script Windows échouera sur Linux et inversement, et ce sans empêcher le lancement du serveur ou le bon déroulement des tests :

extensions:
    enabled:
        - Codeception\Extension\RunProcess:
            # Run server on Windows platform (won't start on Linux)
            0: bin\run-test-server.bat
            # Run server on Linux platform (won't start on Windows)
            1: bin/run-test-server.sh
            sleep: 1 # wait for php local web server to start

Les principe détaillé dans les parties précédentes est nécessaire car les scripts font usage du répertoire courant (« $PWD » sur Linux, « %cd% » sur Windows) dans la ligne de commande qui lance le serveur Web. Si vous avez uniquement besoin de définir des variables d'environnement simples (comme « MYPDO_ENV=test ») pour des commandes qui fonctionnement aussi bien sur Linux que sur Windows (la commande php, par exemple), vous pouvez utiliser la commande « @putenv » de Composer.

La commande composer run --list affiche l'ensemble des scripts Composer disponibles. Vous pouvez rendre cette liste plus accessible en donnant une description de chaque script.