fix: skip infverif task for sample drivers built with certain GE WDK versions

crates/sample-kmdf-driver/Makefile.toml

@@ -1,4 +1,4 @@
 extend = "../wdk-build/rust-driver-makefile.toml"
 
 [env]
-WDK_BUILD_ADDITIONAL_INFVERIF_FLAGS = "/msft"
+WDK_IS_SAMPLE = true

crates/wdk-build/rust-driver-makefile.toml

@@ -80,6 +80,9 @@ script = '''
 
 wdk_build::cargo_make::validate_and_forward_args();
 wdk_build::cargo_make::setup_path()?;
+
+let wdk_version = wdk_build::cargo_make::setup_wdk_version()?;
+wdk_build::cargo_make::set_sample_infverif(wdk_version)?;
 '''
 
 [tasks.copy-inx-to-output]
@@ -177,13 +180,16 @@ args = [
   "1.33",
 ]
 
+
 [tasks.infverif]
 private = true
 dependencies = ["stampinf"]
+condition = { env_not_set = ["WDK_INF_NEW_VERSION"] }
 command = "infverif"
 args = [
   "/v",
   "/w",
+  "@@decode(WDK_IS_SAMPLE,true,${WDK_INFVERIF_SAMPLE_FLAG})",
   "@@split(WDK_BUILD_ADDITIONAL_INFVERIF_FLAGS, )",
   "${WDK_BUILD_OUTPUT_DIRECTORY}/${CARGO_MAKE_CRATE_FS_NAME}.inf",
 ]

crates/wdk-build/src/cargo_make.rs

@@ -20,6 +20,13 @@ use crate::{
 };
 
 const PATH_ENV_VAR: &str = "Path";
+const WDK_VERSION_ENV_VAR: &str = "WDK_VER";
+/// The name of the environment variable we store the appropriate `InfVerif`
+/// flag for samples in.
+const SAMPLE_ENV_VAR: &str = "WDK_INFVERIF_SAMPLE_FLAG";
+/// The first WDK version with the new `InfVerif` behavior.
+const WDK_INF_NEW_VERSION: i32 = 25798;
+const WDK_INF_NEW_VERSION_FLAG: &str = "WDK_INF_NEW_VERSION";
 
 /// The name of the environment variable that cargo-make uses during `cargo
 /// build` and `cargo test` commands
@@ -492,6 +499,57 @@ pub fn setup_path() -> Result<(), ConfigError> {
     Ok(())
 }
 
+/// Adds the WDK version to the environment.
+///
+/// # Errors
+///
+/// This function returns a [`ConfigError::WDKContentRootDetectionError`] if the
+/// WDK content root directory could not be found.
+pub fn setup_wdk_version() -> Result<String, ConfigError> {
+    let Some(wdk_content_root) = detect_wdk_content_root() else {
+        return Err(ConfigError::WDKContentRootDetectionError);
+    };
+    let version = get_latest_windows_sdk_version(&wdk_content_root.join("Lib"))?;
+    prepend_to_semicolon_delimited_env_var(WDK_VERSION_ENV_VAR, &version);
+    forward_env_var_to_cargo_make(WDK_VERSION_ENV_VAR);
+    Ok(version)
+}
+
+/// Sets the `WDK_INFVERIF_SAMPLE_FLAG` environment variable to contain the
+/// appropriate flag for building samples.
+///
+/// # Errors
+///
+/// This function returns a [`ConfigError::WDKContentRootDetectionError`] if the
+/// WDK version is ill-formed (that is, it does not match the form
+/// 10.x.yyyyy.z).
+pub fn set_sample_infverif<S: AsRef<str>>(version: S) -> Result<(), ConfigError> {
+    let wdk_version = version.as_ref();
+    let mut version_parts = wdk_version.split('.');
+    let version_number = version_parts
+        .nth(2)
+        .and_then(|version_str| version_str.parse::<i32>().ok());
+
+    if let Some(version) = version_number {
+        let sample_flag = if version > WDK_INF_NEW_VERSION {
+            "/samples"
+        } else {
+            "/msft"
+        };
+        std::env::set_var(SAMPLE_ENV_VAR, sample_flag);
+        forward_env_var_to_cargo_make(SAMPLE_ENV_VAR);
+        if version > WDK_INF_NEW_VERSION {
+            std::env::set_var(WDK_INF_NEW_VERSION_FLAG, "true");
+            forward_env_var_to_cargo_make(WDK_INF_NEW_VERSION_FLAG);
+        }
+        return Ok(());
+    }
+
+    // If we get this far, we weren't able to parse the WDK version number from the
+    // path
+    Err(ConfigError::WDKContentRootDetectionError)
+}
+
 /// Returns the path to the WDK build output directory for the current
 /// cargo-make flow
 ///
@@ -706,3 +764,29 @@ fn forward_env_var_to_cargo_make<S: AsRef<str>>(env_var_name: S) {
         );
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use crate::ConfigError;
+
+    const WDK_TEST_OLD_INF_VERSION: &str = "10.0.22061.0";
+    const WDK_TEST_NEW_INF_VERSION: &str = "10.0.26100.0";
+
+    #[test]
+    fn check_env_passing() -> Result<(), ConfigError> {
+        crate::cargo_make::set_sample_infverif(WDK_TEST_OLD_INF_VERSION)?;
+        let env_string = std::env::var_os(crate::cargo_make::SAMPLE_ENV_VAR).map_or_else(
+            || panic!("Couldn't get OS string"),
+            |os_env_string| os_env_string.to_string_lossy().into_owned(),
+        );
+        assert_eq!(env_string, "/msft");
+
+        crate::cargo_make::set_sample_infverif(WDK_TEST_NEW_INF_VERSION)?;
+        let env_string = std::env::var_os(crate::cargo_make::SAMPLE_ENV_VAR).map_or_else(
+            || panic!("Couldn't get OS string"),
+            |os_env_string| os_env_string.to_string_lossy().into_owned(),
+        );
+        assert_eq!(env_string, "/samples");
+        Ok(())
+    }
+}