Merge pull request #74 from bxparks/develop

merge 1.5.5 into master

CHANGELOG.md

@@ -1,6 +1,18 @@
 # Changelog
 
 * Unreleased
+* 1.5.5 (2021-05-03)
+    * Prevent accidental inclusion of `HardwareSerial` class (via the `Serial`
+      global variable). Remove reference to `SERIAL_PORT_MONITOR` from
+      `Printer::sPrinter`. Move reference to `SERIAL_PORT_MONITOR` from
+      TestRunner.cpp to TestRunner.h. Saves about 800 bytes on AVR applications
+      which don't use `Serial` at all.
+    * Activate
+      [GitHub Discussions](https://github.com/bxparks/AUnit/discussions)
+      for this project.
+    * Blacklist all other platforms using ArduinoCore-API (e.g. RP2040) to
+      generate a user-friendly error message instead of pages of obscure
+      compiler errors.
 * 1.5.4 (2021-03-02)
     * Implement `assertNoFatalFailure(statement)` macro to prevent continued
       execution if `statement` contains assertion failures. Fixes

README.md

@@ -1,6 +1,11 @@
 # AUnit
 
-![AUnit Tests](https://github.com/bxparks/AUnit/workflows/AUnit%20Tests/badge.svg)
+[![AUnit Tests](https://github.com/bxparks/AUnit/actions/workflows/aunit_tests.yml/badge.svg)](https://github.com/bxparks/AUnit/actions/workflows/aunit_tests.yml)
+
+**New**: [GitHub Discussions](https://github.com/bxparks/AUnit/discussions)
+for this project is now active! Let's use that for general support questions,
+and reserve the [GitHub Issues](https://github.com/bxparks/AUnit/issues)
+section for bugs and feature requests.
 
 A unit testing framework for Arduino platforms inspired by by
 [ArduinoUnit](https://github.com/mmurdoch/arduinounit) and [Google
@@ -20,7 +25,7 @@ instead of having to go through the Arduino IDE. Both the AUniter and
 EpoxyDuino tools can be used in a continuous integration system like Jenkins,
 or with [GitHub Actions](https://github.com/features/actions).
 
-**Version**: 1.5.4 (2021-03-02)
+**Version**: 1.5.5 (2021-05-03)
 
 **Changelog**: [CHANGELOG.md](CHANGELOG.md)
 
@@ -81,7 +86,7 @@ or with [GitHub Actions](https://github.com/features/actions).
     * [Tool Chain](#ToolChains)
     * [Operating System](#ToolChains)
 * [License](#License)
-* [Feedback and Support](#Feedback)
+* [Feedback and Support](#FeedbackAndSupport)
 * [Authors](#Authors)
 
 <a name="Summary"></a>
@@ -1828,10 +1833,17 @@ I will occasionally test on the following hardware as a sanity check:
 * Mini Mega 2560 (Arduino Mega 2560 compatible, 16 MHz ATmega2560)
 * Teensy LC (48 MHz ARM Cortex-M0+)
 
-The following boards are *not* supported:
+The following boards are **not** supported:
 
-* megaAVR (e.g. Nano Every)
-* SAMD21 boards w/ `arduino:samd` version >= 1.8.10 (e.g. MKRZero)
+* megaAVR (e.g. Nano Every) using ArduinoCore-megaavr
+  (https://github.com/arduino/ArduinoCore-megaavr/)
+* SAMD21 boards (e.g. MKRZero) using ArduinoCore-samd
+  (https://github.com/arduino/ArduinoCore-samd) starting with
+  `arduino:samd` version >= 1.8.10
+* Raspberry Pi Pico (RP2040) using Arduino-Pico
+  (https://github.com/earlephilhower/arduino-pico)
+* Any other platform using the ArduinoCore-API
+  (https://github.com/arduino/ArduinoCore-api)
 
 <a name="ToolChain"></a>
 ### Tool Chain
@@ -1845,7 +1857,7 @@ This library was validated using:
 * [SparkFun SAMD Boards 1.8.1](https://github.com/sparkfun/Arduino_Boards)
 * [STM32duino 1.9.0](https://github.com/stm32duino/Arduino_Core_STM32)
 * [ESP8266 Arduino 2.7.4](https://github.com/esp8266/Arduino)
-* [ESP32 Arduino 1.0.4](https://github.com/espressif/arduino-esp32)
+* [ESP32 Arduino 1.0.6](https://github.com/espressif/arduino-esp32)
 * [Teensyduino 1.53](https://www.pjrc.com/teensy/td_download.html)
 
 This library is *not* compatible with:
@@ -1869,19 +1881,25 @@ I used MacOS 10.13.3, Ubuntu 18.04, and Ubuntu 20.04 for most of my development.
 
 [MIT License](https://opensource.org/licenses/MIT)
 
-<a name="Feedback"></a>
+<a name="FeedbackAndSupport"></a>
 ## Feedback and Support
 
 If you find this library useful, consider starring this project on GitHub. The
 stars will let me prioritize the more popular libraries over the less popular
 ones.
 
-If you have any questions, comments, bug reports, or feature requests, please
-file a GitHub ticket instead of emailing me unless the content is sensitive.
-(The problem with email is that I cannot reference the email conversation when
-other people ask similar questions later.) I'd love to hear about how this
-software and its documentation can be improved. I can't promise that I will
-incorporate everything, but I will give your ideas serious consideration.
+If you have any questions, comments and other support questions about how to
+use this library, please use the
+[GitHub Discussions](https://github.com/bxparks/AUnit/discussions)
+for this project. If you have bug reports or feature requests, please file a
+ticket in [GitHub Issues](https://github.com/bxparks/AUnit/issues).
+I'd love to hear about how this software and its documentation can be improved.
+I can't promise that I will incorporate everything, but I will give your ideas
+serious consideration.
+
+Please refrain from emailing me directly unless the content is sensitive. The
+problem with email is that I cannot reference the email conversation when other
+people ask similar questions later.
 
 <a name="Authors"></a>
 ## Authors

docs/doxygen.cfg

@@ -38,7 +38,7 @@ PROJECT_NAME           = "AUnit"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.5.4
+PROJECT_NUMBER         = 1.5.5
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

docs/html/AUnitVerbose_8h.html

@@ -22,7 +22,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">AUnit
-   &#160;<span id="projectnumber">1.5.4</span>
+   &#160;<span id="projectnumber">1.5.5</span>
    </div>
    <div id="projectbrief">Unit testing framework for Arduino platforms inspired by ArduinoUnit and Google Test.</div>
   </td>
@@ -91,27 +91,27 @@
 <div class="dyncontent">
 <div class="center"><img src="AUnitVerbose_8h__incl.png" border="0" usemap="#_2home_2brian_2src_2AUnit_2src_2AUnitVerbose_8h" alt=""/></div>
 <map name="_2home_2brian_2src_2AUnit_2src_2AUnitVerbose_8h" id="_2home_2brian_2src_2AUnit_2src_2AUnitVerbose_8h">
-<area shape="rect" title=" " alt="" coords="772,5,935,47"/>
+<area shape="rect" title=" " alt="" coords="436,5,599,47"/>
 <area shape="rect" href="print64_8h.html" title=" " alt="" coords="5,95,123,121"/>
-<area shape="rect" href="Verbosity_8h_source.html" title=" " alt="" coords="1023,468,1153,495"/>
-<area shape="rect" href="Compare_8h.html" title=" " alt="" coords="95,244,225,271"/>
-<area shape="rect" href="Printer_8h_source.html" title=" " alt="" coords="631,319,745,345"/>
-<area shape="rect" href="Test_8h_source.html" title=" " alt="" coords="939,393,1037,420"/>
-<area shape="rect" href="Assertion_8h_source.html" title=" " alt="" coords="821,319,953,345"/>
-<area shape="rect" href="MetaAssertion_8h_source.html" title=" " alt="" coords="771,244,936,271"/>
-<area shape="rect" href="TestOnce_8h_source.html" title=" " alt="" coords="669,169,800,196"/>
-<area shape="rect" href="TestAgain_8h_source.html" title=" " alt="" coords="198,169,333,196"/>
-<area shape="rect" href="TestRunner_8h_source.html" title=" " alt="" coords="1163,319,1306,345"/>
-<area shape="rect" href="AssertVerboseMacros_8h.html" title=" " alt="" coords="1112,95,1323,121"/>
-<area shape="rect" href="MetaAssertMacros_8h.html" title=" " alt="" coords="1397,244,1589,271"/>
-<area shape="rect" href="TestMacros_8h.html" title=" " alt="" coords="451,95,595,121"/>
-<area shape="rect" title=" " alt="" coords="123,543,197,569"/>
-<area shape="rect" title=" " alt="" coords="59,169,123,196"/>
-<area shape="rect" title=" " alt="" coords="849,543,919,569"/>
-<area shape="rect" href="FCString_8h_source.html" title=" " alt="" coords="498,468,587,495"/>
-<area shape="rect" href="Flash_8h.html" title=" " alt="" coords="845,393,915,420"/>
-<area shape="rect" title=" " alt="" coords="821,468,947,495"/>
-<area shape="rect" title=" " alt="" coords="409,169,493,196"/>
+<area shape="rect" href="Verbosity_8h_source.html" title=" " alt="" coords="512,468,643,495"/>
+<area shape="rect" href="Compare_8h.html" title=" " alt="" coords="197,244,328,271"/>
+<area shape="rect" href="Printer_8h_source.html" title=" " alt="" coords="390,319,503,345"/>
+<area shape="rect" href="Test_8h_source.html" title=" " alt="" coords="563,393,661,420"/>
+<area shape="rect" href="Assertion_8h_source.html" title=" " alt="" coords="579,319,711,345"/>
+<area shape="rect" href="MetaAssertion_8h_source.html" title=" " alt="" coords="555,244,720,271"/>
+<area shape="rect" href="TestOnce_8h_source.html" title=" " alt="" coords="765,169,896,196"/>
+<area shape="rect" href="TestAgain_8h_source.html" title=" " alt="" coords="921,169,1055,196"/>
+<area shape="rect" href="TestRunner_8h_source.html" title=" " alt="" coords="555,95,698,121"/>
+<area shape="rect" href="AssertVerboseMacros_8h.html" title=" " alt="" coords="824,95,1035,121"/>
+<area shape="rect" href="MetaAssertMacros_8h.html" title=" " alt="" coords="997,244,1189,271"/>
+<area shape="rect" href="TestMacros_8h.html" title=" " alt="" coords="1131,95,1275,121"/>
+<area shape="rect" title=" " alt="" coords="225,543,300,569"/>
+<area shape="rect" title=" " alt="" coords="8,169,72,196"/>
+<area shape="rect" title=" " alt="" coords="778,543,849,569"/>
+<area shape="rect" href="FCString_8h_source.html" title=" " alt="" coords="769,468,858,495"/>
+<area shape="rect" href="Flash_8h.html" title=" " alt="" coords="1059,393,1128,420"/>
+<area shape="rect" title=" " alt="" coords="1030,468,1157,495"/>
+<area shape="rect" title=" " alt="" coords="657,169,741,196"/>
 </map>
 </div>
 </div>
@@ -120,10 +120,10 @@
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
 Macros</h2></td></tr>
 <tr class="memitem:a87cbb10969eff63f8ae66afc4e9457eb"><td class="memItemLeft" align="right" valign="top"><a id="a87cbb10969eff63f8ae66afc4e9457eb"></a>
-#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUNIT_VERSION</b>&#160;&#160;&#160;10504</td></tr>
+#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUNIT_VERSION</b>&#160;&#160;&#160;10505</td></tr>
 <tr class="separator:a87cbb10969eff63f8ae66afc4e9457eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a70ade1487f0d9d7172f24897cd0f2dd5"><td class="memItemLeft" align="right" valign="top"><a id="a70ade1487f0d9d7172f24897cd0f2dd5"></a>
-#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUNIT_VERSION_STRING</b>&#160;&#160;&#160;&quot;1.5.4&quot;</td></tr>
+#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUNIT_VERSION_STRING</b>&#160;&#160;&#160;&quot;1.5.5&quot;</td></tr>
 <tr class="separator:a70ade1487f0d9d7172f24897cd0f2dd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

docs/html/AUnitVerbose_8h__incl.map

@@ -1,23 +1,23 @@
 <map id="/home/brian/src/AUnit/src/AUnitVerbose.h" name="/home/brian/src/AUnit/src/AUnitVerbose.h">
-<area shape="rect" id="node1" title=" " alt="" coords="772,5,935,47"/>
+<area shape="rect" id="node1" title=" " alt="" coords="436,5,599,47"/>
 <area shape="rect" id="node2" href="$print64_8h.html" title=" " alt="" coords="5,95,123,121"/>
-<area shape="rect" id="node5" href="$Verbosity_8h_source.html" title=" " alt="" coords="1023,468,1153,495"/>
-<area shape="rect" id="node7" href="$Compare_8h.html" title=" " alt="" coords="95,244,225,271"/>
-<area shape="rect" id="node8" href="$Printer_8h_source.html" title=" " alt="" coords="631,319,745,345"/>
-<area shape="rect" id="node9" href="$Test_8h_source.html" title=" " alt="" coords="939,393,1037,420"/>
-<area shape="rect" id="node11" href="$Assertion_8h_source.html" title=" " alt="" coords="821,319,953,345"/>
-<area shape="rect" id="node14" href="$MetaAssertion_8h_source.html" title=" " alt="" coords="771,244,936,271"/>
-<area shape="rect" id="node15" href="$TestOnce_8h_source.html" title=" " alt="" coords="669,169,800,196"/>
-<area shape="rect" id="node16" href="$TestAgain_8h_source.html" title=" " alt="" coords="198,169,333,196"/>
-<area shape="rect" id="node17" href="$TestRunner_8h_source.html" title=" " alt="" coords="1163,319,1306,345"/>
-<area shape="rect" id="node18" href="$AssertVerboseMacros_8h.html" title=" " alt="" coords="1112,95,1323,121"/>
-<area shape="rect" id="node19" href="$MetaAssertMacros_8h.html" title=" " alt="" coords="1397,244,1589,271"/>
-<area shape="rect" id="node20" href="$TestMacros_8h.html" title=" " alt="" coords="451,95,595,121"/>
-<area shape="rect" id="node3" title=" " alt="" coords="123,543,197,569"/>
-<area shape="rect" id="node4" title=" " alt="" coords="59,169,123,196"/>
-<area shape="rect" id="node6" title=" " alt="" coords="849,543,919,569"/>
-<area shape="rect" id="node10" href="$FCString_8h_source.html" title=" " alt="" coords="498,468,587,495"/>
-<area shape="rect" id="node12" href="$Flash_8h.html" title=" " alt="" coords="845,393,915,420"/>
-<area shape="rect" id="node13" title=" " alt="" coords="821,468,947,495"/>
-<area shape="rect" id="node21" title=" " alt="" coords="409,169,493,196"/>
+<area shape="rect" id="node5" href="$Verbosity_8h_source.html" title=" " alt="" coords="512,468,643,495"/>
+<area shape="rect" id="node7" href="$Compare_8h.html" title=" " alt="" coords="197,244,328,271"/>
+<area shape="rect" id="node8" href="$Printer_8h_source.html" title=" " alt="" coords="390,319,503,345"/>
+<area shape="rect" id="node9" href="$Test_8h_source.html" title=" " alt="" coords="563,393,661,420"/>
+<area shape="rect" id="node11" href="$Assertion_8h_source.html" title=" " alt="" coords="579,319,711,345"/>
+<area shape="rect" id="node14" href="$MetaAssertion_8h_source.html" title=" " alt="" coords="555,244,720,271"/>
+<area shape="rect" id="node15" href="$TestOnce_8h_source.html" title=" " alt="" coords="765,169,896,196"/>
+<area shape="rect" id="node16" href="$TestAgain_8h_source.html" title=" " alt="" coords="921,169,1055,196"/>
+<area shape="rect" id="node17" href="$TestRunner_8h_source.html" title=" " alt="" coords="555,95,698,121"/>
+<area shape="rect" id="node19" href="$AssertVerboseMacros_8h.html" title=" " alt="" coords="824,95,1035,121"/>
+<area shape="rect" id="node20" href="$MetaAssertMacros_8h.html" title=" " alt="" coords="997,244,1189,271"/>
+<area shape="rect" id="node21" href="$TestMacros_8h.html" title=" " alt="" coords="1131,95,1275,121"/>
+<area shape="rect" id="node3" title=" " alt="" coords="225,543,300,569"/>
+<area shape="rect" id="node4" title=" " alt="" coords="8,169,72,196"/>
+<area shape="rect" id="node6" title=" " alt="" coords="778,543,849,569"/>
+<area shape="rect" id="node10" href="$FCString_8h_source.html" title=" " alt="" coords="769,468,858,495"/>
+<area shape="rect" id="node12" href="$Flash_8h.html" title=" " alt="" coords="1059,393,1128,420"/>
+<area shape="rect" id="node13" title=" " alt="" coords="1030,468,1157,495"/>
+<area shape="rect" id="node18" title=" " alt="" coords="657,169,741,196"/>
 </map>

docs/html/AUnitVerbose_8h__incl.md5

@@ -1 +1 @@
-8350e4c6c7068d949e9846bc218ff24b
+50e9dd29c8ce25d29ac0d20ad15abb19