Utilisation de SVN. 1 Introduction. 2 Architecture. 3 Références et aide en ligne

Transcription

1 N7 1IMA TECHNOLOGIE OBJET TP 3 18/02/2015 (Séance TP 2) Objectifs : Comprendre le principe d un outil de gestion de configuration Savoir utiliser SVN (subversion) 1 Introduction Pour travailler en groupe sur un projet, le besoin d un outil de partage de fichiers se fait assez vite sentir. Ce que l on recherche, c est un moyen de : mettre en commun un ensemble de fichiers sur une machine distante, pouvoir obtenir une copie de l ensemble des fichiers du projet, pouvoir mettre à jour la version partagée à partir d une version locale, pouvoir mettre à jour une version locale à partir d une version partagée, gérer les inévitables conflits, mémoriser les modifications pour pouvoir revenir sur des versions précédentes. L outil que nous allons étudier réalise toutes ces tâches. Il s agit de SVN (Subversion). De nombreux autres produits similaires existent, que ce soit dans le domaine open source (CVS, arch, git...) ou dans le domaine commercial (clearcase). Le principe de SVN est de stocker non seulement les fichiers, mais également les modifications faites entre deux versions d un même fichier. SVN permet alors à tout moment de reconstruire une version particulière d un fichier. 2 Architecture SVN offre une architecture centralisée (pour une architecture répartie, on s intéressera à git, arch, etc.). Tous les fichiers d un projet vont donc reposer dans un endroit unique, appelé dépôt ou repository en anglais. Chaque dépôt SVN peut abriter plusieurs modules. Un module peut correspondre à un projet, ou bien à une sous-partie d un projet, suivant la granularité choisie. Une fois un dépôt construit, il faut s y connecter pour l utiliser. Toutes les commandes svn sont accessibles à partir du seul exécutable éponyme. 3 Références et aide en ligne Le site de Subversion : Le livre en ligne sur Subversion : TP 3 1/8

2 L aide fournie par le client svn : La commande svn help pour avoir une aide générale à propos de svn ; La commande svn help commit pour avoir de l aide à propos de la sous-commande commit. Bien entendu, cela fonctionne avec toutes les sous-commandes de svn. 4 Utilisation de base Nous allons passer en revue les différentes commandes de SVN. Chaque commande SVN est de la forme : $> svn [<options>...] <commande> [<options commande>...] [<noms fichiers>...] Pour obtenir de la documentation : $> svn help $> svn help commit 4.1 Cycle de développement Pour un des développeurs du projet, la vision est la suivante : il crée une version locale du projet à partir du dépôt (commande svn checkout). Ensuite, il va utiliser ses outils habituels pour modifier les fichiers de la version locale. Périodiquement, il va synchroniser sa copie locale avec le dépôt, pour récupérer les modifications faites par les autres développeurs (commande svn update). Et enfin, il va reverser ses modifications dans le dépôt (commande svn commit). Dans la version locale, un répertoire SVN contient les informations sur les fichiers locaux ainsi que sur le dépôt. Par défaut, un fichier ou un répertoire nouveau créé dans la copie locale n est pas suivi par SVN. Pour cela, il faut explicitement utiliser la commande svn add. En résumé, on sort d abord les fichiers du dépôt pour les mettre dans un répertoire local, on les modifie, puis on les remet dans le dépôt. 4.2 Création de la copie locale Pour commencer à travailler, la première opération est de créer une copie locale des fichiers d un projet stocké dans un dépôt SVN. Pour cela, on utilise la commande svn checkout. Cette commande peut s abréger en svn co. Le seul argument nécessaire est le nom du module (ici le module correspond à un répertoire et son contenu) que l on souhaite charger. Un répertoire local est alors créé, portant le nom du module et contenant tous les fichiers de ce module. $> svn checkout svn+ssh://cregut.svn.enseeiht.fr/2012/1ima/tob/svn/$user Si ceci ne marche pas, on peut utiliser (moins sûr) : $> svn checkout TP 3 2/8

3 Cette commande consulte le répertoire /2012/1IN/TOB/SVN/XXX (vous pouvez utiliser $USER ou utiliser votre login) sur la machine et crée une copie locale dans le répertoire courant. Créer la copie locale de votre dépôt et s y déplacer. 4.3 Ajouter un document au pot commun Pour rajouter une nouvelle ressource à la gestion SVN, il faut d abord créer un fichier (par exemple avec un éditeur de texte ou avec la commande touch). Ensuite, il faut spécifier explicitement que cette ressource doit être ajoutée à la copie SVN locale. Pour cela : $> svn add Toto.java Cette commande ajoute le fichier Toto.java à la copie locale. Il ne sera ajouté au dépôt qu à la prochaine validation (svn commit). Pour les répertoires, les commandes à utiliser sont les mêmes. Attention : tout le contenu du répertoire est ajouté, il faut donc commencer par le nettoyer (les fichiers qui peuvent être engendrés ne sont normalement pas mis sur le SVN). Faites attention, quand vous ajoutez un fichier ou un répertoire dans le SVN, assurez vous que toute l arborescence parente menant à cette ressource a également été rajoutée au SVN. Ajouter un fichier Compteur.java et un répertoire tmp, contenant un fichier tmp.txt. 4.4 Mise à jour de la copie locale La copie locale dérive avec le temps de la version centralisée sur le serveur. Pour incorporer les modifications de la version commune dans la version locale, il faut utiliser la commande svn update : $> svn update La commande svn update est assez bavarde. Nous reviendrons dans la suite sur la signification des messages. 4.5 Modification du dépôt Vous pouvez modifier les fichiers de la copie locale avec vos outils habituels. Quand vous voudrez incorporer vos modifications au dépôt, il suffira d utiliser la commande svn commit. $> svn update $> svn commit Toto.java -m "Modification du fichier Toto.java" TP 3 3/8

4 Avant d utiliser la commande svn commit, il faut impérativement mettre sa copie locale à jour avec les modifications faites par les autres membres du projet, en utilisant la commande svn update. Cette commande va permettre de détecter les éventuels conflits entre vos modifications et celles des autres développeurs. Nous traiterons de la gestion des conflits un peu plus tard et supposons pour le moment que tout se passe bien. dépôt : Modifier le fichier Compteur.java avec le contenu suivant, et le mettre à jour sur le 4.6 Changer le nom d un répertoire ou d un fichier La gestion d un projet de grande ampleur vous amènera parfois à modifier le nom d un fichier ou d un répertoire. Tout comme l ajout de nouveaux fichiers, il est nécessaire de spécifier ces changements à l espace de travail. Cela s effectue à l aide de la commande svn move. Notez que les modifications ne seront pas visibles par les autres utilisateurs tant que vous ne les envoyez pas avec svn commit. $> svn move Toto.java Titi.java $> svn commit Toto.java Titi.java -m "Changement de Toto.java en Titi.java" Il est également possible de fait svn commit -m Changement de Toto.java en Titi.java" Sans préciser le nom du fichier à mettre à jour sur le dépôt, tous les fichiers seront alors commités. Changer le nom du fichier tmp.txt en tmp2.txt 4.7 Enlever un document du pot commun L opération de suppression se fait de façon similaire au renomage. D abord il faut informer SVN de cette suppression, puis il faut l envoyer avec svn commit. $> svn remove Toto.java $> svn commit Toto.java -m "Suppression de Toto.java" La commande svn remove est récursive, ce qui permet de marquer pour la suppression toute une arborescence. Dans le cas du move et du remove, lorsqu un autre utilisateur fera un update, les fichiers qui n existent plus dans le dépôt seront supprimés de sa copie locale. Supprimer votre fichier tmp2.txt. TP 3 4/8

5 4.8 Consulter l historique Le dépôt garde une trace de tous les changements propagés, et vous permet d explorer cet historique en examinant des versions précédentes des fichiers et répertoires ainsi que les métadonnées qui les accompagnent. svn log fournit un grand nombre d informations : commentaires d historique avec les dates et les auteurs attachés aux révisions ainsi que les éléments qui ont été modifiés à chaque révision. Regarder l historique des log de votre dépôt. 5 Signification des messages de SVN Avant de s intéresser à la gestion des conflits, regardons un peu plus la sortie de la commande svn update. Pour utiliser un format allégé, vous pouvez rajouter l option -q à la commande. U fichier : la copie locale du fichier a été mise à jour? fichier : fichier existant dans la copie locale mais pas dans le dépôt, et non géré par SVN. Typiquement des fichiers créés localement et qui n ont pas été ajoutés grâce à svn add. A fichier : l ajout de ce fichier au dépôt a été enregistré. M fichier : vous avez modifié ce fichier localement. SVN a pu incorporer les modifications provenant du dépôt sans générer de conflit. R fichier : la suppression de ce fichier du dépôt a été enregistrée. C fichier : vous avez modifié ce fichier localement. SVN a incorporé les modifications provenant du dépôt, mais elles rentrent en conflit avec les vôtres. A tout moment, la commande svn status fichier permet de connaître l état d un fichier. 6 Gestion des conflits Qu est-ce qu un conflit? SVN se repère à l intérieur des fichiers textes par les numéros de ligne. Si deux modifications ont été faites sur le même fichier par deux sources différentes, alors il peut y avoir conflit. Nous allons voir les différents types de conflits et comment les résoudre. Pour la suite du TP, vous allez créer une seconde copie locale de votre dépôt. Créer un répertoire copie2 dans le répertoire /tmp de votre machine et récupérer le dépôt. 6.1 Résolution automatique de conflits Dans certains cas, SVN est en mesure de résoudre automatiquement les conflits. Suivez les étapes suivantes : 1. Dans le répertoire initial, dans le fichier Compteur.java ajouter un attribut cpt et un constructeur qui l initialisera à 0. TP 3 5/8

6 private int cpt; public Compteur(){ cpt = 0; > svn commit Compteur.java -m "Ajout: attribut cptr et constructeur" 2. Puis dans la seconde copie ajouter une méthode getvaleur(). public int getvaleur(){ return cpt; > svn commit Compteur.java -m "Ajout de la méthode getvaleur()" Le commit de la seconde modification ne se déroule pas normalement. En effet, ici les modifications ont été faites sur le même fichier. Lorsque le second commit est réalisé, SVN signale qu il n est pas à jour et refuse l opération. Il faut faire un update sur la seconde copie (regarder le contenu du fichier Compteur.java) avant de faire le commit. Comme les modifications ont été faites dans des portions distinctes du fichier, SVN arrive à fusionner les différents changements. Le conflit a été résolu automatiquement. 3. Faire update sur les deux copies. Le contenu du fichier doit être : private int cpt; public Compteur(){ cpt = 0; public int getvaleur(){ return cpt; 6.2 Résolution manuelle de conflits Certains conflits ne peuvent pas être résolus automatiquement. SVN vous les signalera, et ce sera à vous de les résoudre. Nous voulons maintenant initialiser la valeur du compteur à 1 dans la copie initiale et -1 dans la deuxième copie. 1. Dans la copie initiale initialiser le compteur à 1 et commiter le fichier. TP 3 6/8

7 2. Dans la seconde copie initialiser le compteur à -1 et commiter le fichier. Comme précédemment, les modifications ont été faites sur le même fichier donc il y a un conflit et SVN veut que la version locale soit mise à jour. 3. Faire un update sur la seconde copie. Ici, les modifications ont été apportées sur les mêmes portions du fichier donc SVN ne peut pas résoudre le conflit. Le fichier a été modifié par SVN et l utilisateur doit donc l éditer pour résoudre le conflit. Ci-après le fichier modifié par SVN mentionnant les lignes posant problème : private int cpt; public Compteur(){ <<<<<<<.mine cpt = -1; ======= cpt = 1; >>>>>>>.r32931 public int getvaleur(){ return cpt; Les conflits sont délimités par les lignes : <<<<<<<.mine cpt = -1; ======= cpt = 1; >>>>>>>.r32931.mine est la modification faite sur la seconde copie et.r32931 est la modification en provenance du dépôt correspondant à la version du fichier commité sur la copie initiale. La résolution manuelle du conflit se fait en 3 étapes : (a) Sur la seconde copie, il faut modifier le fichier à la main et supprimer les lignes ajoutées par SVN et celles posant problème. (b) Il faut signaler localement que le conflit a été résolu en utilisant la commande svn resolved Compteur.java (c) Enfin il peut rendre sa modification effective (commit). 4. Faire un update sur la copie initiale pour voir le résultat. 7 Mais aussi... SVN permet également de : créer des branches de travail ; TP 3 7/8

8 récupérer l état du dépôt à une date donnée ; récupérer une version spécifique du projet ; annuler une modification ;... TP 3 8/8