omni.kit.test#

Classes Summary:

AsyncTestCase

Base class for all async test cases.

AsyncTestCaseFailOnLogError

Test Case which automatically subscribes to logging events and fails if any error is produced during the test.

AsyncTestSuite

A test suite is a composite test consisting of a number of TestCases.

BenchmarkTestCase

Base class for benchmark tests.

ExtTest

A class for executing extension tests.

ExtTestResult

A class representing the result of an extension test run.

TestPopulateAll

Implementation of TestPopulator that returns a list of all tests known to Kit

TestPopulateDisabled

Implementation of the TestPopulator that returns a list of all tests disabled in their extension.toml file

TestPopulator

Base class for the objects used to populate the initial list of tests, before filtering.

TestReturnCode

Return codes used by omni.kit.test.

TestRunStatus

Enumeration that defines the possible statuses for test run execution.

UploadResults

Create a collection of name/value pairs.

Functions Summary:

add_test_case_to_tested_extension

Add test case to the tested extension.

add_test_status_report_cb

Add callback to be called when tests start, fail, pass.

add_upload_command

Save generated upload command to be executed later.

fallback_omnihydra

fsd_off_if_fallback

get_setting

Retrieve a setting from the settings interface using the specified path and return its value. If the setting does not exist, the provided default is returned.

get_tests

Default function to get all current tests. It gets tests from all enabled extensions, but also includes include and exclude settings to filter them.

get_tests_from_modules

Return the list of tests registered or dynamically discovered from the list of modules.

restore_fsd_if_fallback

run_tests

Run the provided tests using the asynchronous test runner. Sets up the test output path and playlist, then executes tests asynchronously. The status and finish callback functions, if provided, are invoked during and after test execution.

upload_all_comparison_results

Kick off all saved upload commands in background. Only run on CI.

upload_comparison_results

Generate command and upload comparison results. Only run on CI.