Enable virutal GPU for tests #42

laforel · 2025-07-28T13:55:22Z

Implements comprehensive virtual GPU support for running GPU-dependent tests in headless GitHub Actions Linux runners using Xvfb and Mesa software rendering.

Added Xvfb (X Virtual Framebuffer) setup for headless OpenGL rendering
Configured Mesa LLVMpipe software renderer with optimized settings
Set up proper environment variables (DISPLAY, LIBGL_ALWAYS_SOFTWARE, GALLIUM_DRIVER)
Fixed Linux RPATH configuration ($ORIGIN/ vs macOS @loader_path/)
Added --disable-new-dtags linker flags to force RPATH over RUNPATH
Ensured automatic OpenUSD library discovery without manual LD_LIBRARY_PATH
Created Linux-specific baseline images for all rendering tests
Consolidated platform-specific baseline strategy using _linux suffix
Added support for new tests: TestFramePasses_ClearDepthBuffer and TestFramePasses_ClearColorBuffer
Updated TestSearchEdges and TestSearchPoints with Linux-specific expected results
Fixed algorithmic differences between platforms in search functionality
Limited test execution to Linux runners only (unlimited resources)
Cleaned up redundant environment variable declarations
Maintained platform-agnostic CMake presets

autodesk-chorus · 2025-07-30T22:55:39Z

Chorus detected one or more security issues with this pull request. See the Checks tab for more details.

As a reminder, please follow the secure code review process as part of the Secure Coding Non-Negotiable requirement.

Implements comprehensive virtual GPU support for running GPU-dependent tests in headless GitHub Actions Linux runners using Xvfb and Mesa software rendering. - Added Xvfb (X Virtual Framebuffer) setup for headless OpenGL rendering - Configured Mesa LLVMpipe software renderer with optimized settings - Set up proper environment variables (DISPLAY, LIBGL_ALWAYS_SOFTWARE, GALLIUM_DRIVER) - Fixed Linux RPATH configuration (`$ORIGIN/` vs macOS `@loader_path/`) - Added `--disable-new-dtags` linker flags to force RPATH over RUNPATH - Ensured automatic OpenUSD library discovery without manual LD_LIBRARY_PATH - Created Linux-specific baseline images for all rendering tests - Consolidated platform-specific baseline strategy using `_linux` suffix - Added support for new tests: `TestFramePasses_ClearDepthBuffer` and `TestFramePasses_ClearColorBuffer` - Updated `TestSearchEdges` and `TestSearchPoints` with Linux-specific expected results - Fixed algorithmic differences between platforms in search functionality - Limited test execution to Linux runners only (unlimited resources) - Cleaned up redundant environment variable declarations - Maintained platform-agnostic CMake presets

hodoulp

⚠️ Now I better understand what you did. That's an idea but the side-effect is that we have more baseline images for software GPU linux but we already have them i.e., hardware GPU linux. We have to stop and rethink about this challenge.

Copilot

Pull Request Overview

This PR implements comprehensive virtual GPU support for running GPU-dependent tests in headless Linux CI environments, enabling platform-specific baseline testing with software rendering fallbacks.

Added Xvfb and Mesa software rendering setup for headless Linux testing
Fixed Linux RPATH configuration to use $ORIGIN/ instead of macOS @loader_path/
Created Linux-specific baseline images with _linux suffix for all rendering tests

Reviewed Changes

Copilot reviewed 35 out of 35 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
test/tests/testSearches.cpp	Added software rendering detection logic for platform-specific test results
test/data/baselines/*_linux.png	Added Linux-specific baseline images for rendering tests
test/RenderingFramework/TestHelpers.h	Added software rendering detection function declaration
test/RenderingFramework/TestHelpers.cpp	Implemented software rendering detection and Linux baseline logic
CMakeLists.txt	Fixed Linux RPATH configuration with proper linker flags
.github/workflows/ci-steps.yaml	Added virtual GPU setup and enabled Linux-only test execution

Copilot · 2025-07-31T14:13:45Z

test/tests/testSearches.cpp

@@ -314,30 +316,41 @@ TEST(TestViewportToolbox, TestSearchEdges)
    ASSERT_EQ(primState->pointIndices.size(), 0);
    ASSERT_EQ(primState->pointColorIndices.size(), 0);

+    // Use helper function to detect software rendering
+    bool isSoftwareRendering = TestHelpers::isSoftwareRenderingEnabled();
+
    static const std::vector<VtIntArray> results
 #if defined(_WIN32) || defined(__linux__)


[nitpick] The conditional compilation logic is becoming complex with nested runtime checks. Consider refactoring this into a helper function that returns the appropriate expected results based on platform and rendering mode to improve maintainability.

Copilot · 2025-07-31T14:13:45Z

test/RenderingFramework/TestHelpers.cpp

+    const char* softwareRendering = getenv("LIBGL_ALWAYS_SOFTWARE");
+    if (softwareRendering != nullptr) {
+        // Validate the environment variable value for safety
+        std::string envValue(softwareRendering);
+        return (envValue == "1" || envValue == "true");


Using getenv() can be unsafe in multi-threaded environments. Consider using a thread-safe alternative or ensuring this function is only called during single-threaded initialization phases.

Suggested change

const char* softwareRendering = getenv("LIBGL_ALWAYS_SOFTWARE");

if (softwareRendering != nullptr) {

// Validate the environment variable value for safety

std::string envValue(softwareRendering);

return (envValue == "1" || envValue == "true");

const std::string softwareRendering = getEnvVar("LIBGL_ALWAYS_SOFTWARE");

if (!softwareRendering.empty()) {

// Validate the environment variable value for safety

return (softwareRendering == "1" || softwareRendering == "true");

Copilot · 2025-07-31T14:13:45Z

test/RenderingFramework/TestHelpers.cpp

@@ -120,8 +139,15 @@ std::string HydraRendererContext::getFilename(
    }
    fullFilepath += "_ios";
 #else
+    // macOS hardware GPU uses _osx baselines  


There is an extra trailing space after 'baselines' in the comment.

Suggested change

// macOS hardware GPU uses _osx baselines

// macOS hardware GPU uses _osx baselines

hodoulp · 2025-07-31T14:16:02Z

cc'ing @erikaharrison-adsk In order to use the same baseline images for Linux (software vs. hardware) & thinking that we only want to trap major errors can we investigate the idea of having a different threshold for swf Linux?
So we can use the existing Linux baseline images while waiting for the right long-term solution.

laforel requested a review from Copilot July 28, 2025 13:55

This comment was marked as outdated.

Sign in to view

laforel force-pushed the laforel/gpu-tests branch 15 times, most recently from f2384dc to 4540cb9 Compare July 30, 2025 22:55

laforel force-pushed the laforel/gpu-tests branch 7 times, most recently from c8dea80 to 8a11bf5 Compare July 31, 2025 11:04

laforel force-pushed the laforel/gpu-tests branch from 8a11bf5 to be7ce79 Compare July 31, 2025 11:58

hodoulp requested review from hodoulp and erikaharrison-adsk July 31, 2025 14:11

laforel requested a review from Copilot July 31, 2025 14:12

hodoulp requested changes Jul 31, 2025

View reviewed changes

Copilot AI reviewed Jul 31, 2025

View reviewed changes

laforel force-pushed the laforel/gpu-tests branch from fb7a517 to 0714ce4 Compare July 31, 2025 18:31

Test lavapipe with opengl frontend

4fcebda

laforel force-pushed the laforel/gpu-tests branch from 0714ce4 to 4fcebda Compare August 16, 2025 10:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Enable virutal GPU for tests #42

Enable virutal GPU for tests #42

Uh oh!

laforel commented Jul 28, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

autodesk-chorus bot commented Jul 30, 2025

Uh oh!

hodoulp left a comment •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 31, 2025

Uh oh!

Copilot AI Jul 31, 2025

Uh oh!

Copilot AI Jul 31, 2025

Uh oh!

hodoulp commented Jul 31, 2025

Uh oh!

Uh oh!

	// macOS hardware GPU uses _osx baselines
	// macOS hardware GPU uses _osx baselines

Enable virutal GPU for tests #42

Are you sure you want to change the base?

Enable virutal GPU for tests #42

Uh oh!

Conversation

laforel commented Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

autodesk-chorus bot commented Jul 30, 2025

Uh oh!

hodoulp left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

hodoulp commented Jul 31, 2025

Uh oh!

Uh oh!

laforel commented Jul 28, 2025 •

edited

Loading

hodoulp left a comment •

edited

Loading