DocScoDoc/tests/api/exemple-api-basic.py

294 lines
7.5 KiB
Python
Raw Normal View History

#!/usr/bin/env python3
# -*- mode: python -*-
# -*- coding: utf-8 -*-
"""Exemple utilisation API ScoDoc 9 avec jeton obtenu par basic authentication
2022-08-10 10:49:58 +02:00
Usage:
cd /opt/scodoc/tests/api
python -i exemple-api-basic.py
2022-08-10 10:51:40 +02:00
Pour utiliser l'API, (sur une base quelconque):
2022-08-10 10:49:58 +02:00
```
cd /opt/scodoc/tests/api
2022-08-10 10:51:40 +02:00
python -i exemple-api-basic.p
2022-08-10 10:49:58 +02:00
>>> admin_h = get_auth_headers("admin", "xxx")
>>> GET("/etudiant/etudid/14806", headers=admin_h)
```
2022-08-10 10:51:40 +02:00
Créer éventuellement un fichier `.env` dans /opt/scodoc/tests/api
avec la config du client API:
```
SCODOC_URL = "http://localhost:5000/"
API_USER = "admin"
API_PASSWORD = "test"
```
"""
from pprint import pprint as pp
2022-08-10 10:49:58 +02:00
import urllib3
from setup_test_api import (
API_PASSWORD,
API_URL,
API_USER,
APIError,
CHECK_CERTIFICATE,
get_auth_headers,
GET,
POST_JSON,
SCODOC_URL,
)
if not CHECK_CERTIFICATE:
urllib3.disable_warnings()
print(f"SCODOC_URL={SCODOC_URL}")
2022-05-03 13:35:17 +02:00
print(f"API URL={API_URL}")
2022-08-10 10:49:58 +02:00
HEADERS = get_auth_headers(API_USER, API_PASSWORD)
2022-08-10 10:49:58 +02:00
departements = GET("/departements", headers=HEADERS)
pp(departements)
2022-05-03 13:35:17 +02:00
# Liste de tous les étudiants en cours (de tous les depts)
2022-08-10 10:49:58 +02:00
etuds = GET("/etudiants/courants", headers=HEADERS)
print(f"{len(etuds)} étudiants courants")
2022-08-10 10:49:58 +02:00
raise Exception("arret en mode interactif")
2022-05-03 13:35:17 +02:00
2022-08-10 15:21:47 +02:00
# ---------------- DIVERS ESSAIS EN MODE INTERACTIF
# ---------------- A ADAPTER A VOS BESOINS
2022-05-03 13:35:17 +02:00
# Bulletin d'un BUT
2022-07-06 00:05:14 +02:00
formsemestre_id = 1063 # A adapter
etudid = 16450
2022-08-10 15:21:47 +02:00
bul = GET(
f"/etudiant/etudid/{etudid}/formsemestre/{formsemestre_id}/bulletin",
headers=HEADERS,
)
2022-05-03 13:35:17 +02:00
# d'un DUT
2022-07-06 00:05:14 +02:00
formsemestre_id = 1062 # A adapter
etudid = 16309
2022-08-10 15:21:47 +02:00
bul_dut = GET(
f"/etudiant/etudid/{etudid}/formsemestre/{formsemestre_id}/bulletin",
headers=HEADERS,
)
2022-05-11 00:59:51 +02:00
# Infos sur un étudiant
etudid = 3561
code_nip = "11303314"
2022-08-10 15:21:47 +02:00
etud = GET(f"/etudiant/etudid/{etudid}", headers=HEADERS)
2022-05-11 00:59:51 +02:00
print(etud)
2022-08-10 15:21:47 +02:00
etud = GET(f"/etudiant/nip/{code_nip}", headers=HEADERS)
2022-05-11 00:59:51 +02:00
print(etud)
2022-08-10 15:21:47 +02:00
sems = GET(f"/etudiant/etudid/{etudid}/formsemestres", headers=HEADERS)
2022-05-11 00:59:51 +02:00
print("\n".join([s["titre_num"] for s in sems]))
2022-08-10 15:21:47 +02:00
sems = GET(f"/etudiant/nip/{code_nip}/formsemestres", headers=HEADERS)
2022-05-11 00:59:51 +02:00
print("\n".join([s["titre_num"] for s in sems]))
# Evaluation
evals = GET("/evaluations/1")
2022-05-11 00:59:51 +02:00
2022-07-20 16:12:20 +02:00
# Partitions d'un BUT
formsemestre_id = 1063 # A adapter
2022-08-10 15:21:47 +02:00
partitions = GET(f"/formsemestre/{formsemestre_id}/partitions", headers=HEADERS)
2022-07-20 16:12:20 +02:00
print(partitions)
pid = partitions[1]["id"]
2022-08-10 15:21:47 +02:00
partition = GET(f"/partition/{pid}", headers=HEADERS)
2022-07-20 16:12:20 +02:00
print(partition)
group_id = partition["groups"][0]["id"]
2022-08-10 15:21:47 +02:00
etuds = GET(f"/group/{group_id}/etudiants", headers=HEADERS)
2022-07-20 16:12:20 +02:00
print(f"{len(etuds)} étudiants")
pp(etuds[1])
2022-08-10 15:21:47 +02:00
etuds_dem = GET(f"/group/{group_id}/etudiants/query?etat=D", headers=HEADERS)
2022-07-20 16:12:20 +02:00
print(f"{len(etuds_dem)} étudiants")
etudid = 16650
group_id = 5315
2022-08-10 15:21:47 +02:00
POST(f"/group/{group_id}/set_etudiant/{etudid}", headers=HEADERS)
2022-07-20 16:12:20 +02:00
2022-07-20 22:03:29 +02:00
2022-08-10 15:21:47 +02:00
POST_JSON(
f"/partition/{pid}/group/create", data={"group_name": "Omega10"}, headers=HEADERS
)
partitions = GET(f"/formsemestre/{formsemestre_id}/partitions", headers=HEADERS)
2022-07-20 22:33:41 +02:00
pp(partitions)
2022-08-10 15:21:47 +02:00
POST_JSON(f"/group/5559/delete", headers=HEADERS)
POST_JSON(f"/group/5327/edit", data={"group_name": "TDXXX"}, headers=HEADERS)
2022-07-20 22:33:41 +02:00
2022-07-26 09:00:48 +02:00
# --------- XXX à passer en dans les tests unitaires
# 0- Prend un étudiant au hasard dans le semestre
2022-08-10 15:21:47 +02:00
etud = GET(f"/formsemestre/{formsemestre_id}/etudiants", headers=HEADERS)[10]
etudid = etud["id"]
# 1- Crée une partition, puis la change de nom
js = POST_JSON(
2022-07-20 22:33:41 +02:00
f"/formsemestre/{formsemestre_id}/partition/create",
data={"partition_name": "PART"},
2022-07-20 22:33:41 +02:00
)
partition_id = js["id"]
2022-07-20 22:33:41 +02:00
POST_JSON(
f"/partition/{partition_id}/edit",
data={"partition_name": "PART1", "show_in_lists": True},
2022-08-10 15:21:47 +02:00
headers=HEADERS,
2022-07-20 22:33:41 +02:00
)
2022-07-20 22:03:29 +02:00
# 2- Crée un groupe
2022-08-10 15:21:47 +02:00
js = POST_JSON(
f"/partition/{partition_id}/group/create",
data={"group_name": "G1"},
headers=HEADERS,
)
group_1 = js["id"]
# 3- Crée deux autres groupes
2022-08-10 15:21:47 +02:00
js = POST_JSON(
f"/partition/{partition_id}/group/create",
data={"group_name": "G2"},
headers=HEADERS,
)
js = POST_JSON(
f"/partition/{partition_id}/group/create",
data={"group_name": "G3"},
headers=HEADERS,
)
# 4- Affecte étudiant au groupe G1
2022-08-10 15:21:47 +02:00
POST_JSON(f"/group/{group_1}/set_etudiant/{etudid}", headers=HEADERS)
# 5- retire du groupe
2022-08-10 15:21:47 +02:00
POST_JSON(f"/group/{group_1}/remove_etudiant/{etudid}", headers=HEADERS)
# 6- affecte au groupe G2
partition = GET(f"/partition/{partition_id}")
assert len(partition["groups"]) == 3
group_2 = [g for g in partition["groups"].values() if g["group_name"] == "G2"][0]["id"]
2022-08-10 15:21:47 +02:00
POST_JSON(f"/group/{group_2}/set_etudiant/{etudid}", headers=HEADERS)
# 7- Membres du groupe
2022-08-10 15:21:47 +02:00
etuds_g2 = GET(f"/group/{group_2}/etudiants", headers=HEADERS)
assert len(etuds_g2) == 1
assert etuds_g2[0]["id"] == etudid
# 8- Ordres des groupes
group_3 = [g for g in partition["groups"].values() if g["group_name"] == "G3"][0]["id"]
POST_JSON(
f"/partition/{partition_id}/groups/order",
data=[group_2, group_1, group_3],
2022-08-10 15:21:47 +02:00
headers=HEADERS,
)
2022-08-10 15:21:47 +02:00
new_groups = [
g["id"]
for g in GET(f"/partition/{partition_id}", headers=HEADERS)["groups"].values()
]
assert new_groups == [group_2, group_1, group_3]
# 9- Suppression
POST_JSON(f"/partition/{partition_id}/delete")
2022-07-26 09:00:48 +02:00
# ------
# Tests accès API:
"""
* En mode API:
Avec admin:
- GET, POST ci-dessus : OK
Avec user ayant ScoView (rôle LecteurAPI)
- idem
Avec user sans ScoView:
- GET et POST: erreur 403
* En mode Web:
admin: GET
user : GET = 403
"""
2022-07-20 22:03:29 +02:00
2022-07-24 22:04:37 +02:00
#
POST_JSON(
"/partition/2264/groups/order",
data=[5563, 5562, 5561, 5560, 5558, 5557, 5316, 5315],
2022-08-10 15:21:47 +02:00
headers=HEADERS,
2022-07-24 22:04:37 +02:00
)
POST_JSON(
"/formsemestre/1063/partitions/order",
data=[2264, 2263, 2265, 2266, 2267, 2372, 2378],
2022-08-10 15:21:47 +02:00
headers=HEADERS,
2022-07-24 22:04:37 +02:00
)
2022-08-10 15:21:47 +02:00
GET(f"/partition/2264", headers=HEADERS)
2022-07-24 22:04:37 +02:00
2022-07-21 08:53:44 +02:00
# Recherche de formsemestres
2022-08-10 15:21:47 +02:00
sems = GET(f"/formsemestres/query?etape_apo=V1RT&annee_scolaire=2021", headers=HEADERS)
2022-07-21 08:53:44 +02:00
# Table récap:
2022-08-10 15:21:47 +02:00
pp(GET(f"/formsemestre/1063/resultats", headers=HEADERS)[0])
2022-08-10 15:21:47 +02:00
pp(GET(f"/formsemestre/880/resultats", headers=HEADERS)[0])
# # sems est une liste de semestres (dictionnaires)
# for sem in sems:
# if sem["etat"]:
# break
# if sem["etat"] == "0":
# raise ScoError("Aucun semestre non verrouillé !")
# # Affiche le semestre trouvé:
# pp(sem)
# # ---- Récupère la description de ce semestre:
# # semdescr = GET(s, f"Notes/formsemestre_description?formsemestre_id={sem['formsemestre_id']}&with_evals=0&format=json" )
# # ---- Liste les modules et prend le premier
# mods = GET(s, f"/Notes/moduleimpl_list?formsemestre_id={sem['formsemestre_id']}")
# print(f"{len(mods)} modules dans le semestre {sem['titre']}")
# mod = mods[0]
# # ---- Etudiants inscrits dans ce module
# inscrits = GET(
# s, f"Notes/do_moduleimpl_inscription_list?moduleimpl_id={mod['moduleimpl_id']}"
# )
# print(f"{len(inscrits)} inscrits dans ce module")
# # prend le premier inscrit, au hasard:
# etudid = inscrits[0]["etudid"]
# # ---- Création d'une evaluation le dernier jour du semestre
# jour = sem["date_fin"]
# evaluation_id = POST(
# s,
# "/Notes/do_evaluation_create",
# data={
# "moduleimpl_id": mod["moduleimpl_id"],
# "coefficient": 1,
# "jour": jour, # "5/9/2019",
# "heure_debut": "9h00",
# "heure_fin": "10h00",
# "note_max": 20, # notes sur 20
# "description": "essai",
# },
# errmsg="échec création évaluation",
# )
# print(
# f"Evaluation créée dans le module {mod['moduleimpl_id']}, evaluation_id={evaluation_id}"
# )
# print(
# f"Pour vérifier, aller sur: {DEPT_URL}/Notes/moduleimpl_status?moduleimpl_id={mod['moduleimpl_id']}",
# )