En r\u00e9alit\u00e9, la plupart des serveur d’int\u00e9gration continue se basant sur ANT ou MAVEN (ou les deux), ils permettent une liste quasi infinie d’actions possible.<\/p>\n
Les b\u00e9n\u00e9fices d’une int\u00e9gration continue sont ind\u00e9niable, elle permet de v\u00e9rifier petit \u00e0 petit le travail de toute l’\u00e9quipe, de d\u00e9tecter les erreurs beaucoup plus rapidement et d’assurer la coh\u00e9rence de l’application. coupl\u00e9 \u00e0 un lancement des tests, elle permet de voir l’\u00e9volution de la qualit\u00e9 de l’application et montre les progr\u00e8s de l’\u00e9quipe en temps r\u00e9el. Le plus souvent, ces outils sont livr\u00e9 avec des modules de statistique tr\u00e8s int\u00e9ressant.<\/p>\n
Bien sure , utiliser un serveur d’int\u00e9gration continue implique de se donner quelques r\u00e8gles de d\u00e9veloppements sans lesquels l’int\u00e9r\u00eat d’une int\u00e9gration continue est amoindrie:<\/p>\n
- La compilation doit \u00eatre automatis\u00e9 (ANT, MAVEN, …), aucune intervention humaine doit \u00eatre n\u00e9cessaire pour avoir une compilation r\u00e9ussie<\/li>\n\n
- Des commit r\u00e9gulier du code source doivent \u00eatre r\u00e9alis\u00e9 par l’\u00e9quipe<\/li>\n\n
- Des tests automatiques doivent pouvoir \u00eatre lanc\u00e9 (JUNIT et ANT ou MAVEN par exemple)<\/li>\n\n
- Un responsable doit recevoir les rapports et v\u00e9rifier que les personnes recevant les erreurs les corrigent. En d’autre terme, les r\u00e9sultat de l’int\u00e9gration continue doivent \u00eatre utilis\u00e9! L\u00e0, on arrive plus dans la gestion de projet.<\/li>\n<\/ul>\n
Pour aller plus loin, l’excellent article de Martin Flower(en anglais) : http:\/\/www.martinfowler.com\/articles\/continuousIntegration.html<\/a><\/a><\/p>\n
Continuons maintenant sur Cruise Control. En me basant sur quelques capture d’\u00e9cran, je vais faire le tours de ses fonctionnalit\u00e9s les plus courantes, sans trop aller dans le d\u00e9tails, l’application \u00e9tant tr\u00e8s compl\u00e8te. Pour aller plus loin, consultez donc son site web: http:\/\/cruisecontrol.sourceforge.net<\/a><\/a><\/p>\n\n
1. L’application de configuration<\/h3>\n
Lancez tout d’abord l’application de configuration de Cruise Control ( CruiseConfig) qui est une application Java Webstart, ce qui est fort pratique car vous pouvez alors la lancer depuis un ordinateur diff\u00e9rent de votre serveur d’int\u00e9gration. Vous obtenez alors cela:<\/p>\n
![\"Cruise](\"https:\/\/i0.wp.com\/loicmathieu.free.fr\/wordpress\/wp-content\/uploads\/cruise-control-01.jpg?w=640\")
\nCette application vous permet de monitorer les diff\u00e9rents projets d\u00e9finie et de les configurer en cliquant sur Server -> Configure Projects. C’est cette partie que nous allons voire plus en d\u00e9tail.<\/p>\n
2. Configuration d’un projet<\/h3>\n
La configuration des projets de Cruise Control se trouve dans le fichier config.xml qui est \u00e0 la racine du r\u00e9pertoire d’installation de Cruise Control. Son \u00e9criture est facilit\u00e9e par l’application de configuration CruiseConfig qui permet de d\u00e9finir via une interface utilisateur simple les diff\u00e9rentes parties de ce fichier XML.<\/p>\n
On voit dans cette capture d’\u00e9cran, l’interface de modification du config.xml qui liste les propri\u00e9t\u00e9 (possibilit\u00e9 de d\u00e9finir un fichier de propri\u00e9t\u00e9), les projets et les plugin (configuration par d\u00e9faut d’un plugin, par exemple pour configurer par d\u00e9faut ANT).<\/p>\n
![\"Cruise](\"https:\/\/i0.wp.com\/loicmathieu.free.fr\/wordpress\/wp-content\/uploads\/cruise-control-02.jpg?w=640\")
\nPour configurer un projet, le principe est le suivant:<\/p>\n
- modificationset <\/strong>: configurer le gestionnaire de source control pour pouvoir lister les changements depuis la derni\u00e8re compilation et mettre \u00e0 jour ses sources.<\/li>\n\n
- schedule <\/strong>: configurer les t\u00e2ches \u00e0 lancer tel que la compilation ou le lancement des tests (ANT, MAVEN)<\/li>\n\n
- log <\/strong>: configurer les fichiers de logs du projet. Cruise Control se base uniquement sur les fichiers de logs g\u00e9n\u00e9r\u00e9s lors de la compilation ou de l’ex\u00e9cution des tests.<\/li>\n\n
- publishers <\/strong>: permet de d\u00e9finir quoi faire apr\u00e8s une t\u00e2che (envoi de mails, copie de fichier, …)<\/li>\n\n
- listeners <\/strong>: permet de d\u00e9finir des \u00e9l\u00e9ments de contr\u00f4le du d\u00e9roulement des t\u00e2ches<\/li>\n<\/ul>\n
La premi\u00e8re page du projet permet de d\u00e9finir des \u00e9l\u00e9ments globaux tel que le nom du projet, la n\u00e9cessit\u00e9 d’avoir des modifications au sein du gestion de source avant de lancer une t\u00e2che, …<\/p>\n
Tout les \u00e9l\u00e9ments de configuration sont expliqu\u00e9 gr\u00e2ce \u00e0 un fichier d’aide HTML chang\u00e9 en dessous.<\/p>\n
2.1 modificationset de type clearcase<\/h4>\n
Je n’ai utilis\u00e9 que le modificationset de clearcase, donc c’est celui-ci dont je vais parler ici. Mais il en existe pour la plupart des type de gestionnaire de source du march\u00e9.<\/p>\n
Le principe est de d\u00e9finir le gestionnaire de source pour que cruise control puisse mettre \u00e0 jour ses sources (faire un update) et aussi savoir qui sont les contributeur des derni\u00e8res modifications, ces informations lui seront tr\u00e8s utile plus tard.<\/p>\n
![\"Cruise](\"https:\/\/i0.wp.com\/loicmathieu.free.fr\/wordpress\/wp-content\/uploads\/cruise-control-03.jpg?w=640\")
\nLes principales propri\u00e9t\u00e9 de configuration sont:<\/p>\n
- QuietPeriod <\/strong>: p\u00e9riode minimale en seconde d’inaction dans le gestionnaire de source avant de faire un update. Cela permet de ne pas faire d’update au milieu d’un checkin\/commit<\/li>\n\n
- ViewPath <\/strong>: chemin de la vue clearcase dans laquelle l’update se fait.<\/li>\n\n
- Branch <\/strong>: stream clearcase (si elle n’est pas pr\u00e9cis\u00e9, les modifications list\u00e9 par Cruise Control seront toutes stream!)<\/li>\n<\/ul>\n
2.2 schedule de type ant<\/h4>\n
Enfin, on entre dans le vif du sujet! Les t\u00e2ches \u00e0 effectuer. C’est ici que l’on d\u00e9finie ce que va faire Cruise Control. Pour cela, tout simplement on peut appeler p\u00e9riodiquement des scripts ANT ou MAVEN (d’autres sont disponible).<\/p>\n
Les possibilit\u00e9 d’appel sont divers: \u00e0 une heure pr\u00e9cise ou p\u00e9riodiquement (en seconde), on peut aussi d\u00e9finir des pauses ou des jours pr\u00e9cis, …<\/p>\n
Quelques propri\u00e9t\u00e9s sont d\u00e9finie au niveau global du schedule:<\/p>\n
- Interval <\/strong>: interval de la t\u00e2che (en seconde)<\/li>\n\n
- ShowInProgress <\/strong>: affichage d’une barre de progression si support\u00e9 par le plugin<\/li>\n<\/ul>\n
Pour faciliter la d\u00e9finition des taches dans les diff\u00e9rents projets, j’ai d\u00e9finit une configuration globale pour ANT, pour Cruise Control on appel cela d\u00e9finit une configuration d’un plugin (tout est plugin pour Cruise Control … et bien sur on peut d\u00e9finir les siens propre en plus de ceux par d\u00e9faut)<\/p>\n
![\"Cruise](\"https:\/\/i0.wp.com\/loicmathieu.free.fr\/wordpress\/wp-content\/uploads\/cruise-control-04.jpg?w=640\")
\nEnsuite, par projet, j’ai red\u00e9finit juste les propri\u00e9t\u00e9 qui m’int\u00e9ressaient<\/p>\n
![\"Cruise](\"https:\/\/i0.wp.com\/loicmathieu.free.fr\/wordpress\/wp-content\/uploads\/cruise-control-05.jpg?w=640\")
\nExplications des propri\u00e9t\u00e9s les plus utilis\u00e9es:<\/p>\n
- Taget<\/strong>: la target ANT appel\u00e9e.<\/li>\n\n
- SaveLogDir<\/strong>: le r\u00e9pertoire dans lequel est mis le log de ANT (remarquez ici l’utilisation d’une variable de CruiseControl: project.name).<\/li>\n\n
- AntHome<\/strong>: le r\u00e9pertoire d’installation de ANT.<\/li>\n\n
- UseLogger<\/strong>: ANT utilisera un Logger au lieu de la console (conseill\u00e9 pour des raisons de performance).<\/li>\n\n
- UseDebug<\/strong>: Si vous voulez lancer ANT en mode debug (attention aux performances!).<\/li>\n\n
- UseQuiet<\/strong>: L’inverse de UseDebug …<\/li>\n\n
- KeepGoing<\/strong>: Lance ant avec l’option -keep-going<\/li>\n\n
- Time<\/strong>: Permet de d\u00e9finir \u00e0 quelle heure le script est lanc\u00e9, dans ce cas l\u00e0, la propri\u00e9t\u00e9 Interval est ignor\u00e9e<\/li>\n<\/ul>\n
2.3 log<\/h4>\n
Cruise control d\u00e9finit un fichier de log XML unique pour chaque compilation de chaque projet.<\/p>\n
On peut ensuite configurer le r\u00e9pertoire o\u00f9 Cruise Controle placera ce fichier de log et optionnellement, des fichiers de logs ext\u00e9rieurs que nous voudrions merger \u00e0 ce fichier de log primaire (log ANT, JUNIT, …)<\/p>\n
![\"Cruise](\"https:\/\/i0.wp.com\/loicmathieu.free.fr\/wordpress\/wp-content\/uploads\/cruise-control-06.jpg?w=640\")
\nLe snapshot me semble \u00e9loquant sans explications :)<\/p>\n
L’application de reporting et le dashboard utilisent ce fichier de log XML pour pr\u00e9senter les donn\u00e9e d’une compilation. Il est d’ailleurs lui-m\u00eame accessible depuis ces applications.<\/p>\n
2.4 publishers<\/h4>\n
Un publisher permet, comme son nom l’indique de publier des donn\u00e9es en fin de compilation.\nJe vais ici \u00e9voquer deux publisher tr\u00e8s utile: l’arifact publisher et le l’htmlmail publisher<\/p>\n
2.4.1 artifact publisher<\/h5>\n
L’artifact publisher permet, en fin de compilation, de publier dans un repertoir pr\u00e9cis un fichier donn\u00e9. Il permet par exemple de copier le JAR g\u00e9n\u00e9r\u00e9 par ANT dans un r\u00e9pertoire donn\u00e9. Ce fichier artifact sera ensuite accessible depuis l’application de reporting et le dashboard.<\/p>\n
![\"Cruise](\"https:\/\/i0.wp.com\/loicmathieu.free.fr\/wordpress\/wp-content\/uploads\/cruise-control-07.jpg?w=640\")
\nLes principales propri\u00e9t\u00e9s sont:<\/p>\n
- File<\/strong>: le fichier \u00e0 exporter (il faut utiliser soit File, soit Dir)<\/li>\n\n
- Dir<\/strong>: le r\u00e9pertoire \u00e0 exporter (il faut utiliser soit File, soit Dir)<\/li>\n\n
- Dest<\/strong>: le r\u00e9pertoire de destination, Cruise control cr\u00e9era ensuite un sous r\u00e9pertoire par compilation et placera dedans le ou les fichiers \u00e0 exporter.<\/li>\n\n
- PublishOnFailure<\/strong>: si oui ou non la publication doit se faire en cas de failure de la compilation.<\/li>\n<\/ul>\n
2.4.2 htmlmail publisher<\/h5>\n
Le grand int\u00e9r\u00eat de Cruise Control r\u00e9side dans sa possibilit\u00e9 d’envoyer un mail automatique en fin de compilation. Ce mail pouvant se baser sur les utilisateurs ayant fait des modifications pour les informer qu’une compilation a \u00e9t\u00e9 faites contenant leurs changements et du r\u00e9sultat de la compilation. C’est sans doute la fonctionnalit\u00e9 la plus utilise de Cruise Control.<\/p>\n
Tout d’abord, pour \u00e9viter trop de configuration dans chaque tache mail de chaque projet, j’ai d\u00e9finit une configuration par d\u00e9faut du plugin de mail<\/p>\n
![\"Cruise](\"https:\/\/i0.wp.com\/loicmathieu.free.fr\/wordpress\/wp-content\/uploads\/cruise-control-08.jpg?w=640\")
\nLes principales propri\u00e9t\u00e9s sont:<\/p>\n
- MailHost<\/strong>: l’adresse du serveur SMTP<\/li>\n\n
- MailPort<\/strong>: le port du serveur SMTP si diff\u00e9rent du port par d\u00e9faut<\/li>\n\n
- ReturnAddress<\/strong>: l’adresse qui va envoyer le mail<\/li>\n\n
- DefaultSuffix<\/strong>: le suffixe qui permet de passer des utilisateurs du gestionnaire de source \u00e0 son adresse mail. Par exemple, si vos utilisateurs s’appellent ‘toto’ et ‘tata’ et que votre DefaultSuffix est ‘@mondomaine.com’, les emails seront envoy\u00e9 \u00e0 ‘toto@mondomaine.com’ et ‘tata@mondomaine.com’<\/li>\n<\/ul>\n
Ensuite on d\u00e9finit l’htmlemail du projet avec juste les propri\u00e9t\u00e9s manquantes<\/p>\n
![\"Cruise](\"https:\/\/i0.wp.com\/loicmathieu.free.fr\/wordpress\/wp-content\/uploads\/cruise-control-09.jpg?w=640\")
\nLes principales propri\u00e9t\u00e9s sont:<\/p>\n
- SubjectPrefix<\/strong>: Le prefix du sujet du mail. Cruise Control y ajoutera ensuite le num\u00e9ro de compilation et le statuts (success, failed, fixed – statuts donn\u00e9 pour une compilation r\u00e9ussie apr\u00e8s une compilation rat\u00e9e)<\/li>\n\n
- BuildResultUrl<\/strong>: L’URL mise en d\u00e9but de mail pour pouvoir consulter les r\u00e9sultats de la compilation.<\/li>\n<\/ul>\n
2.5 listeners<\/h4>\n
Permet de d\u00e9finir un listener (un ‘\u00e9couteur’, donc quelque chose qui \u00e9coute en temps r\u00e9\u00e9l) de la compilation. Utile pour suivre en temps r\u00e9\u00e9l la compilation.<\/p>\n
![\"Cruise](\"https:\/\/i0.wp.com\/loicmathieu.free.fr\/wordpress\/wp-content\/uploads\/cruise-control-10.jpg?w=640\")
\nIci, j’ai utilis\u00e9 un currentbuildstatuslistener qui se configure via la propri\u00e9t\u00e9 File <\/strong>qui d\u00e9finit le fichier dans lequel le statuts de la compilation est inscrit.<\/p>\n
3 Aller plus loin<\/h4>\n
Pour aller plus loin, le mieux est d’installer Cruise Control et de fouiller. Une fois familiariser avec sa configuration gr\u00e2ce \u00e0 ce tutoriel et \u00e0 l’aide contextuelle, configurer le reste est tr\u00e9s simple.<\/p>\n
Les fonctionnalit\u00e9s de Cruise Control sont tr\u00e9s compl\u00e8tes, quelques exemples de ce qui n’a pas \u00e9t\u00e9 abord\u00e9:<\/p>\n
- delete<\/strong>: cr\u00e9ation de tache de suppression des fichiers g\u00e9n\u00e9r\u00e9 par Cruise Control<\/li>\n\n
- pause<\/strong>: permet de d\u00e9finir des p\u00e9riode de pause dans la compilation(\u00e9viter de compiler toute la nuit par exemple)<\/li>\n\n
- always, onsuccess, onfailure<\/strong>: capacit\u00e9 \u00e9tendue d’envoi de mail<\/li>\n\n
- possibilit\u00e9 de mapper les utilisateurs du gestionnaire de source sur des adresse email via un fichier de propri\u00e9t\u00e9<\/li>\n\n
- …<\/li>\n<\/ul>\n
UPDATE <\/em><\/strong><\/strong><\/p>\n
J’ai \u00e9crit un article sur d\u00e9veloppez.com, inspir\u00e9 de celui-ci (et enrichi).\nhttp:\/\/loic-mathieu.developpez.com\/conception\/article\/cruise-control\/<\/a> <\/a><\/p>","protected":false},"excerpt":{"rendered":"
Derni\u00e8rement, j’ai essay\u00e9 un serveur d’int\u00e9gration continue : Cruise Control. Je vais donc vous en parler ici. Tout d’abord, qu’est-ce que l’int\u00e9gration continue: L’int\u00e9gration continue est une technique de d\u00e9veloppement\/management de projet qui implique d’int\u00e9grer tr\u00e8s fr\u00e9quemment le travail de tout les membres. Ensuite, une compilation automatique doit \u00eatre lanc\u00e9 pour v\u00e9rifier les \u00e9ventuelle erreurs de compilation du projet puis si possible les tests unitaires doivent aussi \u00eatre lanc\u00e9e. Concr\u00e8tement, l’int\u00e9gration continue est le fait d’automatiser des compilations fr\u00e9quentes du…
- pause<\/strong>: permet de d\u00e9finir des p\u00e9riode de pause dans la compilation(\u00e9viter de compiler toute la nuit par exemple)<\/li>\n\n
- BuildResultUrl<\/strong>: L’URL mise en d\u00e9but de mail pour pouvoir consulter les r\u00e9sultats de la compilation.<\/li>\n<\/ul>\n
- MailPort<\/strong>: le port du serveur SMTP si diff\u00e9rent du port par d\u00e9faut<\/li>\n\n
- Dir<\/strong>: le r\u00e9pertoire \u00e0 exporter (il faut utiliser soit File, soit Dir)<\/li>\n\n
- SaveLogDir<\/strong>: le r\u00e9pertoire dans lequel est mis le log de ANT (remarquez ici l’utilisation d’une variable de CruiseControl: project.name).<\/li>\n\n
- ShowInProgress <\/strong>: affichage d’une barre de progression si support\u00e9 par le plugin<\/li>\n<\/ul>\n
- ViewPath <\/strong>: chemin de la vue clearcase dans laquelle l’update se fait.<\/li>\n\n
- schedule <\/strong>: configurer les t\u00e2ches \u00e0 lancer tel que la compilation ou le lancement des tests (ANT, MAVEN)<\/li>\n\n
- modificationset <\/strong>: configurer le gestionnaire de source control pour pouvoir lister les changements depuis la derni\u00e8re compilation et mettre \u00e0 jour ses sources.<\/li>\n\n