Extension: omni.graph.test-1.10.0

Documentation Generated: Dec 04, 2025

Changelog

Overview

In order to effectively test the OmniGraph access to nodes and scripts that are not necessary for the graph to operate correctly. In order to minimize the unnecessary files, yet still have nodes and files explicitly for testing, all of that functionality has been broken out into this extension.

Dependencies

As the purpose of this extension is to provide testing facilities for all of OmniGraph it will have load dependencies on all of the omni.graph.* extensions. If any new ones are added they should be added to the dependencies in the file config/extension.toml.

Data Files

Three types of data files are accessed in this extension:

1. Generic data files, created in other extensions for use by the user (e.g. compound node definitions)

2. Example files, created to illustrate how to use certain nodes but not intended for general use

3. Test files, used only for the purpose of loading to test certain features

The data/ subdirectories in this extension contains the latter of those three. The other files live in the lowest level extension in which they are legal (e.g. if they contain a node from omni.graph.nodes then they will live in that extension). As this extension has dependencies on all of the OmniGraph extensions it will have access to all of their data files as well.

Node Files

Most nodes will come from other extensions. Some nodes are created explicitly for testing purposes. These will appear in this extension and should not be used for any other purpose.

Import Example

This simple example shows how the test files from the omni.graph.examples.python extension were imported and enabled in this extension.

The first step was to move the required files into the directory tree:

omni.graph.test/
├── python/
    └── tests/
        ├──── test_omnigraph_simple.py
        └── data/
            ├──── TestEventTrigger.usda
            └──── TestExecutionConnections.usda

Note

The two .usda files contain only nodes from the omni.graph.examples.python extension and are solely used for test purposes. That is why they could be moved into the extension’s test directory.

Next the standard automatic test detection file was added to omni.graph.test/python/tests/__init__.py

"""There is no public API to this module."""

__all__ = []

scan_for_test_modules = True
"""The presence of this object causes the test runner to automatically scan the directory for unit test cases"""

Finally, the config/extension.toml had additions made to inform it of the dependency on the new extension:

[package]
version = "1.10.0"
title = "OmniGraph Regression Testing"
category = "Graph"
readme = "docs/README.md"
changelog = "docs/CHANGELOG.md"
description = "Contains test scripts and files used to test the OmniGraph extensions where the tests cannot live in a single extension."
repository = "https://gitlab-master.nvidia.com/omniverse/kit-extensions/kit-omnigraph"
keywords = ["kit", "omnigraph", "tests"]
python.import_mode = "ParallelThread"
preview_image = "data/preview.png"
icon = "data/icon.svg"
writeTarget.kit = true
writeTarget.usd = true
support_level = "Sample"

# Main module for the Python interface
[[python.module]]
name = "omni.graph.test"

[[native.plugin]]
path = "bin/*.plugin"
recursive = false

# Watch the .ogn files for hot reloading (only works for Python files)
[fswatcher.patterns]
include = ["*.ogn", "*.py"]
exclude = ["Ogn*Database.py"]

# The bare minimum of dependencies required for bringing up the extension
[dependencies]
"omni.graph.core" = { version = "3.0.0" }
"omni.graph" = { version = "1.139.0" }
"omni.graph.tools" = { version = "1.77.0" }

[[test]]
timeout = 1800

# Other extensions that need to load in order for this one to work.
# This list deliberately omits omni.graph and omni.graph.tools to ensure that extensions that rely on recursive
# dependencies on OmniGraph work properly.
dependencies = [
    "omni.kit.ui_test",
    "omni.kit.usd.layers",
    "omni.graph.examples.cpp",
    "omni.graph.examples.python",
    "omni.graph.nodes",
    "omni.graph.tutorials",
    "omni.graph.action",
    "omni.graph.scriptnode",
    "omni.kit.stage_template.core",
    "omni.kit.primitive.mesh",
    # Needed for tests which use Fabric Scene Delegate
    "omni.hydra.usdrt_delegate",
]

stdoutFailPatterns.exclude = [
    # Exclude carb.events leak that only shows up locally
    "*[Error] [carb.events.plugin]*PooledAllocator*",
    # Exclude messages which say they should be ignored
    "*Ignore this error/warning*",
    "*Types: unknown and rel*"  # OM-86183
]

pythonTests.unreliable = [
    "*test_change_pipeline_stage*",  # OM-66115
    "*test_action_compounds*",  # OM-120545
]

args = [
    "--no-window",
    "--enable omni.inspect"  # here instead of in `dependencies` to avoid 'definition sanity check failure'
]

[documentation]
pages = [
    "docs/Overview.md",
    "docs/CHANGELOG.md",
]