Add optional argument to catch_discover_tests to set DYLD_FRAMEWORK_PATH #2880
Conversation
This file contains 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
…WORK_PATH environment variable on Apple platforms.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## devel #2880 +/- ##
==========================================
+ Coverage 91.10% 91.14% +0.04%
==========================================
Files 198 198
Lines 8493 8487 -6
==========================================
- Hits 7737 7735 -2
+ Misses 756 752 -4 |
horenmar
added
the
Extras
|
It's fine to keep the paths duplicated. |
horenmar
reviewed
Jul 22, 2024
| packaged as frameworks on Apple platforms when running the test executable | ||
| (DYLD_FRAMEWORK_PATH). These paths will both be set when retrieving the list | ||
| of test cases from the test executable and when the tests are executed themselves. | ||
| This requires cmake/ctest >= 3.22. |
There was a problem hiding this comment.
On line 166, the script explicitly errors out if _DL_PATHS are used with CMake version before 3.22. _DL_FRAMEWORK_PATHS should be checked there as well.
There was a problem hiding this comment.
Thanks for pointing that out, check added.
|
Thanks |
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.
If a 3rd party library used in tests depends on the DYLD_FRAMEWORK_PATH environment variable to be set on OSX (in order to find its dependent libraries packaged as Apple frameworks during test discovery and run them), then catch_discover_tests will fail. It's similar to the need and usage of the DL_PATHS argument.
Two solutions I initially thought of. One, set the DYLD_FRAMEWORK_PATH implicitly to the same value as DL_PATHS. Second, adding an explicit optional argument to set the paths specifically used for Apple frameworks.
In this PR I have opted for the second solution to allow the two variables to hold different values, even though DYLD_FRAMEWORK_PATH only needs to be set on OSX. There is some repetition in the code to process the paths and set the variables which could be improved in a separate commit or PR.