arduino_ci 0.1.18 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7de3ae0cd1c73eb41fe0b7f897e20f7a3d2e5c0
-  data.tar.gz: 29dc639c29a0dcb3841e3dd903002e1fc72ef892
+  metadata.gz: 70602a4768ed2df9cbd04f83888f229119f00267
+  data.tar.gz: 337f60474895f3cfdecd9497328a7772adcc9254
 SHA512:
-  metadata.gz: cf8434e69d4b3cc1c65d4b37db875133fdd1055e2d435b3936c15ef1e731c9160238a597ed2e2f8c21d28ce4522963e02371482ddfebc00307b2b16c2bfebf9d
-  data.tar.gz: db0f703d2d7dad26ccc1a54f098e64ef9953ef66266f4379e1936ff915dfb38e04899304ca666ea79fac8e1dee52868979b96d6ef2937a7a085a6383dec1f176
+  metadata.gz: 78f6e93158cd15a1398396a631646f20b4ce843d5fd386185505ea84b230f2fc5da927e532bdb174818bf73c060bdb09d2e870ab742653df58fa68c802a37c49
+  data.tar.gz: 2cf0fb5e0755ed5fe2ac989fa591a923fb162c922499c6467a45edb7dd6bd811a2e23ceb945597cf48311656fee45cb0eddbc5005d0688a52179dedf4cce01ec

data/README.md

@@ -1,12 +1,12 @@
 
-# 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)
+# 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.19)
 
-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.
-
-You want to run tests on your Arduino library without hardware present, but the IDE doesn't support that.  Arduino CI provides that ability.
+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.
 
 You want to precisely replicate certain software states in your library, but you don't have sub-millisecond reflexes for physically faking the inputs, outputs, and serial port.   Arduino CI fakes 100% of the physical input and output of an Arduino board, including the clock.
 
+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.
+
 `arduino_ci` is a cross-platform build/test system, consisting of a Ruby gem and a series of C++ mocks.  It enables tests to be run both locally and as part of a CI service like Travis or Appveyor.  Any OS that can run the Arduino IDE can run `arduino_ci`.
 
 Platform | CI Status
@@ -16,13 +16,36 @@ Linux    | [![Linux Build Status](http://badges.herokuapp.com/travis/ianfixes/ar
 Windows  | [![Windows Build status](https://ci.appveyor.com/api/projects/status/8f6e39dea319m83q/branch/master?svg=true)](https://ci.appveyor.com/project/ianfixes/arduino-ci)
 
 
-## Installation In Your GitHub Project And Using Travis CI
+## Comparison to Other Arduino Testing Tools
 
-The following prerequisites must be fulfilled:
+| Project                                                                     | CI | Builds Examples | Unittest | Arduino Mocks | Windows | OSX | Linux | License |
+|-----------------------------------------------------------------------------|:--:|:---------------:|:--------:|:-------------:|:-------:|:---:|:-----:|:--------|
+|[ArduinoCI](https://github.com/ianfixes/arduino_ci)                          | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |Free (Apache-2.0)|
+|[ArduinoUnit](https://github.com/mmurdoch/arduinounit)                       | ❌ | ❌ | ⚠️ Hardware-based|❌ | ✅ | ✅ | ✅ |Free (MIT)|
+|[Adafruit `travis-ci-arduino`](https://github.com/adafruit/travis-ci-arduino)| ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ |Free (MIT)|
+|[PlatformIO](https://platformio.org)                                         | ✅ | ✅ | ⚠️ Paid only | ❌ | ✅ | ✅ | ✅ |⚠️ EULA|
+|Official [Arduino IDE](https://www.arduino.cc/en/main/software)              | ❌ | ⚠️ Manually | ❌ |N/A 😉| ✅ | ✅ | ✅ |Free (GPLv2)|
 
-* A compiler; [g++](https://gcc.gnu.org/) is preferred.  On OSX, this is provided by the built-in `clang`.
-* A GitHub (or other repository-hosting) project for your library
-* A CI system like Travis or Appveor that is linked to your project
+
+## Quick Start
+
+For a bare-bones example that you can copy from, see [SampleProjects/DoSomething](SampleProjects/DoSomething).
+
+The complete set of C++ unit tests for the `arduino_ci` library itself are in the [SampleProjects/TestSomething](SampleProjects/TestSomething) project.  The [test files](SampleProjects/TestSomething/test/) are named after the type of feature being tested.
+
+
+### You Need Ruby and Bundler
+
+You'll need Ruby version 2.2 or higher, and to `gem install bundler` if it's not already there.
+
+
+### You Need A Compiler (`g++`)
+
+For unit testing, you will need a compiler; [g++](https://gcc.gnu.org/) is preferred.
+
+* **Linux**: `gcc`/`g++` is likely pre-installed.
+* **OSX**: `g++` is an alias for `clang`, which is provided by Xcode and the developer tools.  You are free to `brew install gcc` as well; this is also tested and working.
+* **Windows**: you will need Cygwin, and the `mingw-gcc-g++` package.  A full set of (working) install instructions can be found in `appveyor.yml`, as this is how CI runs for this project.
 
 
 ### Changes to Your Repo
@@ -34,21 +57,66 @@ source 'https://rubygems.org'
 gem 'arduino_ci'
 ```
 
-### Testing Locally
+It would also make sense to add the following to your `.gitignore`, or copy [the `.gitignore` used by this project](.gitignore):
+
+```
+/.bundle/
+/.yardoc
+Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+vendor
+*.gem
+
+# rspec failure tracking
+.rspec_status
+
+# C++ stuff
+*.bin
+*.bin.dSYM
+```
+
+
+### Installing the Dependencies
 
-First, pull in the `arduino_ci` library as a dependency.
+Fulfilling the `arduino_ci` library dependency is as easy as running this command:
 
 ```
 $ bundle install
 ```
 
 
+### Running tests
+
 With that installed, just the following shell command each time you want the tests to execute:
 
 ```
 $ bundle exec arduino_ci_remote.rb
 ```
 
+`arduino_ci_remote.rb` is the main entry point for this library.  This command will iterate over all the library's `examples/` and attempt to compile them.  If you set up unit tests, it will run those as well.
+
+
+### Reference
+
+For more information on the usage of `arduino_ci_remote.rb`, see [REFERENCE.md](REFERENCE.md).  It contains information such as:
+
+* How to configure build options (platforms to test, Arduino library dependencies to install) with an `.arduino-ci.yml` file
+* Where to put unit test files
+* How to structure unit test files
+* How to control the global (physical) state of the Arduino board
+* How to modify the Arduino platforms, compilers, test plans, etc
+
+
+## Setting up Pull Request Testing and/or External CI
+
+The following prerequisites must be fulfilled:
+
+* A GitHub (or other repository-hosting) project for your library
+* A CI system like [Travis CI](https://travis-ci.org/) or [Appveyor](https://www.appveyor.com/) that is linked to your project
 
 
 ### Testing with remote CI
@@ -66,10 +134,11 @@ Next, you need this in `.travis.yml` in your repo
 sudo: false
 language: ruby
 script:
-   - bundle install
-   - bundle exec arduino_ci_remote.rb
+  - bundle install
+  - bundle exec arduino_ci_remote.rb
 ```
 
+
 #### Appveyor CI
 
 You'll need to go to https://ci.appveyor.com/projects and add your project.
@@ -83,20 +152,6 @@ test_script:
   - bundle exec arduino_ci_remote.rb
 ```
 
-## Quick Start
-
-This software is in beta.  But [SampleProjects/DoSomething](SampleProjects/DoSomething) has a decent writeup and is a good bare-bones example of all the features.
-
-## Reference
-
-For more information on the usage of `arduino_ci`, see [REFERENCE.md](REFERENCE.md).  It contains information such as:
-
-* Where to put unit test files
-* How to structure unit test files
-* How to control the global (physical) state of the Arduino board
-* How to modify the Arduino platforms, compilers, test plans, etc
-
-
 ## Known Problems
 
 * The Arduino library is not fully mocked.
@@ -104,16 +159,6 @@ For more information on the usage of `arduino_ci`, see [REFERENCE.md](REFERENCE.
 * https://github.com/ianfixes/arduino_ci/issues
 
 
-## Comparison to Other Arduino Testing Tools
-
-
-| Project | CI | Builds Examples | Unittest | Arduino Mocks | Windows | OSX | Linux | License |
-|---------|----|-----------------|----------|---------------|---------|-----|-------|---------|
-|[ArduinoCI](https://github.com/ianfixes/arduino_ci)| ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |Free (Apache-2.0)|
-|[ArduinoUnit](https://github.com/mmurdoch/arduinounit)|❌ |❌ |Hardware-based|❌ | ✅ | ✅ | ✅ |Free (MIT)| |
-|[Adafruit `travis-ci-arduino`](https://github.com/adafruit/travis-ci-arduino)   | ✅ | ✅ | ❌| ❌ | ❌ | ❌ | ✅ |Free (MIT)|
-|[PlatformIO](https://platformio.org)| ✅ | ✅ | Paid only | ❌ | ✅ | ✅ | ✅ |Proprietary (EULA)|
-
 ## Author
 
 This gem was written by Ian Katz (ianfixes@gmail.com) in 2018.  It's released under the Apache 2.0 license.

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 "Nullptr.h"
 
 typedef bool boolean;
 typedef uint8_t byte;
@@ -72,7 +73,3 @@ 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/Nullptr.h

@@ -0,0 +1,7 @@
+#pragma once
+
+// Define C++11 nullptr
+typedef void * my_nullptr_t;
+#define nullptr (my_nullptr_t)NULL
+
+inline std::ostream& operator << (std::ostream& out, const my_nullptr_t &np) { return out << "nullptr"; }

data/cpp/unittest/Assertion.h

@@ -39,6 +39,7 @@
 #define assertTrue(arg) assertEqual(true, arg)
 #define assertFalse(arg) assertEqual(false, arg)
 #define assertNull(arg) assertEqual((void*)NULL, (void*)arg)
+#define assertNotNull(arg) assertNotEqual((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)
@@ -50,4 +51,5 @@
 #define assureTrue(arg) assureEqual(true, arg)
 #define assureFalse(arg) assureEqual(false, arg)
 #define assureNull(arg) assureEqual((void*)NULL, (void*)arg)
+#define assureNotNull(arg) assureNotEqual((void*)NULL, (void*)arg)
 

data/cpp/unittest/Compare.h

@@ -1,6 +1,7 @@
 #pragma once
 #include <avr/pgmspace.h>
 #include <WString.h>
+#include <Nullptr.h>
 
 template  < typename A, typename B > struct Compare
 {
@@ -897,10 +898,21 @@ template  < size_t N, size_t M > struct Compare<char [N],char [M]>
     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); }
-template <typename A, typename B> bool compareLess(const A &a, const B &b) { return Compare<A,B>::less(a,b); }
-template <typename A, typename B> bool compareMore(const A &a, const B &b) { return Compare<A,B>::more(a,b); }
-template <typename A, typename B> bool compareLessOrEqual(const A &a, const B &b) { return Compare<A,B>::lessOrEqual(a,b); }
-template <typename A, typename B> bool compareMoreOrEqual(const A &a, const B &b) { return Compare<A,B>::moreOrEqual(a,b); }
+
+// null pointer comparisons
+template <typename B> int  compareBetween(    const my_nullptr_t &a, const B &b) { return Compare<my_nullptr_t,B>::between(    a, b); }
+template <typename B> bool compareEqual(      const my_nullptr_t &a, const B &b) { return Compare<my_nullptr_t,B>::equal(      a, b); }
+template <typename B> bool compareNotEqual(   const my_nullptr_t &a, const B &b) { return Compare<my_nullptr_t,B>::notEqual(   a, b); }
+template <typename B> bool compareLess(       const my_nullptr_t &a, const B &b) { return Compare<my_nullptr_t,B>::less(       a, b); }
+template <typename B> bool compareMore(       const my_nullptr_t &a, const B &b) { return Compare<my_nullptr_t,B>::more(       a, b); }
+template <typename B> bool compareLessOrEqual(const my_nullptr_t &a, const B &b) { return Compare<my_nullptr_t,B>::lessOrEqual(a, b); }
+template <typename B> bool compareMoreOrEqual(const my_nullptr_t &a, const B &b) { return Compare<my_nullptr_t,B>::moreOrEqual(a, b); }
+
+// super general comparisons
+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); }
+template <typename A, typename B> bool compareLess(       const A &a, const B &b) { return Compare<A,B>::less(       a, b); }
+template <typename A, typename B> bool compareMore(       const A &a, const B &b) { return Compare<A,B>::more(       a, b); }
+template <typename A, typename B> bool compareLessOrEqual(const A &a, const B &b) { return Compare<A,B>::lessOrEqual(a, b); }
+template <typename A, typename B> bool compareMoreOrEqual(const A &a, const B &b) { return Compare<A,B>::moreOrEqual(a, b); }

data/lib/arduino_ci/ci_config.rb

@@ -287,17 +287,17 @@ module ArduinoCI
     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
+    # @param paths [Array<Pathname>] the initial set of test files
+    # @return [Array<Pathname>] 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)) } }
+        ret.select! { |p| unittest_info[:testfiles][:select].any? { |glob| p.basename.fnmatch(glob) } }
       end
       unless @unittest_info[:testfiles][:reject].nil?
-        ret = ret.reject { |p| unittest_info[:testfiles][:reject].any? { |glob| File.fnmatch(glob, File.basename(p)) } }
+        ret.reject! { |p| unittest_info[:testfiles][:reject].any? { |glob| p.basename.fnmatch(glob) } }
       end
       ret
     end

data/lib/arduino_ci/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino_ci
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-29 00:00:00.000000000 Z
+date: 2019-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -113,7 +113,6 @@ email:
 - ianfixes@gmail.com
 executables:
 - arduino_ci_remote.rb
-- arduino_ci_remote.rb.orig
 - arduino_library_location.rb
 - ensure_arduino_installation.rb
 - libasan.rb
@@ -129,6 +128,7 @@ files:
 - cpp/arduino/Godmode.cpp
 - cpp/arduino/Godmode.h
 - cpp/arduino/HardwareSerial.h
+- cpp/arduino/Nullptr.h
 - cpp/arduino/PinHistory.h
 - cpp/arduino/Print.h
 - cpp/arduino/SPI.h
@@ -424,7 +424,6 @@ 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

data/exe/arduino_ci_remote.rb.orig

@@ -1,387 +0,0 @@
-#!/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)