Compile with 3rd-party Arduino libraries (includes and CPP files)

Author: ianfixes

CHANGELOG.md

@@ -7,7 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased]
 ### Added
 - Explicit checks that the requested test platforms are defined in YML
-- Method to guess whether a library is installed
+- Arduino command wrapper can now guess whether a library is installed
+- CPP library class now reaches into included Arduino libraries for source files
 
 ### Changed
 - Refactored documentation

exe/arduino_ci_remote.rb

@@ -74,7 +74,7 @@ def assured_platform(purpose, name, config)
 # initialize library under test
 installed_library_path = assure("Installing library under test") { @arduino_cmd.install_local_library(".") }
 library_examples = @arduino_cmd.library_examples(installed_library_path)
-cpp_library = ArduinoCI::CppLibrary.new(installed_library_path)
+cpp_library = ArduinoCI::CppLibrary.new(installed_library_path, @arduino_cmd.lib_dir)
 attempt("Library installed at #{installed_library_path}") { true }
 
 # check GCC

lib/arduino_ci/arduino_cmd.rb

@@ -66,8 +66,8 @@ def parse_pref_string(arduino_output)
     end
 
     # @return [String] the path to the Arduino libraries directory
-    def _lib_dir
-      "<lib dir not defined>"
+    def lib_dir
+      "<lib_dir not defined>"
     end
 
     # fetch preferences in their raw form
@@ -190,7 +190,7 @@ def install_library(library_name)
     # @param library_name [String] The name of the library
     # @return [String] The fully qualified library name
     def library_path(library_name)
-      File.join(_lib_dir, library_name)
+      File.join(lib_dir, library_name)
     end
 
     # Determine whether a library is present in the lib dir

lib/arduino_ci/arduino_cmd_linux.rb

@@ -33,7 +33,7 @@ def _prefs_raw
 
     # implementation for Arduino library dir location
     # @return [String] the path to the Arduino libraries directory
-    def _lib_dir
+    def lib_dir
       File.join(get_pref("sketchbook.path"), "libraries")
     end
 

lib/arduino_ci/arduino_cmd_linux_builder.rb

@@ -16,7 +16,7 @@ class ArduinoCmdLinuxBuilder < ArduinoCmd
 
     # linux-specific implementation
     # @return [String] The path to the library dir
-    def _lib_dir
+    def lib_dir
       File.join(get_pref("sketchbook.path"), "libraries")
     end
 

lib/arduino_ci/arduino_cmd_osx.rb

@@ -13,7 +13,7 @@ class ArduinoCmdOSX < ArduinoCmd
     flag :install_library, "--install-library"
     flag :verify,          "--verify"
 
-    def _lib_dir
+    def lib_dir
       File.join(ENV['HOME'], "Documents", "Arduino", "libraries")
     end
 

lib/arduino_ci/arduino_cmd_windows.rb

@@ -13,7 +13,7 @@ class ArduinoCmdWindows < ArduinoCmd
     flag :install_library, "--install-library"
     flag :verify,          "--verify"
 
-    def _lib_dir
+    def lib_dir
       File.join(ENV['userprofile'], "Documents", "Arduino", "libraries")
     end
 

lib/arduino_ci/cpp_library.rb

@@ -14,6 +14,9 @@ class CppLibrary
     # @return [String] The path to the library being tested
     attr_reader :base_dir
 
+    # @return [String] The path to the Arduino 3rd-party library directory
+    attr_reader :arduino_lib_dir
+
     # @return [Array<String>] The set of artifacts created by this class (note: incomplete!)
     attr_reader :artifacts
 
@@ -27,8 +30,9 @@ class CppLibrary
     attr_reader :last_cmd
 
     # @param base_dir [String] The path to the library being tested
-    def initialize(base_dir)
+    def initialize(base_dir, arduino_lib_dir)
       @base_dir = File.expand_path(base_dir)
+      @arduino_lib_dir = File.expand_path(arduino_lib_dir)
       @artifacts = []
       @last_err = ""
       @last_out = ""
@@ -83,6 +87,12 @@ def cpp_files_unittest
       cpp_files_in(UNITTEST_HEADER_DIR)
     end
 
+    # CPP files that are part of the 3rd-party libraries we're including
+    # @return [Array<String>]
+    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]
     def tests_dir
@@ -123,11 +133,24 @@ def gcc_version(gcc_binary)
       @last_err
     end
 
+    # Arduino library directories containing sources
+    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| File.join(@arduino_lib_dir, libdir, subdir) }
+      end
+      all_aux_include_dirs_nested.flatten.select { |d| File.exist?(d) }
+    end
+
     # GCC command line arguments for including aux libraries
     # @param aux_libraries [String] 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
 
@@ -189,6 +212,7 @@ def build_for_test_with_configuration(test_file, aux_libraries, gcc_binary, ci_g
       args = [
         ["-std=c++0x", "-o", executable, "-DARDUINO=100"],
         test_args(aux_libraries, ci_gcc_config),
+        cpp_files_libraries(aux_libraries),
         [test_file],
       ].flatten(1)
       return nil unless run_gcc(gcc_binary, *args)

spec/arduino_cmd_spec.rb

@@ -49,7 +49,7 @@ def get_sketch(dir, file)
   context "libraries" do
     it "knows where to find libraries" do
       fake_lib = "_____nope"
-      expected_dir = File.join(arduino_cmd._lib_dir, fake_lib)
+      expected_dir = File.join(arduino_cmd.lib_dir, fake_lib)
       expect(arduino_cmd.library_path(fake_lib)).to eq(expected_dir)
       expect(arduino_cmd.library_present?(fake_lib)).to be false
     end

spec/arduino_installation_spec.rb

@@ -11,7 +11,7 @@
     arduino_cmd = ArduinoCI::ArduinoInstallation.autolocate!
     it "doesn't fail" do
       expect(arduino_cmd.base_cmd).not_to be nil
-      expect(arduino_cmd._lib_dir).not_to be nil
+      expect(arduino_cmd.lib_dir).not_to be nil
     end
   end
 

spec/ci_config_spec.rb

@@ -110,7 +110,7 @@
 
   context "allowable_unittest_files" do
     cpp_lib_path = File.join(File.dirname(__FILE__), "fake_library")
-    cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path)
+    cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path, "my_fake_arduino_lib_dir")
 
     it "starts with a known set of files" do
       expect(cpp_library.test_files.map { |f| File.basename(f) }).to match_array([

spec/cpp_library_spec.rb

@@ -4,7 +4,7 @@
 
 RSpec.describe ArduinoCI::CppLibrary do
   cpp_lib_path = File.join(sampleproj_path, "DoSomething")
-  cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path)
+  cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path, "my_fake_arduino_lib_dir")
   context "cpp_files" do
     it "finds cpp files in directory" do
       dosomething_cpp_files = ["DoSomething/do-something.cpp"]

spec/testsomething_unittests_spec.rb

@@ -4,7 +4,7 @@
 
 RSpec.describe "TestSomething C++" do
   cpp_lib_path = File.join(sampleproj_path, "TestSomething")
-  cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path)
+  cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path, "my_fake_arduino_lib_dir")
   context "cpp_files" do
     it "finds cpp files in directory" do
       testsomething_cpp_files = ["TestSomething/test-something.cpp"]