From feb31e48f592356ebb1b3de47a39f32f369514e5 Mon Sep 17 00:00:00 2001 From: Thomas Rubini <74205383+ThomasRubini@users.noreply.github.com> Date: Tue, 7 Jun 2022 22:25:44 +0200 Subject: [PATCH] Un peu de documentation --- src/main/java/fr/univ_amu/iut/DataMain.java | 5 ++++- src/main/java/fr/univ_amu/iut/Launcher.java | 5 +++++ .../univ_amu/iut/dao/factory/DAOFactoryProducer.java | 2 +- .../java/fr/univ_amu/iut/secret/SecretProvider.java | 6 ++++++ src/main/java/module-info.java | 2 +- src/test/java/fr/univ_amu/iut/BackendTest.java | 11 +++++++++++ 6 files changed, 28 insertions(+), 3 deletions(-) diff --git a/src/main/java/fr/univ_amu/iut/DataMain.java b/src/main/java/fr/univ_amu/iut/DataMain.java index d51ca1c..50886c7 100644 --- a/src/main/java/fr/univ_amu/iut/DataMain.java +++ b/src/main/java/fr/univ_amu/iut/DataMain.java @@ -12,7 +12,10 @@ import fr.univ_amu.iut.model.*; public class DataMain { - // A executer une seule fois, pour populate la base de données + /* + Code utilitaire que nous avons utilisé pendant le développement de l'application, afin de remplir la base de donnée + **SUPPRIMER LES TABLES DE LA BASE DE DONNEES AVANT D'EXECUTER** + */ public static void main(String[] args) { DAOFactory daoFactory = DAOFactoryProducer.getFactory(DAOType.JPA); diff --git a/src/main/java/fr/univ_amu/iut/Launcher.java b/src/main/java/fr/univ_amu/iut/Launcher.java index c6c7065..1d0fa2a 100644 --- a/src/main/java/fr/univ_amu/iut/Launcher.java +++ b/src/main/java/fr/univ_amu/iut/Launcher.java @@ -1,6 +1,11 @@ package fr.univ_amu.iut; public class Launcher { + + /* + Déployer l'application au travers d'un fichier .jar exécutable nous demandait + une classe main sans extends (sans lien avec JavaFX) + */ public static void main(String[] args) throws Exception { AppMain.main(args); } diff --git a/src/main/java/fr/univ_amu/iut/dao/factory/DAOFactoryProducer.java b/src/main/java/fr/univ_amu/iut/dao/factory/DAOFactoryProducer.java index 55e2252..7d2dbc5 100644 --- a/src/main/java/fr/univ_amu/iut/dao/factory/DAOFactoryProducer.java +++ b/src/main/java/fr/univ_amu/iut/dao/factory/DAOFactoryProducer.java @@ -1,7 +1,7 @@ package fr.univ_amu.iut.dao.factory; import fr.univ_amu.iut.dao.jpa.DAOFactoryJPA; -import fr.univ_amu.iut.test.DAOFactoryTest; +import fr.univ_amu.iut.dao.test.DAOFactoryTest; public class DAOFactoryProducer { public static DAOFactory getFactory(DAOType type) { diff --git a/src/main/java/fr/univ_amu/iut/secret/SecretProvider.java b/src/main/java/fr/univ_amu/iut/secret/SecretProvider.java index 630e1e0..0d0bcdd 100644 --- a/src/main/java/fr/univ_amu/iut/secret/SecretProvider.java +++ b/src/main/java/fr/univ_amu/iut/secret/SecretProvider.java @@ -1,5 +1,11 @@ package fr.univ_amu.iut.secret; + +/* +SecretProvider : API permettant de vérifier si le mot de passe entré est le bon +Nous avons fait une interface afin de pouvoir créer facilement d'autres implémentations dans le futur +(comme par exemple une implémentation faisant une requête web pour vérifier le mot de passe auprès d'un serveur) + */ public interface SecretProvider { static SecretProvider getInstance(){ diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java index 9028ea3..e2754f0 100644 --- a/src/main/java/module-info.java +++ b/src/main/java/module-info.java @@ -17,5 +17,5 @@ open module francefx { exports fr.univ_amu.iut; exports fr.univ_amu.iut.dao; exports fr.univ_amu.iut.dao.factory; - exports fr.univ_amu.iut.test; + exports fr.univ_amu.iut.dao.test; } \ No newline at end of file diff --git a/src/test/java/fr/univ_amu/iut/BackendTest.java b/src/test/java/fr/univ_amu/iut/BackendTest.java index 4a65f06..469b8fa 100644 --- a/src/test/java/fr/univ_amu/iut/BackendTest.java +++ b/src/test/java/fr/univ_amu/iut/BackendTest.java @@ -11,6 +11,13 @@ import org.junit.jupiter.api.Test; import static org.assertj.core.api.Assertions.assertThat; +/* +Tests unitaires servants à tester le backend JPA de l'application +On utilise un JPA modifié (une persistenceUnit différente) +afin de faire une base de données en mémoire* +*/ + + public class BackendTest { private static DAOFactory daoFactory; @@ -110,6 +117,10 @@ public class BackendTest { assertThat(list.get(0).getNom()).isEqualTo("Second usage"); } + /* + On essaye d'insérer la même donnée de nouveau (2 fois pour être sûr, + après tout les tests sont faits pour vérifier que l'application est robuste) + */ @Test public void should_not_insert_again(){ daoFactory.createDAOThematique().insert(Thematique.ExpressionOrale);