ci(json): Add configuration requirements to ci.json files (espressif#10385)

* ci(json): Add support for checking sdkconfig before running tests

* docs(ci): Add explanation about requires field in JSON

* fix(json): Ignore comments when searching requirements

* feat(json): Add extended regex support to requires field

* change(json): Move to using requirements in JSON

* fix(json): Fix requirements for touch tests

* refactor(json): Fix formatting of JSON files

* fix(spi): Fix SPI example and JSON

Author: lucasssvaz

.github/scripts/install-platformio-esp32.sh

@@ -6,6 +6,7 @@ PLATFORMIO_ESP32_URL="https://github.com/platformio/platform-espressif32.git"
 TOOLCHAIN_VERSION="12.2.0+20230208"
 ESPTOOLPY_VERSION="~1.40501.0"
 ESPRESSIF_ORGANIZATION_NAME="espressif"
+LIBS_DIR="tools/esp32-arduino-libs"
 
 echo "Installing Python Wheel ..."
 pip install wheel > /dev/null 2>&1
@@ -88,12 +89,25 @@ function count_sketches(){ # count_sketches <examples-path>
         local sketchname=$(basename $sketch)
         if [[ "${sketchdirname}.ino" != "$sketchname" ]]; then
             continue
+        elif [ -f $sketchdir/ci.json ]; then
+            # If the target is listed as false, skip the sketch. Otherwise, include it.
+            is_target=$(jq -r '.targets[esp32]' $sketchdir/ci.json)
+            if [[ "$is_target" == "false" ]]; then
+                continue
+            fi
+
+            # Check if the sketch requires any configuration options
+            requirements=$(jq -r '.requires[]? // empty' $sketchdir/ci.json)
+            if [[ "$requirements" != "null" ]] || [[ "$requirements" != "" ]]; then
+                for requirement in $requirements; do
+                    found_line=$(grep -E "^$requirement" $LIBS_DIR/esp32/sdkconfig)
+                    if [[ "$found_line" == "" ]]; then
+                        continue 2
+                    fi
+                done
+            fi
         fi
-        is_target=$(jq -r --arg target $target '.targets[$target]' $sketchdir/ci.json)
-        # If the target is listed as false, skip the sketch. Otherwise, include it.
-        if [[ "$is_target" == "false" ]]; then
-            continue
-        fi
+
         echo $sketch >> sketches.txt
         sketchnum=$(($sketchnum + 1))
     done
@@ -163,12 +177,27 @@ function build_pio_sketches(){ # build_pio_sketches <board> <options> <examples-
         local sketchdir=$(dirname $sketch)
         local sketchdirname=$(basename $sketchdir)
         local sketchname=$(basename $sketch)
-        is_target=$(jq -r --arg target $target '.targets[$target]' $sketchdir/ci.json)
-        # If the target is listed as false, skip the sketch. Otherwise, include it.
-        if [ "${sketchdirname}.ino" != "$sketchname" ] \
-        || [[ "$is_target" == "false" ]]; then
+        if [[ "$sketchdirname.ino" != "$sketchname" ]]; then
             continue
+        elif [ -f $sketchdir/ci.json ]; then
+            # If the target is listed as false, skip the sketch. Otherwise, include it.
+            is_target=$(jq -r '.targets[esp32]' $sketchdir/ci.json)
+            if [[ "$is_target" == "false" ]]; then
+                continue
+            fi
+
+            # Check if the sketch requires any configuration options
+            requirements=$(jq -r '.requires[]? // empty' $sketchdir/ci.json)
+            if [[ "$requirements" != "null" ]] || [[ "$requirements" != "" ]]; then
+                for requirement in $requirements; do
+                    found_line=$(grep -E "^$requirement" $LIBS_DIR/esp32/sdkconfig)
+                    if [[ "$found_line" == "" ]]; then
+                        continue 2
+                    fi
+                done
+            fi
         fi
+
         sketchnum=$(($sketchnum + 1))
         if [ "$sketchnum" -le "$start_index" ] \
         || [ "$sketchnum" -gt "$end_index" ]; then

.github/scripts/sketch_utils.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+LIBS_DIR="tools/esp32-arduino-libs"
+
 function build_sketch(){ # build_sketch <ide_path> <user_path> <path-to-ino> [extra-options]
     while [ ! -z "$1" ]; do
         case "$1" in
@@ -140,16 +142,25 @@ function build_sketch(){ # build_sketch <ide_path> <user_path> <path-to-ino> [ex
 
     sketchname=$(basename $sketchdir)
 
-    # If the target is listed as false, skip the sketch. Otherwise, include it.
     if [ -f $sketchdir/ci.json ]; then
+        # If the target is listed as false, skip the sketch. Otherwise, include it.
         is_target=$(jq -r --arg target $target '.targets[$target]' $sketchdir/ci.json)
-    else
-        is_target="true"
-    fi
+        if [[ "$is_target" == "false" ]]; then
+            echo "Skipping $sketchname for target $target"
+            exit 0
+        fi
 
-    if [[ "$is_target" == "false" ]]; then
-        echo "Skipping $sketchname for target $target"
-        exit 0
+        # Check if the sketch requires any configuration options
+        requirements=$(jq -r '.requires[]? // empty' $sketchdir/ci.json)
+        if [[ "$requirements" != "null" ]] || [[ "$requirements" != "" ]]; then
+            for requirement in $requirements; do
+                found_line=$(grep -E "^$requirement" $LIBS_DIR/$target/sdkconfig)
+                if [[ "$found_line" == "" ]]; then
+                    echo "Target $target does not meet the requirement $requirement for $sketchname. Skipping."
+                    exit 0
+                fi
+            done
+        fi
     fi
 
     ARDUINO_CACHE_DIR="$HOME/.arduino/cache.tmp"
@@ -288,16 +299,23 @@ function count_sketches(){ # count_sketches <path> [target] [file]
         local sketchname=$(basename $sketch)
         if [[ "$sketchdirname.ino" != "$sketchname" ]]; then
             continue
-        elif [[ -n $target ]]; then
+        elif [[ -n $target ]] && [[ -f $sketchdir/ci.json ]]; then
             # If the target is listed as false, skip the sketch. Otherwise, include it.
-            if [ -f $sketchdir/ci.json ]; then
-                is_target=$(jq -r --arg target $target '.targets[$target]' $sketchdir/ci.json)
-            else
-                is_target="true"
-            fi
+            is_target=$(jq -r --arg target $target '.targets[$target]' $sketchdir/ci.json)
             if [[ "$is_target" == "false" ]]; then
                 continue
             fi
+
+            # Check if the sketch requires any configuration options
+            requirements=$(jq -r '.requires[]? // empty' $sketchdir/ci.json)
+            if [[ "$requirements" != "null" ]] || [[ "$requirements" != "" ]]; then
+                for requirement in $requirements; do
+                    found_line=$(grep -E "^$requirement" $LIBS_DIR/$target/sdkconfig)
+                    if [[ "$found_line" == "" ]]; then
+                        continue 2
+                    fi
+                done
+            fi
         fi
         echo $sketch >> sketches.txt
         sketchnum=$(($sketchnum + 1))