BE Graphes - Mise en place

▸Objectifs

Récupérer le projet initial, le compiler.
Mettre en place un dépôt GIT pour votre projet, afin que l'on puisse suivre en permanence votre avancement.

Prérequis

▸Mémo GIT

Une présentation de GIT, by Mikaël Capelle (INSA IR 2014).

git clone "url": effectué une fois pour cloner le projet sur votre machine.
git pull --rebase: met à jour votre projet pour qu'il corresponde au dépôt git distant.
À effectuer régulièrement si vous travaillez en binôme et que votre binôme a avancé sur le projet (et fait commit et push).
git status: afficher l'état de l'archive locale. Indique s'il y a des fichiers à ajouter, un commit à effectuer, ...
git add fichier(s)ou git add chemin/*.java: pour ajouter de nouveaux fichiers ou nouveaux répertoires dans l'archive.
git add fichier(s)ou git add chemin/*.java (la même commande) : pour prendre en compte les modifications de ces fichiers ou répertoires.
git commit -m "Message explicatif": pour créer une nouvelle révision (à faire après les commandes add).
git push: pour envoyer les révisions sur le serveur git distant (à faire en général après la commande commit). Si l'URL de votre dépôt est en https, vous avez besoin d'un personal token à utiliser en guise de mot de passe.

Ressources GIT

Une introduction toute tranquille à git.
Un tutoriel sur git.
Un mémo assez complet.

Gitlab INSA

Quick start du gitlab insa

Vous avez déjà un compte sur un dépôt GIT accessible, par exemple gitlab insa, github, bitbucket.
Vous avez quelques notions de base concernant GIT (commandes add, commit, push, pull, ... )

▸Consignes

▸Initialisation de votre depôt git

Il s'agit de créer le dépôt GIT pour votre projet et de le peupler avec les fichiers java nécessaires au démarrage.
Suivez les consignes how to start? accessibles ici :
- Projet BE-Graphes (projet initial du BE, créé pour vous par Mikaël Capelle, INSA IR 2014).
- L'import dans GIT doit prendre moins d'une minute. S'il ne termine pas, annulez et recommencez.
Une URL correspond au dépôt de votre projet , par exemple git@github.com:lebotlan/begraphe2.git (dans github : Code -> Clone -> SSH -- il faut être connecté).
Afin de travailler sur votre machine perso ou sur votre compte insa :
- git clone votre-URL-ici

Pour vérifier si git est content :

git status (dans le dossier du projet) affiche

Sur la branche master
Votre branche est à jour avec 'origin/master'.
rien à valider, la copie de travail est propre

git remote -vaffiche les URLs de votre dépôt :

origin	https://github.com/lebotlan/graphoo.git (fetch)
origin	https://github.com/lebotlan/graphoo.git (push)

▸Utilisation de vscode

Placez vous dans le dossier be-graphes et lancez code .
Installez l'extension Java - vous n'avez pas besoin d'installer le JDK qui est déjà sur les machines de l'INSA.
"Explore your projects". Attendez un peu que tout compile.
Exécutez Run, choisissez MainWindow. Les cartes sont sur /mnt/commetud/3MIC... vérifiez que la carte choisie s'affiche.
Enfin, trouvez comment lancer les tests dans vscode. Beaucoup de tests échouent, c'est normal, c'est à vous de travailler.
(Optionel mais recommandé) Supprimer les warnings dus à la version de Java :
- Si vous examinez la liste des +50 warnings, certains concernent la version Java.
- Éditer le fichier pom.xml situé dans be-graphes. Modifiez la version de java <jdk.version>1.8</jdk.version> ; à l'INSA, c'est 1.11.

▸Import dans Eclipse (outdated -- si vous tenez absolument à utiliser Eclipse)

Utilisez un IDE de votre choix pour travailler sur votre projet.
Si vous utilisez Eclipse, voici les consignes pour créer le projet Java :
Lancez une première fois Eclipse : à l'INSA, eclipse-java (qui est installé dans /usr/local/insa/bin/).
Une version à peu près récente d'Eclipse se lance. Si c'est le premier lancement, il vous demande où installer le workspace.
Choisissez librement. Par défaut, il propose ~/eclipse-workspace.
Démarrez Eclipse : Launch et allez lire l'intégrale de Dostoïevski.
Fermez la Welcome window.
(menu)File → Import → Maven → Existing Maven Projects → Next
- Indiquez à Eclipse votre dossier de projet (celui où vous avez cloné votre projet git, vous suivez ?).
- Puis Finish.
Si tout se passe bien, vous observez les quatre packages be-graphes comme ceci :
Sinon, il faut ouvrir le Package explorer : Window → Show view → Package Explorer
(Optionel mais recommandé) Passer en vue « Working Set » :
- Cliquer sur la petite flèche à coté de « Package Explorer » > Top Level Elements > Working Sets.
- Comme un projet Maven contient plusieurs sous-modules, cela permet d'avoir une vue plus compacte.
(Optionel mais recommandé) Passer en vue hiérarchique :
- Cliquer sur la petite flèche à coté de « Package Explorer » > Package Presentation > Hierarchical.
- Ça permet d'avoir une vue hiérarchique des packages, ce qui est beaucoup plus commode !
Dépliez l'arborescence du projet. Il se compile tout seul, il ne doit pas y avoir d'erreur (uniquement des warnings).
Exécutez les tests : clic-droit sur be-graphes-model/src/testRun As Junit Test vous voyez les résultats des tests déjà écrits (dont la plupart échouent).
Éxécutez le programme principal : clic-droit sur be-graphes-guiRun as Java Application et choisissez de lancer MainWindow
Chargez une carte (elles sont disponibles dans /mnt/commetud/3eme Annee MIC/Graphes-et-Algorithmes/Maps). Pour naviguer sur le fond de carte plutôt que sur le dessin du graphe, activez le menu Graph → Redraw Map
(Optionel mais recommandé) Supprimer les warnings dus à la version de Java :
- Si vous examinez la liste des +50 warnings, certains concernent la version Java.
- Éditer le fichier pom.xml situé dans le sous-dossier be-graphes-all. Modifiez la version de java <jdk.version>1.8</jdk.version> ; à l'INSA, c'est 1.11.
- Clic-droit sur be-graphes-all (celui tout en haut) → Maven → Update Project. Puis patientez un peu et les warnings de version devraient disparaître.

Si vous exécutez le projet sur votre propre machine, vous devez copier les cartes chez vous.

Elles sont disponibles sur les machines INSA sur commetud : /mnt/commetud/3eme Annee MIC/Graphes-et-Algorithmes/Maps/
Ou directement sur le site typename de M. Capelle..

N'ajoutez surtout pas les cartes à votre projet GIT. Elles sont trop volumineuses.
.gitignore !

▸Bilan

Votre projet est accessible en permanence sur votre dépôt git.
Vous penserez systématiquement à le mettre à jour (git add, git commit, git push).
Votre projet compile, vous êtes prêt à démarrer.
Les tests Junit se lancent. La plupart échouent, car les algorithmes ne sont pas encore codés.