CI: refactor cargo build

Cargo doesn't make any distinction between flags and extra arguments.
There is no reason we should do so in our CI either. Removed the flags
parameter from the cargo_build function.

Instead of having many test function for different build types,
we can have one function and use the pytest parametrize annotation.
This way we can get all the required configuration without duplicating
code.

Signed-off-by: Andreea Florescu <[email protected]>

Author: andreeaflorescu

tests/host_tools/cargo_build.py

@@ -17,11 +17,10 @@
 RELEASE_BINARIES_REL_PATH = 'x86_64-unknown-linux-musl/release/'
 
 
-def cargo_build(path, flags='', extra_args=''):
+def cargo_build(path, extra_args=''):
     """Trigger build depending on flags provided."""
-    cmd = 'CARGO_TARGET_DIR={} cargo build {} {}'.format(
+    cmd = 'CARGO_TARGET_DIR={} cargo build {}'.format(
         path,
-        flags,
         extra_args
     )
     run(cmd, shell=True, check=True)
@@ -54,7 +53,6 @@ def get_firecracker_binaries(root_path):
         )
         cargo_build(
             build_path,
-            flags='--release',
-            extra_args='>/dev/null 2>&1'
+            extra_args='--release >/dev/null 2>&1'
         )
     return fc_binary_path, jailer_binary_path

tests/integration_tests/build/test_build.py

@@ -2,60 +2,47 @@
 # SPDX-License-Identifier: Apache-2.0
 """Tests that check if both the debug and the release builds pass."""
 
+import itertools
 import os
+import pytest
 
 import host_tools.cargo_build as host  # pylint:disable=import-error
 
-
-CARGO_DEBUG_REL_PATH = os.path.join(host.CARGO_BUILD_REL_PATH, 'debug')
-CARGO_DEBUG_REL_PATH_FEATURES = os.path.join(
-    host.CARGO_BUILD_REL_PATH,
-    'debug-features'
-)
-CARGO_RELEASE_REL_PATH_FEATURES = os.path.join(
-    host.CARGO_BUILD_REL_PATH,
-    'release-features'
-)
+FEATURES = ["", "vsock"]
+BUILD_TYPES = ["debug", "release"]
 
 
-def test_build_debug(test_session_root_path):
-    """Test if a debug-mode build works."""
-    build_path = os.path.join(
-        test_session_root_path,
-        CARGO_DEBUG_REL_PATH
-    )
-    host.cargo_build(build_path)
-
-
-def test_build_debug_with_features(test_session_root_path):
-    """Test if a debug-mode build works for supported features."""
-    build_path = os.path.join(
-        test_session_root_path,
-        CARGO_DEBUG_REL_PATH_FEATURES
+@pytest.mark.parametrize(
+    "features, build_type",
+    itertools.product(FEATURES, BUILD_TYPES)
+)
+def test_build(test_session_root_path, features, build_type):
+    """
+    Test build using a cartesian product of possible features and build
+    types.
+    """
+    extra_args = ""
+
+    if build_type == "release":
+        extra_args += "--release "
+
+    # The relative path of the binaries is computed using the build_type
+    # (either release or debug) and if any features are provided also using
+    # the features names.
+    # For example, a default release build with no features will end up in
+    # the relative directory "release", but for a vsock release build the
+    # relative directory will be "release-vsock".
+    rel_path = os.path.join(
+        host.CARGO_BUILD_REL_PATH,
+        build_type
     )
-    # Building with multiple features is as simple as:
-    # cargo build --features "feature1 feature2". We are currently
-    # supporting only one features: vsock.
-    host.cargo_build(build_path, '--features "{}"'.format('vsock'))
+    if features:
+        rel_path += "-{}".format(features)
+        extra_args = "--features {} ".format(features)
 
-
-def test_build_release(test_session_root_path):
-    """Test if a release-mode build works."""
     build_path = os.path.join(
         test_session_root_path,
-        host.CARGO_RELEASE_REL_PATH
+        rel_path
     )
-    host.cargo_build(build_path, '--release')
-
 
-def test_build_release_with_features(test_session_root_path):
-    """Test if a release-mode build works for supported features."""
-    build_path = os.path.join(
-        test_session_root_path,
-        CARGO_RELEASE_REL_PATH_FEATURES
-    )
-    host.cargo_build(
-        build_path,
-        '--features "{}"'.format('vsock'),
-        '--release'
-    )
+    host.cargo_build(build_path, extra_args=extra_args)