Gérer le cycle de vie d'une application PHP avec Phing

pear channel-discover pear.phing.info
pear install phing/phing

pear upgrade phing/phing

<?php
echo 'hello world';	
?>

<?php	
phpinfo();
?>

<?xml version="1.0" encoding="UTF-8"?>

<project name="SimpleHelloworld" basedir="." default="build">
    <target name="build">
        <echo msg="Debut du build" />
        
        <echo msg="Création du répertoire build" />
        <mkdir dir="./build" />
        
        <echo msg="Création du répertoire release" />
        <mkdir dir="./build/release" />
        
        <echo msg="Copie du fichier helloworld.php vers build/release/helloworld.php" />
        <copy file="helloworld.php" tofile="./build/release/helloworld.php /">
        <echo msg="Fin du build" />
    </target>
</project>

Buildfile: D:\Programming\Projects\0019-PhingDiscoveryArticle\svn\trunk\app\01-simple-helloworld\build.xml

SimpleHelloworld > build:

     [echo] Debut du build
     [echo] Creation du repertoire build
    [mkdir] Created dir: D:\Programming\Projects\0019-PhingDiscoveryArticle\svn\trunk\app\01-simple-helloworld\build
     [echo] Creation du repertoire release
    [mkdir] Created dir: D:\Programming\Projects\0019-PhingDiscoveryArticle\svn\trunk\app\01-simple-helloworld\build\rel
ease
     [echo] Copie du fichier helloworld.php vers build/release/helloworld.php
     [copy] Copying 1 file to D:\Programming\Projects\0019-PhingDiscoveryArticle\svn\trunk\app\01-simple-helloworld\buil
d\release
     [echo] Fin du build

BUILD FINISHED

Total time: 0.4153 seconds

<project name="SimpleHelloworld" basedir="." default="build">

<target name="build">

<echo msg="Debut du build" />

<mkdir dir="./build" />

<copy file="helloworld.php" tofile="./build/release/helloworld.php /">

Qu'est-ce que c'est ?
----------------------

Vous pourrez grâce à cet exemple exécuter un script de build qui archive 
automatiquement chacune de vos releases. Ce build est adapté aux petits 
projets pour lesquels vous travaillez souvent seul et pour lesquels vous n'employez 
pas de serveur de version.

Le fichier build.xml propose les opérations suivantes :
 # déploiement de l'application dans l'environnement de debug ;
 # déploiement de l'application dans l'environnement de release et création 
    d'un package dont le nom est basé sur le numéro de version (si un package 
    existe, il ne sera pas remplacé et le script affichera un message d'erreur) ;
 # déploiement forcé de l'application dans l'environnement de release et
    création / remplacement d'un package dont le nom est basé sur le numéro de version.
 
Pour changer le numéro de version, vous devez éditer la propriété projectVersion 
dans le fichier build.xml.

Pour un simple helloworld, ce déploiement est trop lourd, mais vous pouvez l'adapter
à la majorité de vos applications. Les prérequis sont peu nombreux.

Contrairement au build précédent, vous ne configurez pas la copie fichier par fichier
mais vous configurez la tâche de copy pour copier tous les fichiers respectant certaines
conventions. Si vous rajoutez un fichier ou plusieurs fichiers à votre application, 
vous n'aurez pas à modifier votre script de build.

Quelles sont les fonctionnalités de Phing utilisées ?
--------------------------------------------------

Ce sont :
# AvailableTask : vérifier qu'un dossier ou un fichier est disponible ;
# CopyTask : copier un ou plusieurs dossiers / fichiers ;
# DeleteTask : supprimer un ou plusieurs dossiers / fichiers ;
# ExitTask (FailTask) : arrêter l'exécution d'un script ;
# Fileset : permet de définir un groupe de fichiers à partir de règles d'inclusion
    et d'exclusion pour les instructions manipulant des fichiers (CopyTask, DeleteTask...) ;
# IfTask : prise de décision durant le build ;
# Mapper : permet d'effectuer certaines transformations sur le nom des fichiers 
    dans le cadre de certaines opérations (CopyTask, DeleteTask...) ;
# PropertyTask : utiliser des variables permettant de modifier 
    la configuration du build ;
# Target : utiliser des targets dépendant les unes des autres ;
# ZipTask : compresser dans un seul fichier à l'aide de l'algorithme Zip, un ou 
    plusieurs dossiers / fichiers ;

Qu'est-ce que c'est ?
----------------------

Cet exemple présente un build plus complexe. Celui-ci exécute les tests unitaires
PHPUnit, vérife que le code respecte la convention de code du projet PEAR 
grâce à PHP_CodeSniffer et génère la documentation de l'API en utilisant PhpDoc.

Comme dans les projets précédents, nous allons sortir un package au format zip
incluant le numéro de version, la date de l'exécution et le statut des tests 
unitaires qui ont été exécutés.

Le nom du package se présentera de la façon suivante :
NomDuProjet-Version-YYYY-MM-DD-hh-mm-ss-TestsResult

Pour ce type de projet, l'emploi d'un serveur de version serait très avantageux.
Cependant, nous allons volontairement l'omettre dans cet exemple pour des raisons 
de facilité de mise en oeuvre.

Note : dans la pratique, si vous n'avez pas de serveur de version, vous 
pouvez figer votre environnement dans une archive, en excluant le dossier contenant
tous les packages de release. Ainsi, vous pourrez en quelques clics revenir à une 
version différente de votre développement. Vous pourrez également utiliser un outil
tel que winmerge pour comparer les deux versions de votre projet. Il ne s'agit toutefois que 
d'un palliatif valable si vous travaillez seul, un serveur de version restant
recommandé car il rend beaucoup plus de services que le simple archivage.

Dans cet exemple, vous découvrirez une méthode pour sauvegarder dans un fichier 
séparé le code commun à chacun de vos builds (procédé recommandé dans le cadre de 
l'industrialisation de vos projets)

Le fichier build.xml propose les opérations suivantes
 # exécution des tests PHPUnit ;
 # exécution des tests PHP_CodeSniffer (le fichier app/function.php déclenche deux
    warnings) ;
 # génération de la documentation d'API ;
 # exécution de toutes les opérations de "quality assurance" (documentation, tests) ;
 # déploiement de l'application dans l'environnement de debug ;
 # déploiement de l'application dans l'environnement de release ;
 # packaging de l'application au format ZIP.
 
Quelles sont les fonctionnalités de Phing utilisées ?
--------------------------------------------------

Ce sont :
# PhingTask : vous pouvez appeler une target dans un autre fichier de build
    (ceci est utile pour mettre en commun le code de vos builds) ;
# PhpUnitTask : vous exécutez les tests unitaires grâce à cette tâche (mais ceci n'est 
    pas compatible avec les suites de tests ; Phing construit ses propres suites) ;
# PhpCodeSnifferTask : vous vérifiez avec cette tâche le style de votre code
    grâce à PHP_CodeSniffer ;
# PhpDocumentorTask :  vous pouvez générer la documentation de l'API de votre
    code et le manuel utilisateur à partir de fichiers docbook grâce à Phpdoc.