arduino_ci 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a089a7486b4295c2ed49a832a0dd148d6e31561a
-  data.tar.gz: 0c13b415b9b585c42ec2a8501c5e6ef606137c30
+  metadata.gz: d7de3ae0cd1c73eb41fe0b7f897e20f7a3d2e5c0
+  data.tar.gz: 29dc639c29a0dcb3841e3dd903002e1fc72ef892
 SHA512:
-  metadata.gz: 74819da0c7bbaf23fbd5ceaf1952e43442d0bdd4789ecf1beb4c3a110038350797b9b6629698a3348bc9803afb444344badc2f0bdebbc930bf42835bb07b3109
-  data.tar.gz: 794e75954f74a2e9420d6ec4e884683b86f2a04d2ac0b0a3cf13776126e8db40c29724ebe397fb2d9bd062c5e3044cea206ed078aa5958dee825cd902d38e5a9
+  metadata.gz: cf8434e69d4b3cc1c65d4b37db875133fdd1055e2d435b3936c15ef1e731c9160238a597ed2e2f8c21d28ce4522963e02371482ddfebc00307b2b16c2bfebf9d
+  data.tar.gz: db0f703d2d7dad26ccc1a54f098e64ef9953ef66266f4379e1936ff915dfb38e04899304ca666ea79fac8e1dee52868979b96d6ef2937a7a085a6383dec1f176

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.1.17)
+# 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.1.18)
 
 You want your Arduino library to be automatically built and tested every time someone contributes code to your project on GitHub, but the Arduino IDE lacks the ability to run unit tests. [Arduino CI](https://github.com/ianfixes/arduino_ci) provides that ability.
 

data/cpp/arduino/Arduino.h

@@ -72,5 +72,7 @@ inline unsigned int makeWord(unsigned char h, unsigned char l) { return (h << 8)
 #define word(...) makeWord(__VA_ARGS__)
 
 
+// Define C++11 nullptr
+#define nullptr (std::nullptr_t)NULL
 
 

data/cpp/arduino/avr/pgmspace.h

@@ -29,25 +29,26 @@ out.each { |l| puts d(l) }
 
 // everything's a no-op
 #define PSTR(s) ((const char *)(s))
-#define pgm_read_byte_near(x)  (x)
-#define pgm_read_word_near(x)  (x)
-#define pgm_read_dword_near(x) (x)
-#define pgm_read_float_near(x) (x)
-#define pgm_read_ptr_near(x)   (x)
 
-#define pgm_read_byte_far(x)  (x)
-#define pgm_read_word_far(x)  (x)
-#define pgm_read_dword_far(x) (x)
-#define pgm_read_float_far(x) (x)
-#define pgm_read_ptr_far(x)   (x)
+#define pgm_read_byte_near(address_short)  (* (const uint8_t *)  (address_short) )
+#define pgm_read_word_near(address_short)  (* (const uint16_t *) (address_short) )
+#define pgm_read_dword_near(address_short) (* (const uint32_t *) (address_short) )
+#define pgm_read_float_near(address_short) (* (const float *)    (address_short) )
+#define pgm_read_ptr_near(address_short)   (* (const void *)     (address_short) )
 
+#define pgm_read_byte_far(address_long)    (* (const uint8_t *)  (address_long) )
+#define pgm_read_word_far(address_long)    (* (const uint16_t *) (address_long) )
+#define pgm_read_dword_far(address_long)   (* (const uint32_t *) (address_long) )
+#define pgm_read_float_far(address_long)   (* (const float *)    (address_long) )
+#define pgm_read_ptr_far(address_long)     (* (const void *)     (address_long) )
 
-#define pgm_read_byte(addr) (*(const uint8_t *)(addr))
-#define pgm_read_word(x) (x)
-#define pgm_read_dword(x) (x)
-#define pgm_read_float(x) (x)
-#define pgm_read_ptr(x) (x)
-#define pgm_get_far_address(x) (x)
+#define pgm_read_byte(address_short)   pgm_read_byte_near(address_short)
+#define pgm_read_word(address_short)   pgm_read_word_near(address_short)
+#define pgm_read_dword(address_short)  pgm_read_dword_near(address_short)
+#define pgm_read_float(address_short)  pgm_read_float_near(address_short)
+#define pgm_read_ptr(address_short)    pgm_read_ptr_near(address_short)
+
+#define pgm_get_far_address(var) ( (uint_farptr_t) (&(var)) )
 
 #define memchr_P(...) ::memchr(__VA_ARGS__)
 #define memcmp_P(...) ::memcmp(__VA_ARGS__)

data/cpp/unittest/ArduinoUnitTests.cpp

@@ -1,3 +1,6 @@
 #include "ArduinoUnitTests.h"
 
+TestSetup *TestSetup::sInstance;
+TestTeardown *TestTeardown::sInstance;
+
 Test* Test::sRoot = 0;

data/cpp/unittest/ArduinoUnitTests.h

@@ -15,6 +15,26 @@ struct TestData {
   int result;
 };
 
+class TestSetup
+{
+  public:
+  TestSetup() {
+    sInstance = this;
+  }
+  virtual void run() {}
+  static TestSetup *sInstance;
+};
+
+class TestTeardown
+{
+  public:
+  TestTeardown() {
+    sInstance = this;
+  }
+  virtual void run() {}
+  static TestTeardown *sInstance;
+};
+
 class Test
 {
   public:
@@ -49,29 +69,29 @@ class Test
         }
 
         template <typename A, typename B> void onAssert(
-              const char* file,
-              int line,
-              const char* description,
-              bool pass,
-              const char* lhsRelevance,
-              const char* lhsLabel,
-              const A &lhs,
-              const char* opLabel,
-              const char* rhsRelevance,
-              const char* rhsLabel,
-              const B &rhs
-          ) {
-            cerr << "    " << (pass ? "" : "not ") << "ok " << ++mAssertCounter << " - ";
-            cerr << description << " " << lhsLabel << " " << opLabel << " " << rhsLabel << endl;
-            if (!pass) {
-              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;
+          const char* file,
+          int line,
+          const char* description,
+          bool pass,
+          const char* lhsRelevance,
+          const char* lhsLabel,
+          const A &lhs,
+          const char* opLabel,
+          const char* rhsRelevance,
+          const char* rhsLabel,
+          const B &rhs
+        ) {
+          cerr << "    " << (pass ? "" : "not ") << "ok " << ++mAssertCounter << " - ";
+          cerr << description << " " << lhsLabel << " " << opLabel << " " << rhsLabel << endl;
+          if (!pass) {
+            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;
           }
         }
     };
@@ -152,7 +172,9 @@ class Test
     static int run_and_report(int argc, char *argv[]) {
       // TODO: pick a reporter based on args
       ReporterTAP rep;
+      if (TestSetup::sInstance) TestSetup::sInstance->run();
       Results results = run(&rep);
+      if (TestTeardown::sInstance) TestTeardown::sInstance->run();
       return results.failed + results.skipped;
     }
 
@@ -217,6 +239,24 @@ class Test
   } test_##name##_instance;        \
   void test_##name ::task()
 
+/**
+ * The unittest_setup and unittest_teardown functions are intended to be used
+ * to set up "external" dependencies that needs to present but are not directly
+ * related to the functionality that you are testing, for instance a LCD.
+ */
+#define unittest_setup()                          \
+  class unittest_setup_class : public TestSetup { \
+    public:                                       \
+    virtual void run() override;                  \
+  } unittest_setup_instance;                      \
+  void unittest_setup_class::run()
+
+#define unittest_teardown()                             \
+  class unittest_teardown_class : public TestTeardown { \
+    public:                                             \
+    virtual void run() override;                        \
+  } unittest_teardown_instance;                         \
+  void unittest_teardown_class::run()
 
 #define unittest_main()                      \
   int main(int argc, char *argv[]) {         \

data/cpp/unittest/Assertion.h

@@ -38,6 +38,7 @@
 #define assertMoreOrEqual(arg1,arg2) assertOp("assertMoreOrEqual","upperBound",arg1,compareMoreOrEqual,">=","lowerBound",arg2)
 #define assertTrue(arg) assertEqual(true, arg)
 #define assertFalse(arg) assertEqual(false, arg)
+#define assertNull(arg) assertEqual((void*)NULL, (void*)arg)
 
 /** macro generates optional output and calls fail() followed by a return if false. */
 #define assureEqual(arg1,arg2)       assureOp("assureEqual","expected",arg1,compareEqual,"==","actual",arg2)
@@ -48,4 +49,5 @@
 #define assureMoreOrEqual(arg1,arg2) assureOp("assureMoreOrEqual","upperBound",arg1,compareMoreOrEqual,">=","lowerBound",arg2)
 #define assureTrue(arg) assureEqual(true, arg)
 #define assureFalse(arg) assureEqual(false, arg)
+#define assureNull(arg) assureEqual((void*)NULL, (void*)arg)
 

data/exe/arduino_ci_remote.rb

@@ -13,22 +13,36 @@ FIND_FILES_INDENT = 4
 # Use some basic parsing to allow command-line overrides of config
 class Parser
   def self.parse(options)
-    parsed_config = {}
-    parsed_config["unittest"] = {}
+    unit_config = {}
+    output_options = {
+      skip_unittests: false,
+      skip_compilation: false,
+      ci_config: {
+        "unittest" => unit_config
+      },
+    }
 
     opt_parser = OptionParser.new do |opts|
       opts.banner = "Usage: #{File.basename(__FILE__)} [options]"
 
+      opts.on("--skip-unittests", "Don't run unit tests") do |p|
+        output_options[:skip_unittests] = p
+      end
+
+      opts.on("--skip-compilation", "Don't compile example sketches") do |p|
+        output_options[:skip_compilation] = p
+      end
+
       opts.on("--testfile-select=GLOB", "Unit test file (or glob) to select") do |p|
-        parsed_config["unittest"]["testfiles"] ||= {}
-        parsed_config["unittest"]["testfiles"]["select"] ||= []
-        parsed_config["unittest"]["testfiles"]["select"] << p
+        unit_config["testfiles"] ||= {}
+        unit_config["testfiles"]["select"] ||= []
+        unit_config["testfiles"]["select"] << p
       end
 
       opts.on("--testfile-reject=GLOB", "Unit test file (or glob) to reject") do |p|
-        parsed_config["unittest"]["testfiles"] ||= {}
-        parsed_config["unittest"]["testfiles"]["reject"] ||= []
-        parsed_config["unittest"]["testfiles"]["reject"] << p
+        unit_config["testfiles"] ||= {}
+        unit_config["testfiles"]["reject"] ||= []
+        unit_config["testfiles"]["reject"] << p
       end
 
       opts.on("-h", "--help", "Prints this help") do
@@ -38,7 +52,7 @@ class Parser
     end
 
     opt_parser.parse!(options)
-    parsed_config
+    output_options
   end
 end
 
@@ -154,9 +168,11 @@ def display_files(pathname)
 end
 
 def perform_unit_tests(file_config)
-  puts file_config.to_h[:unittest].to_s
-  config = file_config.with_override_config(@cli_options)
-  puts config.to_h[:unittest].to_s
+  if @cli_options[:skip_unittests]
+    inform("Skipping unit tests") { "as requested via command line" }
+    return
+  end
+  config = file_config.with_override_config(@cli_options[:ci_config])
   cpp_library = ArduinoCI::CppLibrary.new(Pathname.new("."), @arduino_cmd.lib_dir)
 
   # check GCC
@@ -220,6 +236,10 @@ def perform_unit_tests(file_config)
 end
 
 def perform_compilation_tests(config)
+  if @cli_options[:skip_compilation]
+    inform("Skipping compilation of examples") { "as requested via command line" }
+    return
+  end
 
   # index the existing libraries
   attempt("Indexing libraries") { @arduino_cmd.index_libraries } unless @arduino_cmd.libraries_indexed
@@ -228,17 +248,22 @@ def perform_compilation_tests(config)
   installed_library_path = attempt("Installing library under test") do
     @arduino_cmd.install_local_library(Pathname.new("."))
   end
-  if installed_library_path.exist?
+
+  if !installed_library_path.nil? && installed_library_path.exist?
     inform("Library installed at") { installed_library_path.to_s }
   else
     assure_multiline("Library installed successfully") do
-      # print out the contents of the deepest directory we actually find
-      @arduino_cmd.lib_dir.ascend do |path_part|
-        next unless path_part.exist?
-
-        break display_files(path_part)
+      if installed_library_path.nil?
+        puts @arduino_cmd.last_msg
+      else
+        # print out the contents of the deepest directory we actually find
+        @arduino_cmd.lib_dir.ascend do |path_part|
+          next unless path_part.exist?
+
+          break display_files(path_part)
+        end
+        false
       end
-      false
     end
   end
   library_examples = @arduino_cmd.library_examples(installed_library_path)

data/exe/arduino_ci_remote.rb.orig

@@ -0,0 +1,387 @@
+#!/usr/bin/env ruby
+require 'arduino_ci'
+require 'set'
+require 'pathname'
+require 'optparse'
+
+WIDTH = 80
+FIND_FILES_INDENT = 4
+
+@failure_count = 0
+@passfail = proc { |result| result ? "✓" : "✗" }
+
+# Use some basic parsing to allow command-line overrides of config
+class Parser
+  def self.parse(options)
+    unit_config = {}
+    output_options = {
+      skip_unittests: false,
+      skip_compilation: false,
+      ci_config: {
+        "unittest" => unit_config
+      },
+    }
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: #{File.basename(__FILE__)} [options]"
+
+      opts.on("--skip-unittests", "Don't run unit tests") do |p|
+        output_options[:skip_unittests] = p
+      end
+
+      opts.on("--skip-compilation", "Don't compile example sketches") do |p|
+        output_options[:skip_compilation] = p
+      end
+
+      opts.on("--testfile-select=GLOB", "Unit test file (or glob) to select") do |p|
+        unit_config["testfiles"] ||= {}
+        unit_config["testfiles"]["select"] ||= []
+        unit_config["testfiles"]["select"] << p
+      end
+
+      opts.on("--testfile-reject=GLOB", "Unit test file (or glob) to reject") do |p|
+        unit_config["testfiles"] ||= {}
+        unit_config["testfiles"]["reject"] ||= []
+        unit_config["testfiles"]["reject"] << p
+      end
+
+      opts.on("-h", "--help", "Prints this help") do
+        puts opts
+        exit
+      end
+    end
+
+    opt_parser.parse!(options)
+    output_options
+  end
+end
+
+# Read in command line options and make them read-only
+@cli_options = (Parser.parse ARGV).freeze
+
+# terminate after printing any debug info.  TODO: capture debug info
+def terminate(final = nil)
+  puts "Failures: #{@failure_count}"
+  unless @failure_count.zero? || final
+    puts "Last message: #{@arduino_cmd.last_msg}"
+    puts "========== Stdout:"
+    puts @arduino_cmd.last_out
+    puts "========== Stderr:"
+    puts @arduino_cmd.last_err
+  end
+  retcode = @failure_count.zero? ? 0 : 1
+  exit(retcode)
+end
+
+# make a nice status line for an action and react to the action
+# TODO / note to self: inform_multline is tougher to write
+#   without altering the signature because it only leaves space
+#   for the checkmark _after_ the multiline, it doesn't know how
+#   to make that conditionally the body
+# @param message String the text of the progress indicator
+# @param multiline boolean whether multiline output is expected
+# @param mark_fn block (string) -> string that says how to describe the result
+# @param on_fail_msg String custom message for failure
+# @param tally_on_fail boolean whether to increment @failure_count
+# @param abort_on_fail boolean whether to abort immediately on failure (i.e. if this is a fatal error)
+def perform_action(message, multiline, mark_fn, on_fail_msg, tally_on_fail, abort_on_fail)
+  line = "#{message}... "
+  endline = "...#{message} "
+  if multiline
+    puts line
+  else
+    print line
+  end
+  STDOUT.flush
+  result = yield
+  mark = mark_fn.nil? ? "" : mark_fn.call(result)
+  # if multline, put checkmark at full width
+  print endline if multiline
+  puts mark.to_s.rjust(WIDTH - line.length, " ")
+  unless result
+    puts on_fail_msg unless on_fail_msg.nil?
+    @failure_count += 1 if tally_on_fail
+    # print out error messaging here if we've captured it
+    terminate if abort_on_fail
+  end
+  result
+end
+
+# Make a nice status for something that defers any failure code until script exit
+def attempt(message, &block)
+  perform_action(message, false, @passfail, nil, true, false, &block)
+end
+
+# Make a nice status for something that defers any failure code until script exit
+def attempt_multiline(message, &block)
+  perform_action(message, true, @passfail, nil, true, false, &block)
+end
+
+# Make a nice status for something that kills the script immediately on failure
+FAILED_ASSURANCE_MESSAGE = "This may indicate a problem with ArduinoCI, or your configuration".freeze
+def assure(message, &block)
+  perform_action(message, false, @passfail, FAILED_ASSURANCE_MESSAGE, true, true, &block)
+end
+
+def assure_multiline(message, &block)
+  perform_action(message, true, @passfail, FAILED_ASSURANCE_MESSAGE, true, true, &block)
+end
+
+def inform(message, &block)
+  perform_action(message, false, proc { |x| x }, nil, false, false, &block)
+end
+
+def inform_multiline(message, &block)
+  perform_action(message, true, nil, nil, false, false, &block)
+end
+
+# Assure that a platform exists and return its definition
+def assured_platform(purpose, name, config)
+  platform_definition = config.platform_definition(name)
+  assure("Requested #{purpose} platform '#{name}' is defined in 'platforms' YML") do
+    !platform_definition.nil?
+  end
+  platform_definition
+end
+
+# Return true if the file (or one of the dirs containing it) is hidden
+def file_is_hidden_somewhere?(path)
+  # this is clunkly but pre-2.2-ish ruby doesn't return ascend as an enumerator
+  path.ascend do |part|
+    return true if part.basename.to_s.start_with? "."
+  end
+  false
+end
+
+# print out some files
+def display_files(pathname)
+  # `find` doesn't follow symlinks, so we should instead
+  realpath = pathname.symlink? ? pathname.readlink : pathname
+
+  # suppress directories and dotfile-based things
+  all_files = realpath.find.select(&:file?)
+  non_hidden = all_files.reject { |path| file_is_hidden_somewhere?(path) }
+
+  # print files with an indent
+  margin = " " * FIND_FILES_INDENT
+  non_hidden.each { |p| puts "#{margin}#{p}" }
+end
+
+def perform_unit_tests(file_config)
+<<<<<<< HEAD
+  puts file_config.to_h[:unittest].to_s
+  config = file_config.with_override_config(@cli_options)
+  puts config.to_h[:unittest].to_s
+=======
+  if @cli_options[:skip_unittests]
+    inform("Skipping unit tests") { "as requested via command line" }
+    return
+  end
+  config = file_config.with_override_config(@cli_options[:ci_config])
+>>>>>>> 9c4b0f0... Allow skipping of unittests and/or compilation in arduino_ci_remote.rb
+  cpp_library = ArduinoCI::CppLibrary.new(Pathname.new("."), @arduino_cmd.lib_dir)
+
+  # check GCC
+  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
+    inform("libasan availability for #{gcc_binary}") { cpp_library.libasan?(gcc_binary) }
+  end
+
+  # Ensure platforms exist for unit test, and save their info in all_platform_info keyed by name
+  all_platform_info = {}
+  config.platforms_to_unittest.each { |p| all_platform_info[p] = assured_platform("unittest", p, config) }
+
+  # iterate boards / tests
+  if !cpp_library.tests_dir.exist?
+    inform_multiline("Skipping unit tests; no tests dir at #{cpp_library.tests_dir}") do
+      puts "  In case that's an error, this is what was found in the library:"
+      display_files(cpp_library.tests_dir.parent)
+      true
+    end
+  elsif cpp_library.test_files.empty?
+    inform_multiline("Skipping unit tests; no test files were found in #{cpp_library.tests_dir}") do
+      puts "  In case that's an error, this is what was found in the tests directory:"
+      display_files(cpp_library.tests_dir)
+      true
+    end
+  elsif config.platforms_to_unittest.empty?
+    inform("Skipping unit tests") { "no platforms were requested" }
+  else
+    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
+        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,
+              gcc_binary,
+              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
+        end
+      end
+    end
+  end
+end
+
+def perform_compilation_tests(config)
+  if @cli_options[:skip_compilation]
+    inform("Skipping compilation of examples") { "as requested via command line" }
+    return
+  end
+
+  # index the existing libraries
+  attempt("Indexing libraries") { @arduino_cmd.index_libraries } unless @arduino_cmd.libraries_indexed
+
+  # initialize library under test
+  installed_library_path = attempt("Installing library under test") do
+    @arduino_cmd.install_local_library(Pathname.new("."))
+  end
+  if installed_library_path.exist?
+    inform("Library installed at") { installed_library_path.to_s }
+  else
+    assure_multiline("Library installed successfully") do
+      # print out the contents of the deepest directory we actually find
+      @arduino_cmd.lib_dir.ascend do |path_part|
+        next unless path_part.exist?
+
+        break display_files(path_part)
+      end
+      false
+    end
+  end
+  library_examples = @arduino_cmd.library_examples(installed_library_path)
+
+  # gather up all required boards for compilation so we can install them up front.
+  # start with the "platforms to unittest" and add the examples
+  # 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)
+  # while collecting the platforms, ensure they're defined
+
+  library_examples.each do |path|
+    ovr_config = config.from_example(path)
+    ovr_config.platforms_to_build.each do |platform|
+      # assure the platform if we haven't already
+      next if example_platform_info.key?(platform)
+
+      platform_info = assured_platform("library example", platform, config)
+      next if platform_info.nil?
+
+      example_platform_info[platform] = platform_info
+      package = platform_info[:package]
+      board_package_url[package] = ovr_config.package_url(package)
+    end
+    aux_libraries.merge(ovr_config.aux_libraries_for_build)
+  end
+
+  # with all platform info, we can extract unique packages and their urls
+  # do that, set the URLs, and download the packages
+  all_packages = example_platform_info.values.map { |v| v[:package] }.uniq.reject(&:nil?)
+
+  # inform about builtin packages
+  all_packages.select { |p| config.package_builtin?(p) }.each do |p|
+    inform("Using built-in board package") { p }
+  end
+
+  # make sure any non-builtin package has a URL defined
+  all_packages.reject { |p| config.package_builtin?(p) }.each do |p|
+    assure("Board package #{p} has a defined URL") { board_package_url[p] }
+  end
+
+  # set up all the board manager URLs.
+  # we can safely reject nils now, they would be for the builtins
+  all_urls = all_packages.map { |p| board_package_url[p] }.uniq.reject(&:nil?)
+
+  unless all_urls.empty?
+    assure("Setting board manager URLs") do
+      @arduino_cmd.board_manager_urls = all_urls
+    end
+  end
+
+  all_packages.each do |p|
+    assure("Installing board package #{p}") do
+      @arduino_cmd.install_boards(p)
+    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
+
+  last_board = nil
+  if config.platforms_to_build.empty?
+    inform("Skipping builds") { "no platforms were requested" }
+    return
+  elsif library_examples.empty?
+    inform_multiline("Skipping builds; no examples found in #{installed_library_path}") do
+      display_files(installed_library_path)
+    end
+    return
+  end
+
+  attempt("Setting compiler warning level")  { @arduino_cmd.set_pref("compiler.warning_level", "all") }
+
+  # switching boards takes time, so iterate board first
+  # _then_ whichever examples match it
+  examples_by_platform = library_examples.each_with_object({}) do |example_path, acc|
+    ovr_config = config.from_example(example_path)
+    ovr_config.platforms_to_build.each do |p|
+      acc[p] = [] unless acc.key?(p)
+      acc[p] << example_path
+    end
+  end
+
+  examples_by_platform.each do |platform, example_paths|
+    board = example_platform_info[platform][:board]
+    assure("Switching to board for #{platform} (#{board})") { @arduino_cmd.use_board(board) } unless last_board == board
+    last_board = board
+
+    example_paths.each do |example_path|
+      example_name = File.basename(example_path)
+      attempt("Verifying #{example_name}") do
+        ret = @arduino_cmd.verify_sketch(example_path)
+        unless ret
+          puts
+          puts "Last command: #{@arduino_cmd.last_msg}"
+          puts @arduino_cmd.last_err
+        end
+        ret
+      end
+    end
+  end
+
+end
+
+# initialize command and config
+config = ArduinoCI::CIConfig.default.from_project_library
+
+@arduino_cmd = ArduinoCI::ArduinoInstallation.autolocate!
+inform("Located Arduino binary") { @arduino_cmd.binary_path.to_s }
+
+perform_unit_tests(config)
+perform_compilation_tests(config)
+
+terminate(true)

data/exe/arduino_library_location.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'arduino_ci'
+
+# locate and/or forcibly install Arduino, keep stdout clean
+@arduino_cmd = ArduinoCI::ArduinoInstallation.autolocate!($stderr)
+
+puts @arduino_cmd.lib_dir

data/lib/arduino_ci/arduino_cmd.rb

@@ -190,7 +190,10 @@ module ArduinoCI
     # @param name [String] the library name
     # @return [bool] whether the command succeeded
     def _install_library(library_name)
-      success = run_and_capture(flag_install_library, library_name)[:success]
+      result = run_and_capture(flag_install_library, library_name)
+
+      already_installed = result[:err].include?("Library is already installed: #{library_name}")
+      success = result[:success] || already_installed
 
       @libraries_indexed = (@libraries_indexed || success) if library_name == WORKAROUND_LIB
       success
@@ -237,7 +240,7 @@ module ArduinoCI
     def update_library_index
       # install random lib so the arduino IDE grabs a new library index
       # see: https://github.com/arduino/Arduino/issues/3535
-      install_library("USBHost")
+      install_library(WORKAROUND_LIB)
     end
 
     # use a particular board for compilation
@@ -319,7 +322,7 @@ module ArduinoCI
         proj_file = example_path + e + "#{e}.ino"
         proj_file.exist? ? proj_file.to_s : nil
       end
-      files.reject(&:nil?)
+      files.reject(&:nil?).sort_by(&:to_s)
     end
   end
 end

data/lib/arduino_ci/arduino_downloader.rb

@@ -1,4 +1,5 @@
-require "fileutils"
+require 'fileutils'
+require 'net/http'
 require 'open-uri'
 require 'zip'
 
@@ -9,8 +10,11 @@ module ArduinoCI
   # Manage the OS-specific download & install of Arduino
   class ArduinoDownloader
 
-    def initialize(desired_ide_version)
+    # @param desired_ide_version [string] Version string e.g. 1.8.7
+    # @param output [IO] $stdout, $stderr, File.new(/dev/null, 'w'), etc. where console output will be sent
+    def initialize(desired_ide_version, output = $stdout)
       @desired_ide_version = desired_ide_version
+      @output = output
     end
 
     # Provide guidelines to the implementer of this class
@@ -115,15 +119,15 @@ module ArduinoCI
         total_size += size
         needed_dots = (total_size / chunk_size).to_i
         unprinted_dots = needed_dots - dots
-        print("." * unprinted_dots) if unprinted_dots > 0
+        @output.print("." * unprinted_dots) if unprinted_dots > 0
         dots = needed_dots
       end
 
       open(package_url, ssl_verify_mode: 0, progress_proc: dot_printer) do |url|
         File.open(package_file, 'wb') { |file| file.write(url.read) }
       end
-    rescue Net::OpenTimeout, Net::ReadTimeout => e
-      puts "\nArduino force-install failed downloading #{package_url}: #{e}"
+    rescue Net::OpenTimeout, Net::ReadTimeout, OpenURI::HTTPError, URI::InvalidURIError => e
+      @output.puts "\nArduino force-install failed downloading #{package_url}: #{e}"
     end
 
     # Extract the package_file to extracted_file
@@ -133,7 +137,7 @@ module ArduinoCI
         batch_size = [1, (zip.size / 100).to_i].max
         dots = 0
         zip.each do |file|
-          print "." if (dots % batch_size).zero?
+          @output.print "." if (dots % batch_size).zero?
           file.restore_permissions = true
           file.extract { accept_all }
           dots += 1
@@ -153,7 +157,7 @@ module ArduinoCI
     def execute
       error_preparing = prepare
       unless error_preparing.nil?
-        puts "Arduino force-install failed preparation: #{error_preparing}"
+        @output.puts "Arduino force-install failed preparation: #{error_preparing}"
         return false
       end
 
@@ -161,32 +165,32 @@ module ArduinoCI
 
       loop do
         if File.exist? package_file
-          puts "Arduino package seems to have been downloaded already" if attempts.zero?
+          @output.puts "Arduino package seems to have been downloaded already" if attempts.zero?
           break
         elsif attempts >= DOWNLOAD_ATTEMPTS
-          break puts "After #{DOWNLOAD_ATTEMPTS} attempts, failed to download #{package_url}"
+          break @output.puts "After #{DOWNLOAD_ATTEMPTS} attempts, failed to download #{package_url}"
         else
-          print "Attempting to download Arduino package with #{downloader}"
+          @output.print "Attempting to download Arduino package with #{downloader}"
           download
-          puts
+          @output.puts
         end
         attempts += 1
       end
 
       if File.exist? extracted_file
-        puts "Arduino package seems to have been extracted already"
+        @output.puts "Arduino package seems to have been extracted already"
       elsif File.exist? package_file
-        print "Extracting archive with #{extracter}"
+        @output.print "Extracting archive with #{extracter}"
         extract
-        puts
+        @output.puts
       end
 
       if File.exist? self.class.force_install_location
-        puts "Arduino package seems to have been installed already"
+        @output.puts "Arduino package seems to have been installed already"
       elsif File.exist? extracted_file
         install
       else
-        puts "Could not find extracted archive (tried #{extracted_file})"
+        @output.puts "Could not find extracted archive (tried #{extracted_file})"
       end
 
       File.exist? self.class.force_install_location

data/lib/arduino_ci/arduino_downloader_windows.rb

@@ -2,6 +2,7 @@ require 'base64'
 require 'shellwords' # fingers crossed this works on win32
 require 'win32/registry'
 require "arduino_ci/arduino_downloader"
+require 'net/http'
 require "fileutils"
 
 module ArduinoCI
@@ -30,6 +31,8 @@ module ArduinoCI
       open(URI.parse(package_url), ssl_verify_mode: 0) do |url|
         File.open(package_file, 'wb') { |file| file.write(url.read) }
       end
+    rescue Net::OpenTimeout, Net::ReadTimeout, OpenURI::HTTPError, URI::InvalidURIError => e
+      @output.puts "\nArduino force-install failed downloading #{package_url}: #{e}"
     end
 
     # Move the extracted package file from extracted_file to the force_install_location

data/lib/arduino_ci/arduino_installation.rb

@@ -97,25 +97,25 @@ module ArduinoCI
 
       # Attempt to find a workable Arduino executable across platforms, and install it if we don't
       # @return [ArduinoCI::ArduinoCmd] an instance of a command
-      def autolocate!
+      def autolocate!(output = $stdout)
         candidate = autolocate
         return candidate unless candidate.nil?
 
         # force the install
-        raise ArduinoInstallationError, "Failed to force-install Arduino" unless force_install
+        raise ArduinoInstallationError, "Failed to force-install Arduino" unless force_install(output)
 
         autolocate
       end
 
       # Forcibly install Arduino from the web
       # @return [bool] Whether the command succeeded
-      def force_install
+      def force_install(output = $stdout, version = DESIRED_ARDUINO_IDE_VERSION)
         worker_class =  case Host.os
                         when :osx then ArduinoDownloaderOSX
                         when :windows then ArduinoDownloaderWindows
                         when :linux then ArduinoDownloaderLinux
                         end
-        worker = worker_class.new(DESIRED_ARDUINO_IDE_VERSION)
+        worker = worker_class.new(version, output)
         worker.execute
       end
 

data/lib/arduino_ci/cpp_library.rb

@@ -32,6 +32,9 @@ module ArduinoCI
     # @return [String] the last command
     attr_reader :last_cmd
 
+    # @return [Array<Pathname>] Directories suspected of being vendor-bundle
+    attr_reader :vendor_bundle_cache
+
     # @param base_dir [Pathname] The path to the library being tested
     # @param arduino_lib_dir [Pathname] The path to the libraries directory
     def initialize(base_dir, arduino_lib_dir)
@@ -45,26 +48,57 @@ module ArduinoCI
       @last_out = ""
       @last_msg = ""
       @has_libasan_cache = {}
+      @vendor_bundle_cache = nil
     end
 
     # Guess whether a file is part of the vendor bundle (indicating we should ignore it).
     #
-    # This assumes the vendor bundle will be at `vendor/bundle` and not some other location
+    # A safe way to do this seems to be to check whether any of the installed gems
+    #   appear to be a subdirectory of (but not equal to) the working directory.
+    #   That gets us the vendor directory (or multiple directories). We can check
+    #   if the given path is contained by any of those.
+    #
     # @param path [Pathname] The path to check
     # @return [bool]
     def vendor_bundle?(path)
-      # TODO: look for Gemfile, look for .bundle/config and get BUNDLE_PATH from there?
-      base = @base_dir + "vendor"
-      return false unless base.exist?
+      # Cache bundle information, as it is (1) time consuming to fetch and (2) not going to change while we run
+      if @vendor_bundle_cache.nil?
+        bundle_info = Host.run_and_capture("bundle show --paths")
+        if !bundle_info[:success]
+          # if the bundle show command fails, assume there isn't a bundle
+          @vendor_bundle_cache = false
+        else
+          # Get all the places where gems are stored.  We combine a few things here:
+          # by preemptively switching to the parent directory, we can both ensure that
+          # we skip any gems that are equal to the working directory AND exploit some
+          # commonality in the paths to cut down our search locations
+          #
+          # NOT CONFUSING THE WORKING DIRECTORY WITH VENDOR BUNDLE IS SUPER IMPORTANT
+          # because if we do, we won't be able to run CI on this library itself.
+          bundle_paths = bundle_info[:out].lines
+                                          .map { |l| Pathname.new(l.chomp) }
+                                          .select(&:exist?)
+                                          .map(&:realpath)
+                                          .map(&:parent)
+                                          .uniq
+          wd = Pathname.new(".").realpath
+          @vendor_bundle_cache = bundle_paths.select do |gem_path|
+            gem_path.ascend do |part|
+              break true if wd == part
+            end
+          end
+        end
+      end
 
-      vendor_bundle_aliases = [base, base.realpath]
+      # no bundle existed
+      return false if @vendor_bundle_cache == false
 
-      # we could do this but some rubies don't return an enumerator for ascend
-      # path.ascend.any? { |part| vendor_bundle_aliases.include?(part) }
-      path.ascend do |part|
-        return true if vendor_bundle_aliases.include?(part)
+      # With vendor bundles located, check this file against those
+      @vendor_bundle_cache.any? do |gem_path|
+        path.ascend do |part|
+          break true if gem_path == part
+        end
       end
-      false
     end
 
     # Guess whether a file is part of the tests/ dir (indicating library compilation should ignore it).
@@ -109,7 +143,8 @@ module ArduinoCI
       real = some_dir.realpath
       files = Find.find(real).map { |p| Pathname.new(p) }.reject(&:directory?)
       cpp = files.select { |path| CPP_EXTENSIONS.include?(path.extname.downcase) }
-      cpp.reject { |path| path.basename.to_s.start_with?(".") } # ignore hidden
+      not_hidden = cpp.reject { |path| path.basename.to_s.start_with?(".") }
+      not_hidden.sort_by(&:to_s)
     end
 
     # CPP files that are part of the project library under test

data/lib/arduino_ci/version.rb

@@ -1,3 +1,3 @@
 module ArduinoCI
-  VERSION = "0.1.17".freeze
+  VERSION = "0.1.18".freeze
 end

data/misc/default.yml

@@ -98,6 +98,7 @@ platforms:
     gcc:
       features:
       defines:
+        - __AVR_ATmega2560__
       warnings:
       flags:
   cplayClassic:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino_ci
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-14 00:00:00.000000000 Z
+date: 2019-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: keepachangelog_manager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +113,8 @@ email:
 - ianfixes@gmail.com
 executables:
 - arduino_ci_remote.rb
+- arduino_ci_remote.rb.orig
+- arduino_library_location.rb
 - ensure_arduino_installation.rb
 - libasan.rb
 extensions: []
@@ -408,6 +424,8 @@ files:
 - cpp/unittest/Assertion.h
 - cpp/unittest/Compare.h
 - exe/arduino_ci_remote.rb
+- exe/arduino_ci_remote.rb.orig
+- exe/arduino_library_location.rb
 - exe/ensure_arduino_installation.rb
 - exe/libasan.rb
 - lib/arduino_ci.rb