mirror of
https://github.com/ynput/ayon-core.git
synced 2025-12-24 21:04:40 +01:00
6843ae8532
* make sure the message type is set and unset correctly * Update dummy data in readme * remove debug message from main thread callbacks * removed unused import * cleanup code in muster addon * simplified 'get_publish_instance_label' function * even better json file handling Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com> --------- Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>
55 lines
2.4 KiB
Markdown
55 lines
2.4 KiB
Markdown
Automatic tests for OpenPype
|
|
============================
|
|
|
|
Requirements:
|
|
============
|
|
Tests are recreating fresh DB for each run, so `mongorestore`, `mongodump` and `mongoimport` command line tools must be installed and on Path.
|
|
|
|
You can find intallers here: https://www.mongodb.com/docs/database-tools/installation/installation/
|
|
|
|
You can test that `mongorestore` is available by running this in console, or cmd:
|
|
```mongorestore --version```
|
|
|
|
Structure:
|
|
- integration - end to end tests, slow (see README.md in the integration folder for more info)
|
|
- openpype/modules/MODULE_NAME - structure follow directory structure in code base
|
|
- fixture - sample data `(MongoDB dumps, test files etc.)`
|
|
- `tests.py` - single or more pytest files for MODULE_NAME
|
|
- unit - quick unit test
|
|
- MODULE_NAME
|
|
- fixture
|
|
- `tests.py`
|
|
|
|
How to run:
|
|
----------
|
|
- use Openpype command 'runtests' from command line (`.venv` in ${OPENPYPE_ROOT} must be activated to use configured Python!)
|
|
-- `python ${OPENPYPE_ROOT}/start.py runtests`
|
|
|
|
By default, this command will run all tests in ${OPENPYPE_ROOT}/tests.
|
|
|
|
Specific location could be provided to this command as an argument, either as absolute path, or relative path to ${OPENPYPE_ROOT}.
|
|
(eg. `python ${OPENPYPE_ROOT}/start.py start.py runtests ../tests/integration`) will trigger only tests in `integration` folder.
|
|
|
|
See `${OPENPYPE_ROOT}/cli.py:runtests` for other arguments.
|
|
|
|
Run in IDE:
|
|
-----------
|
|
If you prefer to run/debug single file directly in IDE of your choice, you might encounter issues with imports.
|
|
It would manifest like `KeyError: 'OPENPYPE_DATABASE_NAME'`. That means you are importing module that depends on OP to be running, eg. all expected variables are set.
|
|
|
|
In some cases your tests might be so localized, that you don't care about all env vars to be set properly.
|
|
In that case you might add this dummy configuration BEFORE any imports in your test file
|
|
```
|
|
import os
|
|
os.environ["OPENPYPE_DEBUG"] = "1"
|
|
os.environ["OPENPYPE_MONGO"] = "mongodb://localhost:27017"
|
|
os.environ["OPENPYPE_DATABASE_NAME"] = "openpype"
|
|
os.environ["AVALON_DB"] = "avalon"
|
|
os.environ["AVALON_TIMEOUT"] = "3000"
|
|
os.environ["AVALON_ASSET"] = "Asset"
|
|
os.environ["AVALON_PROJECT"] = "test_project"
|
|
```
|
|
(AVALON_ASSET and AVALON_PROJECT values should exist in your environment)
|
|
|
|
This might be enough to run your test file separately. Do not commit this skeleton though.
|
|
Use only when you know what you are doing!
|