Fix unit tests for source directory exclusion

ianfixes · ianfixes · commit 7ae62ae0894a · 2020-10-26T23:01:43.000-04:00
diff --git a/SampleProjects/ExcludeSomething/.arduino-ci.yml b/SampleProjects/ExcludeSomething/.arduino-ci.yml
@@ -0,0 +1,3 @@
+unittest:
+  exclude_dirs:
+    - src/excludeThis
diff --git a/SampleProjects/ExcludeSomething/README.md b/SampleProjects/ExcludeSomething/README.md
@@ -0,0 +1,3 @@
+# ExcludeSomething
+
+This example exists to test directory-exclusion code of ArduinoCI
diff --git a/SampleProjects/ExcludeSomething/library.properties b/SampleProjects/ExcludeSomething/library.properties
@@ -0,0 +1,10 @@
+name=TestSomething
+version=0.1.0
+author=Ian Katz <ianfixes@gmail.com>
+maintainer=Ian Katz <ianfixes@gmail.com>
+sentence=Arduino CI unit test example
+paragraph=A skeleton library demonstrating file exclusion
+category=Other
+url=https://github.com/Arduino-CI/arduino_ci/SampleProjects/ExcludeSomething
+architectures=avr,esp8266
+includes=do-something.h
diff --git a/SampleProjects/ExcludeSomething/src/exclude-something.cpp b/SampleProjects/ExcludeSomething/src/exclude-something.cpp
@@ -0,0 +1,4 @@
+#include "exclude-something.h"
+int excludeSomething(void) {
+  return -1;
+};
diff --git a/SampleProjects/ExcludeSomething/src/exclude-something.h b/SampleProjects/ExcludeSomething/src/exclude-something.h
@@ -0,0 +1,3 @@
+#pragma once
+#include <Arduino.h>
+int excludeSomething(void);
diff --git a/SampleProjects/ExcludeSomething/src/excludeThis/exclude-this.cpp b/SampleProjects/ExcludeSomething/src/excludeThis/exclude-this.cpp
@@ -0,0 +1,6 @@
+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.
+
+~!@#$%^&*()
diff --git a/SampleProjects/ExcludeSomething/src/excludeThis/exclude-this.h b/SampleProjects/ExcludeSomething/src/excludeThis/exclude-this.h
@@ -0,0 +1,6 @@
+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.
+
+~!@#$%^&*()
diff --git a/SampleProjects/ExcludeSomething/test/null.cpp b/SampleProjects/ExcludeSomething/test/null.cpp
@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()
diff --git a/SampleProjects/README.md b/SampleProjects/README.md
@@ -12,3 +12,4 @@ Because of this, these projects include some intentional quirks that differ from
 * "OnePointFiveMalformed" is a non-functional library meant to test file inclusion logic on libraries that attempt to conform to the ["1.5" specfication](https://arduino.github.io/arduino-cli/latest/library-specification/) but fail to include a `src` directory
 * "OnePointFiveDummy" is a non-functional library meant to test file inclusion logic on libraries conforming to the ["1.5" specfication](https://arduino.github.io/arduino-cli/latest/library-specification/)
 * "DependOnSomething" is a non-functional library meant to test file inclusion logic with dependencies
+* "ExcludeSomething" is a non-functional library meant to test directory exclusion logic
diff --git a/SampleProjects/TestSomething/.arduino-ci.yml b/SampleProjects/TestSomething/.arduino-ci.yml
@@ -1,6 +1,4 @@
 unittest:
-  exclude_dirs:
-    - src/excludeThis
   platforms:
     - uno
     - due
diff --git a/spec/cpp_library_spec.rb b/spec/cpp_library_spec.rb
@@ -10,6 +10,58 @@ def get_relative_dir(sampleprojects_tests_dir)
   sampleprojects_tests_dir.relative_path_from(base_dir)
 end
 
+
+RSpec.describe "ExcludeSomething C++" do
+  next if skip_cpp_tests
+
+  cpp_lib_path = sampleproj_path + "ExcludeSomething"
+  context "without excludes" do
+    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
+        excludesomething_cpp_files = [
+          Pathname.new("ExcludeSomething/src/exclude-something.cpp"),
+          Pathname.new("ExcludeSomething/src/excludeThis/exclude-this.cpp")
+        ]
+        relative_paths = cpp_library.cpp_files.map { |f| get_relative_dir(f) }
+        expect(relative_paths).to match_array(excludesomething_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
+
+  context "with excludes" do
+    cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path,
+                                            Pathname.new("my_fake_arduino_lib_dir"),
+                                            ["src/excludeThis"].map(&Pathname.method(:new)))
+    context "cpp_files" do
+      it "finds cpp files in directory" do
+        excludesomething_cpp_files = [
+          Pathname.new("ExcludeSomething/src/exclude-something.cpp")
+        ]
+        relative_paths = cpp_library.cpp_files.map { |f| get_relative_dir(f) }
+        expect(relative_paths).to match_array(excludesomething_cpp_files)
+      end
+    end
+
+  end
+
+end
+
 RSpec.describe ArduinoCI::CppLibrary do
   next if skip_ruby_tests
 
diff --git a/spec/testsomething_unittests_spec.rb b/spec/testsomething_unittests_spec.rb
@@ -10,37 +10,6 @@ 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/src/test-something.cpp"),
-        Pathname.new("TestSomething/src/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

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+unittest:`
	`2`	`+ exclude_dirs:`
	`3`	`+ - src/excludeThis`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# ExcludeSomething`
	`2`	`+`
	`3`	`+This example exists to test directory-exclusion code of ArduinoCI`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+#pragma once`
	`2`	`+#include <Arduino.h>`
	`3`	`+int excludeSomething(void);`