Débuter avec NAnt sous Visual Studio .NET - version VB.NET

Date de publication : 24/04/2005 , Date de mise a jour : 24/04/2005

Par Minosis (Homepage)
 

Cet article vous propose, à travers une installation pas à pas, de découvrir l'outil de compilation NAnt et de l'intégrer à Visual Studio .NET. Le code proposé est en VB.NET. Téléchargez la version pdf - Voir la version C#. Et après l'article : détente avec du sudoku.

Présentation

1. Installer NAnt sous Windows

Dans cette partie, nous allons rendre Nant utilisable via des lignes de commandes.

Rendez-vous sur http://nant.sourceforge.net/ et téléchargez la dernière version de Nant (0.85 RC3 au moment d'écrire cet article).
Décompressez l'archive récupérée dans le répertoire de votre choix. Nous supposerons que le répertoire de Nant choisi est "C:\Program Files\nant\"

Définissons le répertoire "nant\bin" dans la variable d'environnement "Path" du système afin que l'exécutable "Nant.exe" soit reconnu indépendamment de son répertoire d'installation.

Allez dans le panneau de configuration et ouvrez "Système" puis dans l'onglet "Avancé", cliquez sur le bouton "Variables d'environnement".

Dans la partie "Variables système", cherchez la variable "Path" et cliquez sur "Editer".
Dans la zone "Valeur de variable", ajouter (surtout ne rien supprimer), la chaîne suivante : ";C:\Program Files\nant\bin" à adapter selon le répertoire choisi à l'installation.
Validez ensuite les modifications.

Veillez à bien mettre un " ; " de séparation entre les différents chemins des variables d'environnement.

Ouvrez une console DOS
Tapez à l'invite DOS, la commande suivante : "nant -help"

Si la version de Nant apparaît avec des informations sur les commandes possibles, alors NAnt est bien installé.

2. Intégration à Visual Studio .NET

Copiez le fichier : "C:\Program Files\nant\schema\nant.xsd" dans le répertoire "C:\Program Files\Microsoft Visual Studio .NET 2003\Common7\Packages\schemas\xml\".

Vous devrez peut être adapter les chemins selon votre version de Nant et le répertoire d'installation de Visual Studio .NET. Cette copie permettra dans la partie 3 de permettre la complétion automatique lors de l'édition du fichier de script Nant.

Configurons Visual Studio pour exécuter Nant directement par son interface avec un icône ou un raccourci clavier.

Ouvrez Visual Studio
Choisissez dans la barre de menu : "Outils > Outils externes..."
Cliquez sur le bouton "Ajouter"
Indiquez les valeurs suivantes :
- Titre : Nant
- Commande : nant (il est important que l'étape 1 ait été bien réalisée, sinon indiquez le chemin de l'outil en entier)
- Répertoire initial : $(ProjectDir) (Répertoire du projet)
- Cochez uniquement "Fermer en quittant"
Mémorisez la position dans la liste "Contenu du menu" de la ligne que vous avez créée. Dans mon cas, c'est la 8ème.
Cliquez sur "OK". Si un message d'alerte apparaît vous proposant de modifier la commande apparaît, répondez "Non".

Associons NAnt à un raccourci clavier :

Allez dans "Outils > Personnaliser" et cliquez sur "Clavier..."
Sélectionnez la ligne Outils.CommandeExterne8
Associez à la ligne le raccourci clavier que vous souhaitez, "CTRL+F8" par exemple. Veillez à ne pas choisir un raccourci déjà pris et à cliquer sur le bouton "Assigner"
Si une alerte apparaît vous proposant de créez un nouveau schéma, répondez "Oui" et donnez lui le nom que vous souhaitez.

Associons NAnt à un bouton de la barre d'outils :

Retournez ou restez dans "Outils > Personnaliser"
Dans l'onglet "Barre d'outils", faites "Nouvelle..." et choisissez comme nom "Nant". Une petite zone de barre d'outil flottante devrait apparaître.
Allez dans l'onglet "Commandes", choisissez la catégorie "Outils"
Dans la zone "Commandes", glissez déposez dans la zone flottante la ligne "Commande externe 8"
Cliquez sur "Modifier la sélection > Nom" et donnez comme nom : "Nant Build". Choisissez un icône si vous le souhaitez.

Glissez déposez la zone flottante où vous le souhaitez dans la barre d'outils.
Cliquez sur Fermer dans la fenêtre "Personnaliser"

A ce stade, nous pouvons appeler Nant en appuyant sur "CTRL+F8" ou en cliquant su l'icône "Nant Build".
Créons maintenant notre premier script.

3. Premier script NAnt

Pour le premier projet, nous allons réaliser un simple HelloWorld en mode console et son script de build afin de comprendre les bases de NAnt.

Créez un nouveau projet Visual Basic du type "Application console" avec comme nom "MonHelloWorld"
Placez, dans la méthode Main() de Module1.vb, le code suivant et enregistrez :

Sub Main()
    System.Console.WriteLine("Hello World !")
    System.Console.ReadLine() 'Permet d'empêcher la fermeture de la fenêtre DOS
End Sub

Ajoutez, à partir de Visual Studio, un nouveau fichier texte à la racine du projet et appelez le "MonHelloWorld.build". L'extension du fichier est importante à respecter, le nom ne l'est pas.

A cette étape, le projet doit ressembler à ça :

Faites un clic droit sur le fichier MonHelloWord.build puis "Ouvrir avec..."
Choisissez "Editeur HTML/XML" et cliquez sur le bouton "Par défaut" puis "Ouvrir".
Tous les fichiers "*.build" seront donc ouvert automatiquement par l'éditeur xml intégré.

Dans le fichier MonHelloWorld.build, placez le contenu xml suivant :

<?xml version="1.0"?>
<project name="Mon Hello World" default="execute" basedir="." xmlns="http://nant.sf.net/release/0.85-rc3/nant.xsd">
    <description>Un Hello World pour tester NAnt.</description>
    <property name="debug" value="true" overwrite="false" />
    <property name="output" value="build" overwrite="false" />
    <property name="exename" value="Module1.exe" overwrite="false" />
    <target name="clean" description="Suppression du répertoire \build">
        <delete dir="${output}" failonerror="false" />
    </target>
    <target name="build" description="Compilation de la source" depends="clean">
		<mkdir dir="${output}" failonerror="false" />
        <vbc target="exe" output="${output}\${exename}" debug="${debug}">
            <sources>
                <include name="Module1.vb" />
            </sources>
        </vbc>
    </target>
    <target name="execute" description="Exécution du programme" depends="build">
		<exec program="${output}\${exename}" />
    </target>
</project>

La chaîne "http://nant.sf.net/release/0.85-rc3/nant.xsd" doit être adaptée selon votre version de nant. Vérifiez la concordance de cette valeur en la comparant avec la même chaîne dans le fichier "nant.xsd" manipulé précédemment.

<?xml version="1.0"?>
<project name="Mon Hello World" default="execute" basedir="." xmlns="http://nant.sf.net/schemas/nant-0.85.win32.net-1.0.xsd">
    <description>Un Hello World pour tester NAnt.</description>

<property name="debug" value="true" overwrite="false" />
<property name="output" value="build" overwrite="false" />
<property name="exename" value="Module1.exe" overwrite="false" />

<target name="clean" description="Suppression du répertoire \build">
    <delete dir="${output}" failonerror="false" />
</target>
<target name="build" description="Compilation de la source" depends="clean">
	<mkdir dir="${output}" failonerror="false" />
    <vbc target="exe" output="${output}\${exename}" debug="${debug}">
        <sources>
            <include name="Module1.vb" />
        </sources>
    </vbc>
</target>
<target name="execute" description="Exécution du programme" depends="build">
	<exec program="${output}\${exename}" />
</target>

3 tâches sont proposées ici, chaque tâche est définie par un noeud <target /> :
- clean : la suppression du répertoire de build
- build : la compilation des sources après avoir recréé le répertoire de build
- execute : on exécute le Module1.exe généré

Pour ordonner les tâches, placer les <target /> dans l'ordre d'exécution ne sert à rien. Il faut définir des dépendances : "execute" ne peut être lancé que si "build" est terminé et "build" ne peut être lancé que si "clean" est terminé. Les attributs "depends" dans les noeuds <target /> permettent d'imposer cette règle.
On comprend ainsi la raison de lancer " execute " en premier puisque lui-même appellera les tâches dont il dépend.

Pour finir, appuyez sur "CTRL+F8" ou sur l'icône "Nant Build" et vérifiez que tout fonctionne bien dans la fenêtre DOS qui se lance. Logiquement un répertoire "build" a dû être créé à la racine de votre projet (visible via l'explorateur windows).

			
<property name="backupdir" value="backup" overwrite="false" />
<target name="backup" description="Création de la sauvegarde">
	<mkdir dir="${backupdir}" unless="${directory::exists(backupdir)}" />
	<tstamp property="builddate" pattern="yyyyMMdd_HHmm" />
	<zip zipfile="${backupdir}\${builddate}_MonHelloWorld.zip">
		<fileset basedir=".">
			<include name="*.*" />
		</fileset>
	</zip>
</target>

Compléments

 http://nant.sourceforge.net/ : Site du projet NAnt.
 http://nantcontrib.sourceforge.net/ : Site du projet NAntContrib qui ajoute de nombreuses fonctionnalités à la version NAnt de base.
 http://nantrunner.sourceforge.net/ : Site de NAntRunner, un Addin pour Visual Studio .NET permettant d'utiliser NAnt efficacement.

 Téléchargez la version pdf de cet article.