Run build example action as matrix on hosted runner

Author: fhessel

.github/workflows/build-examples.yml

@@ -0,0 +1,45 @@
+name: Build Examples
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  build-examples:
+    strategy:
+      matrix:
+        os: 
+          - ubuntu-latest
+        example:
+          - Async-Server
+          - Authentication
+          - HTML-Forms
+          - HTTPS-and-HTTP
+          - Middleware
+          - Parameters
+          - Parameter-Validation
+          - Put-Post-Echo
+          - REST-API
+          - Self-Signed-Certificate
+          - Static-Page
+          - Websocket-Chat
+        board:
+          - wrover
+          - wroom
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout codebase
+      uses: actions/checkout@f90c7b395dac7c5a277c1a6d93d5057c1cddb74e
+    - name: Set up Python
+      uses: actions/setup-python@9ac730844c47e52575257e93faf193c4530bc095
+      with:
+        python-version: '3.8'
+    - name: Install PlatformIO
+      run: |
+        python -m pip install --upgrade pip
+        pip install platformio
+    - name: Build example
+      run: ./extras/ci/scripts/build-example.sh ${{ matrix.board }} ${{ matrix.example }}

.github/workflows/ci-master.yml

@@ -1,7 +1,5 @@
 # ESP32 HTTPS Server
 
-![Continuous Integration](https://github.com/fhessel/esp32_https_server/workflows/Continuous%20Integration/badge.svg)
-
 This repository contains an HTTPS server library that can be used with the [ESP32 Arduino Core](https://github.com/espressif/arduino-esp32). It supports HTTP as well.
 
 ## Features

.github/workflows/ci-pull.yml

@@ -0,0 +1,91 @@
+#!/bin/bash
+
+# This script verifies that every example in the examples directory can be built
+
+# Check that PlatformIO is on the path
+if [[ "$(which pio)" == "" ]]; then
+  echo "::error::PlatformIO executable (pio) not found on PATH. Stop."
+  echo "::error::PATH=$PATH"
+  exit 1
+fi
+
+# Parse parameters
+BOARD="$1"
+if [[ "$BOARD" == "" ]]; then
+  echo "::error::No board specified. Stop."
+  exit 1
+fi
+EXAMPLENAME="$2"
+if [[ "$EXAMPLENAME" == "" ]]; then
+  echo "::error::No example specified. Stop."
+  exit 1
+fi
+
+# In general, we want the script to fail if something unexpected happens.
+# This flag gets only revoked for the actual build process.
+set -e
+
+# Find the script and repository location based on the current script location
+SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+REPODIR=$(cd "$(dirname $SCRIPTDIR/../../../..)" && pwd)
+
+# Some other directory definitions
+TMPDIR="$REPODIR/tmp"
+CIDIR="$REPODIR/extras/ci"
+EXAMPLEDIR="$REPODIR/examples"
+
+# Re-create build directory
+if [ -d "$TMPDIR" ]; then
+  rm -r "$TMPDIR"
+fi
+mkdir -p "$TMPDIR"
+
+# Check that an .ino file exists
+if [ ! -d "$EXAMPLEDIR/$EXAMPLENAME" ]; then
+  echo "::error::Example directory does not exist: $EXAMPLENAME"
+  exit 1
+fi
+if [ ! -f "$EXAMPLEDIR/$EXAMPLENAME/$EXAMPLENAME.ino" ]; then
+  echo "::error::Example sketch does not exist: $EXAMPLENAME.ino"
+  exit 1
+fi
+
+# We take the .ino file, rename it as main.cpp and add an Arduino.h include at the top
+PROJECTDIR="$TMPDIR/$EXAMPLENAME-$BOARD"
+MAINCPP="$PROJECTDIR/src/main.cpp"
+INOFILE="$PROJECTDIR/src/$EXAMPLENAME.ino"
+
+# (re-)create the project directory under tmp/
+if [ -d "$PROJECTDIR" ] && [ "$PROJECTDIR" != "" ]; then
+  rm -r "$PROJECTDIR"
+fi
+
+# Create the lib folder to link the current version of the library
+mkdir -p "$PROJECTDIR/lib"
+# Copy the project folder template from ci/templates/example-project
+cp -r "$CIDIR/templates/example-project"/* "$PROJECTDIR/"
+# Copy the source files
+cp -r "$EXAMPLEDIR/$EXAMPLENAME/." "$PROJECTDIR/src"
+# Create the library link
+ln -s "$REPODIR" "$PROJECTDIR/lib/esp32_https_server"
+# Convert .ino to main.cpp
+echo "#include <Arduino.h>" > "$MAINCPP"
+cat "$INOFILE" >> "$MAINCPP"
+rm "$INOFILE"
+
+# If the example has dependencies, rewrite platformio.ini
+if [[ -f "$EXAMPLEDIR/$EXAMPLENAME/.ci_lib_deps" ]]; then
+  LIB_DEPS=$(head -n1 "$EXAMPLEDIR/$EXAMPLENAME/.ci_lib_deps")
+  sed "s#\\#lib_deps#lib_deps = $LIB_DEPS#" "$PROJECTDIR/platformio.ini" > "$PROJECTDIR/platformio.ini.tmp"
+  mv "$PROJECTDIR/platformio.ini.tmp" "$PROJECTDIR/platformio.ini"
+fi
+
+# Try building the application (+e as we want to test every example and get a
+# summary on what is working)
+set +e
+pio --no-ansi run -d "$PROJECTDIR" -e "$BOARD" 2>&1 | "$CIDIR/scripts/pio-to-gh-log.py"
+RC=${PIPESTATUS[0]}
+if [[ "$RC" != "0" ]]; then
+  echo "::error::pio returned with RC=$RC"
+fi
+exit $RC

README.md

@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+import sys
+import re
+
+# Simple Python script that takes PlatformIO's compiler errors and maps them to
+# output that can be understood by the Actions runner.
+
+re_err = re.compile(r"^([^:]+):([0-9]+):([0-9]+): error: (.*)$")
+
+for line in sys.stdin:
+  print(line, end="")
+  m = re_err.match(line.strip())
+  if m is not None:
+    print("::error file={name},line={line},col={col}::{message}".format(
+      name=m.group(1), line=m.group(2), col=m.group(3), message=m.group(4)
+    ))