arduino_ci 0.1.10 → 0.1.11

data/lib/arduino_ci/arduino_cmd_osx.rb

@@ -12,23 +12,6 @@ module ArduinoCI
     flag :install_boards,  "--install-boards"
     flag :install_library, "--install-library"
     flag :verify,          "--verify"
-
-    # run the arduino command
-    # @return [bool] whether the command succeeded
-    def _run_and_output(*args, **kwargs)
-      Host.run_and_output(*args, **kwargs)
-    end
-
-    # run the arduino command
-    # @return [Hash] keys for :success, :out, and :err
-    def _run_and_capture(*args, **kwargs)
-      Host.run_and_capture(*args, **kwargs)
-    end
-
-    def _lib_dir
-      File.join(ENV['HOME'], "Documents", "Arduino", "libraries")
-    end
-
   end
 
 end

data/lib/arduino_ci/arduino_cmd_windows.rb

@@ -12,23 +12,6 @@ module ArduinoCI
     flag :install_boards,  "--install-boards"
     flag :install_library, "--install-library"
     flag :verify,          "--verify"
-
-    # run the arduino command
-    # @return [bool] whether the command succeeded
-    def _run_and_output(*args, **kwargs)
-      Host.run_and_output(*args, **kwargs)
-    end
-
-    # run the arduino command
-    # @return [Hash] keys for :success, :out, and :err
-    def _run_and_capture(*args, **kwargs)
-      Host.run_and_capture(*args, **kwargs)
-    end
-
-    def _lib_dir
-      File.join(ENV['userprofile'], "Documents", "Arduino", "libraries")
-    end
-
   end
 
 end

data/lib/arduino_ci/arduino_downloader.rb

@@ -35,6 +35,7 @@ module ArduinoCI
       locations.each do |loc|
         next if loc.nil?
         next unless File.exist? loc
+
         return loc
       end
       nil
@@ -51,6 +52,7 @@ module ArduinoCI
       locations.each do |loc|
         next if loc.nil?
         next unless File.exist? loc
+
         return loc
       end
       nil
@@ -132,6 +134,8 @@ module ArduinoCI
       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}"
     end
 
     # Extract the package_file to extracted_file

data/lib/arduino_ci/arduino_downloader_linux.rb

@@ -47,6 +47,7 @@ module ArduinoCI
     def self.existing_installation
       exe = self.existing_executable
       return nil if exe.nil?
+
       File.dirname(exe) # it's not really this
       # but for this platform it doesn't really matter
     end
@@ -79,6 +80,7 @@ module ArduinoCI
       end
       forced_arduino = File.join(self.force_install_location, "arduino")
       return forced_arduino if File.exist? forced_arduino
+
       nil
     end
 

data/lib/arduino_ci/arduino_downloader_windows.rb

@@ -73,6 +73,7 @@ module ArduinoCI
     def self.existing_installation
       exe = self.existing_executable
       return nil if exe.nil?
+
       File.dirname(exe)
     end
 
@@ -94,6 +95,7 @@ module ArduinoCI
     def self.force_installed_executable
       exe = File.join(self.force_install_location, "arduino_debug.exe")
       return nil if exe.nil?
+
       exe
     end
 

data/lib/arduino_ci/arduino_installation.rb

@@ -8,7 +8,7 @@ require "arduino_ci/arduino_downloader_linux"
 
 require "arduino_ci/arduino_downloader_windows" if ArduinoCI::Host.os == :windows
 
-DESIRED_ARDUINO_IDE_VERSION = "1.8.5".freeze
+DESIRED_ARDUINO_IDE_VERSION = "1.8.6".freeze
 
 module ArduinoCI
 
@@ -29,11 +29,13 @@ module ArduinoCI
         when :linux then
           loc = ArduinoDownloaderLinux.autolocated_executable
           return nil if loc.nil?
+
           ret = ArduinoCmdLinux.new
           ret.base_cmd = [loc]
         when :windows then
           loc = ArduinoDownloaderWindows.autolocated_executable
           return nil if loc.nil?
+
           ret = ArduinoCmdWindows.new
           ret.base_cmd = [loc]
         end
@@ -51,8 +53,9 @@ module ArduinoCI
           # from https://github.com/arduino/Arduino/issues/1970#issuecomment-321975809
           [
             "java",
-            "-cp", "#{osx_root}/Java/*",
-            "-DAPP_DIR=#{osx_root}/Java",
+            "-cp",
+            "#{osx_root}/Contents/Java/*",
+            "-DAPP_DIR=#{osx_root}/Contents/Java",
             "-Dfile.encoding=UTF-8",
             "-Dapple.awt.UIElement=true",
             "-Xms128M",

data/lib/arduino_ci/ci_config.rb

@@ -54,7 +54,7 @@ module ArduinoCI
       # @return [ArudinoCI::CIConfig] The configuration with defaults filled in
       def default
         ret = new
-        ret.load_yaml(File.expand_path("../../../misc/default.yml", __FILE__))
+        ret.load_yaml(File.expand_path("../../misc/default.yml", __dir__))
         ret
       end
     end
@@ -85,6 +85,7 @@ module ArduinoCI
     # @return [Hash] a copy, containing only expected & valid data
     def validate_data(rootname, source, schema)
       return nil if source.nil?
+
       good_data = {}
       source.each do |key, value|
         ksym = key.to_sym
@@ -125,12 +126,12 @@ module ArduinoCI
 
       if yml.include?("compile")
         valid_data = validate_data("compile", yml["compile"], COMPILE_SCHEMA)
-        @compile_info = valid_data
+        valid_data.each { |k, v| @compile_info[k] = v }
       end
 
       if yml.include?("unittest")
         valid_data = validate_data("unittest", yml["unittest"], UNITTEST_SCHEMA)
-        @unittest_info = valid_data
+        valid_data.each { |k, v| @unittest_info[k] = v }
       end
 
       self
@@ -186,6 +187,7 @@ module ArduinoCI
     def platform_definition(platform_name)
       defn = @platform_info[platform_name]
       return nil if defn.nil?
+
       deep_clone(defn)
     end
 
@@ -195,6 +197,7 @@ module ArduinoCI
     # @return [String] the URL defined for this package
     def package_url(package)
       return nil if @package_info[package].nil?
+
       @package_info[package][:url]
     end
 
@@ -202,6 +205,7 @@ module ArduinoCI
     # @return [Array<String>] The compiler binary names (e.g. g++) to build with
     def compilers_to_use
       return [] if @unittest_info[:compilers].nil?
+
       @unittest_info[:compilers]
     end
 
@@ -209,6 +213,7 @@ module ArduinoCI
     # @return [Array<String>] The platforms to build
     def platforms_to_build
       return [] if @compile_info[:platforms].nil?
+
       @compile_info[:platforms]
     end
 
@@ -216,18 +221,21 @@ module ArduinoCI
     # @return [Array<String>] The platforms to unit test on
     def platforms_to_unittest
       return [] if @unittest_info[:platforms].nil?
+
       @unittest_info[:platforms]
     end
 
     # @return [Array<String>] The aux libraries required for building/verifying
     def aux_libraries_for_build
       return [] if @compile_info[:libraries].nil?
+
       @compile_info[:libraries]
     end
 
     # @return [Array<String>] The aux libraries required for unit testing
     def aux_libraries_for_unittest
       return [] if @unittest_info[:libraries].nil?
+
       @unittest_info[:libraries]
     end
 
@@ -236,6 +244,7 @@ module ArduinoCI
     # @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)) } }
@@ -253,6 +262,7 @@ module ArduinoCI
       plat = @platform_info[platform_name]
       return {} if plat.nil?
       return {} if plat[:gcc].nil?
+
       plat[:gcc]
     end
   end

data/lib/arduino_ci/cpp_library.rb

@@ -1,20 +1,25 @@
 require 'find'
 require "arduino_ci/host"
+require 'pathname'
 
 HPP_EXTENSIONS = [".hpp", ".hh", ".h", ".hxx", ".h++"].freeze
 CPP_EXTENSIONS = [".cpp", ".cc", ".c", ".cxx", ".c++"].freeze
-ARDUINO_HEADER_DIR = File.expand_path("../../../cpp/arduino", __FILE__)
-UNITTEST_HEADER_DIR = File.expand_path("../../../cpp/unittest", __FILE__)
+CI_CPP_DIR = Pathname.new(__dir__).parent.parent + "cpp"
+ARDUINO_HEADER_DIR = CI_CPP_DIR + "arduino"
+UNITTEST_HEADER_DIR = CI_CPP_DIR + "unittest"
 
 module ArduinoCI
 
   # Information about an Arduino CPP library, specifically for compilation purposes
   class CppLibrary
 
-    # @return [String] The path to the library being tested
+    # @return [Pathname] The path to the library being tested
     attr_reader :base_dir
 
-    # @return [Array<String>] The set of artifacts created by this class (note: incomplete!)
+    # @return [Pathname] The path to the Arduino 3rd-party library directory
+    attr_reader :arduino_lib_dir
+
+    # @return [Array<Pathname>] The set of artifacts created by this class (note: incomplete!)
     attr_reader :artifacts
 
     # @return [String] STDERR from the last command
@@ -26,84 +31,124 @@ module ArduinoCI
     # @return [String] the last command
     attr_reader :last_cmd
 
-    # @param base_dir [String] The path to the library being tested
-    def initialize(base_dir)
-      @base_dir = File.expand_path(base_dir)
+    # @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)
+      raise ArgumentError, 'base_dir is not a Pathname' unless base_dir.is_a? Pathname
+      raise ArgumentError, 'arduino_lib_dir is not a Pathname' unless arduino_lib_dir.is_a? Pathname
+
+      @base_dir = base_dir
+      @arduino_lib_dir = arduino_lib_dir.expand_path
       @artifacts = []
       @last_err = ""
       @last_out = ""
       @last_msg = ""
+      @has_libasan_cache = {}
     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
-    # @param path [String] The path to check
-    # @return [Array<String>] The paths of the found files
+    # @param path [Pathname] The path to check
+    # @return [Array<Pathname>] The paths of the found files
     def vendor_bundle?(path)
       # TODO: look for Gemfile, look for .bundle/config and get BUNDLE_PATH from there?
-      base = File.join(@base_dir, "vendor")
-      real = File.join(File.realpath(@base_dir), "vendor")
-      return true if path.start_with?(base)
-      return true if path.start_with?(real)
+      base = @base_dir + "vendor"
+      return false unless base.exist?
+
+      real = base.realpath
+      path.ascend do |path_part|
+        return true if path_part == base
+        return true if path_part == real
+      end
       false
     end
 
+    # Check whether libasan (and by extension -fsanitizer=address) is supported
+    #
+    # This requires compilation of a sample program, and will be cached
+    # @param gcc_binary [String]
+    def libasan?(gcc_binary)
+      unless @has_libasan_cache.key?(gcc_binary)
+        file = Tempfile.new('arduino_ci_libasan_check')
+        begin
+          file.write "int main(){}"
+          file.close
+          @has_libasan_cache[gcc_binary] = run_gcc(gcc_binary, "-o", "/dev/null", "-fsanitize=address", file.path)
+        ensure
+          file.delete
+        end
+      end
+      @has_libasan_cache[gcc_binary]
+    end
+
     # Get a list of all CPP source files in a directory and its subdirectories
-    # @param some_dir [String] The directory in which to begin the search
-    # @return [Array<String>] The paths of the found files
+    # @param some_dir [Pathname] The directory in which to begin the search
+    # @return [Array<Pathname>] The paths of the found files
     def cpp_files_in(some_dir)
-      return [] unless File.exist?(some_dir)
-      real = File.realpath(some_dir)
-      files = Find.find(real).reject { |path| File.directory?(path) }
-      ret = files.select { |path| CPP_EXTENSIONS.include?(File.extname(path)) }
-      ret
+      raise ArgumentError, 'some_dir is not a Pathname' unless some_dir.is_a? Pathname
+      return [] unless some_dir.exist? && some_dir.directory?
+
+      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
     end
 
     # CPP files that are part of the project library under test
-    # @return [Array<String>]
+    # @return [Array<Pathname>]
     def cpp_files
-      real_tests_dir = File.realpath(tests_dir)
+      real_tests_dir = tests_dir.realpath
       cpp_files_in(@base_dir).reject do |p|
-        next true if File.dirname(p).include?(tests_dir)
-        next true if File.dirname(p).include?(real_tests_dir)
-        next true if vendor_bundle?(p)
+        next true if p.ascend do |path_part|
+          break true if path_part == tests_dir
+          break true if path_part == real_tests_dir
+          break true if vendor_bundle?(p)
+        end
+
+        false
       end
     end
 
     # CPP files that are part of the arduino mock library we're providing
-    # @return [Array<String>]
+    # @return [Array<Pathname>]
     def cpp_files_arduino
       cpp_files_in(ARDUINO_HEADER_DIR)
     end
 
     # CPP files that are part of the unit test library we're providing
-    # @return [Array<String>]
+    # @return [Array<Pathname>]
     def cpp_files_unittest
       cpp_files_in(UNITTEST_HEADER_DIR)
     end
 
+    # CPP files that are part of the 3rd-party libraries we're including
+    # @param [Array<String>] aux_libraries
+    # @return [Array<Pathname>]
+    def cpp_files_libraries(aux_libraries)
+      arduino_library_src_dirs(aux_libraries).map { |d| cpp_files_in(d) }.flatten.uniq
+    end
+
     # The directory where we expect to find unit test defintions provided by the user
-    # @return [String]
+    # @return [Pathname]
     def tests_dir
-      File.join(@base_dir, "test")
+      Pathname.new(@base_dir) + "test"
     end
 
     # The files provided by the user that contain unit tests
-    # @return [Array<String>]
+    # @return [Array<Pathname>]
     def test_files
       cpp_files_in(tests_dir)
     end
 
     # Find all directories in the project library that include C++ header files
-    # @return [Array<String>]
+    # @return [Array<Pathname>]
     def header_dirs
-      real = File.realpath(@base_dir)
-      all_files = Find.find(real).reject { |path| File.directory?(path) }
+      real = @base_dir.realpath
+      all_files = Find.find(real).map { |f| Pathname.new(f) }.reject(&:directory?)
       unbundled = all_files.reject { |path| vendor_bundle?(path) }
-      files = unbundled.select { |path| HPP_EXTENSIONS.include?(File.extname(path)) }
-      ret = files.map { |path| File.dirname(path) }.uniq
-      ret
+      files = unbundled.select { |path| HPP_EXTENSIONS.include?(path.extname.downcase) }
+      files.map(&:dirname).uniq
     end
 
     # wrapper for the GCC command
@@ -120,14 +165,29 @@ module ArduinoCI
     # @return [String] the version reported by `gcc -v`
     def gcc_version(gcc_binary)
       return nil unless run_gcc(gcc_binary, "-v")
+
       @last_err
     end
 
+    # Arduino library directories containing sources
+    # @return [Array<Pathname>]
+    def arduino_library_src_dirs(aux_libraries)
+      # Pull in all possible places that headers could live, according to the spec:
+      # https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification
+      # TODO: be smart and implement library spec (library.properties, etc)?
+      subdirs = ["", "src", "utility"]
+      all_aux_include_dirs_nested = aux_libraries.map do |libdir|
+        subdirs.map { |subdir| Pathname.new(@arduino_lib_dir) + libdir + subdir }
+      end
+      all_aux_include_dirs_nested.flatten.select(&:exist?).select(&:directory?)
+    end
+
     # GCC command line arguments for including aux libraries
-    # @param aux_libraries [String] The external Arduino libraries required by this project
+    # @param aux_libraries [Array<Pathname>] The external Arduino libraries required by this project
     # @return [Array<String>] The GCC command-line flags necessary to include those libraries
     def include_args(aux_libraries)
-      places = [ARDUINO_HEADER_DIR, UNITTEST_HEADER_DIR] + header_dirs + aux_libraries
+      all_aux_include_dirs = arduino_library_src_dirs(aux_libraries)
+      places = [ARDUINO_HEADER_DIR, UNITTEST_HEADER_DIR] + header_dirs + all_aux_include_dirs
       places.map { |d| "-I#{d}" }
     end
 
@@ -136,6 +196,7 @@ module ArduinoCI
     # @return [Array<String>] GCC command-line flags
     def feature_args(ci_gcc_config)
       return [] if ci_gcc_config[:features].nil?
+
       ci_gcc_config[:features].map { |f| "-f#{f}" }
     end
 
@@ -144,6 +205,7 @@ module ArduinoCI
     # @return [Array<String>] GCC command-line flags
     def warning_args(ci_gcc_config)
       return [] if ci_gcc_config[:warnings].nil?
+
       ci_gcc_config[:features].map { |w| "-W#{w}" }
     end
 
@@ -152,6 +214,7 @@ module ArduinoCI
     # @return [Array<String>] GCC command-line flags
     def define_args(ci_gcc_config)
       return [] if ci_gcc_config[:defines].nil?
+
       ci_gcc_config[:defines].map { |d| "-D#{d}" }
     end
 
@@ -160,16 +223,20 @@ module ArduinoCI
     # @return [Array<String>] GCC command-line flags
     def flag_args(ci_gcc_config)
       return [] if ci_gcc_config[:flags].nil?
+
       ci_gcc_config[:flags]
     end
 
     # All GCC command line args for building any unit test
-    # @param aux_libraries [String] The external Arduino libraries required by this project
+    # @param aux_libraries [Array<Pathname>] The external Arduino libraries required by this project
     # @param ci_gcc_config [Hash] The GCC config object
     # @return [Array<String>] GCC command-line flags
     def test_args(aux_libraries, ci_gcc_config)
       # TODO: something with libraries?
-      ret = include_args(aux_libraries) + cpp_files_arduino + cpp_files_unittest + cpp_files
+      ret = include_args(aux_libraries)
+      ret += cpp_files_arduino.map(&:to_s)
+      ret += cpp_files_unittest.map(&:to_s)
+      ret += cpp_files.map(&:to_s)
       unless ci_gcc_config.nil?
         cgc = ci_gcc_config
         ret = feature_args(cgc) + warning_args(cgc) + define_args(cgc) + flag_args(cgc) + ret
@@ -178,32 +245,42 @@ module ArduinoCI
     end
 
     # build a file for running a test of the given unit test file
-    # @param test_file [String] The path to the file containing the unit tests
-    # @param aux_libraries [String] The external Arduino libraries required by this project
+    # @param test_file [Pathname] The path to the file containing the unit tests
+    # @param aux_libraries [Array<Pathname>] The external Arduino libraries required by this project
     # @param ci_gcc_config [Hash] The GCC config object
-    # @return [String] path to the compiled test executable
+    # @return [Pathname] path to the compiled test executable
     def build_for_test_with_configuration(test_file, aux_libraries, gcc_binary, ci_gcc_config)
-      base = File.basename(test_file)
-      executable = File.expand_path("unittest_#{base}.bin")
+      base = test_file.basename
+      executable = Pathname.new("unittest_#{base}.bin").expand_path
       File.delete(executable) if File.exist?(executable)
-      args = [
-        ["-std=c++0x", "-o", executable, "-DARDUINO=100"],
-        test_args(aux_libraries, ci_gcc_config),
-        [test_file],
-      ].flatten(1)
+      arg_sets = []
+      arg_sets << ["-std=c++0x", "-o", executable.to_s, "-DARDUINO=100"]
+      if libasan?(gcc_binary)
+        arg_sets << [ # Stuff to help with dynamic memory mishandling
+          "-g", "-O1",
+          "-fno-omit-frame-pointer",
+          "-fno-optimize-sibling-calls",
+          "-fsanitize=address"
+        ]
+      end
+      arg_sets << test_args(aux_libraries, ci_gcc_config)
+      arg_sets << cpp_files_libraries(aux_libraries).map(&:to_s)
+      arg_sets << [test_file.to_s]
+      args = arg_sets.flatten(1)
       return nil unless run_gcc(gcc_binary, *args)
+
       artifacts << executable
       executable
     end
 
     # run a test file
-    # @param [String] the path to the test file
+    # @param [Pathname] the path to the test file
     # @return [bool] whether all tests were successful
     def run_test_file(executable)
       @last_cmd = executable
       @last_out = ""
       @last_err = ""
-      Host.run_and_output(executable)
+      Host.run_and_output(executable.to_s)
     end
 
   end