arduino_ci 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45608f459dc2eeb5eaca6d2d825561a806ba7fcb
-  data.tar.gz: c6c442695f3471518ae5abdbd4098629ecb868e0
+  metadata.gz: a089a7486b4295c2ed49a832a0dd148d6e31561a
+  data.tar.gz: 0c13b415b9b585c42ec2a8501c5e6ef606137c30
 SHA512:
-  metadata.gz: ef50f062dde7ce201362da1a9a1e225ff4f0bd868985dd118d44afa7d50c9bd01250aef7fbefe156d5948a732daa7131dbdc023911aa1d640a6fa07a514f75fd
-  data.tar.gz: 8578a23f2b8c4323279ad3b22950ee44aa991ab09593e666f936059192c5d8878fb69bb4335ad8aae3877cc7116a896654b364308d744d9959707ea214e752ff
+  metadata.gz: 74819da0c7bbaf23fbd5ceaf1952e43442d0bdd4789ecf1beb4c3a110038350797b9b6629698a3348bc9803afb444344badc2f0bdebbc930bf42835bb07b3109
+  data.tar.gz: 794e75954f74a2e9420d6ec4e884683b86f2a04d2ac0b0a3cf13776126e8db40c29724ebe397fb2d9bd062c5e3044cea206ed078aa5958dee825cd902d38e5a9

data/README.md

@@ -1,9 +1,9 @@
 
-# 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.16)
+# 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)
 
 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 proivdes 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 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.
 
@@ -34,6 +34,25 @@ source 'https://rubygems.org'
 gem 'arduino_ci'
 ```
 
+### Testing Locally
+
+First, pull in the `arduino_ci` library as a dependency.
+
+```
+$ bundle install
+```
+
+
+With that installed, just the following shell command each time you want the tests to execute:
+
+```
+$ bundle exec arduino_ci_remote.rb
+```
+
+
+
+### Testing with remote CI
+
 > **Note:** `arduino_ci_remote.rb` expects to be run from the root directory of your Arduino project library.
 
 

data/cpp/arduino/stdlib.cpp

@@ -0,0 +1,61 @@
+
+#if 1 // This code is copied from https://people.cs.umu.se/isak/snippets/ltoa.c and then converted from ltoa to itoa.
+/*
+**  LTOA.C
+**
+**  Converts a integer to a string.
+**
+**  Copyright 1988-90 by Robert B. Stout dba MicroFirm
+**
+**  Released to public domain, 1991
+**
+**  Parameters: 1 - number to be converted
+**              2 - buffer in which to build the converted string
+**              3 - number base to use for conversion
+**
+**  Returns:  A character pointer to the converted string if
+**            successful, a NULL pointer if the number base specified
+**            is out of range.
+*/
+
+#include <stdlib.h>
+#include <string.h>
+
+#define BUFSIZE (sizeof(int) * 8 + 1)
+
+char *itoa(int N, char *str, int base)
+{
+      int i = 2;
+      int uarg;
+      char *tail, *head = str, buf[BUFSIZE];
+
+      if (36 < base || 2 > base)
+            base = 10;                    /* can only use 0-9, A-Z        */
+      tail = &buf[BUFSIZE - 1];           /* last character position      */
+      *tail-- = '\0';
+
+      if (10 == base && N < 0L)
+      {
+            *head++ = '-';
+            uarg    = -N;
+      }
+      else  uarg = N;
+
+      if (uarg)
+      {
+            for (i = 1; uarg; ++i)
+            {
+                  ldiv_t r;
+
+                  r       = ldiv(uarg, base);
+                  *tail-- = (char)(r.rem + ((9L < r.rem) ?
+                                  ('A' - 10L) : '0'));
+                  uarg    = r.quot;
+            }
+      }
+      else  *tail-- = '0';
+
+      memcpy(head, ++tail, i);
+      return str;
+}
+#endif

data/cpp/arduino/stdlib.h

@@ -0,0 +1,14 @@
+#pragma once
+
+// Header file to compensate for differences between
+// arduino-1.x.x/hardware/tools/avr/avr/include/stdlib.h and /usr/include/stdlib.h.
+
+#include_next <stdlib.h>
+
+/*
+ * Arduino stdlib.h includes a prototype for itoa which is not a standard function,
+ * and is not available in /usr/include/stdlib.h. Provide one here.
+ * http://www.cplusplus.com/reference/cstdlib/itoa/
+ * https://stackoverflow.com/questions/190229/where-is-the-itoa-function-in-linux
+ */
+char *itoa(int val, char *s, int radix);

data/exe/arduino_ci_remote.rb

@@ -2,6 +2,7 @@
 require 'arduino_ci'
 require 'set'
 require 'pathname'
+require 'optparse'
 
 WIDTH = 80
 FIND_FILES_INDENT = 4
@@ -9,6 +10,41 @@ 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)
+    parsed_config = {}
+    parsed_config["unittest"] = {}
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: #{File.basename(__FILE__)} [options]"
+
+      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
+      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
+      end
+
+      opts.on("-h", "--help", "Prints this help") do
+        puts opts
+        exit
+      end
+    end
+
+    opt_parser.parse!(options)
+    parsed_config
+  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}"
@@ -28,6 +64,12 @@ end
 #   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} "
@@ -111,7 +153,10 @@ def display_files(pathname)
   non_hidden.each { |p| puts "#{margin}#{p}" }
 end
 
-def perform_unit_tests(config)
+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
   cpp_library = ArduinoCI::CppLibrary.new(Pathname.new("."), @arduino_cmd.lib_dir)
 
   # check GCC
@@ -149,7 +194,7 @@ def perform_unit_tests(config)
     inform("Skipping unit tests") { "no platforms were requested" }
   else
     config.platforms_to_unittest.each do |p|
-      cpp_library.test_files.each do |unittest_path|
+      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

data/lib/arduino_ci/arduino_downloader.rb

@@ -32,13 +32,7 @@ module ArduinoCI
       # if it exists.  I'm not sure why we would have both, but if we did
       # a force install then let's make sure we actually use it.
       locations = [self.force_installed_executable, self.existing_executable]
-      locations.each do |loc|
-        next if loc.nil?
-        next unless File.exist? loc
-
-        return loc
-      end
-      nil
+      locations.find { |loc| !loc.nil? && File.exist?(loc) }
     end
 
     # The autolocated directory of the installation
@@ -49,13 +43,7 @@ module ArduinoCI
       # if it exists.  I'm not sure why we would have both, but if we did
       # a force install then let's make sure we actually use it.
       locations = [self.force_install_location, self.existing_installation]
-      locations.each do |loc|
-        next if loc.nil?
-        next unless File.exist? loc
-
-        return loc
-      end
-      nil
+      locations.find { |loc| !loc.nil? && File.exist?(loc) }
     end
 
     # The path to the directory of an existing installation, or nil
@@ -198,7 +186,7 @@ module ArduinoCI
       elsif File.exist? extracted_file
         install
       else
-        puts "Arduino force-install failed"
+        puts "Could not find extracted archive (tried #{extracted_file})"
       end
 
       File.exist? self.class.force_install_location

data/lib/arduino_ci/arduino_downloader_osx.rb

@@ -27,21 +27,17 @@ module ArduinoCI
     # @param Array<string> a list of places to look
     # @return [string]
     def self.find_existing_arduino_dir(paths)
-      paths.each do |path|
-        return path if File.exist? path
-      end
-      nil
+      paths.find(&File.method(:exist?))
     end
 
     # An existing Arduino file in one of the given directories, or nil
     # @param Array<string> a list of places to look for the executable
     # @return [string]
     def self.find_existing_arduino_exe(paths)
-      paths.each do |path|
+      paths.find do |path|
         exe = File.join(path, "MacOS", "Arduino")
-        return exe if File.exist? exe
+        File.exist? exe
       end
-      nil
     end
 
     # The path to the directory of an existing installation, or nil

data/lib/arduino_ci/arduino_downloader_windows.rb

@@ -81,10 +81,10 @@ module ArduinoCI
     # @return [string]
     def self.existing_executable
       arduino_reg = 'SOFTWARE\WOW6432Node\Arduino'
-      Win32::Registry::HKEY_LOCAL_MACHINE.open(arduino_reg) do |reg|
+      Win32::Registry::HKEY_LOCAL_MACHINE.open(arduino_reg).find do |reg|
         path = reg.read_s('Install_Dir')
         exe = File.join(path, "arduino_debug.exe")
-        return exe if File.exist? exe
+        File.exist? exe
       end
     rescue
       nil
@@ -93,10 +93,7 @@ module ArduinoCI
     # The executable Arduino file in a forced installation, or nil
     # @return [string]
     def self.force_installed_executable
-      exe = File.join(self.force_install_location, "arduino_debug.exe")
-      return nil if exe.nil?
-
-      exe
+      File.join(self.force_install_location, "arduino_debug.exe")
     end
 
   end

data/lib/arduino_ci/arduino_installation.rb

@@ -13,6 +13,8 @@ DESIRED_ARDUINO_IDE_VERSION = "1.8.6".freeze
 
 module ArduinoCI
 
+  class ArduinoInstallationError < StandardError; end
+
   # Manage the OS-specific install location of Arduino
   class ArduinoInstallation
 
@@ -78,7 +80,13 @@ module ArduinoCI
           # don't want to see is a java error.
           args = launcher + ["--bogus-option"]
           result = Host.run_and_capture(*args)
-          next unless result[:err].include? "Error: unknown option: --bogus-option"
+
+          # NOTE: Was originally searching for "Error: unknown option: --bogus-option"
+          #           but also need to find "Erreur: option inconnue : --bogus-option"
+          #           and who knows how many other languages.
+          # For now, just search for the end of the error and hope that the java-style
+          #  launch of this won't include a similar string in it
+          next unless result[:err].include? ": --bogus-option"
 
           ret.base_cmd = launcher
           ret.binary_path = Pathname.new(osx_root)
@@ -94,7 +102,8 @@ module ArduinoCI
         return candidate unless candidate.nil?
 
         # force the install
-        force_install
+        raise ArduinoInstallationError, "Failed to force-install Arduino" unless force_install
+
         autolocate
       end
 

data/lib/arduino_ci/ci_config.rb

@@ -35,6 +35,8 @@ UNITTEST_SCHEMA = {
 }.freeze
 module ArduinoCI
 
+  class ConfigurationError < StandardError; end
+
   # 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_FILENAMES = [
@@ -70,6 +72,21 @@ module ArduinoCI
       @unittest_info = {}
     end
 
+    # @return [Hash] config data as a hash
+    def to_h
+      {
+        packages: @package_info,
+        platforms: @platform_info,
+        compile: @compile_info,
+        unittest: @unittest_info
+      }
+    end
+
+    # @return [String] config data as a string
+    def to_s
+      to_h.to_s
+    end
+
     # Deep-clone a hash
     # @param hash [Hash] the source data
     # @return [Hash] a copy
@@ -108,8 +125,15 @@ 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
+      raise ConfigurationError, "The YAML file at #{path} failed to load" unless yml
+
+      apply_configuration(yml)
+    end
 
+    # Load configuration from a hash
+    # @param yml [Hash] the source data
+    # @return [ArduinoCI::CIConfig] a reference to self
+    def apply_configuration(yml)
       if yml.include?("packages")
         yml["packages"].each do |k, v|
           valid_data = validate_data("packages", v, PACKAGE_SCHEMA)
@@ -137,19 +161,35 @@ module ArduinoCI
       self
     end
 
+    # Create a clone of this configuration and return it
+    # @return [ArduinoCI::CIConfig] the new settings object
+    def clone
+      cloned_config = self.class.new
+      cloned_config.package_info  = deep_clone(@package_info)
+      cloned_config.platform_info = deep_clone(@platform_info)
+      cloned_config.compile_info  = deep_clone(@compile_info)
+      cloned_config.unittest_info = deep_clone(@unittest_info)
+      cloned_config
+    end
+
     # Override these settings with settings from another file
     # @param path [String] the path to the settings yaml file
     # @return [ArduinoCI::CIConfig] the new settings object
     def with_override(path)
-      overridden_config = self.class.new
-      overridden_config.package_info  = deep_clone(@package_info)
-      overridden_config.platform_info = deep_clone(@platform_info)
-      overridden_config.compile_info  = deep_clone(@compile_info)
-      overridden_config.unittest_info = deep_clone(@unittest_info)
+      overridden_config = clone
       overridden_config.load_yaml(path)
       overridden_config
     end
 
+    # Override these settings with settings from a hash
+    # @param config_hash [Hash] A configuration hash
+    # @return [ArduinoCI::CIConfig] the new settings object
+    def with_override_config(config_hash)
+      overridden_config = clone
+      overridden_config.apply_configuration(config_hash)
+      overridden_config
+    end
+
     # 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

data/lib/arduino_ci/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino_ci
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-06 00:00:00.000000000 Z
+date: 2019-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -401,6 +401,8 @@ files:
 - cpp/arduino/ci/Queue.h
 - cpp/arduino/ci/README.md
 - cpp/arduino/ci/Table.h
+- cpp/arduino/stdlib.cpp
+- cpp/arduino/stdlib.h
 - cpp/unittest/ArduinoUnitTests.cpp
 - cpp/unittest/ArduinoUnitTests.h
 - cpp/unittest/Assertion.h