Avoid tests being compiled by Arduino build system #48
Conversation
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
The placement of the tests program in the root of the library caused it to be compiled by the Arduino build system, which causes serious problems: - Compilation fails for boards whose toolchain doesn't provide iostream - When compilation doesn't fail, the test `main()` overrides the Arduino core library's `main()`, completely nuking the user's sketch, including the USB CDC code that provides a serial port for uploads on native USB MCUs (e.g., ATSAMD21G18), soft bricking the board.
|
@ivanseidel ping! |
|
hi @ivanseidel |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
The placement of the tests program in the root of the library caused it to be compiled by the Arduino build system, which
causes serious problems:
main()overrides the Arduino core library'smain(), completely nuking the user's sketch. On MCUs with native USB (e.g., ATSAMD21G18), this includes the USB CDC code that provides a serial port for uploads on native USB MCUs (e.g., ATSAMD21G18), soft bricking the board.The new location for the file is fairly standardized. For example:
https://github.com/arduino-libraries/ArduinoIoTCloud/tree/master/extras/test
The
extrasfolder is intended to be a place to put things that should be ignored by the Arduino development software and build system:https://arduino.github.io/arduino-cli/latest/library-specification/#extra-documentation