Skip to main content

Testing in OpenPype

Introduction​

As OpenPype is growing there also grows need for automatic testing. There are already bunch of tests present in root folder of OpenPype directory. But many tests should yet be created!

How to run (integration) tests​

Requirements​

  • installed DCC you want to test
  • mongorestore on a PATH

You could check that mongorestore is available by running this in console (or cmd), it shouldn't fail and you should see version of utility:

mongorestore --version

If you would like just to experiment with provided integration tests, and have particular DCC installed on your machine, you could run test for this host by:

  • From source:
- use Openpype command 'runtests' from command line (`.venv` in ${OPENPYPE_ROOT} must be activated to use configured Python!)
- `python ${OPENPYPE_ROOT}/start.py runtests ../tests/integration/hosts/nuke`
  • From build:
- ${OPENPYPE_BUILD}/openpype_console runtests {ABSOLUTE_PATH_OPENPYPE_ROOT}/tests/integration/hosts/nuke`

Modify tests path argument to limit which tests should be run (../tests/integration will run all implemented integration tests).

Content of tests folder​

Main tests folder contains hierarchy of folders with tests and supporting lib files. It is intended that tests in each folder of the hierarchy could be run separately.

Main folders in the structure:

  • integration - end to end tests in host applications, mimicking regular publishing process
  • lib - helper classes
  • resources - test data skeletons etc.
  • unit - unit test covering methods and functions in OP

lib folder​

This location should contain library of helpers and miscellaneous classes used for integration or unit tests.

Content:

  • assert_classes.py - helpers for easier use of assert expressions
  • db_handler.py - class for creation of DB dumps/restore/purge
  • file_hanlder.py - class for preparation/cleanup of test data
  • testing_classes.py - base classes for testing of publish in various DCCs

integration folder​

Contains end to end testing in a DCC. Currently it is setup to start DCC application with prepared worfkile, run publish process and compare results in DB and file system automatically. This approach is implemented as it should work in any DCC application and should cover most common use cases. Not all hosts allow "real headless" publishing, but all hosts should allow to trigger publish process programmatically when UI of host is actually running.

There will be eventually also possibility to build workfile and publish it programmatically, this would work only in DCCs that support it (Maya, Nuke).

It is expected that each test class should work with single worfkile with supporting resources (as a dump of project DB, all necessary environment variables, expected published files etc.)

There are currently implemented basic publish tests for Maya, Nuke, AfterEffects and Photoshop. Additional hosts will be added.

Each test_ class should contain single test class based on tests.lib.testing_classes.PublishTest. This base class handles all necessary functionality for testing in a host application.

Steps of publish test​

Each publish test consists of areas:

  • preparation
  • launch of host application
  • publish
  • comparison of results in DB and file system
  • cleanup
Preparation​

Each test publish case expects zip file with this structure:

  • expected - published files after workfile is published (in same structure as in regular manual publish)
  • input
    • dumps - database dumps (check tests.lib.db_handler for implemented functionality)
      • openpype - settings
      • test_db - skeleton of test project (contains project document, asset document etc.)
    • env_vars - env_var.json file with a dictionary of all required environment variables
    • json - json files with human readable content of databases
    • startup - any required initialization scripts (for example Nuke requires one init.py file)
    • workfile - contains single workfile

These folders needs to be zipped (in zip's root must be this structure directly!), currently zip files for all prepared tests are stored in OpenPype GDrive folder.

Each test then goes in steps (by default):

  • download test data zip
  • create temporary folder and unzip there data zip file
  • purge test DB if exists, import dump files from unzipped folder
  • sets environment variables from env_vars folder
  • launches host application and trigger publish process
  • waits until publish process finishes, application closes (or timeouts)
  • compares results in DB with expected values
  • compares published files structure with expected values
  • cleans up temporary test DB and folder
Launch of application and publish​

Integration tests are using same approach as OpenPype process regarding launching of host applications (eg. ApplicationManager().launch). Each host application is in charge of triggering of publish process and closing itself. Different hosts handle this differently, Adobe products are handling this via injected "HEADLESS_PUBLISH" environment variable, Maya and Nuke must contain this in theirs startup files.

Base PublishTest class contains configurable timeout in case of publish process is not working, or taking too long.

Comparison of results​

Each test class requires re-iplemented PublishTest.test_db_asserts fixture. This method is triggered after publish is finished and should compare current results in DB (each test has its own database which gets filled with dump data first, cleaned up after test finishing) with expected results.

tests.lib.assert_classes.py contains prepared method count_of_types which makes easier to write assert expression. This method also produces formatted error message.

Basic use case: DBAssert.count_of_types(dbcon, "version", 2) >> It is expected that DB contains only 2 documents of type==version

If zip file contains file structure in expected folder, PublishTest.test_folder_structure_same implements comparison of expected and published file structure, eg. if test case published all expected files.

Cleanup​

By default, each test case pulls data from GDrive, unzips them in temporary folder, runs publish, compares results and then purges created temporary test database and temporary folder. This could be changed by setting of PublishTest.PERSIST. If set to True, DB and published folder are kept intact until next run of any test.

In case you want to modify test data, use PublishTest.TEST_DATA_FOLDER to point test to specific location where test folder is already unzipped.

Both options are mostly useful for debugging during implementation of new test cases.

Test configuration​

Each test case could be configured from command line with:

  • test_data_folder - use specific folder with extracted test zip file
  • persist - keep content of temporary folder and database after test finishes
  • app_variant - run test for specific version of host app, matches app variants in Settings, eg. 2021 for Photoshop, 12-2 for Nuke
  • timeout - override default time (in seconds)

unit folder​

Here should be located unit tests for classes, methods of OpenPype etc. As most classes expect to be triggered in OpenPype context, best option is to start these tests in similar fashion as integration tests (eg. via runtests).