feat: add manifest options support for cargo build invocations by svasista-ms · Pull Request #656 · microsoft/windows-drivers-rs

svasista-ms · 2026-05-12T09:05:26Z

This PR adds support for forwarding Cargo “manifest options” (--locked, --offline, --frozen) from cargo wdk build down to the underlying Cargo build invocations, improving reproducibility/offline support.

Resolves #648

Changes

Introduces a ManifestOptions clap args struct and exposes it on the build CLI via #[command(flatten)] [1]
Threads ManifestOptions through BuildAction/BuildTask and forwards flags to cargo metadata, cargo build and cargo rustc invocations in the build action. [2] [3] [4]
Adds/updates unit tests and one system level test to validate the forwarding behavior. [5] [6]

Screenshots

cargo wdk build --help showing Manifest Options:

cargo wdk build --locked --sample on the /examples emulated workspace:

Copilot

Pull request overview

This PR adds support for forwarding Cargo “manifest options” (--locked, --offline, --frozen) from cargo wdk build down to the underlying Cargo build invocations, improving reproducibility/offline support.

Changes:

Introduces a ManifestOptions clap args struct and exposes it on the build CLI via #[command(flatten)].
Threads ManifestOptions through BuildAction/BuildTask and forwards flags to cargo build and cargo rustc.
Adds/updates unit tests to validate the forwarding behavior.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
crates/cargo-wdk/src/cli.rs	Adds flattened manifest-related CLI flags to the `build` subcommand and passes them into the build action.
crates/cargo-wdk/src/actions/mod.rs	Defines `ManifestOptions` and a helper to convert the selected options into Cargo CLI args.
crates/cargo-wdk/src/actions/build/mod.rs	Stores/propagates `ManifestOptions` within `BuildAction` and forwards them to `cargo rustc` target-probing.
crates/cargo-wdk/src/actions/build/build_task.rs	Forwards `ManifestOptions` into the `cargo build` command args; adds focused tests for forwarding.
crates/cargo-wdk/src/actions/build/tests.rs	Extends build action tests to cover manifest option forwarding in higher-level orchestration.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

codecov-commenter · 2026-05-12T09:31:42Z

Codecov Report

❌ Patch coverage is 99.12281% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 79.85%. Comparing base (74b1da7) to head (b57d075).

Files with missing lines	Patch %	Lines
crates/cargo-wdk/src/actions/build/mod.rs	85.71%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #656      +/-   ##
==========================================
+ Coverage   79.45%   79.85%   +0.40%     
==========================================
  Files          26       26              
  Lines        5500     5610     +110     
  Branches     5500     5610     +110     
==========================================
+ Hits         4370     4480     +110     
  Misses       1001     1001              
  Partials      129      129

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…-line (manifest) options

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

… tests

…erify_project function

Copilot

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated no new comments.

gurry · 2026-05-26T05:35:45Z

+                        // Confirm fixed ordering: locked before offline before frozen
+                        let locked_idx = args.iter().position(|a| *a == "--locked").unwrap();
+                        let offline_idx = args.iter().position(|a| *a == "--offline").unwrap();
+                        let frozen_idx = args.iter().position(|a| *a == "--frozen").unwrap();


Why does order matter?

gurry · 2026-05-26T06:51:37Z

+impl ManifestOptions {
+    /// Returns an iterator over the cargo CLI flags equivalent to this set of
+    /// options.
+    pub fn cargo_args(&self) -> impl Iterator<Item = &'static str> {


Suggested change

pub fn cargo_args(&self) -> impl Iterator<Item = &'static str> {

pub fn as_cargo_args(&self) -> impl Iterator<Item = &'static str> {

Slightly more idiomatic

gurry · 2026-05-26T06:52:31Z

+}
+
+#[test]
+fn kmdf_driver_builds_successfully_with_offline_flag() {


Add a test for --locked as well

gurry · 2026-05-26T06:53:35Z

+
+- To build a driver project with a strict, reproducible dependency lockfile (e.g. for CI), navigate to the root of the project and run:
+
+    ```pwsh
+    cargo wdk build --locked
+    ```


This is example is not needed. We don't need to add examples for every commandline line arg

gurry · 2026-05-26T06:54:49Z

 ```

-`build` takes a number of inputs specifying build profile (`dev` or `release`), target architecture (`amd64` or `arm64`), a flag enabling signature verification and a flag indicating a sample driver along with verbosity flags.
+`build` takes a number of inputs specifying build profile (`dev` or `release`), target architecture (`amd64` or `arm64`), a flag enabling signature verification and a flag indicating a sample driver along with verbosity flags. It also accepts the cargo manifest flags `--locked`, `--offline` and `--frozen`, which are forwarded to the underlying `cargo` invocations (e.g. `cargo build`, `cargo metadata`).


Suggested change

`build` takes a number of inputs specifying build profile (`dev` or `release`), target architecture (`amd64` or `arm64`), a flag enabling signature verification and a flag indicating a sample driver along with verbosity flags. It also accepts the cargo manifest flags `--locked`, `--offline` and `--frozen`, which are forwarded to the underlying `cargo` invocations (e.g. `cargo build`, `cargo metadata`).

`build` takes a number of inputs specifying build profile (`dev` or `release`), target architecture (`amd64` or `arm64`), a flag enabling signature verification and a flag indicating a sample driver along with verbosity flags. It also accepts cargo manifest options `--locked`, `--offline` and `--frozen`, which are forwarded to `cargo`.

Slightly shorter

Signed-off-by: Shravan Vasista <svasista@microsoft.com>

gurry · 2026-06-01T04:00:20Z

+      --locked   Require Cargo.lock is up to date
+      --offline  Run without accessing the network
+      --frozen   Require Cargo.lock and cache are up to date


This is from cargo build's help:

--locked Assert that `Cargo.lock` will remain unchanged --offline Run without accessing the network --frozen Equivalent to specifying both --locked and --offline

We should use the exact same text as far as possible. Doing so reinforces the idea that these flags are the same as cargo flags. So our help should be:

--locked Assert that `Cargo.lock` will remain unchanged --offline Build code without accessing the network --frozen Equivalent to specifying both --locked and --offline

Notice that I'm using the word "Build" in the --offline help instead of "Run" used in cargo build's --offline help. That is because in our case even if we pass --offline we will still access the network in our packaging phase.

Maybe this should cause a rethink on whether we should use the word --offline at all.

feat: add manifest options support for cargo build invocations

6bfd1d0

Copilot AI review requested due to automatic review settings May 12, 2026 09:05

Copilot started reviewing on behalf of svasista-ms May 12, 2026 09:06 View session

Copilot AI reviewed May 12, 2026

View reviewed changes

Comment thread crates/cargo-wdk/src/actions/mod.rs

Comment thread crates/cargo-wdk/src/actions/build/tests.rs Outdated

svasista-ms added 2 commits May 13, 2026 13:24

fix: modify get_cargo_metadata_at_path to accept additional command…

311b721

…-line (manifest) options

Merge branch 'microsoft:main' into 648-support-locked-option

7e630a2

Copilot AI review requested due to automatic review settings May 13, 2026 07:57

Copilot started reviewing on behalf of svasista-ms May 13, 2026 07:58 View session

Copilot AI reviewed May 13, 2026

View reviewed changes

Comment thread crates/cargo-wdk/src/providers/metadata.rs

svasista-ms added 2 commits May 21, 2026 09:53

feat: add support for additional cargo manifest options in README and…

d243ea1

… tests

fix: allow clippy warning for too many arguments in clean_build_and_v…

b57d075

…erify_project function

Copilot AI review requested due to automatic review settings May 21, 2026 04:43

Copilot started reviewing on behalf of svasista-ms May 21, 2026 04:47 View session

Copilot AI reviewed May 21, 2026

View reviewed changes

svasista-ms marked this pull request as ready for review May 21, 2026 06:55

gurry reviewed May 26, 2026

View reviewed changes

Merge branch 'main' into 648-support-locked-option

84bb042

Signed-off-by: Shravan Vasista <svasista@microsoft.com>

gurry reviewed Jun 1, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add manifest options support for cargo build invocations#656

feat: add manifest options support for cargo build invocations#656
svasista-ms wants to merge 6 commits into
microsoft:mainfrom
svasista-ms:648-support-locked-option

svasista-ms commented May 12, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented May 12, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

gurry May 26, 2026

Uh oh!

gurry May 26, 2026

Uh oh!

gurry May 26, 2026

Uh oh!

gurry May 26, 2026

Uh oh!

gurry May 26, 2026 •

edited

Loading

Uh oh!

gurry Jun 1, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	pub fn cargo_args(&self) -> impl Iterator<Item = &'static str> {
	pub fn as_cargo_args(&self) -> impl Iterator<Item = &'static str> {

Conversation

svasista-ms commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Screenshots

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

gurry May 26, 2026

Choose a reason for hiding this comment

Uh oh!

gurry May 26, 2026

Choose a reason for hiding this comment

Uh oh!

gurry May 26, 2026

Choose a reason for hiding this comment

Uh oh!

gurry May 26, 2026

Choose a reason for hiding this comment

Uh oh!

gurry May 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gurry Jun 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

svasista-ms commented May 12, 2026 •

edited

Loading

codecov-commenter commented May 12, 2026 •

edited

Loading

gurry May 26, 2026 •

edited

Loading

gurry Jun 1, 2026 •

edited

Loading