arduino_ci 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec22bfa6969f75cdb38ffa4365c3d8f2f83f2185
-  data.tar.gz: 2380ce41fe0779e258471b28e9e94eee3c238369
+  metadata.gz: a109dd9f9d784f5cc6b9e471366323b649cd46b6
+  data.tar.gz: 2b3e1296eff822fc0df13e9197c9f13b6b0a048d
 SHA512:
-  metadata.gz: 2c464279ef51852b51b22287960474da51a2818c9d41b8aadc181287636fa095effa8644f08320a62af7316a8540e9279ccf904c4936da619e82b7fb0011b21c
-  data.tar.gz: 7dfecd48948dfa8588e150841ee24c472480a20f10892c6098905fa35220bca26690708f827ec5b290d1564006f5a3c3019c7638eac27b9669311f6203f3973c
+  metadata.gz: 3a6a744be45d9b53740dfe5f9b1ed2850275bd397003adef61d63cc654f2baed573dbc3fe9ca00cbe7e89dd9dd07514bfd56460eb605e1d69a32638125012e19
+  data.tar.gz: feb7bdf3f740f15eb53dca481e4d9401e99243478711ccddb0ee0a342f7b1d5b98b277a54095ad17af3963ee0af0f4c506c04353d780d9c822e1b0a9458fd3db

data/README.md

@@ -1,5 +1,5 @@
 
-# ArduinoCI Ruby gem (`arduino_ci`) [![Gem Version](https://badge.fury.io/rb/arduino_ci.svg)](https://rubygems.org/gems/arduino_ci) [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/0.2.0)
+# ArduinoCI Ruby gem (`arduino_ci`) [![Gem Version](https://badge.fury.io/rb/arduino_ci.svg)](https://rubygems.org/gems/arduino_ci) [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/0.2.1)
 
 You want to run tests on your Arduino library (bonus: without hardware present), but the IDE doesn't support that.  Arduino CI provides that ability.
 

data/cpp/arduino/Arduino.h

@@ -15,6 +15,7 @@ Where possible, variable names from the Arduino library are used to avoid confli
 #include "Stream.h"
 #include "HardwareSerial.h"
 #include "SPI.h"
+#include "Wire.h"
 
 typedef bool boolean;
 typedef uint8_t byte;

data/cpp/arduino/Godmode.cpp

@@ -1,6 +1,7 @@
 #include "Godmode.h"
 #include "HardwareSerial.h"
 #include "SPI.h"
+#include "Wire.h"
 
 GodmodeState* GODMODE() {
   return GodmodeState::getInstance();
@@ -109,3 +110,6 @@ inline std::ostream& operator << ( std::ostream& out, const PinHistory<T>& ph )
 
 // defined in SPI.h
 SPIClass SPI = SPIClass(&GODMODE()->spi.dataIn, &GODMODE()->spi.dataOut);
+
+// defined in Wire.h
+TwoWire Wire = TwoWire();

data/cpp/arduino/HardwareSerial.h

@@ -1,7 +1,7 @@
 #pragma once
 
 //#include <inttypes.h>
-#include "Stream.h"
+#include "ci/StreamTape.h"
 
 // definitions neeeded for Serial.begin's config arg
 #define SERIAL_5N1 0x00
@@ -29,38 +29,19 @@
 #define SERIAL_7O2 0x3C
 #define SERIAL_8O2 0x3E
 
-class HardwareSerial : public Stream, public ObservableDataStream
+class HardwareSerial : public StreamTape
 {
-  protected:
-    String* mGodmodeDataOut;
-
   public:
-    HardwareSerial(String* dataIn, String* dataOut, unsigned long* delay): Stream(), ObservableDataStream() {
-      mGodmodeDataIn      = dataIn;
-      mGodmodeDataOut     = dataOut;
-      mGodmodeMicrosDelay = delay;
-    }
+    HardwareSerial(String* dataIn, String* dataOut, unsigned long* delay): StreamTape(dataIn, dataOut, delay) {}
+
     void begin(unsigned long baud) { begin(baud, SERIAL_8N1); }
     void begin(unsigned long baud, uint8_t config) {
       *mGodmodeMicrosDelay = 1000000 / baud;
     }
     void end() {}
 
-    // virtual int available(void);
-    // virtual int peek(void);
-    // virtual int read(void);
-    // virtual int availableForWrite(void);
-    // virtual void flush(void);
-    virtual size_t write(uint8_t aChar) {
-      mGodmodeDataOut->append(String((char)aChar));
-      advertiseByte((unsigned char)aChar);
-      return 1;
-    }
-
-    // https://stackoverflow.com/a/4271276
-    using Print::write; // pull in write(str) and write(buf, size) from Print
+    // support "if (Serial1) {}" sorts of things
     operator bool() { return true; }
-
 };
 
 #if defined(UBRRH) || defined(UBRR0H)

data/cpp/arduino/Wire.h

@@ -0,0 +1,138 @@
+
+#pragma once
+
+#include <inttypes.h>
+#include "Stream.h"
+
+class TwoWire : public ObservableDataStream
+{
+public:
+  TwoWire() {
+  }
+
+  // https://www.arduino.cc/en/Reference/WireBegin
+  // Initiate the Wire library and join the I2C bus as a master or slave. This should normally be called only once.
+  void begin() {
+    isMaster = true;
+  }
+  void begin(int address) {
+    i2cAddress = address;
+    isMaster = false;
+  }
+  void begin(uint8_t address) {
+    begin((int)address);
+  }
+  void end() {
+    // TODO: implement
+  }
+
+  // https://www.arduino.cc/en/Reference/WireSetClock
+  // This function modifies the clock frequency for I2C communication. I2C slave devices have no minimum working
+  // clock frequency, however 100KHz is usually the baseline.
+  void setClock(uint32_t) {
+    // TODO: implement?
+  }
+
+  // https://www.arduino.cc/en/Reference/WireBeginTransmission
+  // Begin a transmission to the I2C slave device with the given address. Subsequently, queue bytes for
+  // transmission with the write() function and transmit them by calling endTransmission().
+  void beginTransmission(int address) {
+    // TODO: implement
+  }
+  void beginTransmission(uint8_t address) {
+    beginTransmission((int)address);
+  }
+
+  // https://www.arduino.cc/en/Reference/WireEndTransmission
+  // Ends a transmission to a slave device that was begun by beginTransmission() and transmits the bytes that were
+  // queued by write().
+  uint8_t endTransmission(uint8_t sendStop) {
+    // TODO: implement
+    return 0; // success
+  }
+  uint8_t endTransmission(void) {
+    return endTransmission((uint8_t)true);
+  }
+
+  // https://www.arduino.cc/en/Reference/WireRequestFrom
+  // Used by the master to request bytes from a slave device. The bytes may then be retrieved with the
+  // available() and read() functions.
+  uint8_t requestFrom(int address, int quantity, int stop) {
+    // TODO: implement
+    return 0; // number of bytes returned from the slave device
+  }
+  uint8_t requestFrom(int address, int quantity) {
+    int stop = true;
+    return requestFrom(address, quantity, stop);
+  }
+  uint8_t requestFrom(uint8_t address, uint8_t quantity) {
+    return requestFrom((int)address, (int)quantity);
+  }
+  uint8_t requestFrom(uint8_t address, uint8_t quantity, uint8_t stop) {
+    return requestFrom((int)address, (int)quantity, (int)stop);
+  }
+  uint8_t requestFrom(uint8_t, uint8_t, uint32_t, uint8_t, uint8_t) {
+    // TODO: implement
+    return 0;
+  }
+
+  // https://www.arduino.cc/en/Reference/WireWrite
+  // Writes data from a slave device in response to a request from a master, or queues bytes for transmission from a
+  // master to slave device (in-between calls to beginTransmission() and endTransmission()).
+  size_t write(uint8_t value) {
+    // TODO: implement
+    return 0; // number of bytes written
+  }
+  size_t write(const char *str) { return str == NULL ? 0 : write((const uint8_t *)str, String(str).length()); }
+  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 write(unsigned long n) { return write((uint8_t)n); }
+  size_t write(long n) { return write((uint8_t)n); }
+  size_t write(unsigned int n) { return write((uint8_t)n); }
+  size_t write(int n) { return write((uint8_t)n); }
+
+  // https://www.arduino.cc/en/Reference/WireAvailable
+  // Returns the number of bytes available for retrieval with read(). This should be called on a master device after a
+  // call to requestFrom() or on a slave inside the onReceive() handler.
+  int available(void) {
+    // TODO: implement
+    return 0; // number of bytes available for reading
+  }
+
+  // https://www.arduino.cc/en/Reference/WireRead
+  // Reads a byte that was transmitted from a slave device to a master after a call to requestFrom() or was transmitted
+  // from a master to a slave. read() inherits from the Stream utility class.
+  int read(void) {
+    // TODO: implement
+    return '\0'; // The next byte received
+  }
+  int peek(void) {
+    // TODO: implement
+    return 0;
+  }
+  void flush(void) {
+    // TODO: implement
+  }
+
+  // https://www.arduino.cc/en/Reference/WireOnReceive
+  // Registers a function to be called when a slave device receives a transmission from a master.
+  void onReceive( void (*callback)(int) ) {
+    // TODO: implement
+  }
+
+  // https://www.arduino.cc/en/Reference/WireOnRequest
+  // Register a function to be called when a master requests data from this slave device.
+  void onRequest( void (*callback)(void) ) {
+    // TODO: implement
+  }
+
+private:
+  int i2cAddress;
+  bool isMaster = false;
+};
+
+extern TwoWire Wire;

data/cpp/arduino/ci/StreamTape.h

@@ -0,0 +1,36 @@
+#pragma once
+
+#include "../Stream.h"
+
+/**
+ * Stream with godmode-controlled input and godmode-persisted output
+ */
+class StreamTape : public Stream, public ObservableDataStream
+{
+  protected:
+    String* mGodmodeDataOut;
+    // mGodmodeDataIn is provided by Stream
+
+  public:
+    StreamTape(String* dataIn, String* dataOut, unsigned long* delay): Stream(), ObservableDataStream() {
+      mGodmodeDataIn      = dataIn;
+      mGodmodeDataOut     = dataOut;
+      mGodmodeMicrosDelay = delay;
+    }
+
+    // virtual int available(void);
+    // virtual int peek(void);
+    // virtual int read(void);
+    // virtual int availableForWrite(void);
+    // virtual void flush(void);
+    virtual size_t write(uint8_t aChar) {
+      mGodmodeDataOut->append(String((char)aChar));
+      advertiseByte((unsigned char)aChar);
+      return 1;
+    }
+
+    // https://stackoverflow.com/a/4271276
+    using Print::write; // pull in write(str) and write(buf, size) from Print
+
+};
+

data/exe/arduino_ci_remote.rb

@@ -167,6 +167,16 @@ def display_files(pathname)
   non_hidden.each { |p| puts "#{margin}#{p}" }
 end
 
+def install_arduino_library_dependencies(aux_libraries)
+  aux_libraries.each do |l|
+    if @arduino_cmd.library_present?(l)
+      inform("Using pre-existing library") { l.to_s }
+    else
+      assure("Installing aux library '#{l}'") { @arduino_cmd.install_library(l) }
+    end
+  end
+end
+
 def perform_unit_tests(file_config)
   if @cli_options[:skip_unittests]
     inform("Skipping unit tests") { "as requested via command line" }
@@ -209,6 +219,8 @@ def perform_unit_tests(file_config)
   elsif config.platforms_to_unittest.empty?
     inform("Skipping unit tests") { "no platforms were requested" }
   else
+    install_arduino_library_dependencies(config.aux_libraries_for_unittest)
+
     config.platforms_to_unittest.each do |p|
       config.allowable_unittest_files(cpp_library.test_files).each do |unittest_path|
         unittest_name = unittest_path.basename.to_s
@@ -273,7 +285,7 @@ def perform_compilation_tests(config)
   # while we're doing that, get the aux libraries as well
   example_platform_info = {}
   board_package_url = {}
-  aux_libraries = Set.new(config.aux_libraries_for_unittest + config.aux_libraries_for_build)
+  aux_libraries = Set.new(config.aux_libraries_for_build)
   # while collecting the platforms, ensure they're defined
 
   library_examples.each do |path|
@@ -322,13 +334,7 @@ def perform_compilation_tests(config)
     end
   end
 
-  aux_libraries.each do |l|
-    if @arduino_cmd.library_present?(l)
-      inform("Using pre-existing library") { l.to_s }
-    else
-      assure("Installing aux library '#{l}'") { @arduino_cmd.install_library(l) }
-    end
-  end
+  install_arduino_library_dependencies(aux_libraries)
 
   last_board = nil
   if config.platforms_to_build.empty?

data/lib/arduino_ci/arduino_cmd.rb

@@ -6,6 +6,9 @@ WORKAROUND_LIB = "USBHost".freeze
 
 module ArduinoCI
 
+  # To report errors that we can't resolve or possibly even explain
+  class ArduinoExecutionError < StandardError; end
+
   # Wrap the Arduino executable.  This requires, in some cases, a faked display.
   class ArduinoCmd
 
@@ -42,14 +45,14 @@ module ArduinoCI
     attr_reader   :last_msg
 
     # set the command line flags (undefined for now).
-    # These vary between gui/cli
-    flag :get_pref
-    flag :set_pref
-    flag :save_prefs
-    flag :use_board
-    flag :install_boards
-    flag :install_library
-    flag :verify
+    # These vary between gui/cli.  Inline comments added for greppability
+    flag :get_pref           # flag_get_pref
+    flag :set_pref           # flag_set_pref
+    flag :save_prefs         # flag_save_prefs
+    flag :use_board          # flag_use_board
+    flag :install_boards     # flag_install_boards
+    flag :install_library    # flag_install_library
+    flag :verify             # flag_verify
 
     def initialize
       @prefs_cache        = {}
@@ -82,7 +85,8 @@ module ArduinoCI
     # @return [String] Preferences as a set of lines
     def _prefs_raw
       resp = run_and_capture(flag_get_pref)
-      return nil unless resp[:success]
+      fail_msg = "Arduino binary failed to operate as expected; you will have to troubleshoot it manually"
+      raise ArduinoExecutionError, "#{fail_msg}. The command was #{@last_msg}" unless resp[:success]
 
       @prefs_fetched = true
       resp[:out]

data/lib/arduino_ci/ci_config.rb

@@ -293,9 +293,12 @@ module ArduinoCI
       return paths if @unittest_info[:testfiles].nil?
 
       ret = paths
+      # Check for array emptiness, otherwise nothing will be selected!
       unless @unittest_info[:testfiles][:select].nil? || @unittest_info[:testfiles][:select].empty?
         ret.select! { |p| unittest_info[:testfiles][:select].any? { |glob| p.basename.fnmatch(glob) } }
       end
+
+      # It's OK for the :reject array to be empty, that means nothing will be rejected by default
       unless @unittest_info[:testfiles][:reject].nil?
         ret.reject! { |p| unittest_info[:testfiles][:reject].any? { |glob| p.basename.fnmatch(glob) } }
       end

data/lib/arduino_ci/cpp_library.rb

@@ -220,7 +220,10 @@ module ArduinoCI
       # TODO: be smart and implement library spec (library.properties, etc)?
       subdirs = ["", "src", "utility"]
       all_aux_include_dirs_nested = aux_libraries.map do |libdir|
-        subdirs.map { |subdir| Pathname.new(@arduino_lib_dir) + libdir + subdir }
+        # library manager coerces spaces in package names to underscores
+        # see https://github.com/ianfixes/arduino_ci/issues/132#issuecomment-518857059
+        legal_libdir = libdir.tr(" ", "_")
+        subdirs.map { |subdir| Pathname.new(@arduino_lib_dir) + legal_libdir + subdir }
       end
       all_aux_include_dirs_nested.flatten.select(&:exist?).select(&:directory?)
     end

data/lib/arduino_ci/version.rb

@@ -1,3 +1,3 @@
 module ArduinoCI
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino_ci
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-20 00:00:00.000000000 Z
+date: 2019-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -137,6 +137,7 @@ files:
 - cpp/arduino/Stream.h
 - cpp/arduino/WCharacter.h
 - cpp/arduino/WString.h
+- cpp/arduino/Wire.h
 - cpp/arduino/avr/README.md
 - cpp/arduino/avr/common.h
 - cpp/arduino/avr/fuse.h
@@ -416,6 +417,7 @@ files:
 - cpp/arduino/ci/DeviceUsingBytes.h
 - cpp/arduino/ci/ObservableDataStream.h
 - cpp/arduino/ci/README.md
+- cpp/arduino/ci/StreamTape.h
 - cpp/arduino/ci/Table.h
 - cpp/arduino/stdlib.cpp
 - cpp/arduino/stdlib.h