Fix bugs and other issues in contributed code

Author: ianfixes

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 ### Added
+- Unit testing configuration now allows `exclude_dirs` to be set, which prevents stray source files from as part of unit testing allows
 
 ### Changed
 

SampleProjects/TestSomething/excludeThis/exclude-this.cpp

@@ -1,10 +1,6 @@
-#include "test-something.h"
-int testSomething(void) {
-  millis();  // this line is only here to test that we're able to refer to the builtins
-  return 4;
-};
+This file intentionally contains syntactically incorrect code
+to break unit test compilation.  If arduino_ci is working
+properly, it should exclude this file (as per .arduino-ci.yml
+configuration) and unit test compilation should succeed.
 
-int* aNullPointer(void) {
-  int* ret = nullptr;
-  return ret;
-}
+~!@#$%^&*()

SampleProjects/TestSomething/excludeThis/exclude-this.h

@@ -1,4 +1,6 @@
-#pragma once
-#include <Arduino.h>
-int testSomething(void);
-int *aNullPointer(void);
+This file intentionally contains syntactically incorrect code
+to break unit test compilation.  If arduino_ci is working
+properly, it should exclude this file (as per .arduino-ci.yml
+configuration) and unit test compilation should succeed.
+
+~!@#$%^&*()

exe/arduino_ci_remote.rb

@@ -183,7 +183,9 @@ def perform_unit_tests(file_config)
     return
   end
   config = file_config.with_override_config(@cli_options[:ci_config])
-  cpp_library = ArduinoCI::CppLibrary.new(Pathname.new("."), @arduino_cmd.lib_dir, config.exclude_dirs)
+  cpp_library = ArduinoCI::CppLibrary.new(Pathname.new("."),
+                                          @arduino_cmd.lib_dir,
+                                          config.exclude_dirs.map(&Pathname.method(:new)))
 
   # check GCC
   compilers = config.compilers_to_use

lib/arduino_ci/cpp_library.rb

@@ -37,11 +37,12 @@ class CppLibrary
 
     # @param base_dir [Pathname] The path to the library being tested
     # @param arduino_lib_dir [Pathname] The path to the libraries directory
-    def initialize(base_dir, arduino_lib_dir, exclude_dirs = [])
+    # @param exclude_dirs [Array<Pathname>] Directories that should be excluded from compilation
+    def initialize(base_dir, arduino_lib_dir, exclude_dirs)
       raise ArgumentError, 'base_dir is not a Pathname' unless base_dir.is_a? Pathname
       raise ArgumentError, 'arduino_lib_dir is not a Pathname' unless arduino_lib_dir.is_a? Pathname
-      raise ArgumentError, 'exclude_dir is not an array of Pathnames' unless exclude_dirs.is_a?(Array) &&
-                                                                             exclude_dirs.each { |p| p.is_a? Pathname }
+      raise ArgumentError, 'exclude_dir is not an array of Pathnames' unless exclude_dirs.is_a?(Array)
+      raise ArgumentError, 'exclude_dir array contains non-Pathname elements' unless exclude_dirs.all? { |p| p.is_a? Pathname }
 
       @base_dir = base_dir
       @exclude_dirs = exclude_dirs

spec/ci_config_spec.rb

@@ -157,7 +157,7 @@
 
   context "allowable_unittest_files" do
     cpp_lib_path = Pathname.new(__dir__) + "fake_library"
-    cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path, Pathname.new("my_fake_arduino_lib_dir"))
+    cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path, Pathname.new("my_fake_arduino_lib_dir"), [])
 
     it "starts with a known set of files" do
       expect(cpp_library.test_files.map { |f| File.basename(f) }).to match_array([
@@ -177,4 +177,3 @@
   end
 
 end
-

spec/cpp_library_spec.rb

@@ -13,7 +13,7 @@ def get_relative_dir(sampleprojects_tests_dir)
 RSpec.describe ArduinoCI::CppLibrary do
   next if skip_ruby_tests
   cpp_lib_path = sampleproj_path + "DoSomething"
-  cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path, Pathname.new("my_fake_arduino_lib_dir"))
+  cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path, Pathname.new("my_fake_arduino_lib_dir"), [])
   context "cpp_files" do
     it "finds cpp files in directory" do
       dosomething_cpp_files = [Pathname.new("DoSomething") + "do-something.cpp"]

spec/testsomething_unittests_spec.rb

@@ -10,12 +10,44 @@ def get_relative_dir(sampleprojects_tests_dir)
   sampleprojects_tests_dir.relative_path_from(base_dir)
 end
 
+RSpec.describe "TestSomething C++ without excludes" do
+  next if skip_cpp_tests
+  cpp_lib_path = sampleproj_path + "TestSomething"
+  cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path,
+                                          Pathname.new("my_fake_arduino_lib_dir"),
+                                          [])
+  context "cpp_files" do
+    it "finds cpp files in directory" do
+      testsomething_cpp_files = [
+        Pathname.new("TestSomething/test-something.cpp"),
+        Pathname.new("TestSomething/excludeThis/exclude-this.cpp")
+      ]
+      relative_paths = cpp_library.cpp_files.map { |f| get_relative_dir(f) }
+      expect(relative_paths).to match_array(testsomething_cpp_files)
+    end
+  end
+
+  context "unit tests" do
+    it "can't build due to files that should have been excluded" do
+      config = ArduinoCI::CIConfig.default.from_example(cpp_lib_path)
+      path = config.allowable_unittest_files(cpp_library.test_files).first
+      compiler = config.compilers_to_use.first
+      result = cpp_library.build_for_test_with_configuration(path,
+                                                             [],
+                                                             compiler,
+                                                             config.gcc_config("uno"))
+      expect(result).to be nil
+    end
+  end
+
+end
+
 RSpec.describe "TestSomething C++" do
   next if skip_cpp_tests
   cpp_lib_path = sampleproj_path + "TestSomething"
   cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path,
                                           Pathname.new("my_fake_arduino_lib_dir"),
-                                          ["excludeThis"])
+                                          ["excludeThis"].map(&Pathname.method(:new)))
   context "cpp_files" do
     it "finds cpp files in directory" do
       testsomething_cpp_files = [Pathname.new("TestSomething/test-something.cpp")]