arduino_ci 0.1.4 → 0.1.5

data/cpp/arduino/ci/README.md

@@ -0,0 +1,5 @@
+The parent directory is for files that must stand in for their Arduino counterparts -- any `SomeFile` that might be requested as `#include <SomeFile.h>`.
+
+This directory is specificially for support files required by those other files.  That's because we don't want to create collisions on filenames for common data structures like Queue.
+
+If there end up being class-level conflicts, it is this developer's stated intention to rename our classes such that `class Float` becomes `class FloatyMcFloatFace`.

data/cpp/arduino/ci/Table.h

@@ -0,0 +1,125 @@
+#pragma once
+
+// A template-ized lookup table implementation
+//
+// this is this stupidest table implementation ever but it's
+// an MVP for unit testing. O(n).
+template <typename K, typename V>
+class Table {
+  private:
+    struct Node {
+      K key;
+      V val;
+      Node *next;
+    };
+
+    Node* mStart;
+    unsigned long mSize;
+    // to alow const reference signatures, pre-allocate nil values
+    K mNilK;
+    V mNilV;
+
+    void init() {
+      mStart = NULL;
+      mSize = 0;
+    }
+
+  public:
+    Table() : mNilK(), mNilV() { init(); }
+
+    // number of things in the table
+    inline unsigned long size() const { return mSize; }
+
+    // whether there are no things
+    inline bool empty() const { return 0 == mSize; }
+
+    // whether there is a thing stored at the given key
+    bool has(K const key) const {
+      for (Node* p = mStart; p; p = p->next) {
+        if (p->key == key) return true;
+      }
+      return false;
+    }
+
+    // allow find operations on keys
+    template <typename T>
+    const K& getMatchingKey(T const firstArg, bool (*isMatch)(const T, const K)) const {
+        for (Node* p = mStart; p; p = p->next) {
+          if (isMatch(firstArg, p->key)) return p->key;
+        }
+        return mNilK;
+    }
+
+    // allow iteration over entire table, with a work function that takes key/value pairs
+    void iterate(void (*work)(const K&, const V&)) const {
+        for (Node* p = mStart; p; p = p->next) work(p->key, p->val);
+    }
+    void iterate(void (*work)(K, V)) const {
+        for (Node* p = mStart; p; p = p->next) work(p->key, p->val);
+    }
+
+    // allow iteration over entire table, with a work function that takes key/value pairs
+    // plus an initial argument. this enables member function passing (via workaround)
+    template <typename T>
+    void iterate(void (*work)(T&, const K&, const V&), T& firstArg) const {
+        for (Node* p = mStart; p; p = p->next) work(firstArg, p->key, p->val);
+    }
+
+    template <typename T>
+    void iterate(void (*work)(T&, K, V), T& firstArg) const {
+        for (Node* p = mStart; p; p = p->next) work(firstArg, p->key, p->val);
+    }
+
+    template <typename T>
+    void iterate(void (*work)(T, K, V), T firstArg) const {
+        for (Node* p = mStart; p; p = p->next) work(firstArg, p->key, p->val);
+    }
+
+    // return the value for a given key
+    const V& get(K const key) const {
+      for (Node* p = mStart; p; p = p->next) {
+        if (p->key == key) return p->val;
+      }
+      return mNilV;
+    }
+
+    // remove an item by key
+    bool remove(K const key) {
+      Node *o = NULL;
+      for (Node* p = mStart; p; p = p->next) {
+        if (p->key == key) {
+          (o ? o->next : mStart) = p->next;
+          delete p;
+          --mSize;
+          return true;
+        }
+        o = p;
+      }
+      return false;
+    }
+
+    // add a key/value pair.  deletes any existing key by that name.
+    bool add(K const key, V const val) {
+      remove(key);
+      Node *n = new Node;
+      if (n == NULL) return false;
+      n->key = key;
+      n->val = val;
+      n->next = mStart;
+      mStart = n;
+      ++mSize;
+      return true;
+    }
+
+    // remove everything
+    void clear() {
+      Node* p;
+      while (mStart) {
+        p = mStart;
+        mStart = mStart->next;
+        delete p;
+      }
+    }
+
+    ~Table() { clear(); }
+};

data/cpp/unittest/ArduinoUnitTests.h

@@ -28,23 +28,23 @@ class Test
         ~ReporterTAP() {}
 
         void onTestRunInit(int numTests) {
-          cout << "TAP version 13" << endl;
-          cout << 1 << ".." << numTests << endl; // we know how many tests, in advance
+          cerr << "TAP version 13" << endl;
+          cerr << 1 << ".." << numTests << endl; // we know how many tests, in advance
           mTestCounter = 0;
         }
 
         void onTestStart(TestData td) {
           mAssertCounter = 0;
           ++mTestCounter;
-          cout << "# Subtest: " << td.name << endl;
+          cerr << "# Subtest: " << td.name << endl;
         }
 
         void onTestEnd(TestData td) {
-          cout << "    1.." << mAssertCounter << endl;
+          cerr << "    1.." << mAssertCounter << endl;
           if (td.result == RESULT_PASS) {
-            cout << "ok " << mTestCounter << " - " << td.name << endl;
+            cerr << "ok " << mTestCounter << " - " << td.name << endl;
           } else {
-            cout << "not ok " << mTestCounter << " - " << td.name << endl;
+            cerr << "not ok " << mTestCounter << " - " << td.name << endl;
           }
         }
 
@@ -61,17 +61,17 @@ class Test
               const char* rhsLabel,
               const B &rhs
           ) {
-            cout << "    " << (pass ? "" : "not ") << "ok " << ++mAssertCounter << " - ";
-            cout << description << " " << lhsLabel << " " << opLabel << " " << rhsLabel << endl;
+            cerr << "    " << (pass ? "" : "not ") << "ok " << ++mAssertCounter << " - ";
+            cerr << description << " " << lhsLabel << " " << opLabel << " " << rhsLabel << endl;
             if (!pass) {
-              cout << "      ---" << endl;
-              cout << "      operator: " << opLabel << endl;
-              cout << "      " << lhsRelevance << ": " << lhs << endl;
-              cout << "      " << rhsRelevance << ": " << rhs << endl;
-              cout << "      at:" << endl;
-              cout << "        file: " << file << endl;
-              cout << "        line: " << line << endl;
-              cout << "      ..." << endl;
+              cerr << "      ---" << endl;
+              cerr << "      operator: " << opLabel << endl;
+              cerr << "      " << lhsRelevance << ": " << lhs << endl;
+              cerr << "      " << rhsRelevance << ": " << rhs << endl;
+              cerr << "      at:" << endl;
+              cerr << "        file: " << file << endl;
+              cerr << "        line: " << line << endl;
+              cerr << "      ..." << endl;
           }
         }
     };

data/cpp/unittest/Assertion.h

@@ -46,6 +46,6 @@
 #define assureMore(arg1,arg2)        assureOp("assureMore","upperBound",arg1,compareMore,">","lowerBound",arg2)
 #define assureLessOrEqual(arg1,arg2) assureOp("assureLessOrEqual","lowerBound",arg1,compareLessOrEqual,"<=","upperBound",arg2)
 #define assureMoreOrEqual(arg1,arg2) assureOp("assureMoreOrEqual","upperBound",arg1,compareMoreOrEqual,">=","lowerBound",arg2)
-#define assureTrue(arg) assertEqual(true, arg)
-#define assureFalse(arg) assertEqual(false, arg)
+#define assureTrue(arg) assureEqual(true, arg)
+#define assureFalse(arg) assureEqual(false, arg)
 

data/cpp/unittest/Compare.h

@@ -1,7 +1,6 @@
 #pragma once
 #include "string.h"
 
-
 template  < typename A, typename B > struct Compare
 {
   inline static int between(const A &a,const B &b)
@@ -418,6 +417,7 @@ template  <typename T> struct Compare<T, bool>
     return between(a,b) >= 0;
   } // moreOrEqual
 };
+
 template <typename A, typename B> int compareBetween(const A &a, const B &b) { return Compare<A,B>::between(a,b); }
 template <typename A, typename B> bool compareEqual(const A &a, const B &b) { return Compare<A,B>::equal(a,b); }
 template <typename A, typename B> bool compareNotEqual(const A &a, const B &b) { return Compare<A,B>::notEqual(a,b); }

data/exe/arduino_ci_remote.rb

@@ -25,7 +25,7 @@ def perform_action(message, on_fail_msg, abort_on_fail)
   line = "#{message}..."
   print line
   result = yield
-  mark = result ? "✓" : "X"
+  mark = result ? "✓" : "✗"
   puts mark.rjust(WIDTH - line.length, " ")
   unless result
     puts on_fail_msg unless on_fail_msg.nil?
@@ -88,36 +88,49 @@ aux_libraries.each do |l|
   assure("Installing aux library '#{l}'") { @arduino_cmd.install_library(l) }
 end
 
-config.platforms_to_unittest.each do |p|
-  board = all_platforms[p][:board]
-  assure("Switching to board for #{p} (#{board})") { @arduino_cmd.use_board(board) }
-  cpp_library.test_files.each do |unittest_path|
-    unittest_name = File.basename(unittest_path)
-    attempt("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
+# iterate boards / tests
+last_board = nil
+if cpp_library.test_files.empty?
+  attempt("Skipping unit tests; no test files were found") { true }
+elsif config.platforms_to_unittest.empty?
+  attempt("Skipping unit tests; no platforms were requestsed") { true }
+else
+  config.platforms_to_unittest.each do |p|
+    board = all_platforms[p][:board]
+    # assure("Switching to board for #{p} (#{board})") { @arduino_cmd.use_board(board) } unless last_board == board
+    last_board = board
+    cpp_library.test_files.each do |unittest_path|
+      unittest_name = File.basename(unittest_path)
+      attempt("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
+        end
+        cpp_library.run_test_file(exe)
       end
-      cpp_library.run_test_file(exe)
     end
   end
 end
 
-attempt("Setting compiler warning level") { @arduino_cmd.set_pref("compiler.warning_level", "all") }
+unless library_examples.empty?
+  attempt("Setting compiler warning level")  { @arduino_cmd.set_pref("compiler.warning_level", "all") }
+end
 
+# unlike previous, iterate examples / boards
 library_examples.each do |example_path|
   ovr_config = config.from_example(example_path)
   ovr_config.platforms_to_build.each do |p|
     board = all_platforms[p][:board]
-    assure("Switching to board for #{p} (#{board})") { @arduino_cmd.use_board(board) }
+    assure("Switching to board for #{p} (#{board})") { @arduino_cmd.use_board(board) } unless last_board == board
+    last_board = board
     example_name = File.basename(example_path)
     attempt("Verifying #{example_name}") do
       ret = @arduino_cmd.verify_sketch(example_path)

data/lib/arduino_ci/arduino_cmd.rb

@@ -281,6 +281,7 @@ module ArduinoCI
     # @return [Array<String>] Example sketch files
     def library_examples(installed_library_path)
       example_path = File.join(installed_library_path, "examples")
+      return [] unless File.exist?(example_path)
       examples = Pathname.new(example_path).children.select(&:directory?).map(&:to_path).map(&File.method(:basename))
       files = examples.map do |e|
         proj_file = File.join(example_path, e, "#{e}.ino")

data/lib/arduino_ci/arduino_installation.rb

@@ -29,28 +29,22 @@ module ArduinoCI
       # @return [ArduinoCI::ArduinoCmdOSX] an instance of a command
       def autolocate_osx
         osx_root = "/Applications/Arduino.app/Contents"
-        old_way = false
         return nil unless File.exist? osx_root
 
         ret = ArduinoCmdOSX.new
-        osx_place = "#{osx_root}/MacOS"
-
-        if old_way
-          ret.base_cmd = [File.join(osx_place, "Arduino")]
-        else
-          jvm_runtime = `/usr/libexec/java_home`
-          ret.base_cmd = [
-            "java",
-            "-cp", "#{osx_root}/Java/*",
-            "-DAPP_DIR=#{osx_root}/Java",
-            "-Djava.ext.dirs=$JVM_RUNTIME/Contents/Home/lib/ext/:#{jvm_runtime}/Contents/Home/jre/lib/ext/",
-            "-Dfile.encoding=UTF-8",
-            "-Dapple.awt.UIElement=true",
-            "-Xms128M",
-            "-Xmx512M",
-            "processing.app.Base",
-          ]
-        end
+
+        # old_way
+        # ret.base_cmd = [File.join("#{osx_root}/MacOS", "Arduino")]
+        ret.base_cmd = [
+          "java",
+          "-cp", "#{osx_root}/Java/*",
+          "-DAPP_DIR=#{osx_root}/Java",
+          "-Dfile.encoding=UTF-8",
+          "-Dapple.awt.UIElement=true",
+          "-Xms128M",
+          "-Xmx512M",
+          "processing.app.Base",
+        ]
         ret
       end
 

data/lib/arduino_ci/ci_config.rb

@@ -27,12 +27,19 @@ COMPILE_SCHEMA = {
 UNITTEST_SCHEMA = {
   platforms: Array,
   libraries: Array,
+  testfiles: {
+    select: Array,
+    reject: Array,
+  }
 }.freeze
 module ArduinoCI
 
   # The filename controlling (overriding) the defaults for testing.
   # Files with this name can be used in the root directory of the Arduino library and in any/all of the example directories
-  CONFIG_FILENAME = ".arduino-ci.yaml".freeze
+  CONFIG_FILENAMES = [
+    ".arduino-ci.yml",
+    ".arduino-ci.yaml",
+  ].freeze
 
   # Provide the configuration and CI plan
   # - Read from a base config with default platforms defined
@@ -46,7 +53,7 @@ module ArduinoCI
       # @return [ArudinoCI::CIConfig] The configuration with defaults filled in
       def default
         ret = new
-        ret.load_yaml(File.expand_path("../../../misc/default.yaml", __FILE__))
+        ret.load_yaml(File.expand_path("../../../misc/default.yml", __FILE__))
         ret
       end
     end
@@ -99,6 +106,8 @@ module ArduinoCI
     # @return [ArduinoCI::CIConfig] a reference to self
     def load_yaml(path)
       yml = YAML.load_file(path)
+      raise "The YAML file at #{path} failed to load" unless yml
+
       if yml.include?("packages")
         yml["packages"].each do |k, v|
           valid_data = validate_data("packages", v, PACKAGE_SCHEMA)
@@ -139,18 +148,26 @@ module ArduinoCI
       overridden_config
     end
 
-    # Try to override config with a file at a given location (if it exists)
-    # @param path [String] the path to the settings yaml file
-    # @return [ArduinoCI::CIConfig] the new settings object
-    def attempt_override(config_path)
-      return self unless File.exist? config_path
-      with_override(config_path)
+    # Get the config file at a given path, if it exists, and pass that to a block.
+    # Many config files may exist, but only the first match is used
+    # @param base_dir [String] The directory in which to search for a config file
+    # @param val_when_no_match [Object] The value to return if no config files are found
+    # @yield [path] Process the configuration file at the given path
+    # @yieldparam [String] The path of an existing config file
+    # @yieldreturn [ArduinoCI::CIConfig] a settings object
+    # @return [ArduinoCI::CIConfig]
+    def with_config(base_dir, val_when_no_match)
+      CONFIG_FILENAMES.each do |f|
+        path = base_dir.nil? ? f : File.join(base_dir, f)
+        return (yield path) if File.exist?(path)
+      end
+      val_when_no_match
     end
 
     # Produce a configuration, assuming the CI script runs from the working directory of the base project
     # @return [ArduinoCI::CIConfig] the new settings object
     def from_project_library
-      attempt_override(CONFIG_FILENAME)
+      with_config(nil, self) { |path| with_override(path) }
     end
 
     # Produce a configuration override taken from an Arduino library example path
@@ -159,7 +176,7 @@ module ArduinoCI
     # @return [ArduinoCI::CIConfig] the new settings object
     def from_example(example_path)
       base_dir = File.directory?(example_path) ? example_path : File.dirname(example_path)
-      attempt_override(File.join(base_dir, CONFIG_FILENAME))
+      with_config(base_dir, self) { |path| with_override(path) }
     end
 
     # get information about a given platform: board name, package name, compiler stuff, etc
@@ -204,6 +221,21 @@ module ArduinoCI
       @unittest_info[:libraries]
     end
 
+    # Config allows select / reject (aka whitelist / blacklist) criteria.  Enforce on a dir
+    # @param paths [Array<String>] the initial set of test files
+    # @return [Array<String>] files that match the select/reject criteria
+    def allowable_unittest_files(paths)
+      return paths if @unittest_info[:testfiles].nil?
+      ret = paths
+      unless @unittest_info[:testfiles][:select].nil? || @unittest_info[:testfiles][:select].empty?
+        ret = ret.select { |p| unittest_info[:testfiles][:select].any? { |glob| File.fnmatch(glob, File.basename(p)) } }
+      end
+      unless @unittest_info[:testfiles][:reject].nil?
+        ret = ret.reject { |p| unittest_info[:testfiles][:reject].any? { |glob| File.fnmatch(glob, File.basename(p)) } }
+      end
+      ret
+    end
+
     # get GCC configuration for a given platform
     # @param platform_name [String] The name of the platform as defined in yaml
     # @return [Hash] the settings