Add pinhistory tests, fix pinhistory, and make rspec better with C++ unit tests

Author: ianfixes

SampleProjects/TestSomething/test/pinhistory.cpp

@@ -0,0 +1,38 @@
+#include <ArduinoUnitTests.h>
+#include <Arduino.h>
+
+
+unittest(pin_read_history)
+{
+  PinHistory<int> phi;
+
+  const int future[6] = {33, 22, 55, 11, 44, 66};
+  assertEqual(0, phi.queueSize());
+  phi.fromArray(future, 6);
+  for (int i = 0; i < 6; ++i)
+  {
+    assertEqual(6 - i, phi.queueSize());
+    assertEqual(future[i], phi.retrieve());
+    assertEqual(6 - (i + 1), phi.queueSize());
+  }
+
+  // assert end of history works
+  assertEqual(future[5], phi.retrieve());
+
+  PinHistory<bool> phb;
+  assertEqual(0, phb.queueSize());
+  phb.fromAscii("Yo", true);
+  assertEqual(16, phb.queueSize());
+  // digitial history as serial data, big-endian
+  bool binaryAscii[16] = {
+    0, 1, 0, 1, 1, 0, 0, 1,
+    0, 1, 1, 0, 1, 1, 1, 1
+  };
+
+  for (int i = 0; i < 16; ++i) {
+    assertEqual(binaryAscii[i], phb.retrieve());
+  }
+}
+
+
+unittest_main()

SampleProjects/TestSomething/test/queue.cpp

@@ -0,0 +1,51 @@
+#include <ArduinoUnitTests.h>
+#include <Queue.h>
+
+unittest(basic_queue_dequeue_and_size)
+{
+  Queue<int> q;
+  int data[5] = {11, 22, 33, 44, 55};
+
+  assertTrue(q.empty());
+
+  for (int i = 0; i < 5; ++i) {
+    assertEqual(i, q.size());
+    q.push(data[i]);
+    assertEqual(data[i], q.back());
+    assertEqual(i + 1, q.size());
+  }
+
+  for (int i = 0; i < 5; ++i) {
+    assertEqual(5 - i, q.size());
+    assertEqual(data[i], q.front());
+    q.pop();
+    assertEqual(5 - i - 1, q.size());
+  }
+
+  assertTrue(q.empty());
+}
+
+unittest(copy_constructor)
+{
+  Queue<int> q;
+  int data[5] = {11, 22, 33, 44, 55};
+  for (int i = 0; i < 5; ++i) q.push(data[i]);
+
+  Queue<int> q2(q);
+
+  for (int i = 0; i < 5; ++i) {
+    assertEqual(5 - i, q2.size());
+    assertEqual(data[i], q2.front());
+    q2.pop();
+    assertEqual(5 - i - 1, q2.size());
+  }
+
+  for (int i = 0; i < 5; ++i) {
+    assertEqual(5 - i, q.size());
+    assertEqual(data[i], q.front());
+    q.pop();
+    assertEqual(5 - i - 1, q.size());
+  }
+}
+
+unittest_main()

cpp/arduino/PinHistory.h

@@ -1,15 +1,13 @@
 #pragma once
-#include "queue.h"
+#include "Queue.h"
 #include "WString.h"
 
 // pins with history.
 template <typename T>
 class PinHistory {
   private:
-    queue<T> qIn;
-    queue<T> qOut;
-
-    unsigned long mLastRead = 0;
+    Queue<T> qIn;
+    Queue<T> qOut;
 
     void clear() {
       qOut.clear();
@@ -24,36 +22,39 @@ class PinHistory {
       qOut.push(val);
     }
 
-    unsigned int historySize() { return qOut.size(); }
+    unsigned int historySize() const { return qOut.size(); }
+
+    unsigned int queueSize() const { return qIn.size(); }
 
     // This returns the "value" of the pin in a raw sense
     operator T() const {
-      if (mLastRead == 0 && qIn.size()) return qIn.front();
+      if (!qIn.empty()) return qIn.front();
       return qOut.back();
     }
 
     // this sets the value of the pin authoritatively
     // so if there was a queue, dump it.
     // the actual "set" operation doesn't happen until the next read
     const T &operator=(const T& i) {
+      qIn.clear();
       qOut.push(i);
       return qOut.back();
     }
 
     // This returns the "value" of the pin according to the queued values
-    // if now is the same as the last read time, return the same val and exit
     // if there is input, advance it to the output.
     // then take the latest output.
     T retrieve() {
-      if (qIn.size()) {
-        qOut.push(qIn.front());
+      if (!qIn.empty()) {
+        T hack_required_by_travis_ci = qIn.front();
         qIn.pop();
+        qOut.push(hack_required_by_travis_ci);
       }
       return qOut.back();
     }
 
     // enqueue a set of elements
-    void fromArray(T* arr, unsigned int length) {
+    void fromArray(T const * const arr, unsigned int length) {
       for (int i = 0; i < length; ++i) qIn.push(arr[i]);
     }
 
@@ -73,8 +74,8 @@ class PinHistory {
 
     // copy elements to an array, up to a given length
     // return the number of elements moved
-    int toArray(T* arr, unsigned int length) {
-      queue<T> q2(qOut);
+    int toArray (T* arr, unsigned int length) const {
+      Queue<T> q2(qOut);
 
       int ret = 0;
       for (int i = 0; i < length && q2.size(); ++i) {
@@ -86,9 +87,9 @@ class PinHistory {
     }
 
     // see if the array matches the elements in the queue
-    bool hasElements(T* arr, unsigned int length) {
+    bool hasElements (T const * const arr, unsigned int length) const {
       int i;
-      queue<T> q2(qOut);
+      Queue<T> q2(qOut);
       for (i = 0; i < length && q2.size(); ++i) {
         if (q2.front() != arr[i]) return false;
         q2.pop();
@@ -98,10 +99,10 @@ class PinHistory {
 
     // convert the pin history to a string as if it was Serial comms
     // start from offset, consider endianness
-    String toAscii(unsigned int offset, bool bigEndian) {
+    String toAscii (unsigned int offset, bool bigEndian) const {
       String ret = "";
 
-      queue<T> q2(qOut);
+      Queue<T> q2(qOut);
 
       while (offset) {
         q2.pop();

cpp/arduino/queue.h renamed to cpp/arduino/Queue.h

@@ -1,7 +1,7 @@
 #pragma once
 
 template <typename T>
-class queue {
+class Queue {
   private:
     struct Node {
       T data;
@@ -19,9 +19,9 @@ class queue {
     }
 
   public:
-    queue() { init(); }
+    Queue(): mNil() { init(); }
 
-    queue(const queue<T>& q) {
+    Queue(const Queue<T>& q) {
       init();
       for (Node* n = q.mFront; n; n = n->next) push(n->data);
     }
@@ -69,5 +69,5 @@ class queue {
 
     void clear() { while (!empty()) pop(); }
 
-    ~queue() { clear(); }
+    ~Queue() { clear(); }
 };

spec/testsomething_unittests_spec.rb

@@ -2,7 +2,7 @@
 
 sampleproj_path = File.join(File.dirname(File.dirname(__FILE__)), "SampleProjects")
 
-RSpec.describe "TestSomething C++ unit tests" do
+RSpec.describe "TestSomething C++" do
   cpp_lib_path = File.join(sampleproj_path, "TestSomething")
   cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path)
   context "cpp_files" do
@@ -14,7 +14,7 @@
   end
   config = ArduinoCI::CIConfig.default.from_example(cpp_lib_path)
 
-  context "test" do
+  context "unit tests" do
 
     it "is going to test more than one library" do
       test_files = cpp_library.test_files
@@ -29,7 +29,11 @@
     test_files = config.allowable_unittest_files(cpp_library.test_files)
     test_files.each do |path|
       tfn = File.basename(path)
-      context "unit test #{tfn}" do
+      context "file #{tfn}" do
+
+        before(:all) do
+          @exe = cpp_library.build_for_test_with_configuration(path, [], config.gcc_config("uno"))
+        end
 
         # extra debug for c++ failures
         after(:each) do |example|
@@ -42,15 +46,12 @@
           end
         end
 
-        exe = nil
-        it "builds #{tfn} successfully" do
-          exe = cpp_library.build_for_test_with_configuration(path, [], config.gcc_config("uno"))
-          expect(exe).not_to be nil
+        it "#{tfn} builds successfully" do
+          expect(@exe).not_to be nil
         end
-        unless exe.nil?
-          it "tests #{tfn} successfully" do
-            expect(cpp_library.run_test_file(exe)).to_not be_falsey
-          end
+        it "#{tfn} passes tests" do
+          skip "Can't run the test program because it failed to build" if @exe.nil?
+          expect(cpp_library.run_test_file(@exe)).to_not be_falsey
         end
       end
     end