Tests

To test Tracim, you first need to be able to build the backend and the frontend. See how to build.

Backend

In backend directory.

You need to setup tools and directories (only needed once):

python3 ./setup_dev_env.py
./create_test_storage_dir.sh

You will need docker compose to run the backend tests. For Debian-based systems, you can install it with:

sudo apt install docker.io docker-compose-plugin

See installation instructions if you are not using Debian-based systems.

Finally, add the current user to docker group, you'll need to use a new login shell for this change to be taken into account

sudo usermod -a -G docker $USER

To test every databases, you will need the pytest-forked plugin.

pip install pytest-forked

To run backend tests, you need several configurations:

A specific configuration for specific tests is available in TEST_CONFIG_FILE_PATH (by default: ./tests_configs.ini in backend folder).
For a more general configuration, pytest rely on dotenv .env file (by default .test.env in backend folder)
If you want to change general configuration like paths or database used, you should use environment variables instead of modifying TEST_CONFIG_FILE_PATH file or .test.env.

For example, if you want to use another database:

export TRACIM_SQLALCHEMY__URL=sqlite:/tmp/mydatabase
python3 ./setup_dev_env.py
pytest

Order of usage is (from less to more important, last is used if set):

Run tests with the following commands:

docker compose up -d
pytest
docker compose down

By default the tests will be executed with the sqlite database, this can be changed using the --database argument of pytest:

pytest --database=postgresql

Possible databases are sqlite, postgresql, mysql and mariadb. It is possible to specify several databases or even all:

pytest --forked --database=sqlite --database=postgresql

Run tests on all databases.

pytest --forked --database=all

The docker-compose.yml file lists the services needed for testing the Tracim backend.

Script to test load available here

pip install locust

locust --headless --users 50 --spawn-rate 1 --host https://localhost:7999 -t 2min --html report.html