Aller au contenu

Code source wiki de Accueil Hypercerts

Version 31.1 par Matthieu Manginot le 23/07/2020 - 10:29
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 Enfin, la property app.mails sert à définir une ou plusieurs adresses permettant de recevoir les mails applicatifs. ⚠ Aujourd'hui tous les envois sont en copie de cette property.
132
133 ==== WebServices Apogée ====
134
135 {{status colour="Yellow" title="TODO"/}}
136
137 === Configurer et lancer le projet dans Eclipse ===
138
139 * Importer le projet Maven dans eclipse.
140 * 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'.
141
142 === Customisation des services ===
143
144 Plusieurs services sont personnalisables en fonction de votre environnement.
145
146 Sous //fr.univlorraine.hypercerts.apogee.service.customs// :
147
148 * ApogeeUserServiceCustomExample
149 ** Personnalisation de la récupération des adresses mails des utilisateurs Apogée à partir de l'uid LDAP
150 * BlocageServiceCustomExample
151 ** Personnalisation de la récupération des blocages/interdits à partir d'un code étudiant Apogée
152 * ComposanteServiceCustomExample
153 ** Personnalisation de la récupération :
154 *** de toutes les composantes
155 *** des composantes pour un utilisateur à partir de l'uid LDAP
156 *** du nombre de composantes pour un utilisateur à partir de l'uid LDAP
157
158 {{status colour="Yellow" title="TODO"/}}
159
160 === Customisation de Digiposte ===
161
162 //Documentation à venir.//
163
164 === Tâches Maven ===
165
166 * Lancer l'application (hors d'un IDE) :
167
168 {{code language="bash" theme="Eclipse"}}
169 mvn spring-boot:run
170 {{/code}}
171
172 * Lancer les tests :
173
174 {{code language="bash" theme="Eclipse"}}
175 mvn verify
176 {{/code}}
177
178 * Créer le package pour production :
179
180 {{code language="bash" theme="Eclipse"}}
181 mvn clean package -Pproduction
182 {{/code}}
183
184 === Makefile ===
185
186 Un Makefile est également disponible. A la racine, utilisez `make help` pour obtenir les commandes disponibles.
187
188 == Tests unitaires ==
189
190 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
191
192 {{status colour="Red" title="FONCTIONNEMENT A PRECISER"/}}
193
194 == Utilisation d'Hypercerts ==
195
196 {{status colour="Yellow" title="TODO"/}}
197
198 \\
199
200 {{section}}
201 {{column width="60%"}}
202 {{recently-updated/}}
203 {{/column}}
204
205 {{column width="5%"}}
206 \\
207 {{/column}}
208
209 {{column width="35%"}}
210 ====== Navigate space ======
211
212 {{locationSearch reference="WebHome"/}}
213
214 {{pagetree/}}
215 {{/column}}
216 {{/section}}