Disable unit tests on Windows #415
Merged
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
glhewett
approved these changes
Dec 14, 2023
This was referenced Dec 14, 2023
Merged
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.
This PR disables unit testing in Windows CI runs. As the comment in the workflow file notes for posterity, we have two conflicting bugs. A doctest bug discovered through #413 which causes doctest to fail when built with ASAN, and a GitHub Actions bug that causes the tests to hang when not built with ASAN.
Disabling unit tests on Windows is unfortunate, but I don't think it's a huge loss in terms of test fidelity. The behaviors we're testing are higher-level things that I would expect to be pretty portable, not dependent on anything platform-specific.
The long-term fix here probably entails moving to a new test framework, since it looks like doctest is essentially unmaintained. My understanding is that Catch2 is a pretty standard alternative, and appears to be better maintained than doctest. The syntax seems similar (I think by design), so it may be pretty straightforward to change over.