Scan library.properties as part of CI - depends and includes

Author: ianfixes

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - `CIConfig.is_default` to detect when the default configuration is used
 - `ArduinoBackend.boards_installed?` to detect whether a board family (or package, like `arduino:avr`) is installed
 - `ArduinoBackend.library_available?` to detect whether the library manager knows of a library
+- Sanity checks for `library.properties` `includes=` and `depends=` entries
 
 ### Changed
 - Rubocop expected syntax downgraded from ruby 2.6 to 2.5

exe/arduino_ci.rb

@@ -354,6 +354,23 @@ def choose_platform_set(config, reason, desired_platforms, library_properties)
   end
 end
 
+# tests of sane library.properties values
+def perform_property_tests(cpp_library)
+  props = cpp_library.library_properties
+
+  props.depends&.each do |l|
+    assure("library.properties 'depends=' entry '#{l}' exists") { @backend.library_available?(l) }
+  end
+
+  headers = cpp_library.header_files.map { |f| f.relative_path_from(cpp_library.path) }
+  props.includes&.map(&Pathname::method(:new))&.each do |f|
+    assure("library.properties 'includes=' entry '#{f}' exists") do
+      headers.include?(f) || headers.map { |h| h.relative_path_from("src") }.include?(f)
+    end
+  end
+
+end
+
 # Unit test procedure
 def perform_unit_tests(cpp_library, file_config)
   if @cli_options[:skip_unittests]
@@ -488,6 +505,8 @@ def perform_example_compilation_tests(cpp_library, config)
   end
 end
 
+perform_property_tests(cpp_library) if cpp_library.library_properties?
+
 install_arduino_library_dependencies(
   cpp_library.arduino_library_dependencies,
   "<#{ArduinoCI::CppLibrary::LIBRARY_PROPERTIES_FILE}>"