Merge pull request #200 from hathach/action-ci

Add action ci to build examples in libraries folder that comes with BSP

Author: ladyada

.github/workflows/githubci.yml

@@ -0,0 +1,59 @@
+name: Build
+
+on: [pull_request, push]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        arduino-platform: ['metro_m0', 'hallowing', 'circuitplayground_m0',
+                           'metro_m4', 'pybadge_m4', 'pygamer_m4', 'hallowing_m4', 'pyportal_m4', 'pyportal_m4_titano']
+
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Setup Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+        
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Checkout submodules
+      shell: bash
+      run: |
+        auth_header="$(git config --local --get http.https://github.com/.extraheader)"
+        git submodule sync --recursive
+        git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive      
+        
+    - name: Install Arduino CLI and Tools
+      run: |
+        # make all our directories we need for files and libraries
+        mkdir $HOME/.arduino15
+        mkdir $HOME/.arduino15/packages
+        mkdir $HOME/Arduino
+        mkdir $HOME/Arduino/libraries
+        curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh
+        echo "::add-path::$GITHUB_WORKSPACE/bin"
+        
+    - name: Install BSP and Libraries
+      env:
+        BSP_URL: https://adafruit.github.io/arduino-board-index/package_adafruit_index.json
+        BSP_PATH: .arduino15/packages/adafruit/hardware/samd
+        LIB_DEPS: FlashStorage SD
+      run: |
+        arduino-cli config init
+        arduino-cli core update-index
+        arduino-cli core update-index --additional-urls $BSP_URL        
+        arduino-cli core install arduino:samd --additional-urls $BSP_URL
+        arduino-cli core install adafruit:samd --additional-urls $BSP_URL
+        # Repalce release BSP with our code
+        BSP_VERSION=`eval ls $HOME/$BSP_PATH`
+        rm -r $HOME/$BSP_PATH/*
+        ln -s $GITHUB_WORKSPACE $HOME/$BSP_PATH/$BSP_VERSION
+        arduino-cli lib install $LIB_DEPS
+
+    - name: Build examples
+      run: python3 extras/build_all.py ${{ matrix.arduino-platform }}

README.md

@@ -1,5 +1,7 @@
 # Arduino Core for SAMD21 and SAMD51 CPU
 
+[![Build Status](https://github.com/adafruit/ArduinoCore-samd/workflows/Build/badge.svg)](https://github.com/adafruit/ArduinoCore-samd/actions)
+
 This repository contains the source code and configuration files of the Arduino Core
 for Atmel's SAMD21 and SAMD51 processor (used on the Arduino/Genuino Zero, MKR1000 and MKRZero boards).
 

extras/build_all.py

@@ -0,0 +1,109 @@
+import os
+import glob
+import sys
+import subprocess
+import time
+
+all_warnings = False
+exit_status = 0
+success_count = 0
+fail_count = 0
+skip_count = 0
+
+build_format = '| {:22} | {:30} | {:9} '
+build_separator = '-' * 80
+
+default_boards = [ 'metro_m0', 'metro_m4', 'circuitplayground_m0']
+
+build_boards = []
+
+# build all variants if input not existed
+if len(sys.argv) > 1:
+    build_boards.append(sys.argv[1])
+else:
+    build_boards = default_boards
+
+def errorOutputFilter(line):
+    if len(line) == 0:
+        return False
+    if line.isspace(): # Note: empty string does not match here!
+        return False
+    # TODO: additional items to remove?
+    return True
+
+
+def build_examples(variant):
+    global exit_status, success_count, fail_count, skip_count, build_format, build_separator
+
+    print('\n')
+    print(build_separator)
+    print('| {:^76} |'.format('Board ' + variant))
+    print(build_separator)
+    print((build_format + '| {:6} |').format('Library', 'Example', 'Result', 'Time'))
+    print(build_separator)
+    
+    fqbn = "adafruit:samd:adafruit_{}".format(variant)
+
+    for sketch in glob.iglob('libraries/**/*.ino', recursive=True):
+        start_time = time.monotonic()
+
+        # Skip if contains: ".board.test.skip" or ".all.test.skip"
+        # Skip if not contains: ".board.test.only" for a specific board
+        sketchdir = os.path.dirname(sketch)
+        if os.path.exists(sketchdir + '/.all.test.skip') or os.path.exists(sketchdir + '/.' + variant + '.test.skip'):
+            success = "\033[33mskipped\033[0m  "
+        elif glob.glob(sketchdir+"/.*.test.only") and not os.path.exists(sketchdir + '/.build.' + variant):
+            success = "\033[33mskipped\033[0m  "
+        else:
+            # TODO - preferably, would have STDERR show up in **both** STDOUT and STDERR.
+            #        preferably, would use Python logging handler to get both distinct outputs and one merged output
+            #        for now, split STDERR when building with all warnings enabled, so can detect warning/error output.
+            if all_warnings:
+                build_result = subprocess.run("arduino-cli compile --warnings all --fqbn {} {}".format(fqbn, sketch), shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+            else:
+                build_result = subprocess.run("arduino-cli compile --warnings default --fqbn {} {}".format(fqbn, sketch), shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+
+            # get stderr into a form where len(warningLines) indicates a true warning was output to stderr
+            warningLines = [];
+            if all_warnings and build_result.stderr:
+                tmpWarningLines = build_result.stderr.decode("utf-8").splitlines()
+                warningLines = list(filter(errorOutputFilter, (tmpWarningLines)))
+
+            if build_result.returncode != 0:
+                exit_status = build_result.returncode
+                success = "\033[31mfailed\033[0m   "
+                fail_count += 1
+            elif len(warningLines) != 0:
+                exit_status = -1
+                success = "\033[31mwarnings\033[0m "
+                fail_count += 1
+            else:
+                success = "\033[32msucceeded\033[0m"
+                success_count += 1
+
+        build_duration = time.monotonic() - start_time
+
+        print((build_format + '| {:5.2f}s |').format(sketch.split(os.path.sep)[1], os.path.basename(sketch), success, build_duration))
+
+        if success != "\033[33mskipped\033[0m  ":
+            if build_result.returncode != 0:
+                print(build_result.stdout.decode("utf-8"))
+                if (build_result.stderr):
+                    print(build_result.stderr.decode("utf-8"))
+            if len(warningLines) != 0:
+                for line in warningLines:
+                    print(line)
+        else:
+            skip_count += 1
+
+build_time = time.monotonic()
+
+for board in build_boards:
+    build_examples(board)
+
+print(build_separator)
+build_time = time.monotonic() - build_time
+print("Build Summary: {} \033[32msucceeded\033[0m, {} \033[31mfailed\033[0m, {} \033[33mskipped\033[0m and took {:.2f}s".format(success_count, fail_count, skip_count, build_time))
+print(build_separator)
+
+sys.exit(exit_status)

libraries/I2S/examples/InputSerialPlotter/.metro_m0.test.only

@@ -382,3 +382,4 @@ void printProgStr(const prog_char str[])
   if(!str) return;
   while((c = pgm_read_byte(str++)))
     SerialDebug.print(c);
+}