CSC 4509 – Algorithmique et communications des applications réparties

Portail informatique

Création et utilisation du projet GitLabEns

  • Formation des binômes.
  • Création de votre projet GitLabEns et configurations pour le développement.

Installations et configurations pour l'utilisation du projet Maven et pour l'utilisation de GitLabEns

Ce sont les mêmes installations que pour le module CSC4102 et le début du module CSC4509 :

  • JAVA, Maven, Eclipse, SpotBugs, Checkstyle, etc. : cf. page des installations et configurations du module CSC4102 ;
  • nous utilisons des assertions JAVA dans notre code, par exemple avec l'instruction « assert invariant(); ». Nous proposons donc d'activer l'utilisation des assertions dans les tests JUnit : dans Eclipse, menu Window > Preferences > JAVA > JUnit puis cochez la case « Add '-ea' to VM arguments when creating a new JUnit launch configuration » (l'option « ea » de la machine virtuelle JAVA signifie « enable assertions ») ;
  • GitLabEns, chemin de confiance, etc. : cf. énoncé de l'Étape 2 du TP de la séance 1 du module CSC4102.

Création du projet GitLabEns

cette étape est effectuée uniquement par l'un des membres du binôme. Celui-ci ajoute le second membre du binôme au projet après la création.

Voici l'URL du projet GitLabEns, notez le « https » : https://gitlabens.imtbs-tsp.eu/enseignants.csc4509/csc4509-tchat.

Vous vous connectez à la plateforme en utilisant l'authentification Shibboleth repérée par le bouton Shibboleth en bas à droite.

Créez vôtre projet csc4509-tchat par copie avec le bouton Fork. Une fois votre projet créé, configurez-le en suivant les liens Settings et Members :

  • rendez votre projet « privé » en suivant les liens Settings > General, puis expand à la section Visibility, project features, permissions, et ensuite, mettez l'attribut Project Visibility à Private. Le non-respect de cette règle revient à vous exposer aux mesures du paragraphe « Fraude » du règlement de scolarité ;
  • ajoutez votre binôme en tant que Owner et les enseignants du module en tant que Maintainer (au cas où nous ayons besoin d'intervenir dans la branche main) ;
  • pour recevoir les courriels suite aux push (fonctionnalité email on push), sélectionnez la page Settings/Integrations, cochez la case Push events et parcourez la liste des services disponibles pour sélectionner Emails on push. Dans la page ouverte, cochez les cases Active, Push, Tag push et Send from committer, puis ajoutez les adresses courriels de tous les membres du projet dans le formulaire Recipients. N'oubliez pas de cliquez sur Save changes à la fin.
    • Nous (enseignants) demandons à recevoir ces courriels. Par conséquent, ajoutez au moins nos adresses courriels.

Transmettez par courriel aux enseignants l'URL de votre projet GitLabEns ainsi que les nom et prénom des membres du binôme.

Vérification du dépôt du projet

Si ce n'est pas déjà fait, récupérez le dépôt Git de votre projet avec la commande git clone.

Déplacez-vous dans le répertoire du projet et construisez l'application avec la commande « mvn clean install site ».

Adaptez les sources pour le démarrage du projet :

  • dans le fichier pom.xml, remplacez les informations avec les noms et prénoms de chacun des membres du binôme ;
  • reconstruisez l'application avec ces nouvelles informations en exécutant la commande « mvn clean install » ;
  • créez un nouvel instantané du projet en enchaînant les commandes « git status », « git add pom.xml », puis « git commit -m "infos binome" » et ensuite « git push origin main ». Vérifiez que chacun a reçu un courriel pour ce nouvel instantané et que l'intégration continue s'est bien déroulée (dans le site Web de GitLabEns, sélectionnez le projet, puis la page Repository, et ensuite la page Commits). La commande exécutée en intégration continue est contenue dans le fichier .gitlab-ci.yml.

Chargez votre projet dans votre environnement de développement, ici Eclipse :

  • dans Eclipse, utilisez le menu File / Import / Maven / Existing Maven Projects / Next pour ouvrir l'assistant de création de projet Maven. Puis, Browse et recherche du répertoire de votre projet, etc. ;
  • sélectionnez le projet et exécutez la commande mvn install : dans le menu contextuel, Run as, etc. Vous devez voir dans la console Eclipse les résultats de la compilation et de l'exécution des tests JUnit (classes de tests TestScenarioStartingFramework, TestScenarioStartingFrameworkWithInterceptorsOnClientSide, TestPointToPointMessage, et TestVectorClock.java) ;
  • vérifiez l'utilisation de l'outil SpotBugs avec le menu contextuel (bouton droit) SpotBugs / Find Bugs. SpotBugs ne doit pas détecter de problème ;
  • enfin, vérifiez l'utilisation de l'outil Checkstyle. Choisissez la configuration préparée pour le module CSC4102 (cf. l'étape sur la qualité du code). Pour exécuter l'analyse du code par Checkstyle, c'est le menu contextuel Checkstyle / Activate Checkstyle. Checkstyle ne doit pas détecter de problème.

Pendant le développement, analysez régulièrement votre code avec SpotBugs et avec Checkstyle (ou rendez les deux greffons toujours actifs). Par ailleurs, la commande de l'intégration continue exécute les greffons Maven de SpotBugs et Checkstyle (cf. fichier .gitlab-ci.yml).