Skip to content

Commit aab0ca0

Browse files
fhesselfhessel
committed
CI: Build examples on push to master / on labeled PRs
1 parent 9ba205e commit aab0ca0

File tree

7 files changed

+180
-0
lines changed

7 files changed

+180
-0
lines changed

‎.github/workflows/ci-master.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Continuous Integration
2+
3+
on:
4+
push:
5+
branches: master
6+
jobs:
7+
build-examples:
8+
runs-on: self-hosted
9+
steps:
10+
- uses: actions/checkout@f90c7b395dac7c5a277c1a6d93d5057c1cddb74e
11+
- name: Build all examples
12+
run: ./extras/ci/scripts/build-examples.sh

‎.github/workflows/ci-pull.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Continuous Integration (Pull Request)
2+
3+
on:
4+
pull_request:
5+
types: [labeled]
6+
jobs:
7+
build-examples:
8+
runs-on: self-hosted
9+
if: contains( github.event.pull_request.labels.*.name, 'CI - Ready To Run' )
10+
steps:
11+
- uses: actions/checkout@f90c7b395dac7c5a277c1a6d93d5057c1cddb74e
12+
- name: Build all examples
13+
run: ./extras/ci/scripts/build-examples.sh
14+
remove-label:
15+
runs-on: self-hosted
16+
if: contains( github.event.pull_request.labels.*.name, 'CI - Ready To Run' )
17+
steps:
18+
- uses: octokit/request-action@57ec46afcc4c58c813af3afe67e57ced1ea9f165
19+
with:
20+
route: DELETE /repos/:repository/issues/:issue_number/labels/:name
21+
repository: ${{ github.repository }}
22+
issue_number: ${{ github.event.number }}
23+
name: 'CI - Ready To Run'
24+
env:
25+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26+
name: Remove CI Label from PR

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# ESP32 HTTPS Server
22

3+
![Continuous Integration](https://github.com/fhessel/esp32_https_server/workflows/Continuous%20Integration/badge.svg)
4+
35
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.
46

57
## Features

‎extras/ci/scripts/build-examples.sh‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
#!/bin/bash
2+
3+
# This script verifies that every example in the examples directory can be built
4+
5+
# Check that PlatformIO is on the path
6+
if [[ "$(which pio)" == "" ]]; then
7+
echo "PlatformIO executable (pio) not found on PATH. Stop."
8+
echo "PATH=$PATH"
9+
exit 1
10+
fi
11+
12+
# In general, we want the script to fail if something unexpected happens.
13+
# This flag gets only revoked for the actual build process.
14+
set -e
15+
16+
# Find the script and repository location based on the current script location
17+
SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
18+
REPODIR=$(cd "$(dirname $SCRIPTDIR/../../../..)" && pwd)
19+
20+
# Some other directory definitions
21+
TMPDIR="$REPODIR/tmp"
22+
CIDIR="$REPODIR/extras/ci"
23+
EXAMPLEDIR="$REPODIR/examples"
24+
25+
# Re-create build directory
26+
if [ -d "$TMPDIR" ]; then
27+
rm -r "$TMPDIR"
28+
fi
29+
mkdir -p "$TMPDIR"
30+
31+
# Count failed tests
32+
FAILED_TESTS=0
33+
34+
# Lists for failed and successful tests for the summary
35+
EXAMPLES_SUCCESS=()
36+
EXAMPLES_FAILURE=()
37+
38+
# For each example
39+
for EXAMPLE in "$EXAMPLEDIR"/*; do
40+
# Check that an .ino file exists
41+
EXAMPLENAME=$(basename $EXAMPLE)
42+
if [ -d "$EXAMPLE" ] && [ -f "$EXAMPLE/$EXAMPLENAME.ino" ]; then
43+
if [ "$#" -ne 1 ]; then
44+
# No arguments: Test all
45+
TEST_THIS_EXAMPLE=1
46+
else
47+
# Has arguments: Test only examples listed as arguments
48+
TEST_THIS_EXAMPLE=0
49+
for arg in "$@"; do
50+
[[ $arg == "$EXAMPLENAME" ]] && TEST_THIS_EXAMPLE=1 && break
51+
done
52+
fi
53+
# If the test should be executed
54+
if [[ "$TEST_THIS_EXAMPLE" == "1" ]]; then
55+
# We take the .ino file, rename it as main.cpp and add an Arduino.h include at the top
56+
MAINCPP="$TMPDIR/$EXAMPLENAME/src/main.cpp"
57+
INOFILE="$TMPDIR/$EXAMPLENAME/src/$EXAMPLENAME.ino"
58+
PROJECTDIR="$TMPDIR/$EXAMPLENAME"
59+
echo "Building $EXAMPLENAME"
60+
echo "------------------------------------------------------------"
61+
# (re-)create the project directory under tmp/
62+
if [ -d "$PROJECTDIR" ] && [ "$PROJECTDIR" != "" ]; then
63+
rmdir -r "$PROJECTDIR"
64+
fi
65+
# Create the lib folder to link the current version of the library
66+
mkdir -p "$PROJECTDIR/lib"
67+
# Copy the project folder template from ci/templates/example-project
68+
cp -r "$CIDIR/templates/example-project"/* "$PROJECTDIR/"
69+
# Copy the source files
70+
cp -r "$EXAMPLEDIR/$EXAMPLENAME/." "$PROJECTDIR/src"
71+
# Create the library link
72+
ln -s "$REPODIR" "$PROJECTDIR/lib/pio-esp32-ci-demo"
73+
# Convert .ino to main.cpp
74+
echo "#include <Arduino.h>" > "$MAINCPP"
75+
cat "$INOFILE" >> "$MAINCPP"
76+
rm "$INOFILE"
77+
# Try building the application (+e as we want to test every example and get a
78+
# summary on what is working)
79+
set +e
80+
pio run -d "$TMPDIR/$EXAMPLENAME"
81+
SUCCESS=$?
82+
set -e
83+
# Evaluate this example
84+
if [[ "$SUCCESS" != "0" ]]; then
85+
FAILED_TESTS=$[ FAILED_TESTS + 1 ]
86+
EXAMPLES_FAILURE+=("$EXAMPLENAME")
87+
else
88+
EXAMPLES_SUCCESS+=("$EXAMPLENAME")
89+
fi
90+
fi # TEST_THIS_EXAMPLE
91+
fi # example dir exists and contains .ino
92+
done
93+
94+
# Summarize the results
95+
echo "Summary"
96+
echo "------------------------------------------------------------"
97+
for exmpl in "${EXAMPLES_SUCCESS[@]}"; do
98+
printf " \u2714 $exmpl\n"
99+
done
100+
101+
for exmpl in "${EXAMPLES_FAILURE[@]}"; do
102+
printf " \u274c $exmpl\n"
103+
done
104+
105+
# Return the overall success
106+
if [[ "$FAILED_TESTS" != "0" ]]; then
107+
echo "$FAILED_TESTS Tests failed."
108+
exit 1
109+
else
110+
echo "Success."
111+
fi

‎extras/ci/templates/example-project/partitions_wroom.csv‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Name, Type, SubType, Offset, Size, Flags
2+
nvs, data, nvs, 0x9000, 0x5000,
3+
otadata, data, ota, 0xe000, 0x2000,
4+
app0, app, ota_0, 0x10000, 0x1E0000,
5+
spiffs, data, spiffs, 0x1F0000,0x1E0000,

‎extras/ci/templates/example-project/partitions_wrover.csv‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Name, Type, SubType, Offset, Size, Flags
2+
nvs, data, nvs, 0x9000, 0x5000,
3+
otadata, data, ota, 0xe000, 0x2000,
4+
app0, app, ota_0, 0x10000, 0x640000,
5+
app1, app, ota_1, 0x650000,0x640000,
6+
spiffs, data, spiffs, 0xc90000,0x370000,

‎extras/ci/templates/example-project/platformio.ini‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[platformio]
2+
default_envs = wrover, wroom
3+
4+
[env]
5+
platform = espressif32
6+
board = esp32dev
7+
framework = arduino
8+
9+
[env:wrover]
10+
board_build.partitions = partitions_wrover.csv
11+
build_flags =
12+
-DBOARD_HAS_PSRAM
13+
-D_GLIBCXX_USE_C99
14+
15+
[env:wroom]
16+
board_build.partitions = partitions_wroom.csv
17+
build_flags =
18+
-D_GLIBCXX_USE_C99

0 commit comments

Comments
 (0)