Allows specifying which features to build, test and lint

Author: xfbs

.changelog/_unreleased.toml

@@ -0,0 +1,7 @@
+[[entries]]
+id = "05ed5af2-2314-4291-9e00-8f5e9d3fe66a"
+type = "feature"
+description = "Adds the features key for CargoBuildTask"
+author = "[email protected]"
+pr = "https://github.com/kraken-build/kraken/issues/151"
+component = "std"

kraken-build/src/kraken/std/cargo/__init__.py

@@ -12,7 +12,7 @@
 
 from .config import CargoConfig, CargoProject, CargoRegistry
 from .tasks.cargo_auth_proxy_task import CargoAuthProxyTask
-from .tasks.cargo_build_task import CargoBuildTask
+from .tasks.cargo_build_task import CargoBuildTask, CargoCrateFeatures
 from .tasks.cargo_bump_version_task import CargoBumpVersionTask
 from .tasks.cargo_check_toolchain_version import CargoCheckToolchainVersionTask
 from .tasks.cargo_clippy_task import CargoClippyTask
@@ -43,6 +43,7 @@
     "cargo_update",
     "CargoAuthProxyTask",
     "CargoBuildTask",
+    "CargoCrateFeatures",
     "CargoBumpVersionTask",
     "CargoClippyTask",
     "CargoDenyTask",
@@ -305,7 +306,7 @@ def cargo_build(
     group: str | None = "build",
     name: str | None = None,
     project: Project | None = None,
-    features: list[str] | None = None,
+    features: list[str] | CargoCrateFeatures | None = None,
     depends_on: Sequence[Task] = (),
 ) -> CargoBuildTask:
     """Creates a task that runs `cargo build`.
@@ -331,17 +332,20 @@ def cargo_build(
         additional_args.append(crate)
     if mode == "release":
         additional_args.append("--release")
+
+    features_object: CargoCrateFeatures | None = None
     if features:
-        additional_args.append("--features")
-        # `cargo build` expects features to be comma separated, in one string.
-        # For example `cargo build --features abc,efg` instead of `cargo build --features abc efg`.
-        additional_args.append(",".join(features))
+        if isinstance(features, CargoCrateFeatures):
+            features_object = features
+        else:
+            features_object = CargoCrateFeatures(features)
 
     task = project.task(
         f"cargoBuild{mode.capitalize()}" if name is None else name,
         CargoBuildTask,
         group=group,
     )
+    task.features = features_object
     task.incremental = incremental
     task.target = mode
     task.additional_args = additional_args

kraken-build/src/kraken/std/cargo/tasks/cargo_build_task.py

@@ -21,6 +21,38 @@ class CargoLibraryArtifact(LibraryArtifact):
     pass
 
 
+class CargoCrateFeatures:
+    """Specify which crate features to build"""
+
+    #: When set to a list of features, only the specified features are built.
+    features: list[str] = list()
+
+    #: When set to False, default features are disabled.
+    default: bool = True
+
+    #: When set to True, all features are enabled.
+    all: bool = False
+
+    def __init__(self, features: list[str] = list(), default: bool = True, all: bool = False):
+        self.features = features
+        self.default = default
+
+    def flags(self) -> list[str]:
+        flags = []
+
+        if self.all:
+            flags.append("--all-features")
+        else:
+            if not self.default:
+                flags.append("--no-default-features")
+
+            if self.features:
+                features = ",".join(self.features)
+                flags.append(f"--features {features}")
+
+        return flags
+
+
 class CargoBuildTask(Task):
     """This task runs `cargo build` using the specified parameters. It will respect the authentication
     credentials configured in :attr:`CargoProjectSettings.auth`."""
@@ -29,6 +61,9 @@ class CargoBuildTask(Task):
     #: to an empty list instead of parsed from the Cargo manifest.
     target: Property[str]
 
+    #: Features to enable for this build.
+    features: Property[CargoCrateFeatures] = Property.default(CargoCrateFeatures())
+
     #: Additional arguments to pass to the Cargo command-line.
     additional_args: Property[list[str]] = Property.default_factory(list)
 
@@ -58,11 +93,14 @@ def get_description(self) -> str | None:
     def get_cargo_command_additional_flags(self) -> list[str]:
         return shlex.split(os.environ.get("KRAKEN_CARGO_BUILD_FLAGS", ""))
 
-    def get_cargo_command(self, env: dict[str, str]) -> list[str]:
+    def get_cargo_subcommand(self, env: dict[str, str], subcommand: str) -> list[str]:
         incremental = self.incremental.get()
         if incremental is not None:
             env["CARGO_INCREMENTAL"] = "1" if incremental else "0"
-        return ["cargo", "build"] + self.additional_args.get()
+        return ["cargo", subcommand] + self.additional_args.get() + self.features.get().flags()
+
+    def get_cargo_command(self, env: dict[str, str]) -> list[str]:
+        return self.get_cargo_subcommand(env, "build")
 
     def make_safe(self, args: list[str], env: dict[str, str]) -> None:
         pass

kraken-build/src/kraken/std/cargo/tasks/cargo_clippy_task.py

@@ -8,13 +8,14 @@
 class CargoClippyTask(CargoBuildTask):
     """Runs `cargo clippy` for linting or applying suggestions."""
 
+    #: When set to True, tells clippy to fix the issues.
     fix: Property[bool] = Property.default(False)
-    allow: Property[str | None] = Property.default("staged")
 
-    # CargoBuildTask
+    #: When running Clippy in Fix mode, allow a dirty or staged Git work tree.
+    allow: Property[str | None] = Property.default("staged")
 
     def get_cargo_command(self, env: dict[str, str]) -> list[str]:
-        command = ["cargo", "clippy"]
+        command = super().get_cargo_subcommand(env, "clippy")
         if self.fix.get():
             command += ["--fix"]
             allow = self.allow.get()
@@ -24,4 +25,5 @@ def get_cargo_command(self, env: dict[str, str]) -> list[str]:
                 command += ["--allow-dirty", "--allow-staged"]
             elif allow is not None:
                 raise ValueError(f"invalid allow: {allow!r}")
+
         return command

kraken-build/src/kraken/std/cargo/tasks/cargo_test_task.py

@@ -1,12 +1,48 @@
+from enum import Enum, auto
+
+from kraken.core import Property
+
 from .cargo_build_task import CargoBuildTask
 
 
+class CargoTestIgnored(Enum):
+    """How to treat ignored tests"""
+
+    #: Skip ignored tests
+    SKIP = auto()
+
+    #: Run ignored tests
+    INCLUDE = auto()
+
+    #: Run only ignored tests
+    ONLY = auto()
+
+
 class CargoTestTask(CargoBuildTask):
     """This task runs `cargo test` using the specified parameters. It will respect the authentication
     credentials configured in :attr:`CargoProjectSettings.auth`."""
 
     description = "Run `cargo test`."
 
+    #: When set to a list of filters, run only tests which match any of these filters.
+    filter: Property[list[str]] = Property.default_factory(list)
+
+    #: Specify how to treat ignored tests, by default they are skipped.
+    ignored: Property[CargoTestIgnored] = Property.default(CargoTestIgnored.SKIP)
+
     def get_cargo_command(self, env: dict[str, str]) -> list[str]:
-        super().get_cargo_command(env)
-        return ["cargo", "test"] + self.additional_args.get()
+        command = super().get_cargo_subcommand(env, "test")
+        command.append("--")
+
+        match self.ignored.get():
+            case CargoTestIgnored.SKIP:
+                pass
+            case CargoTestIgnored.INCLUDE:
+                command.append("--include-ignored")
+            case CargoTestIgnored.ONLY:
+                command.append("--ignored")
+
+        for filter in self.filter.get():
+            command.append(filter)
+
+        return command