arduino_ci 1.4.0 → 1.6.0

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/logger.rb

@@ -0,0 +1,243 @@
+require 'io/console'
+
+module ArduinoCI
+
+  # Provide all text processing functions to aid readability of the test log
+  class Logger
+
+    TAB_WIDTH   = 4
+    INDENT_CHAR = " ".freeze
+
+    # @return [Integer] the cardinal number of indents
+    attr_reader :tab
+
+    # @return [Integer] The number of failures reported through the logging mechanism
+    attr_reader :failure_count
+
+    # @param width [int] The desired console width
+    def initialize(width = nil)
+      @tab           = 0
+      @width         = width.nil? ? 80 : width
+      @failure_count = 0
+      @passfail      = proc { |result| result ? "✓" : "✗" }
+    end
+
+    # create a logger that's automatically sized to the console, between 80 and 132 characters
+    def self.auto_width
+      width = begin
+        [132, [80, IO::console.winsize[1] - 2].max].min
+      rescue NoMethodError
+        80
+      end
+
+      self.new(width)
+    end
+
+    # print a nice banner for this project
+    def banner
+      art = [
+        "         .                  __  ___",
+        " _, ,_  _| , . * ._   _    /  `  | ",
+        "(_| [ `(_] (_| | [ ) (_)   \\__. _|_   v#{ArduinoCI::VERSION}",
+      ]
+
+      pad = " " * ((@width - art[2].length) / 2)
+      art.each { |l| puts "#{pad}#{l}" }
+      puts
+    end
+
+    # @return [String] the current line indentation
+    def indentation
+      (INDENT_CHAR * TAB_WIDTH * @tab)
+    end
+
+    # put an indented string
+    #
+    # @param str [String] the string to puts
+    # @return [void]
+    def iputs(str = "")
+      print(indentation)
+
+      # split the lines and interleave with a newline character, then render
+      stream_lines = str.to_s.split("\n")
+      marked_stream_lines = stream_lines.flat_map { |s| [s, :nl] }.tap(&:pop)
+      marked_stream_lines.each { |l| print(l == :nl ? "\n#{indentation}" : l) }
+      puts
+    end
+
+    # print an indented string
+    #
+    # @param str [String] the string to print
+    # @return [void]
+    def iprint(str)
+      print(indentation)
+      print(str)
+    end
+
+    # increment an indentation level for the duration of a block's execution
+    #
+    # @param amount [Integer] the number of tabs to indent
+    # @yield [] The code to execute while indented
+    # @return [void]
+    def indent(amount = 1, &block)
+      @tab += amount
+      block.call
+    ensure
+      @tab -= amount
+    end
+
+    # make a nice status line for an action and react to the action
+    #
+    # TODO / note to self: inform_multiline is tougher to write
+    #   without altering the signature because it only leaves space
+    #   for the checkmark _after_ the multiline, it doesn't know how
+    #   to make that conditionally the body
+    #
+    # @param message String the text of the progress indicator
+    # @param multiline boolean whether multiline output is expected
+    # @param mark_fn block (string) -> string that says how to describe the result
+    # @param on_fail_msg String custom message for failure
+    # @param tally_on_fail boolean whether to increment @failure_count
+    # @param abort_on_fail boolean whether to abort immediately on failure (i.e. if this is a fatal error)
+    # @yield [] The action being performed
+    # @yieldreturn [Object] whether the action was successful, can be any type but it is evaluated as a boolean
+    # @return [Object] The return value of the block
+    def perform_action(message, multiline, mark_fn, on_fail_msg, tally_on_fail, abort_on_fail)
+      line = "#{indentation}#{message}... "
+      endline = "#{indentation}...#{message} "
+      if multiline
+        puts line
+        @tab += 1
+      else
+        print line
+      end
+      $stdout.flush
+
+      # handle the block and any errors it raises
+      caught_error = nil
+      begin
+        result = yield
+      rescue StandardError => e
+        caught_error = e
+        result = false
+      ensure
+        @tab -= 1 if multiline
+      end
+
+      # put the trailing mark
+      mark = mark_fn.nil? ? "" : mark_fn.call(result)
+      # if multiline, put checkmark at full width
+      print endline if multiline
+      puts mark.to_s.rjust(@width - line.length, " ")
+      unless result
+        iputs on_fail_msg unless on_fail_msg.nil?
+        raise caught_error unless caught_error.nil?
+
+        @failure_count += 1 if tally_on_fail
+        terminate if abort_on_fail
+      end
+      result
+    end
+
+    # Make a nice status (with checkmark) for something that defers any failure code until script exit
+    #
+    # @param message the message to print
+    # @yield [] The action being performed
+    # @yieldreturn [boolean] whether the action was successful
+    # @return [Object] The return value of the block
+    def attempt(message, &block)
+      perform_action(message, false, @passfail, nil, true, false, &block)
+    end
+
+    # Make a nice multiline status (with checkmark) for something that defers any failure code until script exit
+    #
+    # @param message the message to print
+    # @yield [] The action being performed
+    # @yieldreturn [boolean] whether the action was successful
+    # @return [Object] The return value of the block
+    def attempt_multiline(message, &block)
+      perform_action(message, true, @passfail, nil, true, false, &block)
+    end
+
+    FAILED_ASSURANCE_MESSAGE = "This may indicate a problem with your configuration; halting here".freeze
+    # Make a nice status (with checkmark) for something that kills the script immediately on failure
+    #
+    # @param message the message to print
+    # @yield [] The action being performed
+    # @yieldreturn [boolean] whether the action was successful
+    # @return [Object] The return value of the block
+    def assure(message, &block)
+      perform_action(message, false, @passfail, FAILED_ASSURANCE_MESSAGE, true, true, &block)
+    end
+
+    # Make a nice multiline status (with checkmark) for something that kills the script immediately on failure
+    #
+    # @param message the message to print
+    # @yield [] The action being performed
+    # @yieldreturn [boolean] whether the action was successful
+    # @return [Object] The return value of the block
+    def assure_multiline(message, &block)
+      perform_action(message, true, @passfail, FAILED_ASSURANCE_MESSAGE, true, true, &block)
+    end
+
+    # print a failure message (with checkmark) but do not tally a failure
+    # @param message the message to print
+    # @return [Object] The return value of the block
+    def warn(message)
+      inform("WARNING") { message }
+    end
+
+    # print a failure message (with checkmark) but do not exit
+    # @param message the message to print
+    # @return [Object] The return value of the block
+    def fail(message)
+      attempt(message) { false }
+    end
+
+    # print a failure message (with checkmark) and exit immediately afterward
+    # @param message the message to print
+    # @return [Object] The return value of the block
+    def halt(message)
+      assure(message) { false }
+    end
+
+    # Print a value as a status line "message...      retval"
+    #
+    # @param message the message to print
+    # @yield [] The action being performed
+    # @yieldreturn [String] The value to print at the end of the line
+    # @return [Object] The return value of the block
+    def inform(message, &block)
+      perform_action(message, false, proc { |x| x }, nil, false, false, &block)
+    end
+
+    # Print section beginning and end
+    #
+    # @param message the message to print
+    # @yield [] The action being performed
+    # @return [Object] The return value of the block
+    def inform_multiline(message, &block)
+      perform_action(message, true, nil, nil, false, false, &block)
+    end
+
+    # Print a horizontal rule across the console
+    # @param char [String] the character to use
+    # @return [void]
+    def rule(char)
+      puts char[0] * @width
+    end
+
+    # Print a section heading to the console to break up the text output
+    #
+    # @param name [String] the section name
+    # @return [void]
+    def phase(name)
+      puts
+      rule("=")
+      puts("|  #{name}")
+      puts("====")
+    end
+
+  end
+
+end

data/lib/arduino_ci/version.rb

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

data/lib/arduino_ci.rb

@@ -1,4 +1,5 @@
 require "arduino_ci/version"
+require "arduino_ci/logger"
 require "arduino_ci/arduino_installation"
 require "arduino_ci/cpp_library"
 require "arduino_ci/ci_config"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arduino_ci
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Ian Katz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -78,6 +78,7 @@ files:
 - cpp/arduino/avr/README.md
 - cpp/arduino/avr/common.h
 - cpp/arduino/avr/fuse.h
+- cpp/arduino/avr/interrupt.h
 - cpp/arduino/avr/io.h
 - cpp/arduino/avr/io1200.h
 - cpp/arduino/avr/io2313.h
@@ -359,6 +360,7 @@ files:
 - cpp/arduino/ci/Table.h
 - cpp/arduino/stdlib.cpp
 - cpp/arduino/stdlib.h
+- cpp/arduino/util/atomic.h
 - cpp/unittest/ArduinoUnitTests.cpp
 - cpp/unittest/ArduinoUnitTests.h
 - cpp/unittest/Assertion.h
@@ -379,6 +381,7 @@ files:
 - lib/arduino_ci/cpp_library.rb
 - lib/arduino_ci/host.rb
 - lib/arduino_ci/library_properties.rb
+- lib/arduino_ci/logger.rb
 - lib/arduino_ci/version.rb
 - misc/default.yml
 homepage: http://github.com/Arduino-CI/arduino_ci