arduino_ci 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82a935a3542b8ab937b7176122e9db548ce380680c2d79705106bfe452c8e527
-  data.tar.gz: 5924a473a766721cf3ce2c7a3b47536c0ab57afae539e506349a3d4691d6d401
+  metadata.gz: c3461f2bb4dc34e5e4f0d2f098858babddd990b2fc992a3b29ad034de6e13604
+  data.tar.gz: 613db06952916c533425d68f2d2b721fb121284f0f6c6d44dab83386114a386d
 SHA512:
-  metadata.gz: 9f09f7ff8912769fe5660e519fddf7b07da5b4774e7719a04154f76ff8fb7fdb8e1ccb6732e17b49ad5b286f33fab6538e8c57f5b94e8487a1bff246d3017c89
-  data.tar.gz: 47ee9f776d6fcf2bf5a77de5762b949b131c0fc21fa68663743d79bf4c97bd6e4794da6251e5dbb335611879fb929afe14a69e19b8518c45e58a7496aada4397
+  metadata.gz: 4600b16b94d531d8e70986d80df1dc175fa959a59051e14e1024491cde81d58c5487a77d530eb639a37ec58b83c6e40c23802e03e94a410767c2a7640053a032
+  data.tar.gz: 70b1c55559663b2d6f0e49d01bbc311982830c98ca3cbc24dfb06af2e687f0fb8787f593543f902aaf193efcb4328d197ae425bc3e7a996acde7a30f6f07916b

data/README.md

@@ -1,6 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/arduino_ci.svg)](https://rubygems.org/gems/arduino_ci)
 [![Build Status](https://travis-ci.org/ifreecarve/arduino_ci.svg)](https://travis-ci.org/ifreecarve/arduino_ci)
-[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/0.1.7)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/0.1.8)
 
 # ArduinoCI Ruby gem (`arduino_ci`)
 
@@ -86,15 +86,13 @@ unittest(pin_history)
   digitalWrite(myPin, HIGH);
   digitalWrite(myPin, HIGH);
 
+  // pin history is queued in case we want to analyze it later.
+  // we expect 6 values in that queue.
   assertEqual(6, state->digitalPin[1].size());
   bool expected[6] = {LOW, HIGH, LOW, LOW, HIGH, HIGH};
   bool actual[6];
 
-  // move history queue into an array because at the moment, reading
-  // the history is destructive -- it's a linked-list queue.  this
-  // means that if toArray or hasElements fails, the queue will be in
-  // an unknown state and you should reset it before continuing with
-  // other tests
+  // convert history queue into an array so we can verify it
   int numMoved = state->digitalPin[myPin].toArray(actual, 6);
   assertEqual(6, numMoved);
 
@@ -102,6 +100,7 @@ unittest(pin_history)
   for (int i = 0; i < 6; ++i) {
     assertEqual(expected[i], actual[i]);
   }
+}
 ```
 
 
@@ -141,6 +140,43 @@ unittest(pin_read_history)
 
 #### Serial Data
 
+Basic input and output verification of serial port data can be done as follows:
+
+```c++
+unittest(reading_writing_serial)
+{
+  GodmodeState* state = GODMODE();
+  state->serialPort[0].dataIn = "";             // the queue of data waiting to be read
+  state->serialPort[0].dataOut = "";            // the history of data written
+
+  // When there is no data, nothing happens
+  assertEqual(-1, Serial.peek());
+  assertEqual("", state->serialPort[0].dataIn);
+  assertEqual("", state->serialPort[0].dataOut);
+
+  // if we put data on the input and peek at it, we see the value and it's not consumed
+  state->serialPort[0].dataIn = "a";
+  assertEqual('a', Serial.peek());
+  assertEqual("a", state->serialPort[0].dataIn);
+  assertEqual("", state->serialPort[0].dataOut);
+
+  // if we read the input, we see the value and it's consumed
+  assertEqual('a', Serial.read());
+  assertEqual("", state->serialPort[0].dataIn);
+  assertEqual("", state->serialPort[0].dataOut);
+
+  // when we write data, it shows up in the history -- the output buffer
+  Serial.write('b');
+  assertEqual("", state->serialPort[0].dataIn);
+  assertEqual("b", state->serialPort[0].dataOut);
+
+  // when we print more data, note that the history
+  // still contains the first thing we wrote
+  Serial.print("cdefg");
+  assertEqual("", state->serialPort[0].dataIn);
+  assertEqual("bcdefg", state->serialPort[0].dataOut);
+}
+```
 
 A more complicated example: working with serial port IO.  Let's say I have the following function:
 
@@ -313,6 +349,10 @@ For your unit tests, in addition to setting specific libraries and platforms, yo
 
 ```yaml
 unittest:
+  compilers:
+    - g++      # default
+    - g++-4.9
+    - g++-7
   testfiles:
     select:
       - "*-*.*"

data/cpp/arduino/ArduinoDefines.h

@@ -89,3 +89,6 @@
 #define TIMER5B 17
 #define TIMER5C 18
 
+#if defined(__AVR_ATmega328P__) || defined(__AVR_ATmega32U4__) || defined(__AVR_ATmega328__) || defined(__AVR_ATmega168__) || defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
+  #define LED_BUILTIN 13
+#endif

data/cpp/arduino/Godmode.h

@@ -91,6 +91,11 @@ void analogWrite(uint8_t, int);
 #define analogReadResolution(...) _NOP()
 #define analogWriteResolution(...) _NOP()
 
+// TODO: issue #26 to track the commanded state here
+inline void tone(uint8_t _pin, unsigned int frequency, unsigned long duration = 0) {}
+inline void tone(uint8_t _pin, unsigned int frequency) {}
+inline void noTone(uint8_t _pin) {}
+
 
 GodmodeState* GODMODE();
 

data/cpp/arduino/HardwareSerial.h

@@ -57,11 +57,8 @@ class HardwareSerial : public Stream, public ObservableDataStream
       return 1;
     }
 
-    inline size_t write(unsigned long n) { return write((uint8_t)n); }
-    inline size_t write(long n) { return write((uint8_t)n); }
-    inline size_t write(unsigned int n) { return write((uint8_t)n); }
-    inline size_t write(int n) { return write((uint8_t)n); }
-    // using Print::write; // pull in write(str) and write(buf, size) from Print
+    // https://stackoverflow.com/a/4271276
+    using Print::write; // pull in write(str) and write(buf, size) from Print
     operator bool() { return true; }
 
 };

data/cpp/arduino/Print.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include <stdio.h>
+#include <avr/pgmspace.h>
 #include "WString.h"
 
 #define DEC 10
@@ -32,38 +33,38 @@ class Print
     virtual size_t write(uint8_t) = 0;
     size_t write(const char *str) { return str == NULL ? 0 : write((const uint8_t *)str, String(str).length()); }
 
-
     virtual size_t write(const uint8_t *buffer, size_t size) {
       size_t n;
       for (n = 0; size && write(*buffer++) && ++n; --size);
       return n;
     }
+
     size_t write(const char *buffer, size_t size) { return write((const uint8_t *)buffer, size); }
 
-    size_t print(const String &s)                { return write(s.c_str(), s.length()); }
-    size_t print(const __FlashStringHelper *str) { return print(reinterpret_cast<PGM_P>(str)); }
-    size_t print(const char* str)                { return print(String(str)); }
-    size_t print(char c)                         { return print(String(c)); }
-    size_t print(unsigned char b, int base)      { return print(String(b, base)); }
-    size_t print(int n, int base)                { return print(String(n, base)); }
-    size_t print(unsigned int n, int base)       { return print(String(n, base)); }
-    size_t print(long n, int base)               { return print(String(n, base)); }
-    size_t print(unsigned long n, int base)      { return print(String(n, base)); }
-    size_t print(double n, int digits)           { return print(String(n, digits)); }
-    size_t print(const Printable& x)             { return x.printTo(*this); }
+    size_t print(const String &s)                 { return write(s.c_str(), s.length()); }
+    size_t print(const __FlashStringHelper *str)  { return print(reinterpret_cast<PGM_P>(str)); }
+    size_t print(const char* str)                 { return print(String(str)); }
+    size_t print(char c)                          { return print(String(c)); }
+    size_t print(unsigned char b, int base = DEC) { return print(String(b, base)); }
+    size_t print(int n,           int base = DEC) { return print(String(n, base)); }
+    size_t print(unsigned int n,  int base = DEC) { return print(String(n, base)); }
+    size_t print(long n,          int base = DEC) { return print(String(n, base)); }
+    size_t print(unsigned long n, int base = DEC) { return print(String(n, base)); }
+    size_t print(double n,        int base = DEC) { return print(String(n, base)); }
+    size_t print(const Printable& x)              { return x.printTo(*this); }
 
-    size_t println(void)                           { return print("\r\n"); }
-    size_t println(const String &s)                { return print(s) + println(); }
-    size_t println(const __FlashStringHelper *str) { return println(reinterpret_cast<PGM_P>(str)); }
-    size_t println(const char* c)                  { return println(String(c)); }
-    size_t println(char c)                         { return println(String(c)); }
-    size_t println(unsigned char b, int base)      { return println(String(b, base)); }
-    size_t println(int num, int base)              { return println(String(num, base)); }
-    size_t println(unsigned int num, int base)     { return println(String(num, base)); }
-    size_t println(long num, int base)             { return println(String(num, base)); }
-    size_t println(unsigned long num, int base)    { return println(String(num, base)); }
-    size_t println(double num, int digits)         { return println(String(num, digits)); }
-    size_t println(const Printable& x)             { return print(x) + println(); }
+    size_t println(void)                              { return print("\r\n"); }
+    size_t println(const String &s)                   { return print(s) + println(); }
+    size_t println(const __FlashStringHelper *str)    { return println(reinterpret_cast<PGM_P>(str)); }
+    size_t println(const char* c)                     { return println(String(c)); }
+    size_t println(char c)                            { return println(String(c)); }
+    size_t println(unsigned char b,   int base = DEC) { return println(String(b, base)); }
+    size_t println(int num,           int base = DEC) { return println(String(num, base)); }
+    size_t println(unsigned int num,  int base = DEC) { return println(String(num, base)); }
+    size_t println(long num,          int base = DEC) { return println(String(num, base)); }
+    size_t println(unsigned long num, int base = DEC) { return println(String(num, base)); }
+    size_t println(double num,        int base = DEC) { return println(String(num, base)); }
+    size_t println(const Printable& x)                { return print(x) + println(); }
 
     virtual void flush() { }
 

data/cpp/arduino/Stream.h

@@ -56,11 +56,11 @@ class Stream : public Print
       return ret;
     }
 
+    // https://stackoverflow.com/a/4271276
     using Print::write;
 
     virtual size_t write(uint8_t aChar) { mGodmodeDataIn->append(String((char)aChar)); return 1; }
 
-
     Stream() {
       mTimeoutMillis = 1000;
       mGodmodeMicrosDelay = NULL;

data/cpp/arduino/WString.h

@@ -9,6 +9,22 @@
 
 typedef std::string string;
 
+// work around some portability issues
+#if defined(__clang__)
+  #define ARDUINOCI_ISNAN ::isnan
+  #define ARDUINOCI_ISINF ::isinf
+#elif defined(__GNUC__) || defined(__GNUG__)
+  #define ARDUINOCI_ISNAN std::isnan
+  #define ARDUINOCI_ISINF std::isinf
+#elif defined(_MSC_VER)
+  // TODO: no idea
+  #define ARDUINOCI_ISNAN ::isnan
+  #define ARDUINOCI_ISINF ::isinf
+#else
+  #define ARDUINOCI_ISNAN ::isnan
+  #define ARDUINOCI_ISINF ::isinf
+#endif
+
 class __FlashStringHelper;
 #define F(string_literal) (reinterpret_cast<const __FlashStringHelper *>(PSTR(string_literal)))
 
@@ -36,8 +52,8 @@ class String: public string
 
     static string dtoas(double val, int decimalPlaces) {
       double r = 0.5 * pow(0.1, decimalPlaces); // make sure that integer truncation will properly round
-      if (std::isnan(val)) return "nan";
-      if (std::isinf(val)) return "inf";
+      if (ARDUINOCI_ISNAN(val)) return "nan";
+      if (ARDUINOCI_ISINF(val)) return "inf";
       val += val > 0 ? r : -r;
       if (val > 4294967040.0) return "ovf";
       if (val <-4294967040.0) return "ovf";

data/exe/arduino_ci_remote.rb

@@ -69,11 +69,15 @@ cpp_library = ArduinoCI::CppLibrary.new(installed_library_path)
 attempt("Library installed at #{installed_library_path}") { true }
 
 # check GCC
-attempt_multiline("Checking GCC version") do
-  version = cpp_library.gcc_version
-  next nil unless version
-  puts version.split("\n").map { |l| "    #{l}" }.join("\n")
-  version
+compilers = config.compilers_to_use
+assure("The set of compilers (#{compilers.length}) isn't empty") { !compilers.empty? }
+compilers.each do |gcc_binary|
+  attempt_multiline("Checking #{gcc_binary} version") do
+    version = cpp_library.gcc_version(gcc_binary)
+    next nil unless version
+    puts version.split("\n").map { |l| "    #{l}" }.join("\n")
+    version
+  end
 end
 
 # gather up all required boards so we can install them up front.
@@ -121,20 +125,22 @@ else
     last_board = board
     cpp_library.test_files.each do |unittest_path|
       unittest_name = File.basename(unittest_path)
-      attempt_multiline("Unit testing #{unittest_name}") do
-        exe = cpp_library.build_for_test_with_configuration(
-          unittest_path,
-          config.aux_libraries_for_unittest,
-          config.gcc_config(p)
-        )
-        puts
-        unless exe
-          puts "Last command: #{cpp_library.last_cmd}"
-          puts cpp_library.last_out
-          puts cpp_library.last_err
-          next false
+      compilers.each do |gcc_binary|
+        attempt_multiline("Unit testing #{unittest_name} with #{gcc_binary}") do
+          exe = cpp_library.build_for_test_with_configuration(
+            unittest_path,
+            config.aux_libraries_for_unittest,
+            config.gcc_config(p)
+          )
+          puts
+          unless exe
+            puts "Last command: #{cpp_library.last_cmd}"
+            puts cpp_library.last_out
+            puts cpp_library.last_err
+            next false
+          end
+          cpp_library.run_test_file(exe)
         end
-        cpp_library.run_test_file(exe)
       end
     end
   end

data/lib/arduino_ci/ci_config.rb

@@ -25,6 +25,7 @@ COMPILE_SCHEMA = {
 }.freeze
 
 UNITTEST_SCHEMA = {
+  compilers: Array,
   platforms: Array,
   libraries: Array,
   testfiles: {
@@ -197,6 +198,13 @@ module ArduinoCI
       @package_info[package][:url]
     end
 
+    # compilers to build (unit tests) with
+    # @return [Array<String>] The compiler binary names (e.g. g++) to build with
+    def compilers_to_use
+      return [] if @unittest_info[:compilers].nil?
+      @unittest_info[:compilers]
+    end
+
     # platforms to build [the examples on]
     # @return [Array<String>] The platforms to build
     def platforms_to_build

data/lib/arduino_ci/cpp_library.rb

@@ -107,10 +107,9 @@ module ArduinoCI
     end
 
     # wrapper for the GCC command
-    def run_gcc(*args, **kwargs)
-      full_args = ["g++"] + args
+    def run_gcc(gcc_binary, *args, **kwargs)
+      full_args = [gcc_binary] + args
       @last_cmd = " $ #{full_args.join(' ')}"
-
       ret = Host.run_and_capture(*full_args, **kwargs)
       @last_err = ret[:err]
       @last_out = ret[:out]
@@ -119,8 +118,8 @@ module ArduinoCI
 
     # Return the GCC version
     # @return [String] the version reported by `gcc -v`
-    def gcc_version
-      return nil unless run_gcc("-v")
+    def gcc_version(gcc_binary)
+      return nil unless run_gcc(gcc_binary, "-v")
       @last_err
     end
 
@@ -183,7 +182,7 @@ module ArduinoCI
     # @param aux_libraries [String] The external Arduino libraries required by this project
     # @param ci_gcc_config [Hash] The GCC config object
     # @return [String] path to the compiled test executable
-    def build_for_test_with_configuration(test_file, aux_libraries, ci_gcc_config)
+    def build_for_test_with_configuration(test_file, aux_libraries, gcc_binary, ci_gcc_config)
       base = File.basename(test_file)
       executable = File.expand_path("unittest_#{base}.bin")
       File.delete(executable) if File.exist?(executable)
@@ -192,7 +191,7 @@ module ArduinoCI
         test_args(aux_libraries, ci_gcc_config),
         [test_file],
       ].flatten(1)
-      return nil unless run_gcc(*args)
+      return nil unless run_gcc(gcc_binary, *args)
       artifacts << executable
       executable
     end

data/lib/arduino_ci/version.rb

@@ -1,3 +1,3 @@
 module ArduinoCI
-  VERSION = "0.1.7".freeze
+  VERSION = "0.1.8".freeze
 end

data/misc/default.yml

@@ -80,6 +80,8 @@ compile:
     - leonardo
 
 unittest:
+  compilers:
+    - g++
   libraries: ~
   platforms:
     - uno

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino_ci
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2018-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os