Use singleton GodmodeState, add pinhistory with timestamp

Author: ianfixes

CHANGELOG.md

@@ -18,6 +18,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 * Construction of `MockEventQueue` now includes a constructor argument for the time-fetching function
 * Construction of `PinHistory` now includes a constructor argument for the time-fetching function
 * `PinHistory` can now return an array of timestamps for its events
+* `GodmodeState` is now a singleton pattern, which is necessary to support the globality of Arduino functions
+* `GodmodeState` now uses timestamped PinHistory for Analog and Digital
 
 ### Deprecated
 

SampleProjects/TestSomething/test/godmode.cpp

@@ -1,15 +1,15 @@
 #include <ArduinoUnitTests.h>
 #include <Arduino.h>
+#include "fibonacciClock.h"
 
 GodmodeState* state = GODMODE();
 
-unittest_setup()
-{
+unittest_setup() {
+  resetFibClock();
   state->reset();
 }
 
-unittest(millis_micros_and_delay)
-{
+unittest(millis_micros_and_delay) {
   assertEqual(0, millis());
   assertEqual(0, micros());
   delay(3);
@@ -20,8 +20,7 @@ unittest(millis_micros_and_delay)
   assertEqual(14000, micros());
 }
 
-unittest(random)
-{
+unittest(random) {
   randomSeed(1);
   assertEqual(state->seed, 1);
 
@@ -37,8 +36,7 @@ unittest(random)
   assertEqual(state->seed, 4294967282);
 }
 
-unittest(pins)
-{
+unittest(pins) {
   pinMode(1, OUTPUT);  // this is a no-op in unit tests.  it's just here to prove compilation
   digitalWrite(1, HIGH);
   assertEqual(HIGH, state->digitalPin[1]);
@@ -64,8 +62,7 @@ unittest(pins)
   assertEqual(56, analogRead(1));
 }
 
-unittest(pin_read_history)
-{
+unittest(pin_read_history) {
   int future[6] = {33, 22, 55, 11, 44, 66};
   state->analogPin[1].fromArray(future, 6);
   for (int i = 0; i < 6; ++i)
@@ -88,20 +85,20 @@ unittest(pin_read_history)
   }
 }
 
-unittest(pin_write_history)
-{
+unittest(digital_pin_write_history_with_timing) {
   int numMoved;
+  bool expectedD[6] = {LOW, HIGH, LOW, LOW, HIGH, HIGH};
+  bool actualD[6];
+  unsigned long expectedT[6] = {0, 1, 1, 2, 3, 5};
+  unsigned long actualT[6];
 
-  // history for digital pin
-  digitalWrite(1, HIGH);
-  digitalWrite(1, LOW);
-  digitalWrite(1, LOW);
-  digitalWrite(1, HIGH);
-  digitalWrite(1, HIGH);
+  // history for digital pin. start from 1 since LOW is the initial value
+  for (int i = 1; i < 6; ++i) {
+    state->micros = fibMicros();
+    digitalWrite(1, expectedD[i]);
+  }
 
   assertEqual(6, state->digitalPin[1].historySize());
-  bool expectedD[6] = {LOW, HIGH, LOW, LOW, HIGH, HIGH};
-  bool actualD[6];
   numMoved = state->digitalPin[1].toArray(actualD, 6);
   assertEqual(6, numMoved);
   // assert non-destructive
@@ -113,6 +110,19 @@ unittest(pin_write_history)
     assertEqual(expectedD[i], actualD[i]);
   }
 
+  numMoved = state->digitalPin[1].toTimestampArray(actualT, 6);
+  assertEqual(6, numMoved);
+  for (int i = 0; i < numMoved; ++i)
+  {
+    assertEqual(expectedT[i], actualT[i]);
+  }
+}
+
+unittest(analog_pin_write_history) {
+  int numMoved;
+  int expectedA[6] = {0, 11, 22, 33, 44, 55};
+  int actualA[6];
+
   // history for analog pin
   analogWrite(1, 11);
   analogWrite(1, 22);
@@ -121,8 +131,7 @@ unittest(pin_write_history)
   analogWrite(1, 55);
 
   assertEqual(6, state->analogPin[1].historySize());
-  int expectedA[6] = {0, 11, 22, 33, 44, 55};
-  int actualA[6];
+
   numMoved = state->analogPin[1].toArray(actualA, 6);
   assertEqual(6, numMoved);
   // assert non-destructive
@@ -133,7 +142,9 @@ unittest(pin_write_history)
   {
     assertEqual(expectedA[i], actualA[i]);
   }
+}
 
+unittest(ascii_pin_write_history) {
   // digitial history as serial data, big-endian
   bool binaryAscii[24] = {
       0, 1, 0, 1, 1, 0, 0, 1,
@@ -207,8 +218,7 @@ unittest(spi) {
     }
   }
 
-  unittest(does_nothing_if_no_data)
-  {
+  unittest(does_nothing_if_no_data) {
       int myPin = 3;
       state->serialPort[0].dataIn = "";
       state->serialPort[0].dataOut = "";
@@ -218,8 +228,7 @@ unittest(spi) {
       assertEqual("", state->serialPort[0].dataOut);
   }
 
-  unittest(keeps_pin_low_and_acks)
-  {
+  unittest(keeps_pin_low_and_acks) {
       int myPin = 3;
       state->serialPort[0].dataIn = "0";
       state->serialPort[0].dataOut = "";
@@ -230,8 +239,7 @@ unittest(spi) {
       assertEqual("Ack 3 0", state->serialPort[0].dataOut);
   }
 
-  unittest(flips_pin_high_and_acks)
-  {
+  unittest(flips_pin_high_and_acks) {
       int myPin = 3;
       state->serialPort[0].dataIn = "1";
       state->serialPort[0].dataOut = "";
@@ -242,8 +250,7 @@ unittest(spi) {
       assertEqual("Ack 3 1", state->serialPort[0].dataOut);
   }
 
-  unittest(two_flips)
-  {
+  unittest(two_flips) {
       int myPin = 3;
       state->serialPort[0].dataIn = "10junk";
       state->serialPort[0].dataOut = "";

cpp/arduino/Godmode.cpp

@@ -2,37 +2,45 @@
 #include "HardwareSerial.h"
 #include "SPI.h"
 
-GodmodeState godmode = GodmodeState();
-
 GodmodeState* GODMODE() {
-  return &godmode;
+  return GodmodeState::getInstance();
+}
+
+GodmodeState* GodmodeState::instance = nullptr;
+
+GodmodeState* GodmodeState::getInstance()
+{
+    if (instance == nullptr)
+    {
+        instance = new GodmodeState();
+        for (int i = 0; i < MOCK_PINS_COUNT; ++i) {
+          instance->digitalPin[i].setMicrosRetriever(&GodmodeState::getMicros);
+          instance->analogPin[i].setMicrosRetriever(&GodmodeState::getMicros);
+        }
+    }
+
+    return instance;
 }
 
 unsigned long millis() {
-  GodmodeState* godmode = GODMODE();
-  return godmode->micros / 1000;
+  return GODMODE()->micros / 1000;
 }
 
 unsigned long micros() {
-  GodmodeState* godmode = GODMODE();
-  return godmode->micros;
+  return GODMODE()->micros;
 }
 
 void delay(unsigned long millis) {
-  GodmodeState* godmode = GODMODE();
-  godmode->micros += millis * 1000;
+  GODMODE()->micros += millis * 1000;
 }
 
 void delayMicroseconds(unsigned long micros) {
-  GodmodeState* godmode = GODMODE();
-  godmode->micros += micros;
+  GODMODE()->micros += micros;
 }
 
-
 void randomSeed(unsigned long seed)
 {
-  GodmodeState* godmode = GODMODE();
-  godmode->seed = seed;
+  GODMODE()->seed = seed;
 }
 
 long random(long vmax)
@@ -81,16 +89,16 @@ void detachInterrupt(uint8_t interrupt) {
 
 // Serial ports
 #if defined(HAVE_HWSERIAL0)
-  HardwareSerial Serial(&godmode.serialPort[0].dataIn, &godmode.serialPort[0].dataOut, &godmode.serialPort[0].readDelayMicros);
+  HardwareSerial Serial(&GODMODE()->serialPort[0].dataIn, &GODMODE()->serialPort[0].dataOut, &GODMODE()->serialPort[0].readDelayMicros);
 #endif
 #if defined(HAVE_HWSERIAL1)
-  HardwareSerial Serial1(&godmode.serialPort[1].dataIn, &godmode.serialPort[1].dataOut, &godmode.serialPort[1].readDelayMicros);
+  HardwareSerial Serial1(&GODMODE()->serialPort[1].dataIn, &GODMODE()->serialPort[1].dataOut, &GODMODE()->serialPort[1].readDelayMicros);
 #endif
 #if defined(HAVE_HWSERIAL2)
-  HardwareSerial Serial2(&godmode.serialPort[2].dataIn, &godmode.serialPort[2].dataOut, &godmode.serialPort[2].readDelayMicros);
+  HardwareSerial Serial2(&GODMODE()->serialPort[2].dataIn, &GODMODE()->serialPort[2].dataOut, &GODMODE()->serialPort[2].readDelayMicros);
 #endif
 #if defined(HAVE_HWSERIAL3)
-  HardwareSerial Serial3(&godmode.serialPort[3].dataIn, &godmode.serialPort[3].dataOut, &godmode.serialPort[3].readDelayMicros);
+  HardwareSerial Serial3(&GODMODE()->serialPort[3].dataIn, &GODMODE()->serialPort[3].dataOut, &GODMODE()->serialPort[3].readDelayMicros);
 #endif
 
 template <typename T>
@@ -100,4 +108,4 @@ inline std::ostream& operator << ( std::ostream& out, const PinHistory<T>& ph )
 }
 
 // defined in SPI.h
-SPIClass SPI = SPIClass(&godmode.spi.dataIn, &godmode.spi.dataOut);
+SPIClass SPI = SPIClass(&GODMODE()->spi.dataIn, &GODMODE()->spi.dataOut);

cpp/arduino/Godmode.h

@@ -16,7 +16,6 @@ void delayMicroseconds(unsigned long micros);
 unsigned long millis();
 unsigned long micros();
 
-
 #define MOCK_PINS_COUNT 256
 
 #if defined(UBRR3H)
@@ -32,16 +31,19 @@ unsigned long micros();
 #endif
 
 class GodmodeState {
-  struct PortDef {
-    String dataIn;
-    String dataOut;
-    unsigned long readDelayMicros;
-  };
+  private:
+    struct PortDef {
+      String dataIn;
+      String dataOut;
+      unsigned long readDelayMicros;
+    };
+
+    struct InterruptDef {
+      bool attached;
+      uint8_t mode;
+    };
 
-  struct InterruptDef {
-    bool attached;
-    uint8_t mode;
-  };
+    static GodmodeState* instance;
 
   public:
     unsigned long micros;
@@ -98,8 +100,24 @@ class GodmodeState {
       return NUM_SERIAL_PORTS;
     }
 
-    GodmodeState()
-    {
+    // Using this for anything other than unit testing arduino_ci itself
+    // is unsupported at the moment
+    void overrideClockTruth(unsigned long (*getMicros)(void)) {
+    }
+
+    // singleton pattern
+    static GodmodeState* getInstance();
+
+    static unsigned long getMicros() {
+      return instance->micros;
+    }
+
+    // C++ 11, declare as public for better compiler error messages
+    GodmodeState(GodmodeState const&) = delete;
+    void operator=(GodmodeState const&) = delete;
+
+  private:
+    GodmodeState() {
       reset();
     }
 };
@@ -123,10 +141,3 @@ inline void noTone(uint8_t _pin) {}
 
 
 GodmodeState* GODMODE();
-
-// defined here to break a circular dependency on GODMODE
-// reasons: https://stackoverflow.com/a/1639821/2063546
-template <typename T>
-bool MockEventQueue<T>::push(const T& v) {
-  return pushEvent(v, GODMODE()->micros);
-}