try to test an actual library

Author: ianfixes

exe/ci_system_check.rb

@@ -49,5 +49,16 @@
 puts "verify a simple sketch"
 got_problem = true unless arduino_cmd.verify_sketch(simple_sketch)
 
+puts "verify the examples of a library..."
+puts " - Install the library"
+library_path = File.join(File.dirname(__FILE__), "SampleProjects", "DoSomething")
+installed_library_path = arduino_cmd.install_local_library(library_path)
+got_problem = true if installed_library_path.nil?
+puts " - Iterate over the examples"
+arduino_cmd.each_library_example(installed_library_path) do |example_path|
+  puts "Iterating #{example_path}"
+  got_problem_ true unless arduino_cmd.verify_sketch(example_path)
+end
+
 abort if got_problem
 exit(0)

lib/arduino_ci/arduino_cmd.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 require 'arduino_ci/display_manager'
 require 'arduino_ci/arduino_installation'
 
@@ -159,6 +160,12 @@ def install_library(library_name)
       result[:success]
     end
 
+    # generate the (very likely) path of a library given its name
+    def library_path(library_name)
+      sketchbook = get_pref("sketchbook.path")
+      File.join(sketchbook, library_name)
+    end
+
     # update the library index
     def update_library_index
       # install random lib so the arduino IDE grabs a new library index
@@ -193,5 +200,43 @@ def verify_sketch(path)
       run("--verify", path, err: :out)
     end
 
+    # ensure that the given library is installed, or symlinked as appropriate
+    # return the path of the prepared library, or nil
+    def install_local_library(library_path)
+      sketchbook = get_pref("sketchbook.path")
+      library_name = File.basename(library_path)
+      destination_path = File.join(sketchbook, library_name)
+
+      # things get weird if the sketchbook contains the library.
+      # check that first
+      if File.exist? destination_path
+        uhoh = "There is already a library '#{library_name}' in the sketchbook"
+        return destination_path if destination_path == library_path
+
+        # maybe it's a symlink? that would be OK
+        if File.symlink?(destination_path)
+          return destination_path if File.readlink(destination_path) == library_path
+          puts "#{uhoh} and it's not symlinked to #{library_path}"
+          return nil
+        end
+
+        puts "#{uhoh}.  It may need to be removed manually."
+        return nil
+      end
+
+      # install the library
+      FileUtils.ln_s(library_path, destination_path)
+      destination_path
+    end
+
+    def each_library_example(installed_library_path)
+      example_path = File.join(installed_library_path, "examples")
+      examples = Pathname.new(example_path).children.select(&:directory?).map(&:to_path).reject { |n| n[0] == '.' }
+      examples.each do |e|
+        proj_file = File.join(example_path, e, "#{e}.ino")
+        puts "Considering #{proj_file}"
+        yield e if File.exist?(proj_file)
+      end
+    end
   end
 end