separate example project for CI from example project for rspec

Author: ianfixes

SampleProjects/TestSomething/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gem 'arduino_ci', path: '../../'

SampleProjects/TestSomething/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: /Users/ikatz/Development/non-wayfair/arduino_ci
+  specs:
+    arduino_ci (0.0.1)
+      os (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    os (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  arduino_ci!
+
+BUNDLED WITH
+   1.16.0

SampleProjects/TestSomething/README.md

@@ -0,0 +1,3 @@
+# TestSomething
+
+This is a "beater" example that is referenced by tests of the Arduino CI module itself.

SampleProjects/TestSomething/examples/TestSomethingExample/TestSomethingExample.ino

@@ -0,0 +1,9 @@
+#include <test-something.h>
+// if it seems bare, that's because it's only meant to
+// demonstrate compilation -- that references work
+void setup() {
+}
+
+void loop() {
+  testSomething();
+}

SampleProjects/TestSomething/library.properties

@@ -0,0 +1,10 @@
+name=arduino-ci-unit-tests
+version=0.1.0
+author=Ian Katz <[email protected]>
+maintainer=Ian Katz <[email protected]>
+sentence=Arduino CI unit test example
+paragraph=A skeleton library demonstrating CI and unit tests
+category=Other
+url=https://github.com/ifreecarve/arduino_ci/SampleProjects/DoSomething
+architectures=avr,esp8266
+includes=do-something.h

SampleProjects/TestSomething/test-something.cpp

@@ -0,0 +1,5 @@
+#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;
+};

SampleProjects/TestSomething/test-something.h

@@ -0,0 +1,3 @@
+#pragma once
+#include <Arduino.h>
+int testSomething(void);

SampleProjects/DoSomething/test/bad-null.cpp renamed to SampleProjects/TestSomething/test/bad-null.cpp

@@ -0,0 +1,11 @@
+#include <ArduinoUnitTests.h>
+#include "../test-something.h"
+
+unittest(library_tests_something)
+{
+  assertEqual(4, testSomething());
+}
+
+int main(int argc, char *argv[]) {
+  return Test::run_and_report(argc, argv);
+}

SampleProjects/TestSomething/test/good-library.cpp

@@ -0,0 +1,24 @@
+#include <ArduinoUnitTests.h>
+
+unittest(equality_as_vars)
+{
+  int x = 3;
+  int y = 3;
+  int z = 3;
+  assertEqual(x, y);
+  assertEqual(x, z);
+}
+
+unittest(equality_as_values)
+{
+  assertEqual(1, 1);
+  assertEqual(4, 4);
+}
+
+unittest(nothing)
+{
+}
+
+int main(int argc, char *argv[]) {
+  return Test::run_and_report(argc, argv);
+}

SampleProjects/TestSomething/test/good-null.cpp

@@ -123,13 +123,7 @@ def test_args(aux_libraries, ci_gcc_config)
       ret
     end
 
-    # run a test of the given unit test file
-    def test_with_configuration(test_file, aux_libraries, ci_gcc_config)
-      executable = build_for_test_with_configuration(test_file, aux_libraries, ci_gcc_config)
-      run_test_file(executable)
-    end
-
-    # run a test of the given unit test file
+    # build a file for running a test of the given unit test file
     def build_for_test_with_configuration(test_file, aux_libraries, ci_gcc_config)
       base = File.basename(test_file)
       executable = File.expand_path("unittest_#{base}.bin")
@@ -140,15 +134,11 @@ def build_for_test_with_configuration(test_file, aux_libraries, ci_gcc_config)
       executable
     end
 
+    # run a test file
     def run_test_file(executable)
       Host.run(executable)
     end
 
-    # legacy shortcut for rspec
-    def test(test_file)
-      test_with_configuration(test_file, [], nil)
-    end
-
   end
 
 end

lib/arduino_ci/cpp_library.rb

@@ -3,51 +3,67 @@
 sampleproj_path = File.join(File.dirname(File.dirname(__FILE__)), "SampleProjects")
 
 RSpec.describe ArduinoCI::CppLibrary do
-  cpp_lib_path = File.join(sampleproj_path, "DoSomething")
+  cpp_lib_path = File.join(sampleproj_path, "TestSomething")
   cpp_library = ArduinoCI::CppLibrary.new(cpp_lib_path)
   context "cpp_files" do
     it "finds cpp files in directory" do
-      dosomething_cpp_files = ["DoSomething/do-something.cpp"]
+      testsomething_cpp_files = ["TestSomething/test-something.cpp"]
       relative_paths = cpp_library.cpp_files.map { |f| f.split("SampleProjects/", 2)[1] }
-      expect(relative_paths).to match_array(dosomething_cpp_files)
+      expect(relative_paths).to match_array(testsomething_cpp_files)
     end
   end
 
   context "header_dirs" do
     it "finds directories containing h files" do
-      dosomething_header_dirs = ["DoSomething"]
+      testsomething_header_dirs = ["TestSomething"]
       relative_paths = cpp_library.header_dirs.map { |f| f.split("SampleProjects/", 2)[1] }
-      expect(relative_paths).to match_array(dosomething_header_dirs)
+      expect(relative_paths).to match_array(testsomething_header_dirs)
     end
   end
 
   context "tests_dir" do
     it "locate the tests directory" do
-      dosomething_header_dirs = ["DoSomething"]
+      testsomething_header_dirs = ["TestSomething"]
       relative_path = cpp_library.tests_dir.split("SampleProjects/", 2)[1]
-      expect(relative_path).to eq("DoSomething/test")
+      expect(relative_path).to eq("TestSomething/test")
     end
   end
 
   context "test_files" do
     it "finds cpp files in directory" do
-      dosomething_test_files = [
-        "DoSomething/test/good-null.cpp",
-        "DoSomething/test/good-library.cpp",
-        "DoSomething/test/bad-null.cpp"
+      testsomething_test_files = [
+        "TestSomething/test/good-null.cpp",
+        "TestSomething/test/good-library.cpp",
+        "TestSomething/test/bad-null.cpp"
       ]
       relative_paths = cpp_library.test_files.map { |f| f.split("SampleProjects/", 2)[1] }
-      expect(relative_paths).to match_array(dosomething_test_files)
+      expect(relative_paths).to match_array(testsomething_test_files)
     end
   end
 
   context "test" do
-    arduino_cmd = ArduinoCI::ArduinoInstallation.autolocate!
-    it "tests libraries" do
+    after(:each) do |example|
+      if example.exception
+        puts "Last command: #{cpp_library.last_cmd}"
+        puts "========== Stdout:"
+        puts cpp_library.last_out
+        puts "========== Stderr:"
+        puts cpp_library.last_err
+      end
+    end
+
+    it "is going to test more than one library" do
       test_files = cpp_library.test_files
       expect(test_files.empty?).to be false
-      test_files.each do |path|
-        expect(cpp_library.test(path)).to eq(path.include?("good"))
+    end
+
+    test_files = cpp_library.test_files
+    test_files.each do |path|
+      expected = path.include?("good")
+      it "tests #{File.basename(path)} expecting #{expected}" do
+        exe = cpp_library.build_for_test_with_configuration(path, [], nil)
+        expect(exe).not_to be nil
+        expect(cpp_library.run_test_file(exe)).to eq(expected)
       end
     end
   end