Développement

Récupérer le code source

Le code du projet est disponible sur github.

  1. Vous devez tout d’abord le cloner avec git et aller dans le répertoire du projet:

    $ git clone git@github.com:Scille/parsec-cloud.git
    $ cd parsec-cloud
    
  2. Créer un environnement virtuel Python pour le projet:

    $ python -m venv venv
    $ . ./venv/script/activate
    

Note

Parsec nécessite Python >= 3.6

  1. Install Parsec within the virtualenv:

    $ pip install --editable .[all]
    

Notez l’option --editable, sa présence est nécessaire pour directement utiliser le code présent dans le répertoire parsec-cloud au lieu de le copier dans le répertoire d’installation. De cette façon il n’est pas nécessaire de réinstaller le projet à chaque modification du code source.

Lancer les tests

Les tests se lancent avec pytest:

$ py.test tests

En outre, plusieurs options sont disponibles :

--runmountpoint

Inclus les tests du point de montage

--rungui

Inclus les tests d’interface graphique

--runslow

Inclus les tests lents

--postgresql

Utilise PostgreSQL comme moteur de backend au lieu d’un mock en mémoire

-n 4

Lance les tests en parallèle

Notez qu’il est possible de mélanger ces options, par exemple py.test tests --runmountpoint --postgresql --runslow -n auto.

If you want to run GUI test, it is a good idea to install pytest-xvfb in order to hide the Qt windows when running the GUI tests:

$ apt install xvfb
$ pip install pytest-xvfb

Lancer Parsec en local

Il est possible d’utiliser le script run_testenv afin de facilement créer un environnement de développement :

Sous linux:

$ . ./tests/scripts/run_testenv.sh

Sous Windows:

$ tests\\scripts\\run_testenv.bat

Ce script va :

  • Démarrer un backend de développement avec un stockage de données en mémoire

  • Configurer les variables d’environnement pour isoler l’environnement de développement de la configuration globale de Parsec

  • Créer une organisation par défaut

  • Créer plusieurs utilisateurs et périphériques pour cette organisation