fix(ci): do not run optional tests for doc-only changes

We already avoid running the whole test suite when changes include only
doc changes, or changes to YAML files under .github.

This commit applies the same logic to the optional PR tests.

Signed-off-by: Babis Chalios <[email protected]>

Author: bchalios

.buildkite/common.py

@@ -7,6 +7,8 @@
 
 import argparse
 import json
+import subprocess
+from pathlib import Path
 
 DEFAULT_INSTANCES = [
     "m5d.metal",
@@ -86,6 +88,28 @@ def pipeline_to_json(pipeline):
     return json.dumps(pipeline, indent=4, sort_keys=True, ensure_ascii=False)
 
 
+def get_changed_files(branch):
+    """
+    Get all files changed since `branch`
+    """
+    stdout = subprocess.check_output(["git", "diff", "--name-only", branch])
+    return [Path(line) for line in stdout.decode().splitlines()]
+
+
+def run_all_tests(changed_files):
+    """
+    Check if we should run all tests, based on the files that have been changed
+    """
+
+    # run the whole test suite if either of:
+    # - any file changed that is not documentation nor GitHub action config file
+    # - no files changed
+    return not changed_files or any(
+        x.suffix != ".md" and not (x.parts[0] == ".github" and x.suffix == ".yml")
+        for x in changed_files
+    )
+
+
 class DictAction(argparse.Action):
     """An argparse action that can receive a nested dictionary
 

.buildkite/pipeline_pr.py

@@ -4,24 +4,20 @@
 
 """Generate Buildkite pipelines dynamically"""
 
-import subprocess
-from pathlib import Path
-
-from common import COMMON_PARSER, group, overlay_dict, pipeline_to_json
+from common import (
+    COMMON_PARSER,
+    get_changed_files,
+    group,
+    overlay_dict,
+    pipeline_to_json,
+    run_all_tests,
+)
 
 # Buildkite default job priority is 0. Setting this to 1 prioritizes PRs over
 # scheduled jobs and other batch jobs.
 DEFAULT_PRIORITY = 1
 
 
-def get_changed_files(branch):
-    """
-    Get all files changed since `branch`
-    """
-    stdout = subprocess.check_output(["git", "diff", "--name-only", branch])
-    return [Path(line) for line in stdout.decode().splitlines()]
-
-
 args = COMMON_PARSER.parse_args()
 
 step_style = {
@@ -111,13 +107,7 @@ def get_changed_files(branch):
 if any(x.parts[-1] == "Dockerfile" for x in changed_files):
     steps += [devtool_build_grp]
 
-# run the whole test suite if either of:
-# - any file changed that is not documentation nor GitHub action config file
-# - no files changed
-if not changed_files or any(
-    x.suffix != ".md" and not (x.parts[0] == ".github" and x.suffix == ".yml")
-    for x in changed_files
-):
+if run_all_tests(changed_files):
     steps += [
         kani_grp,
         build_grp,

.buildkite/pipeline_pr_no_block.py

@@ -4,7 +4,14 @@
 
 """Generate Buildkite pipelines dynamically"""
 
-from common import COMMON_PARSER, group, overlay_dict, pipeline_to_json
+from common import (
+    COMMON_PARSER,
+    get_changed_files,
+    group,
+    overlay_dict,
+    pipeline_to_json,
+    run_all_tests,
+)
 
 # Buildkite default job priority is 0. Setting this to 1 prioritizes PRs over
 # scheduled jobs and other batch jobs.
@@ -30,5 +37,6 @@
     **defaults,
 )
 
-pipeline = {"steps": [optional_grp]}
+changed_files = get_changed_files("main")
+pipeline = {"steps": [optional_grp]} if run_all_tests(changed_files) else {"steps": []}
 print(pipeline_to_json(pipeline))