Skip to content

Commit

Permalink
feat: add a few sample docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
n1k0 committed Sep 3, 2024
1 parent 9e71620 commit 583d696
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 4 deletions.
1 change: 1 addition & 0 deletions tech-docs/src/README.md
3 changes: 2 additions & 1 deletion tech-docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Summary

- [Chapter 1](./chapter_1.md)
- [README](./README.md)
- [Gestion des tests](./gestion-des-tests.md)
3 changes: 0 additions & 3 deletions tech-docs/src/chapter_1.md

This file was deleted.

1 change: 1 addition & 0 deletions tech-docs/src/format-de-données-lca-acv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Format de données LCA ACV
25 changes: 25 additions & 0 deletions tech-docs/src/gestion-des-tests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

> 💡 **Prérequis**
>
> Pour exécuter et régler les problèmes de tests en échec suite à la mise à jour d’impacts, il convient de disposer d’une installation locale du projet. Les instructions d’installation et de configuration sont décrites [dans le README sur le dépôt.](https://github.com/MTES-MCT/ecobalyse/blob/master/README.md)
</aside>

**Si suite à une mise à jour des impacts ou des coefficients de complément les tests échouent, voici la méthode pour régler la situation :**

- Depuis votre branche à jour en local et depuis un terminal, lancez `npm test`
- Vérifiez dans les rapports de tests si les échecs ou différences relevés sont attendus ou non
- Si les échecs **ne sont pas attendus**, réglez le problème et soumettez les modifications sur la branche afin que les tests passent à nouveau
- Si les échecs **sont attendus** — par exemple lorsque vous mettez à jour des impacts ou des compléments — et que vous vous souhaitez mettre à jour les tests afin de prendre en compte les nouvelles valeurs obtenues :
- Pour les tests unitaires, mettez à jour les valeurs en échecs directement dans les tests Elm (`tests/**/*Test.elm`)
- Pour les tests e2e (serveur), il faudra copier le ou les fichiers suivants, générés automatiquement à chaque lancement de la suite de tests via `npm test`:
- Pour le textile : `cp tests/e2e-textile-output.json tests/e2e-textile.json`
- Pour l’alimentaire : `cp tests/e2e-food-output.json tests/e2e-food.json`
- Une fois que les tests passent tous à nouveau, vous pouvez commiter et pousser les changements sur votre branche distante, le build de votre pull-request devrait revenir au vert et être déployé automatiquement en recette.💡C’est toujours une bonne idée d’aller sur la recette Web vérifier que tout fonctionne comme prévu.


> 💡 **Cas particulier de la détection d’évolutions inhabituelles d’impacts**
>
> Si vous obtenez des échecs sur les tests de type `Food ingredients ecoscore deviation`, il vous faut également vérifier si ces écarts sont attendus ou non.
>
> S’ils sont attendus, il vous faut commenter le test en question, merger votre branche dans master, puis pousser un commit sur master qui décommente le test à nouveau afin que le contrôle puisse être effectué sur les branches et pull-requests créées par la suite.

0 comments on commit 583d696

Please sign in to comment.