Add recursive library dependency compilation

Author: ianfixes

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - `arduino_ci_remote.rb` CLI switch `--skip-examples-compilation`
 - `CppLibrary.header_files` to find header files
 - `LibraryProperties` to read metadata from Arduino libraries
+- `CppLibrary.library_properties_path`, `CppLibrary.library_properties?`, `CppLibrary.library_properties` to expose library properties of a Cpp library
+- `CppLibrary.arduino_library_dependencies` to list the dependent libraries specified by the library.properties file
 
 ### Changed
 - Move repository from https://github.com/ianfixes/arduino_ci to https://github.com/Arduino-CI/arduino_ci

SampleProjects/DependOnSomething/library.properties

@@ -0,0 +1 @@
+depends=OnePointOhDummy,OnePointFiveDummy

SampleProjects/DependOnSomething/src/YesDeps.cpp

@@ -11,3 +11,4 @@ Because of this, these projects include some intentional quirks that differ from
 * "OnePointOhDummy" is a non-functional library meant to test file inclusion logic on libraries conforming to the "1.0" specification
 * "OnePointFiveMalformed" is a non-functional library meant to test file inclusion logic on libraries that attempt to conform to the ["1.5" specfication](https://arduino.github.io/arduino-cli/latest/library-specification/) but fail to include a `src` directory
 * "OnePointFiveDummy" is a non-functional library meant to test file inclusion logic on libraries conforming to the ["1.5" specfication](https://arduino.github.io/arduino-cli/latest/library-specification/)
+* "DependOnSomething" is a non-functional library meant to test file inclusion logic with dependencies

SampleProjects/DependOnSomething/src/YesDeps.h

@@ -55,16 +55,30 @@ def initialize(base_dir, arduino_lib_dir, exclude_dirs)
       @vendor_bundle_cache = nil
     end
 
+    # The expected path to the library.properties file (i.e. even if it does not exist)
+    # @return [Pathname]
+    def library_properties_path
+      @base_dir + "library.properties"
+    end
+
+    # Whether library.properties definitions for this library exist
+    # @return [bool]
+    def library_properties?
+      lib_props = library_properties_path
+      lib_props.exist? && lib_props.file?
+    end
+
     # Decide whether this is a 1.5-compatible library
     #
     # according to https://arduino.github.io/arduino-cli/latest/library-specification
     #
     # Should match logic from https://github.com/arduino/arduino-cli/blob/master/arduino/libraries/loader.go
     # @return [bool]
     def one_point_five?
-      lib_props = (@base_dir + "library.properties")
+      return false unless library_properties?
+
       src_dir = (@base_dir + "src")
-      [lib_props, src_dir].all?(&:exist?) && lib_props.file? && src_dir.directory?
+      src_dir.exist? && src_dir.directory?
     end
 
     # Guess whether a file is part of the vendor bundle (indicating we should ignore it).
@@ -164,6 +178,21 @@ def libasan?(gcc_binary)
       @has_libasan_cache[gcc_binary]
     end
 
+    # Library properties
+    def library_properties
+      return nil unless library_properties?
+
+      LibraryProperties.new(library_properties_path)
+    end
+
+    # Get a list of all dependencies as defined in library.properties
+    # @return [Array<String>] The library names of the dependencies (not the paths)
+    def arduino_library_dependencies
+      return nil unless library_properties?
+
+      library_properties.depends
+    end
+
     # Get a list of all CPP source files in a directory and its subdirectories
     # @param some_dir [Pathname] The directory in which to begin the search
     # @param extensions [Array<Sring>] The set of allowable file extensions
@@ -282,16 +311,19 @@ def gcc_version(gcc_binary)
       @last_err
     end
 
-    # Arduino library directories containing sources
+    # Arduino library directories containing sources -- only those of the dependencies
     # @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
 
-      aux_libraries.map { |d| self.new(d, @arduino_lib_dir, @exclude_dirs).header_dirs }.flatten
+      aux_libraries.map { |d| self.class.new(@arduino_lib_dir + d, @arduino_lib_dir, @exclude_dirs).header_dirs }.flatten.uniq
     end
 
     # GCC command line arguments for including aux libraries
+    #
+    # This function recursively collects the library directores of the dependencies
+    #
     # @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)
@@ -354,6 +386,9 @@ def test_args(aux_libraries, ci_gcc_config)
     end
 
     # build a file for running a test of the given unit test file
+    #
+    # The dependent libraries configuration is appended with data from library.properties internal to the library under test
+    #
     # @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
@@ -372,8 +407,12 @@ def build_for_test_with_configuration(test_file, aux_libraries, gcc_binary, ci_g
           "-fsanitize=address"
         ]
       end
-      arg_sets << test_args(aux_libraries, ci_gcc_config)
-      arg_sets << cpp_files_libraries(aux_libraries).map(&:to_s)
+
+      # combine library.properties defs (if existing) with config file.
+      # TODO: as much as I'd like to rely only on the properties file(s), I think that would prevent testing 1.0-spec libs
+      full_aux_libraries = arduino_library_dependencies.nil? ? aux_libraries : aux_libaries + arduino_library_dependencies
+      arg_sets << test_args(full_aux_libraries, ci_gcc_config)
+      arg_sets << cpp_files_libraries(full_aux_libraries).map(&:to_s)
       arg_sets << [test_file.to_s]
       args = arg_sets.flatten(1)
       return nil unless run_gcc(gcc_binary, *args)

SampleProjects/README.md

@@ -14,58 +14,79 @@ def get_relative_dir(sampleprojects_tests_dir)
   next if skip_ruby_tests
 
   answers = {
-    "DoSomething": {
+    DoSomething: {
       one_five: false,
       cpp_files: [Pathname.new("DoSomething") + "do-something.cpp"],
+      cpp_files_libraries: [],
       header_dirs: [Pathname.new("DoSomething")],
+      arduino_library_src_dirs: [],
       test_files: [
         "DoSomething/test/good-null.cpp",
         "DoSomething/test/good-library.cpp",
         "DoSomething/test/bad-null.cpp",
       ].map { |f| Pathname.new(f) }
     },
-    "OnePointOhDummy": {
+    OnePointOhDummy: {
       one_five: false,
       cpp_files: [
         "OnePointOhDummy/YesBase.cpp",
         "OnePointOhDummy/utility/YesUtil.cpp",
       ].map { |f| Pathname.new(f) },
+      cpp_files_libraries: [],
       header_dirs: [
         "OnePointOhDummy",
         "OnePointOhDummy/utility"
       ].map { |f| Pathname.new(f) },
+      arduino_library_src_dirs: [],
       test_files: []
     },
-    "OnePointFiveMalformed": {
+    OnePointFiveMalformed: {
       one_five: false,
       cpp_files: [
         "OnePointFiveMalformed/YesBase.cpp",
         "OnePointFiveMalformed/utility/YesUtil.cpp",
       ].map { |f| Pathname.new(f) },
+      cpp_files_libraries: [],
       header_dirs: [
         "OnePointFiveMalformed",
         "OnePointFiveMalformed/utility"
       ].map { |f| Pathname.new(f) },
+      arduino_library_src_dirs: [],
       test_files: []
     },
-    "OnePointFiveDummy": {
+    OnePointFiveDummy: {
       one_five: true,
       cpp_files: [
         "OnePointFiveDummy/src/YesSrc.cpp",
         "OnePointFiveDummy/src/subdir/YesSubdir.cpp",
       ].map { |f| Pathname.new(f) },
+      cpp_files_libraries: [],
       header_dirs: [
         "OnePointFiveDummy/src",
         "OnePointFiveDummy/src/subdir",
       ].map { |f| Pathname.new(f) },
+      arduino_library_src_dirs: [],
       test_files: []
     }
-  }.freeze
+  }
+
+  # easier to construct this one from the other test cases
+  answers[:DependOnSomething] = {
+    one_five: true,
+    cpp_files: ["DependOnSomething/src/YesDeps.cpp"].map { |f| Pathname.new(f) },
+    cpp_files_libraries: answers[:OnePointOhDummy][:cpp_files] + answers[:OnePointFiveDummy][:cpp_files],
+    header_dirs: ["DependOnSomething/src"].map { |f| Pathname.new(f) }, # this is not recursive!
+    arduino_library_src_dirs: answers[:OnePointOhDummy][:header_dirs] + answers[:OnePointFiveDummy][:header_dirs],
+    test_files: []
+  }
+
+  answers.freeze
 
   answers.each do |sampleproject, expected|
     context "#{sampleproject}" do
       cpp_lib_path = sampleproj_path + sampleproject.to_s
-      cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path, Pathname.new("my_fake_arduino_lib_dir"), [])
+      cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path, sampleproj_path, [])
+      dependencies = cpp_library.arduino_library_dependencies.nil? ? [] : cpp_library.arduino_library_dependencies
 
       it "detects 1.5 format" do
         expect(cpp_library.one_point_five?).to eq(expected[:one_five])
@@ -78,6 +99,13 @@ def get_relative_dir(sampleprojects_tests_dir)
         end
       end
 
+      context "cpp_files_libraries" do
+        it "finds cpp files in directories of dependencies" do
+          relative_paths = cpp_library.cpp_files_libraries(dependencies).map { |f| get_relative_dir(f) }
+          expect(relative_paths.map(&:to_s)).to match_array(expected[:cpp_files_libraries].map(&:to_s))
+        end
+      end
+
       context "header_dirs" do
         it "finds directories containing h files" do
           relative_paths = cpp_library.header_dirs.map { |f| get_relative_dir(f) }
@@ -101,6 +129,14 @@ def get_relative_dir(sampleprojects_tests_dir)
           expect(relative_paths.map(&:to_s)).to match_array(expected[:test_files].map(&:to_s))
         end
       end
+
+      context "arduino_library_src_dirs" do
+        it "finds src dirs from dependent libraries" do
+          # we explicitly feed in the internal dependencies
+          relative_paths = cpp_library.arduino_library_src_dirs(dependencies).map { |f| get_relative_dir(f) }
+          expect(relative_paths.map(&:to_s)).to match_array(expected[:arduino_library_src_dirs].map(&:to_s))
+        end
+      end
     end
   end