Atelier ZDD

Contexte

Depuis quelques mois, vous êtes responsable de maintenir et d'enrichir une API publique qui permet de consulter la position d'avions en temps réel.

• Avion
  • En vol
  • Au sol
  • En maintenance
• Aeroport
  • Pistes
  • Hangar
• Position
  • GPS
  • Altitude

Règles métier

• Un avion a un identifiant unique
• Un vol relie deux aéroports
  • Il n'y a pas toujours un avion affecté à ce vol
  • Le vol a un status qui peut avoir des valeurs différentes
    • ongoing : Le vol est en cours

Grâce à vos efforts, et l'appui de quelques sponsors, cette API connait un succès grandissant et le nombre de vos utilisateurs - et donc le nombre de requêtes - ne cesse de grandir. Ce qui était un petit projet aux ambitions modestes doit maintenant continuer à évoluer tout en assurant une disponibilité maximale.

Votre mission, puisque vous l'acceptez

Aujourd'hui, le système conserve la position actuelle de l'avion au sein du vol. Un gros constructeur aérien exige l'intégration de deux modifications avant d'accepter d'utiliser le système. Il demande :

• La conservation de l'historique de la position de vol
• L'ajout de l'altitude

Actuellement, latitude et longitude sont stockés sous la forme d'une seule chaine de caractères. C'est aussi l'occasion de réduire cette dette en normalisant en deux champs de type flottant.

Requirements

• Docker (version 19.0)
• Un éditeur de texte

Architecture applicative

L'application a été construite en s'inspirant du pattern d'architecture connu sous le nom d'architecture hexagonale, popularisé par Alistair Cockburn.

L'application expose une API disponible sur l'adresse http://localhost, qui ne suit pas de formalisme particulier, mais est inspiré du principe de ressource au centre du concept d'API Rest. Le format d'échange est le JSON.

Pour le développement, un pgadmin est disponible sur l'addresse http://localhost:5050 mais cette application n'est pas disponible en production. Il est possible de s'y connecter : identifiant : [email protected] et mot de passe : admin .

L'accès à la base de données est protégé par un mot de passe : postgres

Description technique

Une API

• Python / Flask

Une BDD postgres

• Postgres 10.12

Images (pour le dev local)

• Docker (v19.03.8)

Outils et commandes

Il est possible (et recommandé) de lancer l'application en local pour prendre connaissance du contexte, et d'effectuer des modifications sur son poste avant d'envoyer le code en production.

Une description des endpoints et de comment les utiliser est disponible pour le logiciel Insomnia via le fichier .json éponyme.

Manipuler les migrations

🗞 Les commandes pour manipuler les migrations sont dans le fichier README du répertoire app/alembic/, l'outil de migration utilisé par cette application.

Lancer l'application en local

docker-compose up

Se connecter au conteneur de l'API

docker exec -it api bash

Lancer les tests en local

Dans le répertoire app/

PYTHONPATH=. py.test --durations=0

Se connecter à la base de données en commande

docker exec -it database psql -U postgres