Abandon library.properties scanning in favor of arduino-lint tool

Author: ianfixes

CHANGELOG.md

@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Deprecated
 
 ### Removed
+- scanning of `library.properties`; this can and should now be performed by the standalone [`arduino-lint` tool](https://arduino.github.io/arduino-lint).
 
 ### Fixed
 - Example sketches with no configured platforms were printing the wrong configuration values to the debug message

REFERENCE.md

@@ -64,11 +64,6 @@ 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,7 +9,6 @@
 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 ? "✓" : "✗" }
@@ -22,7 +21,6 @@ def self.parse(options)
     output_options = {
       skip_unittests: false,
       skip_compilation: false,
-      skip_library_properties: false,
       ci_config: {
         "unittest" => unit_config
       },
@@ -39,10 +37,6 @@ 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"] ||= []
@@ -388,33 +382,6 @@ def choose_platform_set(config, reason, desired_platforms, library_properties)
   end
 end
 
-# tests of sane library.properties values
-def perform_property_tests(cpp_library)
-  phase("library.properties validation")
-  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 environment" } 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)
   phase("Unit testing")
@@ -560,8 +527,6 @@ 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}>"