ScoDoc/tests/api
2024-05-25 13:03:51 +02:00
..
__init__.py
dotenv_exemple
dump_all_results.py Script API pour enregistrer tous les résultats. 2024-05-25 13:03:51 +02:00
essai_tous_semestres.py
exemple-api-basic.py Remplace variable 'format' par 'fmt' dans toutes les fonctions et URLs (sauf routes API documentées) 2023-09-21 10:20:19 +02:00
exemple-api-list-modules.py typo 2024-01-22 13:18:54 +01:00
exemple-api-scodoc7.py Remplace variable 'format' par 'fmt' dans toutes les fonctions et URLs (sauf routes API documentées) 2023-09-21 10:20:19 +02:00
make_samples.py Configuration: éditeur de rôles et permissions 2023-09-29 21:17:31 +02:00
README.md
setup_test_api.py Restreint accès aux bulletins PDF si formsemestre.bul_hide_xml (sémantique changée) + WIP tests unitaires API 2024-03-19 18:22:02 +01:00
start_api_server.sh
test_api_assiduites.py Assiduites : ajout test unitaire countCalculator + maj autres tests 2024-01-05 13:42:55 +01:00
test_api_billets.py
test_api_departements.py
test_api_etudiants.py Améliore/met à jour tests unitaires API 2024-04-11 06:00:00 +02:00
test_api_evaluations.py API evaluation: create avec poids, /delete + tests unitaires + corrections 2023-08-26 16:34:56 +02:00
test_api_formations.py
test_api_formsemestre_data.py
test_api_formsemestre.py Améliore/met à jour tests unitaires API 2024-04-11 06:00:00 +02:00
test_api_jury.py
test_api_justificatif2.txt
test_api_justificatif.txt
test_api_justificatifs.py Assiduité : ajout test api manquant closes #689 2024-03-01 12:56:00 +01:00
test_api_logos.py
test_api_partitions.py API: group_set_edt_id. +cosmetic 2023-12-29 02:48:23 +01:00
test_api_permissions.py Fix: assiduite unit tests 2023-12-06 20:57:24 +01:00
test_api_users.py API: enrichit création/édition User 2023-11-21 22:28:50 +01:00
test_test.py
tools_test_api.py RGPD: ViewEtudData. Implements #842 2024-01-20 17:37:24 +01:00

Tests unitaires de l'API ScoDoc

Lancement des tests

La première fois, copier le fichier tests/api/dotenv_exemple vers tests/api/.env. Il est normalement inutile de modifier son contenu.

Dans un shell, lancer le script start_api_server.py, qui se charge d'initialiser une base SQL de test et de lancer le serveur ScoDoc approprié.

tests/api/start_api_server.sh

Dans un autre shell, lancer les tests:

pytest tests/api

Notes sur la démarche

  1. On génère une base SQL de test: voir tools/fakedatabase/create_test_api_database.py

    1. En tant qu'utilisateur scodoc, lancer:
    # evite de modifier /opt/scodoc/.env
    export FLASK_ENV=test_api
    export FLASK_DEBUG=1 
    tools/create_database.sh --drop SCODOC_TEST_API
    flask db upgrade
    flask sco-db-init --erase
    flask init-test-database
    

    en plus court:

    export FLASK_ENV=test_api && tools/create_database.sh --drop SCODOC_TEST_API && flask db upgrade &&flask sco-db-init --erase && flask init-test-database
    
  2. On lance le serveur ScoDoc sur cette base

    flask run --host 0.0.0.0
    
  3. On lance les tests unitaires API

    pytest tests/api/test_api_departements.py

Rappel: pour interroger l'API, il fait avoir un utilisateur avec (au moins) la permission ScoView dans tous les départements. Pour en créer un:

 flask user-create lecteur_api LecteurAPI @all
 flask user-password lecteur_api
 flask edit-role LecteurAPI -a ScoView
 flask user-role lecteur_api -a LecteurAPI