add build all script

Author: hathach

.github/workflows/githubci.yml

@@ -29,7 +29,6 @@ jobs:
         
     - name: Install Arduino CLI and Tools
       run: |
-        pip3 install adafruit-nrfutil
         # make all our directories we need for files and libraries
         mkdir $HOME/.arduino15
         mkdir $HOME/.arduino15/packages
@@ -55,4 +54,4 @@ jobs:
         arduino-cli lib install "FlashStorage"
 
     - name: Build examples
-      run: python3 tools/build_all.py ${{ matrix.arduino-platform }}
+      run: python3 extras/build_all.py ${{ matrix.arduino-platform }}

extras/build_all.py

@@ -0,0 +1,110 @@
+import os
+import glob
+import sys
+import subprocess
+import time
+
+all_warnings = False
+exit_status = 0
+success_count = 0
+fail_count = 0
+
+build_format = '| {:20} | {:30} | {:9} '
+build_separator = '-' * 78
+
+all_boards = [ 'metro_m0' ]
+
+build_boards = []
+
+# build all variants if input not existed
+if len(sys.argv) > 1:
+    if (sys.argv[1] in all_boards):
+        build_boards.append(sys.argv[1])
+    else:
+        print('\033[31INTERNAL ERR\033[0m - invalid variant name "{}"'.format(sys.argv[1]))
+        sys.exit(-1)
+else:
+    build_boards = all_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, build_format, build_separator
+
+    print('\n')
+    print(build_separator)
+    print('| {:^74} |'.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 example contains: ".skip" or ".skip.variant"
+        # however ".build.variant" file can overwrite ".skip", used to build a specific variant only
+        sketchdir = os.path.dirname(sketch)
+        if ( (os.path.exists(sketchdir + '/.skip') or os.path.exists(sketchdir + '/.skip.' + variant)) and
+                not os.path.exists(sketchdir + '/.build.' + variant)):
+            success = "skipped"
+        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 != "skipped":
+            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)
+
+
+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 and took {:.2f}s".format(success_count, fail_count, build_time))
+print(build_separator)
+
+sys.exit(exit_status)