Merge branch 'master' into yield

Author: James Foster

.gitattributes

@@ -1,2 +1,40 @@
+# https://docs.github.com/en/github/using-git/configuring-git-to-handle-line-endings
+# https://git-scm.com/docs/gitattributes
+# https://git-scm.com/docs/git-config 
+# https://adaptivepatchwork.com/2012/03/01/mind-the-end-of-your-line/ 
+
+# Configure this repository to use Git's type detection algorithm to guess 
+# whether a file is text or binary. Text files will have line endings converted 
+# as if you had set 
+#   eol=native
+# That is, on Windows text files will have CRLF line endings in your working
+# directory while on Linux and macOS your text files will have LF line endings
+# in your working directory. In either case, they will have LF line endings in
+# the Git repository itself.
+
 # Set the default behavior, in case people don't have core.autocrlf set.
-* text eol=lf
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout. Git would likely get these right, but
+# we can be sure by adding them here.
+*.ino   text diff=cpp
+*.c     text diff=c
+*.cc    text diff=cpp
+*.cxx   text diff=cpp
+*.cpp   text diff=cpp
+*.c++   text diff=cpp
+*.hpp   text diff=cpp
+*.h     text diff=c
+*.h++   text diff=cpp
+*.hh    text diff=cpp
+
+*.md    text
+*.yaml  text
+*.yml   text
+
+
+# Denote all files that are truly binary and should not be modified.
+# Even if we don't have any of these, they make a good example.
+*.png   binary
+*.jpg   binary

.github/workflows/README.md

@@ -7,4 +7,4 @@ In this project, we define a workflow for each target platform.  **If you're loo
 
 The reason that all platforms are tested in _this_ project is to ensure that, as a framework, `arduino_ci` will run properly on any developer's personal workstation (regardless of OS).
 
-For testing an individual Arduino library in the context of GitHub, [Linux is the cheapest option](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions) and produces results identical to the other OSes.
+For testing an individual Arduino library in the context of GitHub, [Linux is the cheapest option](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions) and should produce results identical to the other OSes.

.github/workflows/linux.yaml

@@ -1,7 +1,7 @@
 # This is the name of the workflow, visible on GitHub UI
 name: linux
 
-on: [pull_request]
+on: [push, pull_request]
 
 jobs:
   "unittest_lint_sampleproject":

.github/workflows/macos.yaml

@@ -1,7 +1,7 @@
 # This is the name of the workflow, visible on GitHub UI
 name: macos
 
-on: [pull_request]
+on: [push, pull_request]
 
 jobs:
   "unittest_lint_sampleproject":

.github/workflows/windows.yaml

@@ -1,7 +1,7 @@
 # This is the name of the workflow, visible on GitHub UI
 name: windows
 
-on: [pull_request]
+on: [push, pull_request]
 
 jobs:
   "unittest_lint_sampleproject":

CHANGELOG.md

@@ -7,10 +7,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 ### Added
+- Show output from successful compile
+- `--min-free-space=N` command-line argument to fail if free space is below requred value
 
 ### Changed
+- Fix copy/paste error to allow additional warnings for a platform
+- Properly report compile errors in GitHub Actions (#296)
+- Put build artifacts in a separate directory to reduce clutter.
 - Change 266 files from CRLF to LF.
 - Replace `#define yield() _NOP()` with `inline void yield() { _NOP(); }` so that other code can define a `yield()` function.
+- Update .gitattributes so we have consistent line endings
+- Run tests on push as well as on a pull request so developers can see impact
 
 ### Deprecated
 
@@ -28,6 +35,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 - Topmost installtion instructions now suggest `gem install arduino_ci` instead of using a `Gemfile`.  Reasons for using a `Gemfile` are listed and discussed separately further down the README.
+- Stream::readStreamUntil() no longer returns delimiter
 
 ### Removed
 - scanning of `library.properties`; this can and should now be performed by the standalone [`arduino-lint` tool](https://arduino.github.io/arduino-lint).

SampleProjects/TestSomething/.arduino-ci.yml

@@ -1,3 +1,18 @@
+platforms:
+  uno:
+    board: arduino:avr:uno
+    package: arduino:avr
+    gcc:
+      features:
+      defines:
+        - __AVR__
+        - __AVR_ATmega328P__
+        - ARDUINO_ARCH_AVR
+        - ARDUINO_AVR_UNO
+      warnings:
+        - no-unknown-attributes
+      flags:
+
 unittest:
   platforms:
     - uno

SampleProjects/TestSomething/test/stream.cpp

@@ -69,4 +69,16 @@ unittest(stream_parse)
 
 }
 
+unittest(readStringUntil) {
+  String data = "";
+  unsigned long micros = 100;
+  data = "abc:def";
+
+  Stream s;
+  s.mGodmodeDataIn = &data;
+  s.mGodmodeMicrosDelay = &micros;
+  // result should not include delimiter
+  assertEqual("abc", s.readStringUntil(':'));
+  assertEqual("def", s.readStringUntil(':'));
+}
 unittest_main()

cpp/arduino/Stream.h

@@ -186,7 +186,7 @@ class Stream : public Print
         ret = String(*mGodmodeDataIn);
         mGodmodeDataIn->clear();
       } else {
-        ret = mGodmodeDataIn->substring(0, idxTrm + 1);
+        ret = mGodmodeDataIn->substring(0, idxTrm);
         fastforward(idxTrm + 1);
       }
       return ret;

exe/arduino_ci.rb

@@ -24,6 +24,7 @@ def self.parse(options)
       ci_config: {
         "unittest" => unit_config
       },
+      min_free_space: 0,
     }
 
     opt_parser = OptionParser.new do |opts|
@@ -49,6 +50,10 @@ def self.parse(options)
         unit_config["testfiles"]["reject"] << p
       end
 
+      opts.on("--min-free-space=VALUE", "Minimum free SRAM memory for stack/heap") do |p|
+        output_options[:min_free_space] = p.to_i
+      end
+
       opts.on("-h", "--help", "Prints this help") do
         puts opts
         puts
@@ -478,8 +483,18 @@ def perform_example_compilation_tests(cpp_library, config)
       board = ovr_config.platform_info[p][:board]
       attempt("Compiling #{example_name} for #{board}") do
         ret = @backend.compile_sketch(example_path, board)
-        unless ret
-          puts
+        puts
+        if ret
+          output = @backend.last_msg
+          puts output
+          i = output.index("leaving")
+          free_space = output[i + 8..-1].to_i
+          min_free_space = @cli_options[:min_free_space]
+          if free_space < min_free_space
+            puts "Free space of #{free_space} is less than minimum of #{min_free_space}"
+            ret = false
+          end
+        else
           puts "Last command: #{@backend.last_msg}"
           puts @backend.last_err
         end

lib/arduino_ci/arduino_backend.rb

@@ -164,6 +164,7 @@ def compile_sketch(path, boardname)
         return false
       end
       ret = run_and_capture("compile", "--fqbn", boardname, "--warnings", "all", "--dry-run", path.to_s)
+      @last_msg = ret[:out]
       ret[:success]
     end
 

lib/arduino_ci/cpp_library.rb

@@ -443,7 +443,7 @@ def feature_args(ci_gcc_config)
     def warning_args(ci_gcc_config)
       return [] if ci_gcc_config[:warnings].nil?
 
-      ci_gcc_config[:features].map { |w| "-W#{w}" }
+      ci_gcc_config[:warnings].map { |w| "-W#{w}" }
     end
 
     # GCC command line arguments for defines (e.g. -Dhave_something)
@@ -491,7 +491,10 @@ def test_args(aux_libraries, ci_gcc_config)
     # @return [Pathname] path to the compiled test executable
     def build_for_test_with_configuration(test_file, aux_libraries, gcc_binary, ci_gcc_config)
       base = test_file.basename
-      executable = Pathname.new("unittest_#{base}.bin").expand_path
+      # hide build artifacts
+      build_dir = '.arduino_ci'
+      Dir.mkdir build_dir unless File.exist?(build_dir)
+      executable = Pathname.new("#{build_dir}/unittest_#{base}.bin").expand_path
       File.delete(executable) if File.exist?(executable)
       arg_sets = []
       arg_sets << ["-std=c++0x", "-o", executable.to_s, "-DARDUINO=100"]

spec/testsomething_unittests_spec.rb

@@ -72,7 +72,7 @@
         context "file #{tfn} (using #{compiler})" do
           around(:example) { |example| fld.in_pristine_fake_libraries_dir(example) }
 
-          before(:all) do
+          before(:each) do
             @cpp_library = backend.install_local_library(cpp_lib_path)
             @exe = @cpp_library.build_for_test_with_configuration(path, [], compiler, config.gcc_config("uno"))
           end