Document run_all_tests.py

This commit is contained in:
Laurent Indermuehle 2023-01-10 18:06:11 +01:00
parent 91e76d190e
commit 05a6589fc5
No known key found for this signature in database
GPG key ID: 93FA944C9F34DD09

View file

@ -13,17 +13,28 @@ Actually, the makefile only support Podman. I don't have tested with docker yet.
The Makefile accept the following options:
- db_engin_version: The name of the container to use. Either MYSQL or MariaDB. Use ':' as a separator. Do not use short version, like mysql:8 for instance. Our tests expect a full version to filter tests based on released version. For instance: when: db_version is version ('8.0.22', '>').
- db_engine_version: The name of the container to use. Either MYSQL or MariaDB. Use ':' as a separator. Do not use short version, like mysql:8 for instance. Our tests expect a full version to filter tests based on released version. For instance: when: db_version is version ('8.0.22', '>').
- connector: The name of the python package of the connector along with its version number. Use '==' as a separator.
- python: The python version to use in the controller.
- target : If omitted, all test targets will run. But you can limit the tests to a single target to speed up your tests.
Exemples:
Examples:
```sh
# Run all tests
# Run all targets
make db_engine_version="mysql:5.7.40" connector="pymysql==0.7.10" python="3.8"
# A single target
make db_engine_version="mysql:5.7.40" connector="pymysql==0.7.10" python="3.8" target="test_mysql_db"
```
### Run all tests
GitHub Action offer a test matrix that run every combination of Python, MySQL, MariaDB and Connector against each other. To reproduce this, this repo provides a script called *run_all_tests.py*.
Examples:
```sh
python run_all_tests.py
```