V2.1 Tests fonctionnels
1 Contexte scientifique
[cf. milestone V1] Le workflow d'analyse de données métagénomique WGS Illumina créé dans le cadre du projet AntiSelfish. Il a également été et sera utilisé dans d'autres projets d'analyse.
2 Description de la demande
Pour améliorer la robustesse du code : implémentation de tests fonctionnels à chaque étape du workflow. De plus, sont nécessaires un refactoring, une revue de la doc et potentiellement un refactoring de celle-ci. À voir à l'usage.
3 Organisation
3.1 Planning
De Juin à mi-Octobre 2021 : développement d'un script permettant à l'utilisateur de fournir un script de lancement du workflow, de le lancer et de tester les résultats en les comparant à une référence composée de résultats attendus. Lui sera fourni en sortie un log comportant mention de toutes les fonctions testées et les résultats des tests ayant échoué. Création d'une documentation précisant l'utilisation du script de test fonctionnel. Refactoring du workflow, aidé par l'utilisation des tests fonctionnels. Mise à jour de la documentation du workflow.
3.2 Personnes
Implémentation : Pierre
Tests et revue du code : Céline & Claire
4 Critères de validation
Test du script de tests fonctionnels, documentation et fichiers expected : Céline & Claire
5 Bilans et modifications du planning et des ressources
5.1 Point d'étape du 16 septembre 2021
Le script functional tests, permettant de tester le workflow, est opérationnel. Il reste :
- formattage des sorties à finaliser
- validation de la documentation des tests
- validation de tous les fichiers expected
- mise à jour de la documentation du workflow metagwgs à finaliser. Quelque refactoring également.
Revoir la manière de lister les issues pour V2.2
5.2 Point d'étape du 27 septembre 2021
Tag 2.1:
- Multiple refactoring actions on metagwgs main script
- Rename some output files and reorganize output directories: i.e: assembly step
- Add mosdepth for contigs depth count + add mosdepth singularity image recipe
- Add taxonomy_dir parameter to use already downloaded taxonomy database
- Add functional tests script to test the pipeline output on reviewed results after functional modifications + add README
- Update documentation for metagwgs
- Change config for test_genotoul_workq parameters
- Change metaspades and megahit to unique assembly process
Il reste :
- formattage des sorties à finaliser
- validation de la documentation des tests
- validation de tous les fichiers expected
- mise à jour de la documentation du workflow metagwgs à finaliser. Quelque refactoring également.
Pas de ressources supplémentaires nécessaires
5.2 Point d'étape du 14 octobre 2021
- Claire a validé tous les fichiers expected le 14 octobre 2021. Nous avons doublé un échantillon pour avoir des clusters avec plusieurs gènes car nous n'avions pas ce cas dans les précédents jeux de tests.
5.2 Point d'étape du 18 octobre 2021
- Transfert du refactoring sur la release 2.2, passage en DSL2
- Formattage des sorties validé
- Documentations metagWGS et tests fonctionnels à valider
5.3 Point d'étape du 2 novembre 2021
- Documentations metagWGS et tests fonctionnels validées