Embedded testing failed with Broken pipe on Arduino

maxgerhardt · September 23, 2023, 6:20pm

Ah, no I remember something: Can you apply this to your project?

github.com/platformio/platformio-core

Add test start delay option

opened 09:20PM - 18 Nov 20 UTC

closed 07:13PM - 29 Apr 22 UTC

maxgerhardt

help wanted unit testing

# Solution Please add to your project a [POST Extra Script](https://docs.plat…formio.org/en/latest/scripting/index.html) with the following contents: **platformio.ini** ```ini [env:seeed_wio_terminal] platform = atmelsam board = seeed_wio_terminal framework = arduino extra_scripts = post:extra_script.py ``` **extra_script.py** ```python import time Import("env") if "test" in env.GetBuildType(): env.AddPostAction("upload", lambda *_, **__: time.sleep(2)) ``` P.S: Do not forget to upgrade to the latest PlatformIO Core via `pio upgrade --dev`. # Related issues: - https://community.platformio.org/t/teensy-4-1-unit-testing-issue/21033/5 - https://github.com/platformio/platformio-core/issues/3956 ### Configuration **Operating system**: Windows 10 x64 **PlatformIO Version** (`platformio --version`): 5.0.4a2 ### Description of problem Reference to topic where this popped up: https://community.platformio.org/t/unit-test-wio-terminal-could-not-open-port-while-testing/17180/ A user wants to do unit testing on a WIO terminal, which has a ~~SAMD21G18A~~ ATSAMD51P19A microcontroller onboard. This microcontroller implements a USB CDC serial connection. When a new firmware is uploaded, or the microcontroller is being reset, the USB connection is temporarily lost, then re-established. The problem is then when testing, PlatformIO does a Build -> Upload -> Test, where there is no delay between uploading and testing when using this specific microcontroller. A problem was problem was observed that when using Linux, after the upload is done, the microcontroller re-enumerates twices on the USB bus, and at the moment the "Test" part of the unit tests wants to access `/dev/ttyACM0`, the Linux kernel or subsystems have not yet fully re-enumerated the device and it's currently owned by root at this point. Then accessing it fails with `[Errno 13] could not open port /dev/ttyACM0: [Errno 13] Permission denied: '/dev/ttyACM0'`. A few milliseconds after it ([exact timing log is here](https://community.platformio.org/t/unit-test-wio-terminal-could-not-open-port-while-testing/17180/9?u=maxgerhardt)), Linux is done processing the device and now the user properly owns `/dev/ttyACM0` and access to it would go through. That's at least how I read these logs. However, since PlatformIO does not have a configurable delay after uploading, or equivalently before testing, `pio test` will always run into this problem. So it would be nice to have such an option to enable these use cases where the to-be-tested MCU is the USB serial port and does some re-enumeration stuff after uploading. #### Steps to Reproduce 1. Create a project for the `seeed_wio_terminal` 2. Add standard unit testing code to it 3. Execute `pio test` ### Actual Results Permission denied error on the serial device. ### Expected Results Testing goes through. ### If problems with PlatformIO Build System: **The content of `platformio.ini`:** ```ini [env:seeed_wio_terminal] platform = atmelsam board = seeed_wio_terminal framework = arduino ``` **Source file to reproduce issue:** ```cpp #include <Arduino.h> #include <unity.h> void TestConvertTemperatureToString(void) { TEST_ASSERT_EQUAL(32, 32); } void setup() { // NOTE!!! Wait for >2 secs // if board doesn't support software reset via Serial.DTR/RTS delay(5000); UNITY_BEGIN(); RUN_TEST(TestConvertTemperatureToString); UNITY_END(); } void loop() { } ``` ### Additional info

i.e

extra_scripts = post:extra_script.py

in the platformio.ini and a new file extra_script.py on the same level as the platformio.ini with

import time

Import("env")

if "test" in env.GetBuildType():
    env.AddPostAction("upload", lambda *_, **__: time.sleep(2))