Extension: omni.kit.test-2.0.6

Documentation Generated: Nov 13, 2025

Settings#

Settings Provided by the Extension#

exts.”omni.kit.test”.autoAddNoWindowArgOnCI#

  • Default Value: True

  • Description: Automatically adds the “–no-window” argument for headless test runs on CI when no explicit window is requested.

exts.”omni.kit.test”.runAsBenchmark#

  • Default Value: False

  • Description: Enables benchmark mode so that tests are executed with performance measurement enabled.

exts.”omni.kit.test”.testLibraries#

  • Default Value: []

  • Description: Specifies a list of C++ test libraries that should be used when executing the extension tests.

exts.”omni.kit.test”.pyCoverageCombinedReport#

  • Default Value: True

  • Description: Determines whether multiple Python coverage data files should be combined into a single report after the tests run.

exts.”omni.kit.test”.pyCoverageFormats#

  • Default Value: [‘json’, ‘html’]

  • Description: Defines the output formats (JSON and HTML) for the generated Python coverage report.

exts.”omni.kit.test”.pyCoverageIncludeTestDependencies#

  • Default Value: False

  • Description: Controls whether Python coverage collection should include code from test-specific dependencies.

exts.”omni.kit.test”.pyCoverageIncludeDependencies#

  • Default Value: True

  • Description: Enables inclusion of dependency modules in the Python coverage analysis to capture a broader code footprint.

exts.”omni.kit.test”.pyCoverageIncludeModules#

  • Default Value: True

  • Description: Specifies if the extension’s own Python modules are to be analyzed for code coverage.

exts.”omni.kit.test”.pyCoverageThreshold#

  • Default Value: 60

  • Description: Sets the minimum acceptable percentage of code coverage required for Python tests to pass.

exts.”omni.kit.test”.pyCoverageEnabled#

  • Default Value: False

  • Description: Determines whether Python code coverage collection is activated during test execution.

exts.”omni.kit.test”.stdoutFailPatterns.trimExcludedMessages#

  • Default Value: True

  • Description: Configures whether standard output messages that match exclusion patterns should be trimmed to reduce noise.

exts.”omni.kit.test”.stdoutFailPatterns.exclude#

  • Default Value: [’Leaking graphics objects’, ‘leaking memory. Missing call to destroyResourceBindingSignature’, ‘[carb.launcher.plugin] [parent]: timed out waiting for the child process’, ‘[carb.launcher.plugin] failed to fork the child process’, ‘[rtx.optixdenoising.plugin] [Optix] [DiskCacheDatabase] Failed to prepare statement: file is not a database’, ‘[rtx.optixdenoising.plugin] [Optix] [WARNING] Error when configuring the database.’, ‘[carb.crashreporter-breakpad.plugin] [previous crash]’]

  • Description: Provides a list of patterns that, when matched in stdout, will be excluded from being flagged as errors during testing.

exts.”omni.kit.test”.stdoutFailPatterns.include#

  • Default Value: [’[error]’, ‘[fatal]’]

  • Description: Defines the list of patterns which, if found in standard output, indicate a failure condition that should be reported.

exts.”omni.kit.test”.testExtTrimStdoutOnSuccess#

  • Default Value: False

  • Description: Indicates whether successful test runs should have their stdout output trimmed to keep logs succinct.

exts.”omni.kit.test”.excludeExts#

  • Default Value: []

  • Description: Lists extension identifiers that are to be explicitly excluded from the testing process.

exts.”omni.kit.test”.testExts#

  • Default Value: []

  • Description: Specifies a set of extensions that are explicitly selected for testing.

exts.”omni.kit.test”.testExtGenerateCoverageReport#

  • Default Value: False

  • Description: Determines whether a Python coverage report should be automatically generated at the end of the test run.

exts.”omni.kit.test”.testExtGenerateReport#

  • Default Value: False

  • Description: Indicates whether an overall test report should be generated after completing the extension tests.

exts.”omni.kit.test”.testExtTestBucket#

  • Default Value:

  • Description: Specifies an optional bucket identifier used to group or categorize test runs for the extension.

exts.”omni.kit.test”.testExtTestType#

  • Default Value:

  • Description: Defines the type or category of tests that are to be executed by the extension.

exts.”omni.kit.test”.testExtMatchVersionAsString#

  • Default Value: True

  • Description: Indicates whether the extension version matching during testing should use string comparison.

exts.”omni.kit.test”.testExtUseRegistry#

  • Default Value: False

  • Description: Determines if the extension manager should use the registry to fetch extension details during tests.

exts.”omni.kit.test”.flakyTestsQueryDays#

  • Default Value: 30

  • Description: Sets the number of past days over which the framework will query for flaky test history.

exts.”omni.kit.test”.testExtRunFlakyTests#

  • Default Value: False

  • Description: When enabled, instructs the test runner to execute tests that are marked as flaky.

exts.”omni.kit.test”.testExtRunUnreliableTests#

  • Default Value: 0

  • Description: Specifies the mode for running unreliable tests, with 0 indicating such tests are not normally executed.

exts.”omni.kit.test”.testExtMaxDurationForRetry#

  • Default Value: 0

  • Description: Sets the maximum allowed duration for a test run after which retry attempts are disabled.

exts.”omni.kit.test”.testExtMaxTestRunCount#

  • Default Value: 1

  • Description: Defines the maximum number of test iterations that will be attempted for the extension tests.

exts.”omni.kit.test”.testExtRetryStrategy#

  • Default Value: no-retry

  • Description: Specifies the strategy used for retrying tests if failures occur (e.g. “no-retry”, “retry-on-failure”).

exts.”omni.kit.test”.useSampling#

  • Default Value: True

  • Description: Determines whether test sampling is enabled to potentially reduce the overall number of test executions.

exts.”omni.kit.test”.testExtSamplingSeed#

  • Default Value: -1

  • Description: Sets the numerical seed used to control randomness during test sampling.

exts.”omni.kit.test”.testExtSamplingContext#

  • Default Value: ci

  • Description: Specifies the context (such as “ci” for continuous integration) in which test sampling is to be applied.

exts.”omni.kit.test”.testExtSamplingFactor#

  • Default Value: 1.0

  • Description: Determines the fraction of tests to run by setting a sampling factor applied during test execution.

exts.”omni.kit.test”.testExtRandomOrder#

  • Default Value: False

  • Description: Enables randomization of the order in which tests are executed to help expose inter-test dependencies.

exts.”omni.kit.test”.testExtMaxTimeout#

  • Default Value: 0

  • Description: Specifies the maximum timeout value for an individual test run; a value of 0 means no override of the default timeout.

exts.”omni.kit.test”.testExtDefaultTimeout#

  • Default Value: 300

  • Description: Sets the default timeout in seconds for extension test runs if no specific timeout is provided.

exts.”omni.kit.test”.testExtSanityChecksEnabled#

  • Default Value: True

  • Description: Determines whether additional sanity checks should be performed before running the extension tests.

exts.”omni.kit.test”.testExtCodeChangeAnalyzerEnabled#

  • Default Value: True

  • Description: Enables a code change analyzer that can decide to skip tests if no relevant changes have been detected.

exts.”omni.kit.test”.testExtEnableProfiler#

  • Default Value: False

  • Description: Indicates whether a profiler should be activated during the test run to collect performance data.

exts.”omni.kit.test”.testExtMaxParallelProcesses#

  • Default Value: 1

  • Description: Specifies the maximum number of test processes that should run in parallel for the extension.

exts.”omni.kit.test”.testExtArgs#

  • Default Value: []

  • Description: Provides a list of extra command-line arguments that will be passed to the test process for additional configuration.

exts.”omni.kit.test”.testExtUIMode#

  • Default Value: False

  • Description: Determines whether the extension test should run in UI mode, which may enable additional graphical interfaces.

exts.”omni.kit.test”.testExtUseKitFileAsApp#

  • Default Value: True

  • Description: Configures the test runner to use a kit file as the application for launching the extension tests.

exts.”omni.kit.test”.testExtTestNameFilter#

  • Default Value:

  • Description: Sets an optional filter string that limits test execution to tests whose names match the provided pattern.

exts.”omni.kit.test”.testExtApp#

  • Default Value: ${omni.kit.test}/apps/omni.app.test_ext.kit

  • Description: Specifies the path to the test application (kit file or extension) that is used to run the extension tests.

exts.”omni.kit.test”.testExtCleanOutputPath#

  • Default Value: False

  • Description: Determines whether the test output directory should be cleaned prior to the execution of tests.

exts.”omni.kit.test”.testExtOutputPath#

  • Default Value: ${omni_data}/_testoutput

  • Description: Defines the directory where the outputs of test runs will be stored.

exts.”omni.kit.test”.runTestsFromFile#

  • Default Value:

  • Description: Specifies the path to a file containing a list of tests to be executed, which can override other test selection methods.

exts.”omni.kit.test”.runTestsFilter#

  • Default Value:

  • Description: Provides a filter pattern used to select a subset of tests to run based on their names or attributes.

exts.”omni.kit.test”.excludeTests#

  • Default Value: []

  • Description: Lists specific tests that should be omitted from execution during the test run.

exts.”omni.kit.test”.includeTests#

  • Default Value: []

  • Description: Lists specific tests that must be included in the test run, overriding default test selection.

exts.”omni.kit.test”.printTestsAndQuit#

  • Default Value: False

  • Description: When enabled, instructs the test runner to print the available tests and exit without running them.

exts.”omni.kit.test”.doNotQuit#

  • Default Value: False

  • Description: Indicates that the test process should remain active after tests complete, instead of automatically quitting.

exts.”omni.kit.test”.runTestsAndQuit#

  • Default Value: False

  • Description: Configures the test runner to execute tests and then immediately terminate the process upon completion.

Settings Used by the Extension but Provided by Another Extension#

/exts/omni.kit.debug.python/mode#

  • Description: Determines the operating mode (such as “connect”) for the Python debugger provided by the debugging extension.

/exts/omni.kit.debug.python/host#

  • Description: Specifies the host address for the Python debugger, enabling the test process to attach to a remote debugger.

/exts/omni.kit.debug.python/port#

  • Description: Specifies the port number for connecting to the Python debugger of the debugging extension.

/app/exts/folders#

  • Description: Provides a list of additional extension folders configured at the application level, which are propagated to the test process.

/persistent/app/exts/userFolders#

  • Description: Returns user-specific extension folder settings that are stored persistently and used to locate extra extensions.

/crashreporter/data/testName#

  • Description: Contains the test name value retrieved from the crash reporter’s settings, which is passed to child processes for reporting crash details.

/telemetry/mode#

  • Description: Determines the telemetry mode for the application, ensuring that test runs generate telemetry data in a test-specific context.

On this page