testing: Fix brittle behavior of tests that need to cmake - #5359
Open
lgritz wants to merge 1 commit into
Open
Conversation
Some tests (like cmake-consumer, but also the newly added imagebufalgo-opencv and openexr-partialtile) build their own executable, and so have their own CMakeLists.txt that needs to find_package(OpenImageIO). This only works in our CI because it sets OpenImageIO_ROOT (and, as it turns out, locally for me it works because I habitually have that set as well). But it can fail for users who don't have OpenImageIO_ROOT set to the place where the build being tested has installed itself. Fix it by setting this environment variable for all tests. This makes it work if the person running the tests has failed to set the variable, and it also ensure that things will work right if it IS set, but to the wrong place (like a different install than the build we're trying to test). Also make failed tests echo build.txt to the main log, if it exists, so that these in-test build failures can be more easily discerned from viewing the main CI log. Fixes 5358 Signed-off-by: Larry Gritz <lg@larrygritz.com>
Collaborator
Author
|
@darix would love for you to test this and give an approval if it works for you |
|
does not work. would it work with that layout? that buildroot directory is passed in via DESTDIR |
Collaborator
Author
|
I'm not sure why the layout would matter. In the patch, it just sets OpenImageIO_ROOT to Though it does depend on having the "install" target build BEFORE running all the tests. They layout of our "build" directory (pre-install) is not quite the same as a full install. |
|
yeah but it isnt installed to |
Collaborator
Author
|
I don't understand. Isn't the way it gets installed to invoke with something like and then that same CMAKE_INSTALL_PREFIX definition provides both the install destination, and via this patch, also the path that OpenImageIO_ROOT will be set to when running the test? |
lgritz
added
the
build / testing / port / CI
Collaborator
Author
|
@darix, any update or thoughts on my last comment here? |
Collaborator
Author
|
@darix Thoughts? To summarize: |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves robustness and debuggability of the CTest-driven testsuite, especially for tests that spawn a nested CMake build and need find_package(OpenImageIO) to resolve against the build-under-test.
Changes:
- Set
OpenImageIO_ROOTin the environment for all tests so nested CMake projects can reliably locate OpenImageIO. - When a test command fails, print
build.txt(if present) into the main test log to make nested build failures easier to diagnose.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| testsuite/runtest.py | Adds logic to emit build.txt content on command failure for easier CI/local debugging. |
| src/cmake/testing.cmake | Extends the default per-test environment with OpenImageIO_ROOT to stabilize nested find_package(OpenImageIO) behavior. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+429
to
+433
| if os.path.isfile("build.txt") : | ||
| print ("--- BUILD LOG ---\n") | ||
| with open("build.txt", "r") as fbuild : | ||
| print (fbuild.read()) | ||
| print ("--- END BUILD LOG ---\n") |
Collaborator
Author
There was a problem hiding this comment.
I'm going to ignore this suggestion because for these couple of isolated tests, the build logs are short and the failures should be rare, and if they happen, we probably do want to see the full log.
Collaborator
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Some tests (like cmake-consumer, but also the newly added imagebufalgo-opencv and openexr-partialtile) build their own executable, and so have their own CMakeLists.txt that needs to find_package(OpenImageIO).
This only works in our CI because it sets OpenImageIO_ROOT (and, as it turns out, locally for me it works because I habitually have that set as well). But it can fail for users who don't have OpenImageIO_ROOT set to the place where the build being tested has installed itself.
Fix it by setting this environment variable for all tests. This makes it work if the person running the tests has failed to set the variable, and it also ensure that things will work right if it IS set, but to the wrong place (like a different install than the build we're trying to test).
Also make failed tests echo build.txt to the main log, if it exists, so that these in-test build failures can be more easily discerned from viewing the main CI log.
Fixes #5358