Merge 2020-10-16_suggestions from infixes (#11)

* Increase clarity of command line tool: The command line option --skip-compilation can be confusing, because unit tests must be compiled before they can run.  This adds some text to the flag such that the fact that examples are compiled is acknowledged.
* Use proper 1.5 library format
* Obey 1.0 / 1.5 library specification when finding C++ library source
* Appease rubocop
* avoid error when testing for membership in a nonexistent directory
* Add library.properties parsing
* Add recursive library dependency compilation
* Fix unit tests for source directory exclusion
* reorder changelog sections
* Fix _SFR_IO8 macro definition -- use volatile keyword to prevent optimization
* Add dummy test files to sample projects to ensure they aren't included in C++ file listings
* Print unit test stack traces if encountered
* Fix definition of SFR macro to prevent linker errors about duplicate symbol
* Explore possible fix for Arduino-CI#187.
* Tests now pass (but only because of a horrible hack by someone who doesn't understand what is happening!).

Co-authored-by: Ian Katz <[email protected]>

Author: James Foster

.rubocop.yml

@@ -31,6 +31,12 @@ Layout/ExtraSpacing:
 Layout/EndOfLine:
   EnforcedStyle: lf
 
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
 Metrics/LineLength:
   Description: Limit lines to 80 characters.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#80-character-limits

CHANGELOG.md

@@ -0,0 +1 @@
+depends=OnePointOhDummy,OnePointFiveDummy

REFERENCE.md

@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()

SampleProjects/DependOnSomething/library.properties

@@ -0,0 +1,3 @@
+unittest:
+  exclude_dirs:
+    - src/excludeThis

SampleProjects/DependOnSomething/src/YesDeps.cpp

@@ -0,0 +1,10 @@
+name=TestSomething
+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 file exclusion
+category=Other
+url=https://github.com/Arduino-CI/arduino_ci/SampleProjects/ExcludeSomething
+architectures=avr,esp8266
+includes=do-something.h

SampleProjects/DependOnSomething/src/YesDeps.h

@@ -0,0 +1,4 @@
+#include "exclude-something.h"
+int excludeSomething(void) {
+  return -1;
+};

SampleProjects/DependOnSomething/test/null.cpp

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

SampleProjects/ExcludeSomething/.arduino-ci.yml

@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()

SampleProjects/ExcludeSomething/README.md

@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()

SampleProjects/ExcludeSomething/library.properties

@@ -0,0 +1,7 @@
+#include <ArduinoUnitTests.h>
+
+unittest(nothing)
+{
+}
+
+unittest_main()

SampleProjects/ExcludeSomething/src/exclude-something.cpp

@@ -1,6 +1,4 @@
 unittest:
-  exclude_dirs:
-    - excludeThis
   platforms:
     - uno
     - due

SampleProjects/ExcludeSomething/src/exclude-something.h

@@ -1,5 +1,5 @@
 #include <ArduinoUnitTests.h>
-#include "../test-something.h"
+#include "../src/test-something.h"
 
 unittest(library_tests_something)
 {

SampleProjects/TestSomething/excludeThis/exclude-this.cpp renamed to SampleProjects/ExcludeSomething/src/excludeThis/exclude-this.cpp

@@ -5,6 +5,7 @@ Mock Arduino.h library.
 Where possible, variable names from the Arduino library are used to avoid conflicts
 
 */
+
 // Chars and strings
 
 #include "ArduinoDefines.h"
@@ -72,5 +73,3 @@ inline unsigned int makeWord(unsigned int w) { return w; }
 inline unsigned int makeWord(unsigned char h, unsigned char l) { return (h << 8) | l; }
 
 #define word(...) makeWord(__VA_ARGS__)
-
-

SampleProjects/TestSomething/excludeThis/exclude-this.h renamed to SampleProjects/ExcludeSomething/src/excludeThis/exclude-this.h

@@ -2,6 +2,7 @@
 require "arduino_ci/arduino_installation"
 require "arduino_ci/cpp_library"
 require "arduino_ci/ci_config"
+require "arduino_ci/library_properties"
 
 # ArduinoCI contains classes for automated testing of Arduino code on the command line
 # @author Ian Katz <[email protected]>

SampleProjects/ExcludeSomething/test/null.cpp

@@ -110,11 +110,11 @@ def autolocate!(output = $stdout)
       # Forcibly install Arduino from the web
       # @return [bool] Whether the command succeeded
       def force_install(output = $stdout, version = DESIRED_ARDUINO_IDE_VERSION)
-        worker_class =  case Host.os
-                        when :osx then ArduinoDownloaderOSX
-                        when :windows then ArduinoDownloaderWindows
-                        when :linux then ArduinoDownloaderLinux
-                        end
+        worker_class = case Host.os
+        when :osx then ArduinoDownloaderOSX
+        when :windows then ArduinoDownloaderWindows
+        when :linux then ArduinoDownloaderLinux
+        end
         worker = worker_class.new(version, output)
         worker.execute
       end