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

REFERENCE.md

@@ -29,6 +29,11 @@ This completely skips the compilation tests (of library examples) portion of the
 This completely skips the compilation tests (of library examples) portion of the CI script.  It does not skip the compilation of unit tests.
 
 
+### `--skip-library-properties` option
+
+This completely skips validation of entries in `library.properties`.
+
+
 ### `--testfile-select` option
 
 This allows a file (or glob) pattern to be executed in your tests directory, creating a whitelist of files to test.  E.g. `--testfile-select=test_animal_*.cpp` would match `test_animal_cat.cpp` and `test_animal_dog.cpp` (testing only those) and not `test_plant_rose.cpp`.
@@ -59,6 +64,11 @@ If set, testing will fail if no unit test files are detected (or if the director
 If set, testing will fail if no example sketches are detected.  This is to avoid communicating a passing status in cases where a commit may have accidentally moved or deleted the examples.
 
 
+### `SKIP_LIBRARY_PROPERTIES` environment variable
+
+If set, testing will skip validating `library.properties` entries.  This is to work around any possible bugs in `arduino_ci`'s interpretation of what is "correct".
+
+
 ## Indirectly Overriding Build Behavior (medium term use), and Advanced Options
 
 For build behavior that you'd like to persist across commits (e.g. defining the set of platforms to test against, disabling a test that you expect to re-enable at some future point), a special configuration file called `.arduino-ci.yml` can be used.  There are 3 places you can put them:

exe/arduino_ci.rb

@@ -9,6 +9,7 @@
 VAR_USE_SUBDIR         = "USE_SUBDIR".freeze
 VAR_EXPECT_EXAMPLES    = "EXPECT_EXAMPLES".freeze
 VAR_EXPECT_UNITTESTS   = "EXPECT_UNITTESTS".freeze
+VAR_SKIP_LIBPROPS      = "SKIP_LIBRARY_PROPERTIES".freeze
 
 @failure_count = 0
 @passfail = proc { |result| result ? "✓" : "✗" }
@@ -21,6 +22,7 @@ def self.parse(options)
     output_options = {
       skip_unittests: false,
       skip_compilation: false,
+      skip_library_properties: false,
       ci_config: {
         "unittest" => unit_config
       },
@@ -37,6 +39,10 @@ def self.parse(options)
         output_options[:skip_compilation] = p
       end
 
+      opts.on("--skip-library-properties", "Don't validate library.properties entries") do |p|
+        output_options[:skip_compilation] = p
+      end
+
       opts.on("--testfile-select=GLOB", "Unit test file (or glob) to select") do |p|
         unit_config["testfiles"] ||= {}
         unit_config["testfiles"]["select"] ||= []
@@ -58,6 +64,7 @@ def self.parse(options)
         puts " - #{VAR_USE_SUBDIR} - if set, the script will install the library from this subdirectory of the cwd"
         puts " - #{VAR_EXPECT_EXAMPLES} - if set, testing will fail if no example sketches are present"
         puts " - #{VAR_EXPECT_UNITTESTS} - if set, testing will fail if no unit tests are present"
+        puts " - #{VAR_SKIP_LIBPROPS} - if set, testing will skip [experimental] library.properties validation"
         exit
       end
     end
@@ -146,6 +153,10 @@ def inform_multiline(message, &block)
   perform_action(message, true, nil, nil, false, false, &block)
 end
 
+def warn(message)
+  inform("WARNING") { message }
+end
+
 # Assure that a platform exists and return its definition
 def assured_platform(purpose, name, config)
   platform_definition = config.platform_definition(name)
@@ -354,6 +365,32 @@ def choose_platform_set(config, reason, desired_platforms, library_properties)
   end
 end
 
+# tests of sane library.properties values
+def perform_property_tests(cpp_library)
+  return inform("Skipping library.properties tests") { "as requested via command line" } if @cli_options[:skip_library_properties]
+  return inform("Skipping library.properties tests") { "as requested via #{VAR_SKIP_LIBPROPS}" } unless ENV[VAR_SKIP_LIBPROPS].nil?
+  return inform("Skipping library.properties tests") { "file not found" } unless cpp_library.library_properties?
+
+  props = cpp_library.library_properties
+
+  props.depends&.each do |l|
+    assure("library.properties 'depends=' entry '#{l}' is available via the library manager") { @backend.library_available?(l) }
+  end
+
+  # the IDE would add these entries to a sketch (as "#include <...>" lines), they are nothing to do with the compioler
+  props.includes&.map(&:strip)&.map(&Pathname::method(:new))&.each do |f|
+    if (cpp_library.path + f).exist?
+      inform("library.properties 'includes=' entry found") { f }
+    elsif (cpp_library.path + "src" + f).exist?
+      inform("library.properties 'includes=' entry found") { Pathname.new("src") + f }
+    else
+      # this is if they want to "#include <math>" or something -- may or may not be valid!  so just warn.
+      warn("library.properties 'includes=' entry '#{f}' does not refer to a file in the library")
+    end
+  end
+
+end
+
 # Unit test procedure
 def perform_unit_tests(cpp_library, file_config)
   if @cli_options[:skip_unittests]
@@ -475,7 +512,7 @@ def perform_example_compilation_tests(cpp_library, config)
 assumed_name = @backend.name_of_library(cpp_library_path)
 ondisk_name = cpp_library_path.realpath.basename.to_s
 if assumed_name != ondisk_name
-  inform("WARNING") { "Installed library named '#{assumed_name}' has directory name '#{ondisk_name}'" }
+  warn("Installed library named '#{assumed_name}' has directory name '#{ondisk_name}'")
 end
 
 if !cpp_library.nil?
@@ -488,6 +525,8 @@ def perform_example_compilation_tests(cpp_library, config)
   end
 end
 
+perform_property_tests(cpp_library)
+
 install_arduino_library_dependencies(
   cpp_library.arduino_library_dependencies,
   "<#{ArduinoCI::CppLibrary::LIBRARY_PROPERTIES_FILE}>"