CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

Added

Changed

Deprecated

Removed

Fixed

Security

1.5.0 - 2023-01-17

Added

• C++ definitions of ARDUINO_CI_COMPILATION_MOCKS and ARDUINO_CI_GODMODE to aid in compilation macros
• CIConfig.available_override_config_path() to search for available override files in standard locations
• CIConfig.override_file_from_project_library and CIConfig.override_file_from_example to expose config locations
• CI runner script now expliclty informs about config overrides
• A project examples/ directory can now provide its own configuration override file, which provides no new flexibility but simply mirrors the behavior for tests/.

Changed

• CIConfig now uses Pathname instead of strings

Removed

• CIConfig.with_config, which was only used internally

Fixed

• arduino_ci.rb --help no longer crashes

• Fix missing LED_BUILTIN definition for Arduino Due, Zero and Circuit Playground.

• No longer ignore failures if the first step of compiling files for the unit test fails.

1.4.0 - 2022-12-28

Added

• Allow use of watchdog timer in application code (though it doesn't do anything)
• Show output from successful compile
• --min-free-space=N command-line argument to fail if free space is below required value
• Add _BV() macro.
• Support for dtostrf()
• Added a CI workflow to lint the code base
• Added a CI workflow to check for spelling errors
• Extraction of bytes usage in a compiled sketch is now calculated in a method: ArduinoBackend.last_bytes_usage
• Added nano_every platform to represent arduino:megaavr architecture
• Working directory is now printed in test runner output
• Explicitly include irb via rubygems

Changed

• We now compile a shared library to be used for each test.
• Put build artifacts in a separate directory to reduce clutter.
• 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
• Change 266 files from CRLF to LF.
• Run tests on push as well as on a pull request so developers can see impact
• ArduinoBackend now exposes config_file_path instead of config_dir so that we can be explicit about strange behavior in arduino-cli that isn't going to change anytime soon
• Use arduino-cli version 0.29.0 as the backend
• Test runner detects console width if possible, allowing variable width from 80-132 chars

Fixed

• Properly report compile errors in GitHub Actions.
• Fix copy/paste error to allow additional warnings for a platform
• Apply "rule of three" to Client copy constructor and copy assignment operator
• Run Windows tests on Windows not Ubuntu
• Properly report error in building shared library
• A missing examples directory no longer causes a crash in cpp_library.rb
• Referring to an undefined platform no longer causes a crash; it's now a helpful error message
• A copy/paste error that prevented compiler warning flags from being supplied has been fixed, via jgfoster
• RSpec was not communicating compile errors from unit test executables that failed to build. Now it does, via jgfoster
• Windows paths now avoid picking up backslashes, for proper equality comparisons
• Libraries are now considered installed if their entry is a symlink (for which exist? would return false)

1.3.0 - 2021-01-13

Added

• Better indications of the build phases in the test runner arduino_ci.rb
• Better indications of which example sketch is being compiled as part of testing

Changed

• Topmost installation 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.

Fixed

• Example sketches with no configured platforms were printing the wrong configuration values to the debug message
• Libraries directory was not being automatically created prior to attempting to change directory into it
• A style error whose "fix" caused an actual error.
• Proper installation order for NetworkLib in CI workflow configuration

1.2.0 - 2021-01-06

Added

• Environment variable to run a custom initialization script during CI testing: CUSTOM_INIT_SCRIPT
• Environment variable to run from a subdirectory during CI testing: USE_SUBDIR
• assertComparativeEquivalent() and assertComparativeNotEquivalent() to evaluate equality on an a - b == 0 basis (and/or !(a > b) && !(a < b))
• assertEqualFloat() and assertNotEqualFloat() for comparing floats with epsilon
• assertInfinity() and assertNotInfinity() for comparing floats to infinity
• assertNAN() and assertNotNAN() for comparing floats to NaN
• assertion(), ReporterTAP.onAssert(), and testBehaviorExp macro to handle simple expression evaluation (is true, is false, etc)
• Wire.resetMocks() and documentation
• shiftIn() and shiftOut()
• CIConfig.is_default to detect when the default configuration is used
• ArduinoBackend.boards_installed? to detect whether a board family (or package, like arduino:avr) is installed
• ArduinoBackend.library_available? to detect whether the library manager knows of a library
• Sanity checks for library.properties includes= and depends= entries

Changed

• Rubocop expected syntax downgraded from ruby 2.6 to 2.5
• assertEqual() and assertNotEqual() use actual == and != -- they no longer require a type to be totally ordered just to do equality tests
• Evaluative assertions (is true/false/null/etc) now produce simpler error messages instead of masquerading as an operation (e.g. "== true")
• LibraryProperties.to_h now properly uses formatters and symbolic keys, in order to support a .to_s
• Architectures from library.properties are considered when iterating over unit test or examples compilation, as well as the configured platforms

Fixed

• Warnings about directory name mismatches are now based on proper comparison of strings
• Now using the recommended "stable" URL for the esp32 board family
• esp8266:huzzah options updated as per upstream
• Errors about '_NOP' was not declared in this scope (test added)
• pinMode() and analogReference() are now functions (no longer macros), because that conflicted with actual function names in the wild
• analogReadResolution() and analogWriteResolution() are also no longer macros

1.1.0 - 2020-12-02

Added

• ensure_arduino_installation.rb now ensures the existence of the library directory as well
• Environment variables to escalate unit tests or examples not being found during CI testing - EXPECT_EXAMPLES and EXPECT_UNITTESTS

Changed

• Conserve CI testing minutes by grouping CI into fewer runs

Fixed

• Improper reference to Host in arduino_ci.rb test runner is now properly qualified
• Failure to set board manager URLs (for 3rd party board providers) has been fixed

1.0.0 - 2020-11-29

Added

• Special handling of attempts to run the arduino_ci.rb CI script against the ruby library instead of an actual Arduino project
• Explicit checks for attempting to test arduino_ci itself as if it were a library, resolving a minor annoyance to this developer.
• Code coverage tooling
• Explicit check and warning for library directory names that do not match our guess of what the library should/would be called
• Symlink tests for Host
• Add documentation on how to use Arduino CI with GitHub Actions
• Allow tests to run on GitHub without external set up, via GitHub Actions (Windows, Linux, MacOS)
• Exposed desired CLI backend version as ArduinoInstallation::DESIRED_ARDUINO_CLI_VERSION

Changed

• Arduino backend is now arduino-cli version 0.13.0
• ArduinoCmd is now ArduinoBackend
• CppLibrary now relies largely on ArduinoBackend instead of making its own judgements about libraries (metadata, includes, and examples)
• ArduinoBackend functionality related to CppLibrary now lives in CppLibrary
• CppLibrary now works in an installation-first manner for exposure to arduino-cli's logic -- without installation, there is no ability to reason about libraries
• CppLibrary forces just-in-time recursive dependency installation in order to work sensibly
• ArduinoBackend maintains the central "best guess" logic on what a library (on disk) might be named

Deprecated

• arduino_ci_remote.rb CLI switch --skip-compilation
• Deprecated arduino_ci_remote.rb in favor of arduino_ci.rb

Removed

• ARDUINO_CI_SKIP_SPLASH_SCREEN_RSPEC_TESTS no longer affects any tests because there are no longer splash screens since switching to arduino-cli
• CIConfig.package_builtin? as this is no longer relevant to the arduino-cli backend (which has no built-in packages)
• Travis and Appveyor CI

Fixed

• Missing include of IPAddress.h in Client.h
• Mismatches between library names in library.properties and the directory names, which can cause cryptic failures
• LibraryProperties skips over parse errors instead of crashing: only lines with non-empty keys and non-nil values are recorded

0.4.0 - 2020-11-21

Added

• arduino_ci_remote.rb CLI switch --skip-examples-compilation
• Add support for digitalPinToPort(), digitalPinToBitMask(), portOutputRegister(), and portInputRegister()
• CppLibrary.header_files to find header files
• LibraryProperties to read metadata from Arduino libraries
• CppLibrary.library_properties_path, CppLibrary.library_properties?, CppLibrary.library_properties to expose library properties of a Cpp library
• CppLibrary.arduino_library_dependencies to list the dependent libraries specified by the library.properties file
• CppLibrary.print_stack_dump prints stack trace dumps (on Windows specifically) to the console if encountered
• Definitions for Arduino zero
• Support for mock EEPROM (but only if board supports it)
• Add stubs for Client.h, IPAddress.h, Printable.h, Server.h, and Udp.h
• Wire now has a mock support for the master role
• Sample project for BusIO to show problem finding header file

Changed

• Move repository from https://github.com/ianfixes/arduino_ci to https://github.com/Arduino-CI/arduino_ci
• Revise math macros to avoid name clashes
• CppLibrary functions returning C++ header or code files now respect the 1.0/1.5 library specification
• Mocks of built-in macros made more accurate
• NUM_SERIAL_PORTS can now be set explicitly
• Improve SPI header strategy

Deprecated

• arduino_ci_remote.rb CLI switch --skip-compilation
• Deprecated arduino_ci_remote.rb in favor of arduino_ci.rb

Fixed

• Don't define ostream& operator<<(nullptr_t) if already defined by Apple
• CppLibrary.in_tests_dir? no longer produces an error if there is no tests directory
• The definition of the _SFR_IO8 macro no longer produces errors about rvalues
• Typo in cpp_library.rb, misspelling of aux_libraries

0.3.0 - 2019-09-03

Added

• Unit testing configuration now allows exclude_dirs to be set, which prevents stray source files from as part of unit testing allows

0.2.1 - 2019-08-12

Added

• Minimal Wire mocks. Will not provide support for unit testing I2C communication yet, but will allow compilation of libraries that use I2C.
• StreamTape class now bridges Stream and HardwareSerial to allow general-purpose stream mocking & history

Changed

• Arduino command failures (to read preferences) now causes a fatal error, with help for troubleshooting the underlying command

Fixed

• Arduino library dependencies are now installed prior to unit testing, instead of prior to compilation testing. Whoops.
• Arduino library dependencies with spaces in their names are now handled properly during compilation -- spaces are automatically coerced to underscores

0.2.0 - 2019-02-20

Added

• release-new-version.sh script
• outputs for PinHistory can now report timestamps
• Fibonacci Clock for clock testing purposes (internal to this library)

Changed

• Shortened ArduinoQueue push and pop operations
• ci/Queue.h is now MockEventQueue.h, with timing data
• MockEventQueue::Node now contains struct MockEventQueue::Event, which contains both the templated type T and a field for a timestamp.
• Construction of MockEventQueue now includes a constructor argument for the time-fetching function
• Construction of PinHistory now includes a constructor argument for the time-fetching function
• PinHistory can now return an array of timestamps for its events
• GodmodeState is now a singleton pattern, which is necessary to support the globality of Arduino functions
• GodmodeState now uses timestamped PinHistory for Analog and Digital

Fixed

• ArduinoQueue no longer leaks memory

0.1.21 - 2019-02-07

Added

• Proper ostream operator << for nullptr
• Proper comparison operations for nullptr

Changed

• Compare.h heavily refactored to use a smallish macro

Removed

• Homegrown implementation of nullptr

Fixed

• nullptr support (again)

0.1.20 - 2019-01-31

Fixed

• unittest_setup() and unittest_teardown() were not being executed for each unit test, only for the set of all tests. My bad.

0.1.19 - 2019-01-30

Added

• Added rspec sensitivity to the environment variable $ARDUINO_CI_SELECT_CPP_TESTS=<glob> (for arduino_ci gem hackers)
• assertNotNull() and assureNotNull() C++ comparisons

Changed

• CiConfig::allowable_unittest_files now uses Pathname to full effect
• nullptr now defined in its own class

Fixed

• Assertions on nullptr
• The definition of nullptr

0.1.18 - 2019-01-29

Added

• ArduinoInstallation and ArduinoDownloader now allow console output to optionally be set to an IO object of choice during force_install
• ArduinoInstallation::force_install now optionally accepts a version string
• arduino_library_location.rb script to print Arduino library location to stdout
• arduino_ci_remote.rb now supports --skip-unittests and --skip-compilation. If you skip both, only the autolocate! of the Arduino binary will be performed.
• keepachangelog_manager gem to begin streamlining the release process
• unittest_setup() and unittest_teardown() macros, my thanks to @hlovdal for contributing this code
• Added rspec sensitivity to the environment variable $ARDUINO_CI_SKIP_SPLASH_SCREEN_RSPEC_TESTS (for arduino_ci gem hackers)
• Added rspec sensitivity to the environment variable $ARDUINO_CI_SKIP_RUBY_RSPEC_TESTS (for arduino_ci gem hackers)
• Added rspec sensitivity to the environment variable $ARDUINO_CI_SKIP_CPP_RSPEC_TESTS (for arduino_ci gem hackers)
• nullptr definition in C++
• assertNull() for unit tests

Changed

• Unit tests and examples are now executed alphabetically by filename
• The pgm_read_... preprocessor macros in cpp/arduino/avr/pgmspace.h now expands to an expression with applicable type.
• Unit tests for interrupts (attachInterrupt and detachInterrupt) get their own file

Fixed

• Library installation no longer "fails" if the library is already installed
• Platform definition for mega2560 now includes proper AVR compiler flag
• CppLibrary::vendor_bundle? now asks where gems are, instead of assuming vendor/bundle/
• install_local_library step in arduino_ci_remote.rb now properly surfaces any error message

0.1.17 - 2019-01-14

Added

• Provide an itoa function. It is present in Arduino's runtime environment but not on most (all?) host systems because itoa is not a portable standard function.
• to_h and to_s functions for ci_config.rb
• CIConfig::clone
• Ability to override CIConfig from a hash instead of just a file
• arduino_ci_remote.rb now supports command line switches --testfile-select=GLOB and --testfile-reject=GLOB (which can both be repeated)

Changed

• Simplified the use of Array.each with a return statement; it's now simply Array.find
• autolocate! for Arduino installations now raises ArduinoInstallationError if force_install fails
• Errors due to missing YAML are now named ConfigurationError

Fixed

• Determining a working OSX launch command no longer breaks on non-English installations
• arduino_ci_remote.rb now honors selected and rejected test files

0.1.16 - 2019-01-06

Changed

• Finally put some factorization into the arduino_ci_remote.rb script: testing unit and testing compilation are now standalone functions

Removed

• Unnecessary board changes during unit tests no longer happen

Fixed

• Proper casting for pgm_read_byte

0.1.15 - 2019-01-04

Added

• Checking for (empty) set of platforms to build now precedes the check for examples to build; this avoids assuming that all libraries will have an example and dumping the file set when none are found

Fixed

• Spaces in the names of project directories no longer cause unit test binaries to fail execution
• Configuration file overrides with nils (or empty arrays) now properly override their base configuration

0.1.14 - 2018-09-21

Added

• Arduino command wrapper now natively supports board manager URLs
• arduino_ci_remote.rb checks for proper board manager URLs for requested platforms
• arduino_ci_remote.rb reports on Arduino executable location
• exposed index_libraries in ArduinoCmd so it can be used as an explicit build step

Changed

• Centralized file listing code in arduino_ci_remote.rb
• arduino_ci_remote.rb is verbose about platforms, packages, and URLs

Removed

• Linux wrapper no longer bails out on long-running commands. That behavior was possible in Arduino 1.6.x that might pop up a graphical error message, but with the display manager removed this is no longer a concern

0.1.13 - 2018-09-19

Changed

• arduino_ci_remote.rb now iterates over example platforms before examples (saves time)

Fixed

• arduino_ci_remote.rb no longer crashes if test/ directory doesn't exist

0.1.12 - 2018-09-13

Added

• Explicit libasan checking (reporting) in build script

Fixed

• Test file int main(){} needed a CPP extension in order to properly compile
• Fixed build script reporting for inform() when it returns a non-string value from its block
• Don't count false returns from inform() blocks as failures

0.1.11 - 2018-09-13

Added

• Explicit checks that the requested test platforms are defined in YML
• Arduino command wrapper can now guess whether a library is installed
• CPP library class now reaches into included Arduino libraries for source files
• SPI mocks
• ensure_arduino_installation.rb to allow custom libraries to be installed
• Copy constructor for ArduinoCITable
• Some error information on failures to download the Arduino binary

Changed

• Refactored documentation
• External libraries aren't forcibly installed via the Arduino binary (in arduino_cmd_remote.rb) if they appear to exist on disk already
• attachInterrupt and detachInterrupt are now mocked instead of _NOP
• Unit test binaries now run with debugging symbols and address sanitization (if available), to help isolate the causes of segfaults
• ArduinoCommand::libdir logic is now centralized, using sketchbook.path from prefs instead of hard-coding

Removed

• Display Manager became no longer necessary with Arduino 1.8.X

Fixed

• OSX splash screen re-disabled
• ArduinoCITable didn't initialize its size on clear()
• CPP file aggregation now ignores dotfiles
• Unit test compilers section of YAML configuration is now properly inherited from parent configuration files
• Retrieving preferences is now properly cached
• Paths on Windows should now work due to the use of Pathname
• symlinking directories in Windows environments now properly uses /D switch to mklink

0.1.10 - 2018-05-06

Added

• Arduino force_install on Linux now attempts downloading 3 times and provides more information on failure
• Explicit check for wget
• Windows / Appveyor support, enabled largely by contributions from @tomduff
• long long support in String
• Representative .gitignore files in sample projects
• Cross-platform symlinking in Host
• OSX CI via Travis, with separate badges

Changed

• Author
• Splash-screen-skip hack on OSX now falls back on "official" launch method if the hack doesn't work
• Refactored download/install code in prepration for windows CI
• Explicitly use 32-bit math for mocked Random()
• Ruby-centric download and unzipping of Arduino IDE packages, now with progress dots

Removed

• ArduinoDownloaderPosix became empty, so it was removed

Fixed

• Gemfile.lock files are properly ignored
• Windows hosts won't try to open a display manager
• isnan portability
• OSX force_install

0.1.9 - 2018-04-12

Added

• Explicit tests of .arduino-ci.yml in TestSomething example

Fixed

• Malformed YAML (duplicate unittests section) now has no duplicate section
• arduino_ci_remote.rb script now has correct arguments in build_for_test

0.1.8 - 2018-04-03

Added

• Definition of LED_BUILTIN, first reported by dfrencham on GitHub
• Stubs for tone and noTone, first suggested by dfrencham on GitHub
• Ability to specify multiple compilers for unit testing

Fixed

• Compile errors / portability issues in WString.h and Print.h, first reported by dfrencham on GitHub
• Compile errors / inheritance issues in Print.h and Stream.h, first reported by dfrencham on GitHub
• Print functions for int, double, long, etc

0.1.7 - 2018-03-07

Changed

• Queue and Table are now ArduinoCIQueue and ArduinoCITable to avoid name collisions

0.1.6 - 2018-03-07

Added

• CppLibrary can now report gcc_version

Changed

• arduino_ci_remote.rb now formats tasks with multiple output lines more nicely
• Templates for CI classes are now pass-by-value (no const reference)

Fixed

• Replaced pipes with Open3.capture3 to avoid deadlocks when commands have too much output
• ci_config.rb now returns empty arrays (instead of nil) for undefined config keys
• pgmspace.h explicitly includes <string.h>
• __FlashStringHelper should now be properly mocked for compilation
• WString.h bool operator now works and is simpler

0.1.5 - 2018-03-05

Added

• Yaml files can have either .yml or .yaml extensions
• Yaml files support select/reject criteria for paths of unit tests for targeted testing
• Pins now track history and can report it in Ascii (big- or little-endian) for digital sequences
• Pins now accept an array (or string) of input bits for providing pin values across multiple reads
• FlashStringHelper (and related macros) compilation mocks
• SoftwareSerial. That took a while.
• Queue template implementation
• Table template implementation
• ObservableDataStream and DataStreamObserver pattern implementation
• DeviceUsingBytes and implementation of mocked serial device

Changed

• Unit test executables print to STDERR just in case there are segfaults. Uh, just in case I ever write any.

Fixed

• OSX no longer experiences javax.net.ssl.SSLKeyException: RSA premaster secret error messages when downloading board package files
• arduino_ci_remote.rb no longer makes unnecessary changes to the board being tested
• Scripts no longer crash if there is no test/ directory
• Scripts no longer crash if there is no examples/ directory
• assureTrue and assureFalse now assure instead of just asserting.

0.1.4 - 2018-02-01

Added

• Support for all builtin Math functions https://www.arduino.cc/reference/en/
• Support for all builtin Bits and Bytes functions https://www.arduino.cc/reference/en/
• Support for GODMODE and time functions
• Support for Character functions https://www.arduino.cc/reference/en/
• Mocks for random functions with seed control
• Many original Arduino #defines
• Mocks for pinMode, analog/digital read/write
• Support for WString
• Support for Print
• Support for Stream (backed by a String implementation)
• All the IO stuff (pins, serial port support flags, etc) from the Arduino library
• Support for Serial (backed by GODMODE)

Changed

• Made wget have quieter output

0.1.3 - 2018-01-25

Added

• C++ functions for assure; asserts will run tests and continue, assures will abort on failures
• Missing dotfiles in the DoSomething project have been committed

Changed

• arduino_ci_remote.rb doesn't attempt to set URLs if nothing needs to be downloaded
• arduino_ci_remote.rb does unit tests first
• unittest_main() is now the macro for the int main() of test files

Fixed

• All test files were reporting "not ok" in TAP output. Now they are OK iff all asserts pass.
• Directories with a C++ extension in their name could cause problems. Now they are ignored.
• CppLibrary had trouble with symlinks. It shouldn't anymore.
• CppLibrary had trouble with vendor bundles. It might in the future, but I have a better fix ready to go if it's an issue.

0.1.2 - 2018-01-25

Fixed

• Actually package CPP and YAML files into the gem. Whoops.

0.1.1 - 2018-01-24

Added

• README documentation for the actual unit tests

0.1.0 - 2018-01-24

Added

• Unit testing support
• Documentation for all Ruby methods
• ArduinoInstallation class for managing lib / executable paths
• DisplayManager class for managing Xvfb instance if needed
• ArduinoCmd captures and caches preferences
• ArduinoCmd reports on whether a board is installed
• ArduinoCmd sets preferences
• ArduinoCmd installs boards
• ArduinoCmd installs libraries
• ArduinoCmd selects boards (compiler preference)
• ArduinoCmd verifies sketches
• CppLibrary manages GCC for unittests
• CIConfig manages overridable config for all testing

Changed

• DisplayManger.with_display doesn't disable if the display was enabled prior to starting the block

Fixed

• Built gems are .gitignored
• Updated gems based on Github's security advisories

0.0.1 - 2018-01-10

Added

• Skeleton for gem with working unit tests