WIP: runs unit tests.

James Foster · James Foster · commit 28b0525a35dd · 2020-11-05T17:38:07.000-08:00
diff --git a/SampleProjects/NetworkLib/.arduino-ci.yml b/SampleProjects/NetworkLib/.arduino-ci.yml
@@ -0,0 +1,11 @@
+unittest:
+  platforms:
+    - mega2560
+  # libraries:
+    # - "Ethernet"
+
+compile:
+  platforms:
+    - mega2560
+  # libraries:
+    # - "Ethernet"
diff --git a/SampleProjects/NetworkLib/.gitignore b/SampleProjects/NetworkLib/.gitignore
@@ -0,0 +1 @@
+.bundle
diff --git a/SampleProjects/NetworkLib/Gemfile b/SampleProjects/NetworkLib/Gemfile
@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gem 'arduino_ci', path: '../../'
diff --git a/SampleProjects/NetworkLib/README.md b/SampleProjects/NetworkLib/README.md
@@ -0,0 +1,3 @@
+# NetworkLib
+
+This is an example of a library that depends on Ethernet.
diff --git a/SampleProjects/NetworkLib/library.properties b/SampleProjects/NetworkLib/library.properties
@@ -0,0 +1,10 @@
+name=Ethernet
+version=0.1.0
+author=James Foster <arduino@jgfoster.net>
+maintainer=James Foster <arduino@jgfoster.net>
+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
diff --git a/SampleProjects/NetworkLib/scripts/install.sh b/SampleProjects/NetworkLib/scripts/install.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+cd "$( dirname "${BASH_SOURCE[0]}" )"
+cd ../src
+rm -rf Ethernet > /dev/null 2>&1
+# get Ethernet library
+git clone https://github.com/arduino-libraries/Ethernet.git
diff --git a/SampleProjects/NetworkLib/src/NetworkLib.cpp b/SampleProjects/NetworkLib/src/NetworkLib.cpp
@@ -0,0 +1 @@
+#include "Ethernet.h"
diff --git a/SampleProjects/NetworkLib/src/NetworkLib.h b/SampleProjects/NetworkLib/src/NetworkLib.h
@@ -0,0 +1,3 @@
+#pragma once
+
+#include <Arduino.h>
diff --git a/SampleProjects/NetworkLib/test/test.cpp b/SampleProjects/NetworkLib/test/test.cpp
@@ -0,0 +1,16 @@
+/*
+cd SampleProjects/Ethernet 
+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 <ArduinoUnitTests.h>
+#include <Arduino.h>
+
+unittest(test) {
+  assertTrue(true);
+}
+
+unittest_main()
diff --git a/cpp/arduino/Arduino.h b/cpp/arduino/Arduino.h
@@ -9,6 +9,7 @@ Where possible, variable names from the Arduino library are used to avoid confli
 
 #include "ArduinoDefines.h"
 
+#include "IPAddress.h"
 #include "WCharacter.h"
 #include "WString.h"
 #include "Print.h"
diff --git a/cpp/arduino/Client.h b/cpp/arduino/Client.h
@@ -0,0 +1,14 @@
+#pragma once
+
+#include <Stream.h>
+
+// https://github.com/arduino-libraries/Ethernet/blob/master/src/utility/w5100.h:341
+extern volatile uint8_t mmapPorts[MOCK_PINS_COUNT];
+#define portOutputRegister(port)  (uint8_t *) (&mmapPorts[port])
+#define digitalPinToPort(pin)     (pin)
+#define digitalPinToBitMask(pin)  (1)
+
+class Client : public Stream {
+protected:
+  uint8_t* rawIPAddress(IPAddress& addr) { return addr.raw_address(); };
+};
diff --git a/cpp/arduino/Godmode.cpp b/cpp/arduino/Godmode.cpp
@@ -113,3 +113,6 @@ SPIClass SPI = SPIClass(&GODMODE()->spi.dataIn, &GODMODE()->spi.dataOut);
 
 // defined in Wire.h
 TwoWire Wire = TwoWire();
+
+// Memory-mapped ports defined in Client.h
+uint8_t volatile mmapPorts[MOCK_PINS_COUNT];
diff --git a/cpp/arduino/IPAddress.h b/cpp/arduino/IPAddress.h
@@ -0,0 +1,60 @@
+#pragma once
+
+#include <stdint.h>
+
+class IPAddress {
+private:
+  union {
+    uint8_t bytes[4];
+    uint32_t dword;
+    operator uint8_t* () const { return (uint8_t*) bytes; }
+  } _address;
+
+public:
+  // Constructors
+  IPAddress() { IPAddress(0, 0, 0, 0); }
+  IPAddress(uint8_t octet1, uint8_t octet2, uint8_t octet3, uint8_t octet4) {
+    _address.bytes[0] = octet1;
+    _address.bytes[1] = octet2;
+    _address.bytes[2] = octet3;
+    _address.bytes[3] = octet4;
+  }
+  IPAddress(uint32_t dword) { _address.dword = dword; }
+  IPAddress(const uint8_t bytes[]) {
+    _address.bytes[0] = bytes[0];
+    _address.bytes[1] = bytes[1];
+    _address.bytes[2] = bytes[2];
+    _address.bytes[3] = bytes[3];
+  }
+
+  IPAddress(unsigned long dword) { _address.dword = (uint32_t) dword; }
+
+  // Accessors
+  uint32_t asWord() const { return _address.dword; }
+  uint8_t *raw_address() { return _address.bytes; };
+
+  // Comparisons
+  bool operator==(const IPAddress &rhs) const {
+    return _address.dword == rhs.asWord();
+  }
+
+  bool operator!=(const IPAddress &rhs) const {
+    return _address.dword != rhs.asWord();
+  }
+
+  // Indexing
+  uint8_t operator[](int index) const { return _address.bytes[index]; }
+  uint8_t &operator[](int index) { return _address.bytes[index]; }
+
+  // Conversions
+  operator uint32_t() const { return _address.dword; };
+
+  friend class EthernetClass;
+  friend class UDP;
+  friend class Client;
+  friend class Server;
+  friend class DhcpClass;
+  friend class DNSClient;
+};
+
+const IPAddress INADDR_NONE(0, 0, 0, 0);
diff --git a/cpp/arduino/Print.h b/cpp/arduino/Print.h
@@ -2,6 +2,8 @@
 
 #include <stdio.h>
 #include <avr/pgmspace.h>
+
+#include "Printable.h"
 #include "WString.h"
 
 #define DEC 10
@@ -12,22 +14,17 @@
 #endif
 #define BIN 2
 
-class Print;
-
-class Printable
-{
-  public:
-    virtual size_t printTo(Print& p) const = 0;
-};
-
 class Print
 {
+  private:
+    int write_error;
+  protected:
+    void setWriteError(int err = 1) { write_error = err; }
   public:
-    Print() {}
+    Print() : write_error(0) {}
 
-    // Arduino's version of this is richer but until I see an actual error case I'm not sure how to mock
-    int getWriteError() { return 0; }
-    void clearWriteError() { }
+    int getWriteError() { return write_error; }
+    void clearWriteError() { setWriteError(0); }
     virtual int availableForWrite() { return 0; }
 
     virtual size_t write(uint8_t) = 0;
diff --git a/cpp/arduino/Printable.h b/cpp/arduino/Printable.h
@@ -0,0 +1,8 @@
+#pragma once
+
+class Print;
+
+class Printable {
+public:
+  virtual size_t printTo(Print &p) const = 0;
+};
diff --git a/cpp/arduino/Server.h b/cpp/arduino/Server.h
@@ -0,0 +1,5 @@
+#pragma once
+
+#include <Stream.h>
+
+class Server : public Print {};
diff --git a/cpp/arduino/Udp.h b/cpp/arduino/Udp.h
@@ -0,0 +1,9 @@
+#pragma once
+
+#include <Stream.h>
+#include <IPAddress.h>
+
+class UDP : public Stream {
+protected:
+  uint8_t *rawIPAddress(IPAddress &addr) { return addr.raw_address(); };
+};

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+source 'https://rubygems.org'`
	`2`	`+gem 'arduino_ci', path: '../../'`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# NetworkLib`
	`2`	`+`
	`3`	`+This is an example of a library that depends on Ethernet.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#pragma once`
	`2`	`+`
	`3`	`+#include <Arduino.h>`