ci(json): Add requires_any field

lucasssvaz · lucasssvaz · commit 0d9407f69330 · 2024-10-16T16:26:24.000-03:00
diff --git a/.github/scripts/install-platformio-esp32.sh b/.github/scripts/install-platformio-esp32.sh
@@ -96,7 +96,7 @@ function count_sketches(){ # count_sketches <examples-path>
                 continue
             fi
 
-            # Check if the sketch requires any configuration options
+            # Check if the sketch requires any configuration options (AND)
             requirements=$(jq -r '.requires[]? // empty' $sketchdir/ci.json)
             if [[ "$requirements" != "null" ]] || [[ "$requirements" != "" ]]; then
                 for requirement in $requirements; do
@@ -107,6 +107,23 @@ function count_sketches(){ # count_sketches <examples-path>
                     fi
                 done
             fi
+
+            # Check if the sketch requires any configuration options (OR)
+            requirements_or=$(jq -r '.requires_any[]? // empty' $sketchdir/ci.json)
+            if [[ "$requirements_or" != "null" ]] || [[ "$requirements_or" != "" ]]; then
+                found=false
+                for requirement in $requirements_or; do
+                    requirement=$(echo $requirement | xargs)
+                    found_line=$(grep -E "^$requirement" "$SDKCONFIG_DIR/esp32/sdkconfig")
+                    if [[ "$found_line" != "" ]]; then
+                        found=true
+                        break
+                    fi
+                done
+                if [[ "$found" == "false" ]]; then
+                    continue
+                fi
+            fi
         fi
 
         echo $sketch >> sketches.txt
@@ -198,6 +215,23 @@ function build_pio_sketches(){ # build_pio_sketches <board> <options> <examples-
                     fi
                 done
             fi
+
+            # Check if the sketch requires any configuration options (OR)
+            requirements_or=$(jq -r '.requires_any[]? // empty' $sketchdir/ci.json)
+            if [[ "$requirements_or" != "null" ]] || [[ "$requirements_or" != "" ]]; then
+                found=false
+                for requirement in $requirements_or; do
+                    requirement=$(echo $requirement | xargs)
+                    found_line=$(grep -E "^$requirement" "$SDKCONFIG_DIR/esp32/sdkconfig")
+                    if [[ "$found_line" != "" ]]; then
+                        found=true
+                        break
+                    fi
+                done
+                if [[ "$found" == "false" ]]; then
+                    continue
+                fi
+            fi
         fi
 
         sketchnum=$(($sketchnum + 1))
diff --git a/.github/scripts/sketch_utils.sh b/.github/scripts/sketch_utils.sh
@@ -171,7 +171,7 @@ function build_sketch(){ # build_sketch <ide_path> <user_path> <path-to-ino> [ex
             exit 0
         fi
 
-        # Check if the sketch requires any configuration options
+        # Check if the sketch requires any configuration options (AND)
         requirements=$(jq -r '.requires[]? // empty' $sketchdir/ci.json)
         if [[ "$requirements" != "null" ]] || [[ "$requirements" != "" ]]; then
             for requirement in $requirements; do
@@ -183,6 +183,24 @@ function build_sketch(){ # build_sketch <ide_path> <user_path> <path-to-ino> [ex
                 fi
             done
         fi
+
+        # Check if the sketch excludes any configuration options (OR)
+        requirements_or=$(jq -r '.requires_any[]? // empty' $sketchdir/ci.json)
+        if [[ "$requirements_or" != "null" ]] || [[ "$requirements_or" != "" ]]; then
+            found=false
+            for requirement in $requirements_or; do
+                requirement=$(echo $requirement | xargs)
+                found_line=$(grep -E "^$requirement" "$SDKCONFIG_DIR/$target/sdkconfig")
+                if [[ "$found_line" != "" ]]; then
+                    found=true
+                    break
+                fi
+            done
+            if [[ "$found" == "false" ]]; then
+                echo "Target $target meets none of the requirements in requires_any for $sketchname. Skipping."
+                exit 0
+            fi
+        fi
     fi
 
     ARDUINO_CACHE_DIR="$HOME/.arduino/cache.tmp"
@@ -330,7 +348,7 @@ function count_sketches(){ # count_sketches <path> [target] [file] [ignore-requi
             fi
 
             if [ "$ignore_requirements" != "1" ]; then
-                # Check if the sketch requires any configuration options
+                # Check if the sketch requires any configuration options (AND)
                 requirements=$(jq -r '.requires[]? // empty' $sketchdir/ci.json)
                 if [[ "$requirements" != "null" ]] || [[ "$requirements" != "" ]]; then
                     for requirement in $requirements; do
@@ -341,6 +359,23 @@ function count_sketches(){ # count_sketches <path> [target] [file] [ignore-requi
                         fi
                     done
                 fi
+
+                # Check if the sketch excludes any configuration options (OR)
+                requirements_or=$(jq -r '.requires_any[]? // empty' $sketchdir/ci.json)
+                if [[ "$requirements_or" != "null" ]] || [[ "$requirements_or" != "" ]]; then
+                    found=false
+                    for requirement in $requirements_or; do
+                        requirement=$(echo $requirement | xargs)
+                        found_line=$(grep -E "^$requirement" $SDKCONFIG_DIR/$target/sdkconfig)
+                        if [[ "$found_line" != "" ]]; then
+                            found=true
+                            break
+                        fi
+                    done
+                    if [[ "$found" == "false" ]]; then
+                        continue
+                    fi
+                fi
             fi
         fi
         echo $sketch >> sketches.txt
diff --git a/.github/scripts/tests_run.sh b/.github/scripts/tests_run.sh
@@ -36,7 +36,7 @@ function run_test() {
             return 0
         fi
 
-        # Check if the sketch requires any configuration options
+        # Check if the sketch requires any configuration options (AND)
         requirements=$(jq -r '.requires[]? // empty' $sketchdir/ci.json)
         if [[ "$requirements" != "null" ]] || [[ "$requirements" != "" ]]; then
             for requirement in $requirements; do
@@ -49,6 +49,25 @@ function run_test() {
                 fi
             done
         fi
+
+        # Check if the sketch requires any configuration options (OR)
+        requirements_or=$(jq -r '.requires_any[]? // empty' $sketchdir/ci.json)
+        if [[ "$requirements_or" != "null" ]] || [[ "$requirements_or" != "" ]]; then
+            found=false
+            for requirement in $requirements_or; do
+                requirement=$(echo $requirement | xargs)
+                found_line=$(grep -E "^$requirement" "$SDKCONFIG_PATH")
+                if [[ "$found_line" != "" ]]; then
+                    found=true
+                    break
+                fi
+            done
+            if [[ "$found" == "false" ]]; then
+                printf "\033[93mTarget $target meets none of the requirements in requires_any for $sketchname. Skipping.\033[0m\n"
+                printf "\n\n\n"
+                return 0
+            fi
+        fi
     fi
 
     if [ $len -eq 1 ]; then
diff --git a/docs/en/contributing.rst b/docs/en/contributing.rst
@@ -408,7 +408,9 @@ CI JSON File
 The ``ci.json`` file is used to specify how the test suite and sketches will handled by the CI system. It can contain the following fields:
 
 * ``requires``: A list of configurations in ``sdkconfig`` that are required to run the test suite. The test suite will only run on the targets
-  that have the required configurations. By default, no configurations are required.
+  that have **ALL** the required configurations. By default, no configurations are required.
+* ``requires_any``: A list of configurations in ``sdkconfig`` that are required to run the test suite. The test suite will only run on the targets
+  that have **ANY** of the required configurations. By default, no configurations are required.
 * ``targets``: A dictionary that specifies the targets for which the tests will be run. The key is the target name and the value is a boolean
   that specifies if the test should be run for that target. By default, all targets are enabled as long as they have the required configurations
   specified in the ``requires`` field. This field is also valid for examples.
