arduino_ci 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0b4bb5ffc81d0b5888f13b871c4b79155c5edab347d3c9211a453556690bbd2
-  data.tar.gz: 67156a3b8c1754cb83967a60b2acb76253e06a7f676e2517dfec7e240d8a88c7
+  metadata.gz: c3fcf7949cd16f89c3b4b62b6aa44121e68a3e9a4424d106d2912f7aa628902e
+  data.tar.gz: 04ae38ca97c87a875628d01f2611916238d8ff2a2f98281911192319333438ec
 SHA512:
-  metadata.gz: a31668d85a2a80b705389f9b42916decd5c73848da29ee1e42094ae8d9fb1f77ccd410450734356cb838ec50a635c0a8421afd690d0ae98de18611e71bfe0c03
-  data.tar.gz: ec2e5655f327ecf0fac4ba62c47f4e29c113193efcf65b70f38929f4973635171bfd08f7a9351748a6162aac6a18be59de9948e6566b003c59797f4ce87635ab
+  metadata.gz: 70a31c4b7e8d97a019de95e9a6af215885cbb2c21b1b6c13db014c1a08d1c507fb8a5eea960fae09ae18a3cc11c5bb7e8b7f965beca40f597a6b41a0d4fddc8c
+  data.tar.gz: cd5567a69c0ab3a183e83c9a8ab88b5e6afd1547c366f4debd7aa88947298cdcb88ecbe0964548a58a89571c4c076b85b87bbc523c3c2c42e6283647043aae03

data/README.md

@@ -1,7 +1,7 @@
 
 # ArduinoCI Ruby gem (`arduino_ci`)
 [![Gem Version](https://badge.fury.io/rb/arduino_ci.svg)](https://rubygems.org/gems/arduino_ci)
-[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/1.4.0)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/1.5.0)
 [![Gitter](https://badges.gitter.im/Arduino-CI/arduino_ci.svg)](https://gitter.im/Arduino-CI/arduino_ci?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 [![GitHub Marketplace](https://img.shields.io/badge/Get_it-on_Marketplace-informational.svg)](https://github.com/marketplace/actions/arduino_ci)
 
@@ -118,11 +118,11 @@ gem 'arduino_ci', path: '/path/to/development/dir/for/arduino_ci'
 
 ### Installing the Dependencies
 
-Fulfilling the `arduino_ci` library dependency is as easy as running either of these two commands:
+Fulfilling the `arduino_ci` library dependency is as easy as running one or both of these commands:
 
 ```console
-$ bundle install   # adds packages to global library (may require admin rights)
-$ bundle install --path vendor/bundle   # adds packages to local library
+$ bundle config set --local path 'vendor/bundle'   # if you lack administrative privileges to install globally
+$ bundle install
 ```
 
 This will create a `Gemfile.lock` in your project directory, which you may optionally check into source control.  A broader introduction to ruby dependencies is outside the scope of this document.
@@ -169,7 +169,7 @@ jobs:
   runTest:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

data/REFERENCE.md

@@ -44,6 +44,11 @@ This allows a file (or glob) pattern to be executed in your tests directory, cre
 This allows a file (or glob) pattern to be executed in your tests directory, creating a blacklist of files to skip.  E.g. `--testfile-reject=test_animal_*.cpp` would match `test_animal_cat.cpp` and `test_animal_dog.cpp` (skipping those) and test only `test_plant_rose.cpp`, `test_plant_daisy.cpp`, etc.
 
 
+### `--min-free-space` option
+
+This specifies the minimum free SRAM memory for stack/heap, in bytes, that _must_ be leftover after compilation.  This value applies globally -- to _all_ platforms that will be included in a test run.
+
+
 ### `CUSTOM_INIT_SCRIPT` environment variable
 
 If set, testing will execute (using `/bin/sh`) the script referred to by this variable -- relative to the current working directory (i.e. the root directory of the library).  The script will _run_ in the Arduino Libraries directory (changing to the Libraries directory, running the script, and returning to the individual library root afterward).  This enables use cases like the GitHub action to install custom library versions (i.e. a version of a library that is different than what the library manager would automatically install by name) prior to CI test runs.

data/cpp/arduino/Arduino.h

@@ -5,6 +5,11 @@ Mock Arduino.h library.
 Where possible, variable names from the Arduino library are used to avoid conflicts
 
 */
+
+// signal to the developer that we are in an arduino_ci mocked environment
+#define ARDUINO_CI_COMPILATION_MOCKS
+
+
 // Chars and strings
 
 #include "ArduinoDefines.h"

data/cpp/arduino/ArduinoDefines.h

@@ -89,7 +89,8 @@
 #define TIMER5B 17
 #define TIMER5C 18
 
-#if defined(__AVR_ATmega328P__) || defined(__AVR_ATmega32U4__) || defined(__AVR_ATmega328__) || defined(__AVR_ATmega168__) || defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
+#if defined(__AVR_ATmega328P__) || defined(__AVR_ATmega32U4__) || defined(__AVR_ATmega328__) || defined(__AVR_ATmega168__) || defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) || defined(__SAM3X8E__) || defined(__SAMD21G18A__)
+  // Verified on these platforms, see https://github.com/Arduino-CI/arduino_ci/pull/341#issuecomment-1368118880
   #define LED_BUILTIN 13
 #endif
 

data/cpp/arduino/Godmode.h

@@ -6,6 +6,9 @@
 #include "WString.h"
 #include "PinHistory.h"
 
+// signal to the developer that we are in an arduino_ci mocked environment
+#define ARDUINO_CI_GODMODE
+
 // random
 void randomSeed(unsigned long seed);
 long random(long vmax);

data/exe/arduino_ci.rb

@@ -69,7 +69,6 @@ class Parser
         puts " - #{VAR_USE_SUBDIR} - if set, the script will install the library from this subdirectory of the cwd"
         puts " - #{VAR_EXPECT_EXAMPLES} - if set, testing will fail if no example sketches are present"
         puts " - #{VAR_EXPECT_UNITTESTS} - if set, testing will fail if no unit tests are present"
-        puts " - #{VAR_SKIP_LIBPROPS} - if set, testing will skip [experimental] library.properties validation"
         exit
       end
     end
@@ -194,6 +193,13 @@ def assured_platform(purpose, name, config)
   platform_definition
 end
 
+def inform_override(from_where, &block)
+  inform("Using configuration override from #{from_where}") do
+    file = block.call
+    file.nil? ? "<none>" : file
+  end
+end
+
 # Return true if the file (or one of the dirs containing it) is hidden
 def file_is_hidden_somewhere?(path)
   # this is clunkly but pre-2.2-ish ruby doesn't return ascend as an enumerator
@@ -436,7 +442,7 @@ def perform_unit_tests(cpp_library, file_config)
     puts
     compilers.each do |gcc_binary|
       # before compiling the tests, build a shared library of everything except the test code
-      next unless build_shared_library(gcc_binary, p, config, cpp_library)
+      next @failure_count += 1 unless build_shared_library(gcc_binary, p, config, cpp_library)
 
       # now build and run each test using the shared library build above
       config.allowable_unittest_files(cpp_library.test_files).each do |unittest_path|
@@ -489,12 +495,17 @@ def perform_example_compilation_tests(cpp_library, config)
     return
   end
 
+  inform_override("examples") { config.override_file_from_example(cpp_library.examples_dir) }
+  ex_config = config.from_example(cpp_library.examples_dir)
+
   library_examples.each do |example_path|
     example_name = File.basename(example_path)
     puts
     inform("Discovered example sketch") { example_name }
 
-    ovr_config = config.from_example(example_path)
+    inform_override("example") { ex_config.override_file_from_example(example_path) }
+    ovr_config = ex_config.from_example(example_path)
+
     platforms = choose_platform_set(ovr_config, "library example", ovr_config.platforms_to_build, cpp_library.library_properties)
 
     # having no platforms defined is probably an error
@@ -542,9 +553,13 @@ inform("Host OS") { ArduinoCI::Host.os }
 inform("Working directory") { Dir.pwd }
 
 # initialize command and config
-config = ArduinoCI::CIConfig.default.from_project_library
+default_config = ArduinoCI::CIConfig.default
+inform_override("project") { default_config.override_file_from_project_library }
+config = default_config.from_project_library
+
 @backend = ArduinoCI::ArduinoInstallation.autolocate!
 inform("Located arduino-cli binary") { @backend.binary_path.to_s }
+inform("Using arduino-cli version") { @backend.version.to_s }
 if @backend.lib_dir.exist?
   inform("Found libraries directory") { @backend.lib_dir }
 else

data/lib/arduino_ci/arduino_backend.rb

@@ -182,7 +182,10 @@ module ArduinoCI
       result = if @additional_urls.empty?
         run_and_capture("core", "install", boardfamily)
       else
-        run_and_capture("core", "install", boardfamily, "--additional-urls", @additional_urls.join(","))
+        urls = @additional_urls.join(",")
+        # update the index, then install. if the update step fails, return that result
+        updater = run_and_capture("core", "update-index", "--additional-urls", urls)
+        updater[:success] ? run_and_capture("core", "install", boardfamily, "--additional-urls", urls) : updater
       end
       result[:success]
     end

data/lib/arduino_ci/ci_config.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'pathname'
 
 # base config (platforms)
 #   project config - .arduino_ci_platforms.yml
@@ -58,7 +59,7 @@ module ArduinoCI
       def default
         ret = new
         ret.instance_variable_set("@is_default", true)
-        ret.load_yaml(File.expand_path("../../misc/default.yml", __dir__))
+        ret.load_yaml((Pathname.new(__dir__) + "../../misc/default.yml").realpath)
         ret
       end
     end
@@ -195,35 +196,45 @@ module ArduinoCI
       overridden_config
     end
 
-    # Get the config file at a given path, if it exists, and pass that to a block.
-    # Many config files may exist, but only the first match is used
+    # Get available configuration file, if one exists
     # @param base_dir [String] The directory in which to search for a config file
-    # @param val_when_no_match [Object] The value to return if no config files are found
-    # @yield [path] Process the configuration file at the given path
-    # @yieldparam [String] The path of an existing config file
-    # @yieldreturn [ArduinoCI::CIConfig] a settings object
-    # @return [ArduinoCI::CIConfig]
-    def with_config(base_dir, val_when_no_match)
-      CONFIG_FILENAMES.each do |f|
-        path = base_dir.nil? ? f : File.join(base_dir, f)
-        return (yield path) if File.exist?(path)
-      end
-      val_when_no_match
+    # @return [Pathname] the first available config file we could find, or nil
+    def available_override_config_path(base_dir = nil)
+      CONFIG_FILENAMES.map { |f| base_dir.nil? ? Pathname.new(f) : base_dir + f }.find(&:exist?)
+    end
+
+    # Find an available override file from the project directory
+    #
+    # @todo this is currently reliant on launching the arduino_ci.rb test runner from
+    #        the correct working directory
+    # @return [Pathname] A file that can override project config, or nil if none was found
+    def override_file_from_project_library
+      available_override_config_path(nil)
+    end
+
+    # Find an available override file from an example sketch
+    #
+    # @param path [Pathname] the path to the example or example directory
+    # @return [Pathname] A file that can override project config, or nil if none was found
+    def override_file_from_example(example_path)
+      base_dir = example_path.directory? ? example_path : example_path.dirname
+      available_override_config_path(base_dir)
     end
 
     # Produce a configuration, assuming the CI script runs from the working directory of the base project
     # @return [ArduinoCI::CIConfig] the new settings object
     def from_project_library
-      with_config(nil, self) { |path| with_override(path) }
+      ovr = override_file_from_project_library
+      ovr.nil? ? self : with_override(ovr)
     end
 
     # Produce a configuration override taken from an Arduino library example path
     # handle either path to example file or example dir
-    # @param path [String] the path to the settings yaml file
+    # @param path [Pathname] the path to the settings yaml file
     # @return [ArduinoCI::CIConfig] the new settings object
     def from_example(example_path)
-      base_dir = File.directory?(example_path) ? example_path : File.dirname(example_path)
-      with_config(base_dir, self) { |path| with_override(path) }
+      ovr = override_file_from_example(example_path)
+      ovr.nil? ? self : with_override(ovr)
     end
 
     # get information about a given platform: board name, package name, compiler stuff, etc

data/lib/arduino_ci/host.rb

@@ -30,11 +30,31 @@ module ArduinoCI
       nil
     end
 
+    # Execute a shell command and capture stdout, stderr, and status
+    #
+    # @see Process.spawn
+    # @see https://docs.ruby-lang.org/en/2.0.0/Process.html#method-c-spawn
+    # @return [Hash] with keys "stdout" (String), "stderr" (String), and "success" (bool)
     def self.run_and_capture(*args, **kwargs)
       stdout, stderr, status = Open3.capture3(*args, **kwargs)
       { out: stdout, err: stderr, success: status.exitstatus.zero? }
     end
 
+    # Merge multiple capture results into one aggregate value
+    #
+    # @param args [Array] Array of hashes from `run_and_capture`
+    # @return [Hash] with keys "stdout" (String), "stderr" (String), and "success" (bool)
+    def self.merge_capture_results(*args)
+      {
+        out: args.map { |a| a[:out] }.join,
+        err: args.map { |a| a[:err] }.join,
+        success: args.all? { |a| a[:success] }
+      }
+    end
+
+    # Execute a shell command
+    #
+    # @see system
     def self.run_and_output(*args, **kwargs)
       system(*args, **kwargs)
     end

data/lib/arduino_ci/version.rb

@@ -1,3 +1,3 @@
 module ArduinoCI
-  VERSION = "1.4.0".freeze
+  VERSION = "1.5.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino_ci
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Ian Katz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2023-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os