ci: add option to use a different Firecracker binary

This enables us to run a pipeline against an existing binary.

The binary has to exist in the Buildkite artifacts buckets.

Signed-off-by: Pablo Barbáchano <[email protected]>

Author: pb8o

.buildkite/common.py

@@ -110,6 +110,24 @@ def run_all_tests(changed_files):
     )
 
 
+def devtool_test(test_path, devtool_opts=None, pytest_opts=None, binary_dir=None):
+    """Generate a `devtool test` command"""
+    cmds = []
+    parts = ["./tools/devtool -y test"]
+    if devtool_opts:
+        parts.append(devtool_opts)
+    parts.append("--")
+    if pytest_opts:
+        parts.append(pytest_opts)
+    if binary_dir is not None:
+        cmds.append(f'buildkite-agent artifact download "{binary_dir}/$(uname -m)/*" .')
+        cmds.append(f"chmod -v a+x {binary_dir}/**/*")
+        parts.append(f"--binary-dir=../{binary_dir}/$(uname -m)")
+    parts.append(test_path)
+    cmds.append(" ".join(parts))
+    return cmds
+
+
 class DictAction(argparse.Action):
     """An argparse action that can receive a nested dictionary
 
@@ -159,3 +177,10 @@ def __call__(self, parser, namespace, value, option_string=None):
     default={},
     type=str,
 )
+COMMON_PARSER.add_argument(
+    "--binary-dir",
+    help="Use the Firecracker binaries from this path",
+    required=False,
+    default=None,
+    type=str,
+)

.buildkite/pipeline_perf.py

@@ -4,7 +4,7 @@
 
 """Generate Buildkite performance pipelines dynamically"""
 
-from common import COMMON_PARSER, group, overlay_dict, pipeline_to_json
+from common import COMMON_PARSER, devtool_test, group, overlay_dict, pipeline_to_json
 
 perf_test = {
     "block": {
@@ -45,9 +45,11 @@ def build_group(test):
     devtool_opts = test.pop("devtool_opts")
     test_path = test.pop("test_path")
     retries = test.pop("retries")
+    binary_dir = test.pop("binary_dir")
+    pytest_opts = f"-m nonci --reruns {retries} --perf-fail"
     return group(
         label=test.pop("label"),
-        command=f"./tools/devtool -y test {devtool_opts} -- -m nonci --reruns {retries} --perf-fail {test_path}",
+        command=devtool_test(test_path, devtool_opts, pytest_opts, binary_dir),
         artifacts=["./test_results/*"],
         instances=test.pop("instances"),
         platforms=test.pop("platforms"),
@@ -75,6 +77,7 @@ def build_group(test):
     test_data.setdefault("agents", {"ag": 1})
     test_data["retries"] = args.retries
     test_data["timeout_in_minutes"] *= args.retries + 1
+    test_data["binary_dir"] = args.binary_dir
     test_data = overlay_dict(test_data, args.step_param)
     test_data["retry"] = {
         "automatic": [

.buildkite/pipeline_pr.py

@@ -6,6 +6,7 @@
 
 from common import (
     COMMON_PARSER,
+    devtool_test,
     get_changed_files,
     group,
     overlay_dict,
@@ -61,7 +62,10 @@
 
 functional_grp = group(
     "⚙ Functional and security 🔒",
-    "./tools/devtool -y test -- -n 8 --dist worksteal integration_tests/{{functional,security}}",
+    devtool_test(
+        "-n 8 --dist worksteal integration_tests/{{functional,security}}",
+        binary_dir=args.binary_dir,
+    ),
     **defaults,
 )
 
@@ -77,7 +81,7 @@
 
 performance_grp = group(
     "⏱ Performance",
-    "./tools/devtool -y test -- ../tests/integration_tests/performance/",
+    devtool_test("../tests/integration_tests/performance/", binary_dir=args.binary_dir),
     **defaults_for_performance,
 )
 

tests/conftest.py

@@ -288,6 +288,8 @@ def microvm_factory(fc_tmp_path, bin_cloner_path, request):
     if binary_dir := request.config.getoption("--binary-dir"):
         fc_binary_path = Path(binary_dir) / "firecracker"
         jailer_binary_path = Path(binary_dir) / "jailer"
+        if not fc_binary_path.exists():
+            raise RuntimeError("Firecracker binary does not exist")
     else:
         fc_binary_path, jailer_binary_path = build_tools.get_firecracker_binaries()