Add Client, Server, and other libraries needed to compile Ethernet (#8)

James Foster · web-flow · commit 8ef2fc8bfd36 · 2020-11-09T00:03:17.000-08:00
diff --git a/.travis.yml b/.travis.yml
@@ -26,4 +26,10 @@ script:
    - bundle exec rspec --backtrace
    - cd SampleProjects/TestSomething
    - bundle install
+   - bundle exec arduino_ci_remote.rb
+   - cd ../NetworkLib
+   - bundle install
+   - cd scripts
+   - bash -x ./install.sh
+   - cd ..
    - bundle exec arduino_ci.rb
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased]
 ### Added
 - Add `__AVR__` to defines when compiling
+- Add stubs for `Client.h`, `IPAddress.h`, `Printable.h`, `Server.h`, and `Udp.h` 
 - Add support for `digitalPinToPort()`, `digitalPinToBitMask()`, and `portOutputRegister()`
 - Support for mock EEPROM (but only if board supports it)
 
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/examples/EthernetExample/EthernetExample.ino b/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() {}
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
+
+# if we don't have an Ethernet library, then get the standard one
+cd $(bundle exec arduino_library_location.rb)
+if [ ! -d ./Ethernet ] ; then
+  git clone https://github.com/arduino-libraries/Ethernet.git
+fi
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,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()
diff --git a/SampleProjects/TestSomething/test/clientServer.cpp b/SampleProjects/TestSomething/test/clientServer.cpp
@@ -0,0 +1,84 @@
+#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; };
+};
+
+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()
diff --git a/appveyor.yml b/appveyor.yml
@@ -24,4 +24,10 @@ test_script:
   - bundle exec rspec --backtrace
   - cd SampleProjects\TestSomething
   - bundle install
+  - bundle exec arduino_ci_remote.rb
+  - cd ../NetworkLib
+  - bundle install
+  - cd scripts
+  - install.sh
+  - cd ..
   - bundle exec arduino_ci.rb
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,26 @@
+#pragma once
+
+#include <Stream.h>
+
+class Client : public Stream {
+public:
+  Client() {
+    // The Stream mock defines a String buffer but never puts anyting in it!
+    if (!mGodmodeDataIn) {
+      mGodmodeDataIn = new String;
+    }
+  }
+  ~Client() {
+    if (mGodmodeDataIn) {
+      delete mGodmodeDataIn;
+      mGodmodeDataIn = nullptr;
+    }
+  }
+  virtual size_t write(uint8_t value) {
+    mGodmodeDataIn->concat(value);
+    return 1;
+  }
+
+protected:
+  uint8_t *rawIPAddress(IPAddress &addr) { return addr.raw_address(); }
+};
diff --git a/cpp/arduino/Godmode.h b/cpp/arduino/Godmode.h
@@ -30,6 +30,14 @@ unsigned long micros();
   #define NUM_SERIAL_PORTS 0
 #endif
 
+// These definitions allow the following to compile (see issue #193):
+// https://github.com/arduino-libraries/Ethernet/blob/master/src/utility/w5100.h:341
+// add padding because some boards (__MK20DX128__) offset from the given address
+#define MMAP_PORTS_SIZE (MOCK_PINS_COUNT + 256)
+#define digitalPinToBitMask(pin)  (1)
+#define digitalPinToPort(pin)     (pin)
+#define portOutputRegister(port)  (GODMODE()->pMmapPort(port))
+
 // different EEPROM implementations have different macros that leak out
 #if !defined(EEPROM_SIZE) && defined(E2END) && (E2END)
   // public value indicates that feature is available
@@ -39,7 +47,7 @@ unsigned long micros();
 #else
   // feature is not available but we want to have the array so other code compiles
   #define _EEPROM_SIZE (0)
-#endif 
+#endif
 
 class GodmodeState {
   private:
diff --git a/cpp/arduino/IPAddress.h b/cpp/arduino/IPAddress.h
@@ -0,0 +1,59 @@
+#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,27 @@
+#pragma once
+
+#include <IPAddress.h>
+#include <Stream.h>
+
+class UDP : public Stream {
+protected:
+  uint8_t *rawIPAddress(IPAddress &addr) { return addr.raw_address(); };
+
+public:
+  UDP() {
+    // The Stream mock defines a String buffer but never puts anyting in it!
+    if (!mGodmodeDataIn) {
+      mGodmodeDataIn = new String;
+    }
+  }
+  ~UDP() {
+    if (mGodmodeDataIn) {
+      delete mGodmodeDataIn;
+      mGodmodeDataIn = nullptr;
+    }
+  }
+  virtual size_t write(uint8_t value) {
+    mGodmodeDataIn->concat(value);
+    return 1;
+  }
+};

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.`