DailyBuild d'un projet Delphi avec R2Build

Lors du développement de l'outil DelphiCodeToDoc, j'ai eu besoin d'utiliser R2Build pour définir et exécuter des Builds automatiques. Je me propose ici de vous faire part de mon expérience, en vous guidant pas à pas.

Pendant le développement de DelphiCodeToDoc, j'ai eu besoin de produire et de mettre à disposition de tous, tous les jours, la version la plus récente du logiciel. Ainsi, les utilisateurs ne sont pas obligés d'attendre une version officielle pour l'essayer ni de recompiler eux-mêmes l'application finale.

Pour produire cette version, j'ai commencé par faire manuellement quelques opérations :

• exporter la version de subversion (outil de versionning) ;
• compiler l'application ;
• compiler les tests unitaires ;
• lancer les tests (unitaires) automatisés ;
• faire un package du livrable ;
• envoyer ce livrable sur mon site FTP.

Tout cela représente ce que l'on nomme couramment un Build. Ils se nomment DailyBuild (ou NightlyBuild) lorsque cette opération est automatisée chaque jour (ou chaque nuit).

Pour mon besoin, je voulais utiliser un outil simple, gratuit et open source (comme DelphiCodeToDoc) et ouvert aux extensions (plugin). En tapant les mots-clés Dailybuild et Delphi dans Google, j'ai trouvé R2Build à la deuxième place. Je ne me suis pas posé plus de questions ;)
La page d'accueil de R2Build se trouve ici : http://r2build.sourceforge.net

Certains d'entre vous s'étonneront peut-être que je n'aie pas utilisé un outil d'intégration continue complet, comme CruiseControl.NET (CC.NET).
La réponse est aussi simple que l'est le besoin : seulement un dailybuild, pas de contrôle particulier, pas de statistiques ni de graphiques, pas de notification, etc.
J'ai plusieurs autres projets inclus dans une architecture d'intégration continue avec CC.NET, mais le besoin est bien plus large.

La première chose dont nous avons besoin, c'est de créer un répertoire temporaire où nous ferons toutes nos opérations.

Plutôt que de donner le nom du chemin en dur dans ce composant, nous allons éditer une variable qui nous servira tout au long du projet.
Pour cela, Project Setting > Setup Variable onglet Global Var et cliquer sur l'icône ajouter (le signe '+').

Nous pouvons maintenant double-cliquer sur le composant Create Dir(s) et remplir le paramètre du dossier à créer, c'est-à-dire la variable $BUILDDIRRECTORY

Pour que cette étape soit la première du script…

Nous allons maintenant poursuivre en faisant l'opération de checkout du code source, c'est-à-dire le redescendre du gestionnaire de versions.

La configuration de cette étape est plutôt simple, car nous allons faire un checkout anonyme de la dernière version comme mentionné dans la page d'accueil de DelphiCodeToDoc.

Paramètres du bloc

• URL : http://dephicodetodoc.svn.sourceforge.net/svnroot/dephicodetodoc/trunk/DelphiCodeToDoc
• Destination : $BUILDDIRECTORY\DelphiCodeToDoc
• Les autres champs sont vides

Avant de compiler tout le projet, nous devons forcer la compilation des tests unitaires sous forme de ligne de commande. Sinon, nous aurions une version avec l'IHM de DUnit et il faudrait lancer les tests à la main.
Le projet de test de DelphiCodeToDoc contient, en plus de DEBUG et RELEASE, une configuration appelée CmdLine qui produit une version ligne de commande des tests. Pour forcer cette configuration, il suffit de modifier dans le fichier *.dproj la configuration active.

Pour configurer cette étape, nous devons fournir les éléments suivants :

• nom du fichier à patcher. Nous sélectionnons le fichier DelphiCodeToDoc_Tests.dproj ;
• la chaîne recherchée dans le fichier, qui contient la configuration Debug ;
• la chaîne de remplacement, avec la nouvelle configuration CmdLine.

Maintenant que nous avons le code source, il faut le compiler.
Depuis Delphi2007, les projets *.dproj sont au format MSBuild, ce qui nous simplifiera la tâche !

La configuration de ce bloc est simple : Target (cible) sera l'action Make, et le projet à compiler $BUILDDIRECTORY\DelphiCodeToDoc\DCTD_and_Tests.groupproj

Pour que MSBuild trouve le compilateur Delphi ainsi que sa configuration, il faut créer une variable d'environnement pour ce composant MSBuild.
Sélectionner le composant MSBuild, cliquer sur Menu > Project Setting > Setup variable, Onglet MSBuild Var.

Configuration de la nouvelle variable :

• Name : BDS ;
• Value : C:\Program Files\CodeGear\RAD Studio\6.0 ;
• Environment variable : Coché

Avant de faire le package final, nous devons être sûrs que les tests unitaires et d'intégration passent tous.
Nous allons donc exécuter les tests précédemment compilés sous forme d'application console.

C'est une exécution de commande DOS simple, avec les mêmes paramètres qu'un raccourci Windows.
Si les tests échouent (quelle qu’en soit la raison), le code de retour indiquera une erreur.

Maintenant que nous avons créé l'exécutable, nous pouvons créer le package, ou le livrable, que nous voulons.
Pour DelphiCodeToDoc, je voulais aller au plus simple et zipper l'exécutable uniquement.
Pour réaliser cela, nous allons d'abord créer un sous-répertoire de travail pour la création de notre livrable.

Nous devons ajouter les éléments suivants :

• le nom de l'archive : $BUILDDIRECTORY\dailybuild\DelphiCodeToDoc.zip ;
• le fichier à compresser : $BUILDDIRECTORY\DelphiCodeToDoc\Exe\DelphiCodeToDoc.exe.

Le nettoyage va consister à supprimer notre répertoire temporaire de build.
R2Build permet de faire cette opération à partir de deux composants.

Cette étape supprimera tous les fichiers de notre arborescence.

Cette étape supprimera tous les répertoires de notre arborescence.

L'emploi de ces deux commandes vide complètement notre répertoire de build, et ne laisse aucune trace.

Pour finaliser notre Build, nous allons incrémenter le numéro de version du build pour garder un historique des versions.