Merge pull request #52 from bxparks/develop

1.3.1 - support SAMD21 and ATmega2560 boards; split off UnixHostDuino; set exit status code

Author: bxparks

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 
 * Unreleased
+    * Add `examples/AUnitPlatformIO` to verify that AUnit works on PlatformIO.
+    * Rename unitduino to UnixHostDuino and move to its own repository at
+      `https://github.com/bxparks/UnixHostDuino`.
+    * Add UnixHostDuino Makefile to all unit tests.
+    * Support SAMD21 and ATmega2560 boards.
+    * Call `exit(1)` upon failure or timeout, `exit(0)` upon success when using
+      UnixHostDuino (#51).
 * 1.3 (2019-06-15)
     * Remove direct creation of `String` object, removing last remaining dynamic
       allocation of heap memory from library.

README.md

@@ -1283,6 +1283,39 @@ The AUniter tools have been integrated into the [Jenkins](https://jenkins.io)
 continuous integration service. See details in
 [Continuous Integration with Jenkins](https://github.com/bxparks/AUniter/tree/develop/jenkins).
 
+### UnixHostDuino
+
+AUnit unit tests can often be compiled and executed natively on Linux or MacOS
+machines using the [UnixHostDuino](https://github.com/bxparks/UnixHostDuino)
+library because most unit tests depend on just the `Serial` port (which
+UnixHostDuino binds to `stdout` and `stdin`).
+
+The [unit tests for AUnit itself](tests) have all been upgraded to run
+under UnixHostDuino. Here are a few tips when writing unit tests
+to run under UnixHostDuino:
+
+**Delay(1000)**
+
+For real Arduino boards, you get more reliable unit tests if you add a
+`delay(1000)` at the start of the program. For UnixHostDuino, this is not
+necessary, so I recommend calling this only on real Arduino boards, like this:
+```C++
+void setup() {
+#ifdef ARDUINO
+  delay(1000); // Wait for stability on some boards, otherwise garage on Serial
+#endif
+  ...
+```
+
+**Exit() Status Code**
+
+On real Arduino boards, the unit test (or any program for that matter) never
+terminates. The `loop()` function executes forever. On Linux or MacOS using
+UnixHostDuino, the test program will terminate at the end through the
+`exit()` function. If the tests are successful (i.e. passing or skipped), it
+will call `exit(0)`. If there are any failing tests (i.e. failed or timed out),
+it will call `exit(1)`.
+
 ## Tips
 
 Collection of useful tidbits.
@@ -1500,28 +1533,40 @@ See [CHANGELOG.md](CHANGELOG.md).
 
 ## System Requirements
 
+### Tool Chain
+
 This library was developed and tested using:
-* [Arduino IDE 1.8.5](https://www.arduino.cc/en/Main/Software)
-* [Teensyduino 1.41](https://www.pjrc.com/teensy/td_download.html)
-* [ESP8266 Arduino Core 2.4.1](https://arduino-esp8266.readthedocs.io/en/2.4.1/)
-* [arduino-esp32](https://github.com/espressif/arduino-esp32)
+* [Arduino IDE 1.8.9](https://www.arduino.cc/en/Main/Software)
+* [Arduino AVR Boards 1.6.23](https://github.com/arduino/ArduinoCore-avr)
+* [Arduino SAMD Boards 1.8.3](https://github.com/arduino/ArduinoCore-samd)
+* [SparkFun AVR Boards 1.1.12](https://github.com/sparkfun/Arduino_Boards)
+* [SparkFun SAMD Boards 1.6.2](https://github.com/sparkfun/Arduino_Boards)
+* [ESP8266 Arduino 2.5.2](https://github.com/esp8266/Arduino)
+* [ESP32 Arduino 1.0.2](https://github.com/espressif/arduino-esp32)
+* [Teensydino 1.46](https://www.pjrc.com/teensy/td_download.html)
+
+It should work with [PlatformIO](https://platformio.org/) but I have
+not tested it extensively.
 
-I used MacOS 10.13.3 and Ubuntu 17.10 for most of my development.
+### Operating System
 
-The library is tested on the following hardware before each release:
+I used MacOS 10.13.3 and Ubuntu 18.04 for most of my development.
+
+### Hardware
+
+The library is tested extensively on the following boards:
 
 * Arduino Nano clone (16 MHz ATmega328P)
 * SparkFun Pro Micro clone (16 MHz ATmega32U4)
-* Teensy 3.2 (72 MHz ARM Cortex-M4)
 * NodeMCU 1.0 clone (ESP-12E module, 80 MHz ESP8266)
+* WeMos D1 Mini clone (ESP-12E module, 80 MHz ESP8266)
 * ESP32 dev board (ESP-WROOM-32 module, 240 MHz dual core Tensilica LX6)
+* SAMD21 M0 Mini board (Arduino Zero compatible, 48 MHz ARM Cortex-M0+)
 
 I will occasionally test on the following hardware as a sanity check:
 
-* Arduino UNO R3 clone (16 MHz ATmega328P)
-* Arduino Pro Mini clone (16 MHz ATmega328P)
-* Teensy LC (48 MHz ARM Cortex-M0+)
-* ESP-01 (ESP-01 module, 80 MHz ESP8266)
+* Teensy 3.2 (72 MHz ARM Cortex-M4)
+* Mini Mega 2560 (Arduino Mega 2560 compatible, 16 MHz ATmega2560)
 
 ## License
 

examples/AUnitPlatformIO/AUnitPlatformIO.ino

@@ -0,0 +1,19 @@
+#line 2 "AUnitPlatformIO.ino"
+
+#include <AUnit.h>
+
+test(exampleTest) {
+  assertEqual(3, 3);
+}
+
+void setup() {
+#if ARDUINO
+  delay(1000); // wait for stability on some boards to prevent garbage Serial
+#endif
+  Serial.begin(115200); // ESP8266 default of 74880 not supported on Linux
+  while(!Serial); // for the Arduino Leonardo/Micro only
+}
+
+void loop() {
+  aunit::TestRunner::run();
+}

examples/AUnitPlatformIO/Makefile

@@ -0,0 +1,6 @@
+# See https://github.com/bxparks/UnixHostDuino for documentation about this
+# Makefile to compile and run Arduino programs natively on Linux or MacOS.
+
+APP_NAME := AUnitPlatformIO
+ARDUINO_LIBS := AUnit
+include ../../../UnixHostDuino/UnixHostDuino.mk

examples/AUnitPlatformIO/README.md

@@ -0,0 +1,49 @@
+# AUnit on PlatformIO
+
+This is an example unit test that runs on the PlatformIO environment. Created to
+track down [AUnit#50](https://github.com/bxparks/AUnit/issues/50) where
+`UnixHostDuino/` directory seems to break PlatformIO because it tries to compile
+it. Unfortunately, I cannot reproduce it. This seems to work fine on my machine.
+
+## Updating PlatformIO
+
+Here are the various pio commands that I had to run to update
+PlatformIO:
+
+```
+$ pio upgrade
+$ pio update
+$ pio lib update
+```
+
+## Compile on All Environments
+
+```
+$ pio run -t clean
+$ pio run
+```
+
+## Upload and Monitor
+Here is the commnad to compile, upload and monitor the test to an Arduino Nano
+on /dev/ttyUSB0:
+
+```
+$ pio run -e nano -t upload --upload-port /dev/ttyUSB0 && \
+    pio device monitor -b 115200 -p /dev/ttyUSB0
+```
+
+Here is the commnad to compile, upload and monitor the test to an ESP32
+on /dev/ttyUSB1:
+
+```
+$ pio run -e esp32 -t upload --upload-port /dev/ttyUSB1 && \
+    pio device monitor -b 115200 -p /dev/ttyUSB1
+```
+
+## Compile and Run on Linux or MacOS
+
+```
+$ make clean
+$ make
+$ ./AUnitPlatformIO.out
+```

examples/AUnitPlatformIO/platformio.ini

@@ -0,0 +1,28 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; http://docs.platformio.org/page/projectconf.html
+
+[env:nano]
+platform = atmelavr
+board = nanoatmega328
+framework = arduino
+lib_deps = AUnit
+
+[env:micro]
+platform = atmelavr
+board = leonardo
+framework = arduino
+lib_deps = AUnit
+
+[env:esp32]
+platform = espressif32
+board = esp32dev
+framework = arduino
+lib_deps = AUnit
+upload_speed = 921600

examples/AUnitPlatformIO/src/AUnitPlatformIO.ino

@@ -0,0 +1 @@
+../AUnitPlatformIO.ino

src/aunit/Flash.h

@@ -95,4 +95,29 @@ class __FlashStringHelper;
   #error Unsupported platform
 #endif
 
+// Define SERIAL_PORT_MONITOR consistently. We should also rename this file to
+// something like "compat.h".
+#if defined(ARDUINO_SAMD_ZERO)
+  // If have a real Arduino Zero and using the "Arduino/Genuino Zero (Native
+  // USB Port)" configuration on the Arduino IDE,  you may need to uncomment
+  // the following to clobber SERIAL_PORT_MONITOR to point to the correct
+  // SerialUSB.
+  //
+  // On the other hand, if you are using a SparkFun breakout board, or one of
+  // the "SAMD21 M0 Mini" clones, you should be using the SparkFun SAMD Boards,
+  // and selecting the "SparkFun SAMD21 Dev Breakout" or the "SparkFun SAMD21
+  // Mini Breakout" settings, which will set the SERIAL_PORT_MONITOR macro
+  // correctly to SerialUSB.
+  #if 0
+    #undef SERIAL_PORT_MONITOR
+    #define SERIAL_PORT_MONITOR SerialUSB
+  #endif
+#elif defined(ESP32)
+  #if ! defined(SERIAL_PORT_MONITOR)
+    #define SERIAL_PORT_MONITOR Serial
+  #endif
+#elif defined(__linux__) or defined(__APPLE__)
+  #define SERIAL_PORT_MONITOR Serial
+#endif
+
 #endif

src/aunit/Printer.cpp

@@ -23,10 +23,11 @@ SOFTWARE.
 */
 
 #include <Arduino.h> // Serial
+#include "Flash.h"
 #include "Printer.h"
 
 namespace aunit {
 
-Print* Printer::sPrinter = &Serial;
+Print* Printer::sPrinter = &SERIAL_PORT_MONITOR;
 
 }

src/aunit/TestRunner.cpp

@@ -81,18 +81,7 @@ void TestRunner::setLifeCycleMatchingPattern(const char* testClass,
   setLifeCycleMatchingPattern(fullPattern, lifeCycle);
 }
 
-TestRunner::TestRunner():
-    mCurrent(nullptr),
-    mIsResolved(false),
-    mIsSetup(false),
-    mIsRunning(false),
-    mVerbosity(Verbosity::kDefault),
-    mCount(0),
-    mPassedCount(0),
-    mFailedCount(0),
-    mSkippedCount(0),
-    mStatusErrorCount(0),
-    mTimeout(kTimeoutDefault) {}
+TestRunner::TestRunner() {}
 
 void TestRunner::runTest() {
   setupRunner();
@@ -109,9 +98,9 @@ void TestRunner::runTest() {
       mEndTime = millis();
       resolveRun();
       mIsResolved = true;
-      #ifndef ARDUINO
-      exit(0);
-      #endif
+    #if UNIX_HOST_DUINO
+      exit((mFailedCount || mExpiredCount) ? 1 : 0);
+    #endif
     }
     return;
   }