Suggested fixes

.rubocop.yml

@@ -31,6 +31,12 @@ Layout/ExtraSpacing:
 Layout/EndOfLine:
   EnforcedStyle: lf
 
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
 Metrics/LineLength:
   Description: Limit lines to 80 characters.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#80-character-limits

.travis.yml

@@ -27,3 +27,9 @@ script:
    - cd SampleProjects/TestSomething
    - bundle install
    - bundle exec arduino_ci.rb
+   - cd ../NetworkLib
+   - cd scripts
+   - bash -x ./install.sh
+   - cd ..
+   - bundle install
+   - bundle exec arduino_ci.rb

CHANGELOG.md

@@ -7,21 +7,36 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 ### Added
-- Add `__AVR__` to defines when compiling
+- `arduino_ci_remote.rb` CLI switch `--skip-examples-compilation`
 - Add support for `diditalPinToPort()`, `digitalPinToBitMask()`, and `portOutputRegister()`
+- `CppLibrary.header_files` to find header files
+- `LibraryProperties` to read metadata from Arduino libraries
+- `CppLibrary.library_properties_path`, `CppLibrary.library_properties?`, `CppLibrary.library_properties` to expose library properties of a Cpp library
+- `CppLibrary.arduino_library_dependencies` to list the dependent libraries specified by the library.properties file
+- `CppLibrary.print_stack_dump` prints stack trace dumps (on Windows specifically) to the console if encountered
+- Definitions for Arduino zero
+- Support for mock EEPROM (but only if board supports it)
+- Add stubs for `Client.h`, `IPAddress.h`, `Printable.h`, `Server.h`, and `Udp.h`
 
 ### Changed
 - Move repository from https://github.com/ianfixes/arduino_ci to https://github.com/Arduino-CI/arduino_ci
 - Revise math macros to avoid name clashes
+- `CppLibrary` functions returning C++ header or code files now respect the 1.0/1.5 library specification
+- Mocks of built-in macros made more accurate
+- NUM_SERIAL_PORTS can now be set explicitly
+- Improve SPI header strategy
+
+### Fixed
+- Don't define `ostream& operator<<(nullptr_t)` if already defined by Apple
+- `CppLibrary.in_tests_dir?` no longer produces an error if there is no tests directory
+- The definition of the `_SFR_IO8` macro no longer produces errors about rvalues
 
 ### Deprecated
+- `arduino_ci_remote.rb` CLI switch `--skip-compilation`
 - Deprecated `arduino_ci_remote.rb` in favor of `arduino_ci.rb`
 
 ### Removed
 
-### Fixed
-- Don't define `ostream& operator<<(nullptr_t)` if already defined by Apple
-
 ### Security
 
 

REFERENCE.md

@@ -19,9 +19,14 @@ When testing locally, it's often advantageous to limit the number of tests that
 This completely skips the unit testing portion of the CI script.
 
 
-### `--skip-compilation` option
+### `--skip-compilation` option (deprecated)
 
-This completely skips the compilation tests (of library examples) portion of the CI script.
+This completely skips the compilation tests (of library examples) portion of the CI script.  It does not skip the compilation of unit tests.
+
+
+### `--skip-examples-compilation` option
+
+This completely skips the compilation tests (of library examples) portion of the CI script.  It does not skip the compilation of unit tests.
 
 
 ### `--testfile-select` option
@@ -90,8 +95,8 @@ platforms:
 
 ### Control How Examples Are Compiled
 
-Put a file `.arduino-ci.yml` in each example directory where you require a different configuration than default.  
-The `compile:` section controls the platforms on which the compilation will be attempted, as well as any external libraries that must be installed and included.  
+Put a file `.arduino-ci.yml` in each example directory where you require a different configuration than default.
+The `compile:` section controls the platforms on which the compilation will be attempted, as well as any external libraries that must be installed and included.
 
 ```yaml
 compile:
@@ -581,3 +586,40 @@ unittest(spi) {
   assertEqual("LMNOe", String(inBuf));
 }
 ```
+
+### EEPROM
+
+`EEPROM` is a global with a simple API to read and write bytes to persistent memory (like a tiny hard disk) given an `int` location. Since the Arduino core already provides this as a global, and the core API is sufficient for basic testing (read/write), there is no direct tie to the `GODMODE` API. (If you need more, such as a log of intermediate values, enter a feature request.)
+
+```C++
+unittest(eeprom)
+{
+  uint8_t a;
+  // size
+  assertEqual(EEPROM_SIZE, EEPROM.length());
+  // initial values
+  a = EEPROM.read(0);
+  assertEqual(255, a);
+  // write and read
+  EEPROM.write(0, 24);
+  a = EEPROM.read(0);
+  assertEqual(24, a);
+  // update
+  EEPROM.write(1, 14);
+  EEPROM.update(1, 22);
+  a = EEPROM.read(1);
+  assertEqual(22, a);
+  // put and get
+  const float f1 = 0.025f;
+  float f2 = 0.0f;
+  EEPROM.put(5, f1);
+  assertEqual(0.0f, f2);
+  EEPROM.get(5, f2);
+  assertEqual(0.025f, f2);
+  // array access
+  int val = 10;
+  EEPROM[2] = val;
+  a = EEPROM[2];
+  assertEqual(10, a);
+}
+```

SampleProjects/DependOnSomething/library.properties

@@ -0,0 +1 @@
+depends=OnePointOhDummy,OnePointFiveDummy

SampleProjects/DependOnSomething/test/null.cpp

@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()

SampleProjects/ExcludeSomething/.arduino-ci.yml

@@ -0,0 +1,3 @@
+unittest:
+  exclude_dirs:
+    - src/excludeThis

SampleProjects/ExcludeSomething/README.md

@@ -0,0 +1,3 @@
+# ExcludeSomething
+
+This example exists to test directory-exclusion code of ArduinoCI

SampleProjects/ExcludeSomething/library.properties

@@ -0,0 +1,10 @@
+name=TestSomething
+version=0.1.0
+author=Ian Katz <[email protected]>
+maintainer=Ian Katz <[email protected]>
+sentence=Arduino CI unit test example
+paragraph=A skeleton library demonstrating file exclusion
+category=Other
+url=https://github.com/Arduino-CI/arduino_ci/SampleProjects/ExcludeSomething
+architectures=avr,esp8266
+includes=do-something.h

SampleProjects/ExcludeSomething/src/exclude-something.cpp

@@ -0,0 +1,4 @@
+#include "exclude-something.h"
+int excludeSomething(void) {
+  return -1;
+};

SampleProjects/ExcludeSomething/src/exclude-something.h

@@ -0,0 +1,3 @@
+#pragma once
+#include <Arduino.h>
+int excludeSomething(void);

SampleProjects/ExcludeSomething/test/null.cpp

@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()

SampleProjects/NetworkLib/.arduino-ci.yml

@@ -0,0 +1,11 @@
+unittest:
+  platforms:
+    - mega2560
+  libraries:
+    - "Ethernet"
+
+compile:
+  platforms:
+    - mega2560
+  libraries:
+    - "Ethernet"

SampleProjects/NetworkLib/.gitignore

@@ -0,0 +1 @@
+.bundle

SampleProjects/NetworkLib/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gem 'arduino_ci', path: '../../'

SampleProjects/NetworkLib/README.md

@@ -0,0 +1,3 @@
+# NetworkLib
+
+This is an example of a library that depends on Ethernet.

SampleProjects/NetworkLib/examples/EthernetExample/EthernetExample.ino

@@ -0,0 +1,6 @@
+#include <NetworkLib.h>
+// if it seems bare, that's because it's only meant to
+// demonstrate compilation -- that references work
+void setup() {}
+
+void loop() {}

SampleProjects/NetworkLib/library.properties

@@ -0,0 +1,10 @@
+name=Ethernet
+version=0.1.0
+author=James Foster <[email protected]>
+maintainer=James Foster <[email protected]>
+sentence=Sample Ethernet library to validate Client/Server mocks
+paragraph=Sample Ethernet library to validate Client/Server mocks
+category=Other
+url=https://github.com/Arduino-CI/arduino_ci/SampleProjects/Ethernet
+architectures=avr,esp8266
+includes=NetworkLib.h

SampleProjects/NetworkLib/scripts/install.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# if we don't have an Ethernet library already (say, in new install or for an automated test),
+# then get the custom one we want to use for testing
+cd $(bundle exec arduino_library_location.rb)
+if [ ! -d ./Ethernet ] ; then
+  git clone https://github.com/Arduino-CI/Ethernet.git
+fi

SampleProjects/NetworkLib/src/NetworkLib.cpp

@@ -0,0 +1 @@
+#include "Ethernet.h"

SampleProjects/NetworkLib/src/NetworkLib.h

@@ -0,0 +1,3 @@
+#pragma once
+
+#include <Arduino.h>

SampleProjects/NetworkLib/test/test.cpp

@@ -0,0 +1,15 @@
+/*
+cd SampleProjects/NetworkLib
+bundle config --local path vendor/bundle
+bundle install
+bundle exec arduino_ci_remote.rb  --skip-compilation
+# bundle exec arduino_ci_remote.rb  --skip-examples-compilation
+*/
+
+#include <Arduino.h>
+#include <ArduinoUnitTests.h>
+#include <Ethernet.h>
+
+unittest(test) { assertEqual(EthernetNoHardware, Ethernet.hardwareStatus()); }
+
+unittest_main()

SampleProjects/OnePointFiveDummy/README.md

@@ -0,0 +1 @@
+This project resembles a "1.5 spec" library: it has `library.properties` and a `src/` directory that will be scanned recursively.  `utility/`, if present, will be ignored.

SampleProjects/OnePointFiveDummy/test/null.cpp

@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()

SampleProjects/OnePointFiveMalformed/README.md

@@ -0,0 +1 @@
+This project lacks a `library.properties` and so should be treated as a "1.0 spec" library -- the base and `utility` directories will be scanned for code, non-recursively.  `src/`, if present, will be ignored.

SampleProjects/OnePointOhDummy/README.md

@@ -0,0 +1 @@
+This project should resemble "1.0 spec" library -- the base and `utility` directories will be scanned for code, non-recursively.  `src/`, if present, will be ignored.

SampleProjects/OnePointOhDummy/test/null.cpp

@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()

SampleProjects/README.md

@@ -1,7 +1,15 @@
 Arduino Sample Projects
 =======================
 
-This directory contains projects that are meant to be built with and tested by this gem. Although this directory is named `SampleProjects`, it is by no means optional. These project test the testing framework itself, but also provide examples of how you might write your own tests (which should be placed in your system's Arduino `libraries` directory). 
+This directory contains projects that are intended solely for testing the various features of this gem -- to test the testing framework itself.  The RSpec tests refer specifically to these projects.
 
-* "DoSomething" is a simple test of the testing framework (arduino_ci) itself to verfy that passes and failures are properly identified and reported.
-* "TestSomething" contains tests for all the mock features of arduino_ci.
+Because of this, these projects include some intentional quirks that differ from what a well-formed an Arduino project for testing with `arduino_ci` might contain.  See other projects in the "Arduino-CI" GitHub organization for practical examples.
+
+
+* "TestSomething" contains a minimial library, but tests for all the C++ compilation feature-mocks of arduino_ci.
+* "DoSomething" is a simple test of the testing framework (arduino_ci) itself to verfy that passes and failures are properly identified and reported.  Because of this, it includes test files that are expected to fail -- they are prefixed with "bad-".
+* "OnePointOhDummy" is a non-functional library meant to test file inclusion logic on libraries conforming to the "1.0" specification
+* "OnePointFiveMalformed" is a non-functional library meant to test file inclusion logic on libraries that attempt to conform to the ["1.5" specfication](https://arduino.github.io/arduino-cli/latest/library-specification/) but fail to include a `src` directory
+* "OnePointFiveDummy" is a non-functional library meant to test file inclusion logic on libraries conforming to the ["1.5" specfication](https://arduino.github.io/arduino-cli/latest/library-specification/)
+* "DependOnSomething" is a non-functional library meant to test file inclusion logic with dependencies
+* "ExcludeSomething" is a non-functional library meant to test directory exclusion logic

SampleProjects/TestSomething/.arduino-ci.yml

@@ -1,6 +1,4 @@
 unittest:
-  exclude_dirs:
-    - excludeThis
   platforms:
     - uno
     - due

SampleProjects/TestSomething/test/clientServer.cpp

@@ -0,0 +1,87 @@
+#include <Arduino.h>
+#include <ArduinoUnitTests.h>
+#include <Client.h>
+#include <IPAddress.h>
+#include <Printable.h>
+#include <Server.h>
+#include <Udp.h>
+
+// Provide some rudamentary tests for these classes
+// They get more thoroughly tested in SampleProjects/NetworkLib
+
+unittest(Client) {
+  Client client;
+  assertEqual(0, client.available());         // subclass of Stream
+  assertEqual(0, client.availableForWrite()); // subclass of Print
+  String outData = "Hello, world!";
+  client.println(outData);
+  String inData = client.readString();
+  assertEqual(outData + "\r\n", inData);
+}
+
+unittest(IPAddress) {
+  IPAddress ipAddress0;
+  assertEqual(0, ipAddress0.asWord());
+  uint32_t one = 0x01020304;
+  IPAddress ipAddress1(one);
+  assertEqual(one, ipAddress1.asWord());
+  IPAddress ipAddress2(2, 3, 4, 5);
+  assertEqual(0x05040302, ipAddress2.asWord());
+  uint8_t bytes[] = {3, 4, 5, 6};
+  IPAddress ipAddress3(bytes);
+  assertEqual(0x06050403, ipAddress3.asWord());
+  uint8_t *pBytes = ipAddress1.raw_address();
+  assertEqual(*(pBytes + 0), 4);
+  assertEqual(*(pBytes + 1), 3);
+  assertEqual(*(pBytes + 2), 2);
+  assertEqual(*(pBytes + 3), 1);
+  IPAddress ipAddress1a(one);
+  assertTrue(ipAddress1 == ipAddress1a);
+  assertTrue(ipAddress1 != ipAddress2);
+  assertEqual(1, ipAddress1[3]);
+  ipAddress1[1] = 11;
+  assertEqual(11, ipAddress1[1]);
+  assertEqual(1, ipAddress0 + 1);
+}
+
+class TestPrintable : public Printable {
+public:
+  virtual size_t printTo(Print &p) const {
+    p.print("TestPrintable");
+    return 13;
+  }
+};
+
+unittest(Printable) {
+  TestPrintable printable;
+  Client client;
+  client.print(printable);
+  assertEqual("TestPrintable", client.readString());
+}
+
+class TestServer : public Server {
+public:
+  uint8_t data;
+  virtual size_t write(uint8_t value) {
+    data = value;
+    return 1;
+  };
+};
+
+unittest(Server) {
+  TestServer server;
+  server.write(67);
+  assertEqual(67, server.data);
+}
+
+unittest(Udp) {
+  UDP udp;
+  assertEqual(0, udp.available());         // subclass of Stream
+  assertEqual(0, udp.availableForWrite()); // subclass of Print
+  String outData = "Hello, world!";
+  udp.println(outData);
+  String inData = udp.readString();
+  assertEqual(outData + "\r\n", inData);
+}
+
+unittest_main()