Aller au contenu

Code source wiki de Accueil Hypercerts

Version 29.1 par Matthieu Manginot le 23/07/2020 - 10:11
Afficher les derniers auteurs
1
2
3 {{toc/}}
4
5 Vous cherchez à délivrer aux étudiants de votre université des attestations de réussite dématérialisées ? Hypercerts vous permettera de générer et envoyer des attestations officielles, numériques, et infalsifiable de façon automatique.
6
7 Ces dernières pourront être envoyées par mail, déposées dans le nuage, et même être certifiées authentiques et intègres grâce à une blockchain dédiée.
8
9 Une fois l'application connectée à Apogée et au LDAP, les gestionnaires de composantes pourront demander la génération et l'envoi des attestations de réussite en un clic.
10
11 {{info}}
12 La version 1.0.x est une première version limitée à l'envoi des attestations par email. Bien que le cœur de l'application soit fonctionnel, les dépôts de documents dans les coffres digisposte et la certification cryptographique sont en cours de dévelopement actif.
13 {{/info}}
14
15 == Prérequis ==
16
17 Hypercerts est une application Java qui se connecte à Apogée et au LDAP. Elle requiert l'utilisation d'une base MariaDB pour son fonctionnement interne. Elle se déploie sur des serveurs comme une application SpringBoot classique. Le WAR pourra être pris en charge par un tomcat et servir les utilisateur•ices via l'URL configuré.
18
19 |=(((
20 Technologie
21 )))|=(((
22 Version
23 )))
24 |(((
25 JDK
26 )))|(((
27 11+
28 )))
29 |(% colspan="1" %)(((
30 SpringBoot
31 )))|(% colspan="1" %)(((
32 2.3
33 )))
34 |(% colspan="1" %)(((
35 Vaadin (Frontend)
36 )))|(% colspan="1" %)(((
37 14
38 )))
39 |(((
40 Tomcat
41 )))|(((
42 9+
43 )))
44 |(% colspan="1" %)(((
45 MariaDB
46 )))|(% colspan="1" %)(((
47 14+
48 )))
49 |(% colspan="1" %)(((
50 Maven
51 )))|(% colspan="1" %)(((
52 3.6+
53 )))
54 |(% colspan="1" %)(((
55 Connection Apogée
56 )))|(% colspan="1" %)(((
57 \\
58 )))
59 |(% colspan="1" %)(((
60 Connection Apogée via WS
61 )))|(% colspan="1" %)(((
62 \\
63 )))
64 |(% colspan="1" %)(((
65 Connection LDAP
66 )))|(% colspan="1" %)(((
67 \\
68 )))
69 |(% colspan="1" %)(((
70 Docker (optionnel)
71 )))|(% colspan="1" %)(((
72 docker-compose 3
73 )))
74
75 == Téléchargement des sources ==
76
77 Provisoirement, les sources de l'application peuvent être téléchargées à [[cet endroit>>url:http://download-sig.univ-lorraine.fr/home/download-sig/public/hypercerts||shape="rect"]].
78
79 == Installation d'Hypercerts ==
80
81 === **Initialisation de la base** ===
82
83 La base de données MariaDB/MySQL s'initialise avec la commande Flyway suivante :
84
85 {{code language="bash" theme="Eclipse"}}
86 mvn -Dflyway.configFiles=flyway.properties flyway:migrate
87 {{/code}}
88
89 Le fichier flyway.properties doit être créé à partir du fichier exemple flyway-sample.properties. Il contient les properties standard à Flyway.
90
91 {{code language="bash" theme="Eclipse" linenumbers="true" collapse="true"}}
92 # Flyway
93 # ConfigFiles : https://flywaydb.org/documentation/configfiles
94 # mvn -Dflyway.configFiles=xxx.properties flyway:migrate
95 flyway.url=jdbc:mariadb://localhost/hypercerts?serverTimezone=Europe/Paris
96 flyway.schemas=hypercerts
97 flyway.user=XXX
98 flyway.password=
99 # Emplacement des fichiers sql de migration
100 flyway.locations=classpath:db/migration
101 # baselineOnMigrate
102 flyway.baselineOnMigrate=false
103 {{/code}}
104
105 Au besoin, les fichiers sql de migration peuvent être trouvés sous //src/main/resources/db/migration//.
106
107 === Configuration l'application ===
108
109 Créer et compléter un fichier **application.yaml** à la racine du projet sur le modèle de **application-sample.yaml**
110
111 Des indications sont présents dans le fichier pour aider à sa configuration.
112
113 === **Éléments de configuration important ** ===
114
115 ==== Property (% style="letter-spacing: -0.003em;" %)//app.production//(%%) ====
116
117 Pour les tests, mettre **app.production** à false pour obtenir une année supplémentaire (N-2) pour la génération, ainsi des diplômes avec résultats seront plus facilement trouvables.
118
119 En étant à false, cette property autorise également l'interception de tout les mails applicatifs.
120
121 ==== **Envoi de mail** ====
122
123 (% style="color: rgb(0,51,102);" %)__**Sur votre environnement de test/développement**, pour empêcher l'envoi de mails de test en réel, il est conseillé :__
124
125 * d'utiliser un mail catcher ([[https:~~/~~/mailcatcher.me/>>url:https://mailcatcher.me/||shape="rect"]]) en remplacement de votre smtp
126 * ou de configurer l'application pour intercepter tout les mails applicatifs avec ces valeurs :
127 ** **app.production** à false
128 ** **spring.mail.intercept.active** à true
129 ** et **spring.mail.intercept.mails** contenant une ou plusieurs adresses de réception des mails
130
131 ==== WebServices Apogée ====
132
133 {{status colour="Yellow" title="TODO"/}}
134
135 === Configurer et lancer le projet dans Eclipse ===
136
137 * Importer le projet Maven dans eclipse.
138 * Lorsque la configuration est terminée, démarrer l'application en faisant un clic droit sur {{code language="none"}}fr.univlorraine.hypercerts.Application.java{{/code}} et en choisissant 'Run As / Java Application'.
139
140 === Customisation des services ===
141
142 Plusieurs services sont personnalisables en fonction de votre environnement.
143
144 Sous //fr.univlorraine.hypercerts.apogee.service.customs// :
145
146 * ApogeeUserServiceCustomExample
147 ** Personnalisation de la récupération des adresses mails des utilisateurs Apogée à partir de l'uid LDAP
148 * BlocageServiceCustomExample
149 ** Personnalisation de la récupération des blocages/interdits à partir d'un code étudiant Apogée
150 * ComposanteServiceCustomExample
151 ** Personnalisation de la récupération :
152 *** de toutes les composantes
153 *** des composantes pour un utilisateur à partir de l'uid LDAP
154 *** du nombre de composantes pour un utilisateur à partir de l'uid LDAP
155
156 {{status colour="Yellow" title="TODO"/}}
157
158 === Customisation de Digiposte ===
159
160 //Documentation à venir.//
161
162 === Tâches Maven ===
163
164 * Lancer l'application (hors d'un IDE) :
165
166 {{code language="bash" theme="Eclipse"}}
167 mvn spring-boot:run
168 {{/code}}
169
170 * Lancer les tests :
171
172 {{code language="bash" theme="Eclipse"}}
173 mvn verify
174 {{/code}}
175
176 * Créer le package pour production :
177
178 {{code language="bash" theme="Eclipse"}}
179 mvn clean package -Pproduction
180 {{/code}}
181
182 === Makefile ===
183
184 Un Makefile est également disponible. A la racine, utilisez `make help` pour obtenir les commandes disponibles.
185
186 == Tests unitaires ==
187
188 Pour s'assurez que les résultats d'admission de vos étudiants soient bien correct, et afin d'éviter les faux positifs (donc envoyer une attestation de réussite à un•e étudiant•e non reçu•e aux examens), vous pouvez ajouter vos jeux de données
189
190 {{status colour="Red" title="FONCTIONNEMENT A PRECISER"/}}
191
192 \\
193
194 {{section}}
195 {{column width="60%"}}
196 {{recently-updated/}}
197 {{/column}}
198
199 {{column width="5%"}}
200 \\
201 {{/column}}
202
203 {{column width="35%"}}
204 ====== Navigate space ======
205
206 {{locationSearch reference="WebHome"/}}
207
208 {{pagetree/}}
209 {{/column}}
210 {{/section}}