Projet de Programmation Benoit Donnet Année Académique

Transcription

1 Projet de Programmation Benoit Donnet Année Académique Agenda Partie 2: Outils Chapitre 1: Compilation Chapitre 2: Librairie Chapitre 3: Tests Chapitre 4: Documentation Chapitre 5: Débogage Chapitre 6: Analyse de Performance Chapitre 7: Gestion des Versions 2

2 Agenda Chapitre 7: Gestion des Versions - Introduction - Partage d un Même Fichier - Concepts du SCM - SVN - git-hub 3 Agenda Chapitre 7: Gestion des Versions - Introduction Témoignages Utilité d un SCM Principe de Base - Partage d un Même Fichier - Concepts du SCM - SVN - git-hub 4

3 Témoignages C est pas de chance - mon projet est sur mon portable qui est tombé - c est mon binôme qui a le projet sur son portable il est malade - mon projet fonctionnait bien et j ai essayé d implémenter une autre fonction et plus rien ne fonctionne 5 Témoignages (2) Travailler à plusieurs, c est pas facile on s échange le projet par mail/dropbox et on travaille à tour de rôle dessus. On avance pas vite pour que ça compile, j ai dû écraser les modifications faites par mon binôme maintenant, il est fâché on a travaillé chacun dans notre coin et on arrive pas à fusionner notre travail rien ne fonctionne à la fin 6

4 1. Travailler à plusieurs Utilité fichier brol.c #include "brol.h" void foo(){ int x; //du code }//fin foo() programmeur programmeur programmeur 7 Utilité (2) 2. Garder un historique 3. Savoir répondre aux questions - qui a modifié ce fichier? - qui a écrit cette ligne? - quelle était la version précédente de ce fichier? - quels fichiers avait-on le 31 janvier 2015? 8

5 Principe de Base et copie locale fichier brol.c #include "brol.h" Serveur (repository) Réseau Lecture void foo(){ int x; //du code }//fin foo() Ecriture #include "brol.h" Copie locale void foo(){ int x; //du code }//fin foo() fichier brol.c programmeur 9 Agenda Chapitre 7: Gestion des Versions - Introduction - Partage d un Même Fichier Problème Solution Simple Copie-Modification-Fusion - Concepts du SCM - SVN - git-hub 10

6 Problème A lecture lecture A A 11 Problème (2) A ' 12

7 Problème (3) écriture ' 13 Problème (4) ' écriture ' 14

8 Solution Simple lecture A A 15 Solution Simple (2) A lecture 16

9 Solution Simple (3) A écriture 17 Solution Simple (4) lecture 18

10 Solution Simple (5) Solution simple à mettre en oeuvre Mais - si verrouille le fichier et l'oublie, restera bloqué - deux utilisateurs ne peuvent pas modifier, en même temps, des endroits différents d'un gros fichier 19 Solution Simple (6) Il faut trouver une autre solution - copie-modification-fusion - pas de verrou persistant 20

11 C-M-F A lecture lecture A A 21 C-M-F (2) A ' 22

12 C-M-F (3) écriture ' 23 C-M-F (4) Erreur: version pas à jour écriture ' 24

13 C-M-F (5) lecture ' + 25 C-M-F (6) A* écriture A* 26

14 C-M-F (7) La fusion automatique est possible si - il s'agit d'un fichier texte - et les modifications sont à des endroits éloignés quelques lignes Unité de suivi - le fichier - aucun problème si les fichiers modifiés sont différents 27 Agenda Chapitre 7: Gestion des Versions - Introduction - Partage d un Même Fichier - Concepts du SCM Vocabulaire Opérations Importantes SCM Centralisé SCM Distribué - SVN - git-hub 28

15 Objets de base? - fichier(s) - dossier(s) Points clés? Vocabulaire - fusion +/- automatique possible pour les fichiers texte code source LaTeX HTML - analyse ligne par ligne - espaces pris en compte attention à la ré-indentation - renommage/copie explicite ou implicite 29 Vocabulaire (2) Etat d'un projet - ensemble de fichiers/dossiers constituant le projet pour une personne à un moment donné - un état peut être sauvé dans le SCM ou pas Patch ou diff - ensemble de modifications entre un état et un autre 30

16 Commit Vocabulaire (3) - état associé à plusieurs méta-données Author personne ayant créé les modifications AuthorDate date de création des modifications Parent(s) commit(s) précédent(s) dans l'historique des versions du projet Message description des modifications Les SCMs stockent souvent un diff par rapport au (premier) commit parent plutôt que l'état complet du projet - mais avec les méta-données 31 Vocabulaire (4) Working directory - état du projet en cours de travail - peut correspondre ou non à un commit - dérive d'un ou plusieurs commit(s) Branche - ensemble de commits partant d'un état initial vide et conduisant au commit final/courant de cette branche - une branche est généralement nommée Historique du - ensemble de branches généralement non disjointes i.e., avec des commits appartenant à plusieurs branches - généralement non manipulable directement 32

17 Opérations Importantes checkout - transfert d'un état de l'historique dans le répertoire de travail commit - enregistrement de l'état courant du répertoire de travail dans un nouveau commit merge - fusion (automatique ou manuelle) de l'état d'une branche et de l'état courant (fusion locale) ou de l'état de deux branches (fusion de branches) clone - duplication d'un historique (souvent associé à un checkout de la branche principale) 33 Opérations Importantes (2) push - envoi des commits d'un historique local dans un historique distant fetch - récupération des commits d'un historique distant dans l'historique local pull - fetch + merge log - affichage de l'historique status - affichage de la situation des fichiers dans l'état courant (modifié, effacé, ) 34

18 SCM Centralisé Un seul dépôt mais plusieurs répertoires de travail Opérations importantes - checkout - commit - merge (local et branches) Exemples - CVS - SVN - Perforce 35 SCM Distribué Chaque répertoire de travail contient aussi l'historique Opérations importantes - checkout - commit - merge (local et branches) - clone - push - fetch Exemples - git-hub - mercurial - bazaar - 36

19 Agenda Chapitre 7: Gestion des Versions - Introduction - Partage d un Même Fichier - Concepts du SCM - SVN Présentation Commandes Gestion Exemple Résolution des Conflits - git-hub 37 Présentation Le dépôt - contient toutes les versions (révisions) de tous les fichiers - n'est jamais manipulé directement sauf pour le créer éventuellement changer les permissions - est stocké sous forme non manipulable directement - toute révision est associée à un auteur commentaire 38

20 Présentation (2) Copie de travail - une (au moins) par utilisateur - contient une révision particulière du dépôt avec (éventuellement) des modifications locales - la commande svn permet de la manipuler 39 Commandes Création d'un nouveau dépôt - svnadmin create Création d'un nouveau répertoire/projet - svn import 40

21 Commandes (2) Lire tout un projet - svn checkout Lire/mettre à jour depuis le dépôt - svn update Ecrire/modifier le dépôt (nouvelle révision) - svn commit -m "mon message" Etat de la copie locale - svn status 41 Commandes (3) Ajouter un fichier - svn add <fichier(s)> Enlever un fichier - svn delete Déplacer un fichier - svn move <fichier(s)> <destination> Obtenir de l'aide sur cmd - svn help cmd 42

22 Gestion Comment bien gérer le dépôt? Un seul dépôt pour plusieurs projets - des répertoires différents pour chaque projet - URL pour désigner le bon projet file:///chemin/complet/dépôt svn+ssh://login@host/chemin/complet/dépôt svn://host/chemin/relatif/au/serveur Manipulations directes - création svnadmin create repertoire - permissions qui a le droit d'écrire dans ce dépôt peut se faire grâce aux clés publiques/privées 43 Gestion (2) Création d'un projet dans le dépôt - à utiliser une seule fois par projet Commande obligatoire pour expliquer ce qui arrive dans le dépôt $>svn import -m "commentaires" répertoire URL le répertoire local (existant) à importer URL du dépôt 44

23 Gestion (3) Récupération d'une copie locale d'un projet existant - à utiliser une seule fois par copie locale Commande URL du dépôt $>svn checkout URL [répertoire] répertoire dans lequel sera créé la copie locale 45 Gestion (4) Mise à jour de la copie locale - à utiliser souvent Commande met à jour ce fichier (uniquement) $>svn update [fichier répertoire] met à jour ce répertoire 46

24 Gestion (5) Ecriture des modifications locales - à utiliser souvent - crée une nouvelle révision dans le dépôt Commande $>svn commit -m "commentaires" obligatoire pour expliquer ce qui arrive dans le dépôt 47 Gestion (6) Etat de la copie locale - svn status [fichier répertoire] Différence entre l'état actuel et la révision du dépôt - svn diff [fichier répertoire] Ajout d'un fichier/répertoire - svn add fichier répertoire Suppression d'un fichier/répertoire - svn delete fichier répertoire 48

25 Gestion (7) Création d'un nouveau répertoire - svn mkdir répertoire Liste des révisions avec commentaires - svn log [fichier répertoire] Renommer un fichier/répertoire - svn move [fichier répertoire] [fichier répertoire] Copie d'un fichier avec son historique - svn copy fichier fichier 49 Exemple lecture A lecture A A [alice@laptop ~/projet]$>svn update U sources/compteur.c U sources/personnage.c U sources/essai.c U images/fond.png Updated to revision 124. [alice@laptop ~/projet]$> 50

26 Exemple (2) A ' [alice@laptop ~/projet]$>gedit *.c & [alice@laptop ~/projet]$> [bob@portable ~/projet]$>gedit *.c & [bob@portable ~/projet]$> 51 Exemple (3) A ' [alice@laptop ~/projet]$>svn status? sources/outilson.c M sources/personnage.c M sources/essai.c [alice@laptop ~/projet]$> 52

27 Exemple (4) écriture ' ~/projet]$>svn commit -m "bug fix: " Sending sources/personnage.c Sending sources/essai.c Transmitting file data Committed version 125. ~/projet]$> 53 Exemple (5) écriture ' ~/projet]$>svn commit -m "mon bug " Sending sources/essai.c svn: Commit failed (details follow): svn: Out of date: 'sources/essai.c' in transaction ' ' ~/projet]$> 54

28 Exemple (6) lecture '+ ~/projet]$>svn update C sources/essai.c G sources/personnage.c Updated to revision 125. [bob@portable ~/projet]$> 55 Exemple (7) A* [bob@portable ~/projet]$>gedit sources/essai.c & [bob@portable ~/projet]$>svn resolved sources/essai.c Resolved conflicted state of 'sources/essai.c' [bob@portable ~/projet]$> 56

29 Exemple (8) A* écriture A* ~/projet]$>svn commit -m "mon bug " Sending sources/essai.c Sending sources/compteur.c Transmitting file data Committed version 126. ~/projet]$> 57 Exemple (9) lecture A* A* A* ~/projet]$>svn update U sources/compteur.c U sources/essai.c Updated to revision 126. [alice@laptop ~/projet]$> 58

30 Résolution Conflits Fichier avec conflit: essai.c #include <stdlib.h> typedef struct{ <<<<<<<.mine int taillexyz; ======= int tailleabc; >>>>>>>.r125 int *tab; }essai; 59 Résolution Conflits (2) 3 fichiers sont créés - essai.c.r124 version avant mes modifications - essai.c.r125 version actuelle du dépôt - essai.c.mine ma version (avant fusion) 60

31 Résolution Conflits (3) 3 étapes pour résoudre (manuellement) un conflit 1. éditer le fichier essai.c et rectifier l'erreur 2. effacer les 3 fichiers créés manuellement ou svn resolved fichier 3. committer 61 Agenda Chapitre 7: Gestion des Versions - Introduction - Partage d un Même Fichier - Concepts du SCM - SVN - git-hub Installation et Configuration git-hub en Local git-hub à Distance Organisation 62

32 Installation/Configuration Site principal sources/binaires pour diverses plate-formes - documentation officielle Il existe - des paquets debian/ubuntu - un plugin pour eclipse 63 Installation/Configuration (2) Invocation - git subcommand [options/arguments ] Il existe plusieurs centaines de sous-commandes Il existe des outils graphiques - git gui 64

33 Installation/Configuration (3) Configuration initiale - s'identifier pour les commits [alice@laptop ~]$>git config --global user.name "" [alice@laptop ~]$>git config --global user.mail "alice@mail.com" 65 En Local Idée - gérer son système de versions en local, sur sa machine - pas de serveur distant 1 ère étape - Création d'un historique [alice@laptop ~]$>mkdir projet [alice@laptop ~]$>cd projet [alice@laptop ~/projet]$>git init 66

34 En Local (2) La création de l'historique crée un sousrépertoire.git dans lequel on trouve - tout l'historique.git/objects/ - un fichier de configuration.git/config - les branches existantes.git/refs/ 67 En Local (3) 2 ème étape - Création de commits Le plus simple reste de passer par l'interface graphique - sélectionner les fichiers à inclure dans le commit - mettre un message pertinent - créer le commit 68

35 En Local (4) 69 Visualisation de l'historique - gitk --all En Local (5) 70

36 A Distance L'historique est stocké sur un serveur distant Comment récupérer un historique existant? - git clone URL Plusieurs protocoles sont autorisés - git - http - ssh git://server-git.domain.com/path/projet.git protocole le plus efficace nécessite un serveur dédié ssh://serveur-ssh.domain.com.path/projet.git 71 A Distance (2) Nécessite la création d'un serveur git-hub est la plateforme la plus connue gratuit mais alors le projet est public - payant et le projet peut être privé 72

37 A Distance (3) Comment créer le serveur? 1. git clone --bare projet projet.git crée l'historique projet.git (sans répertoire de travail) 2. copier projet.git sur le serveur ssh ou web 3. git --bare update-server-info chmod a+x hooks/post-update prépare le serveur à servir correctement les fichier Test en clonant le nouveau dépôt - git clone 73 A Distance (4) Envoyer des commits - à faire souvent Commande $>git push nom branche_locale:branche_distante doit être associé à une URL permettant d'envoyer des commits 74

38 Organisation Il faut choisir une infrastructure pour permettre la communication Deux possibilités - un serveur par personne chacun a son serveur HTTP où il publie autorisation en écriture uniquement pour lui chacun récupère les commits depuis tous les autres serveurs - un serveur centralisé il faut gérer les problèmes de permission d'écriture commune dans le dépôt utiliser des branches séparées pour chaque fonctionnalité 75