flowey_lib_hvlite/
init_vmm_tests_env.rs

1// Copyright (c) Microsoft Corporation.
2// Licensed under the MIT License.
3
4//! Setup the environment variables and directory structure that the VMM tests
5//! require to run.
6
7use crate::build_openhcl_igvm_from_recipe::OpenhclIgvmRecipe;
8use crate::build_test_igvm_agent_rpc_server::TestIgvmAgentRpcServerOutput;
9use crate::build_tpm_guest_tests::TpmGuestTestsOutput;
10use crate::download_release_igvm_files_from_gh::OpenhclReleaseVersion;
11use crate::download_uefi_mu_msvm::MuMsvmArch;
12use crate::resolve_openvmm_deps::OpenvmmDepsArch;
13use flowey::node::prelude::*;
14use std::collections::BTreeMap;
15
16flowey_request! {
17    pub struct Request {
18        /// Directory to symlink / copy test contents into. Does not need to be
19        /// empty.
20        pub test_content_dir: ReadVar<PathBuf>,
21        /// Specify where VMM tests disk images are stored.
22        pub disk_images_dir: Option<ReadVar<PathBuf>>,
23        /// What triple VMM tests are built for.
24        ///
25        /// Used to detect cases of running Windows VMM tests via WSL2, and adjusting
26        /// reported paths appropriately.
27        pub vmm_tests_target: target_lexicon::Triple,
28
29        /// Register an openvmm binary
30        pub register_openvmm: Option<ReadVar<crate::build_openvmm::OpenvmmOutput>>,
31        /// Register a windows pipette binary
32        pub register_pipette_windows: Option<ReadVar<crate::build_pipette::PipetteOutput>>,
33        /// Register a linux-musl pipette binary
34        pub register_pipette_linux_musl: Option<ReadVar<crate::build_pipette::PipetteOutput>>,
35        /// Register a guest_test_uefi image
36        pub register_guest_test_uefi:
37            Option<ReadVar<crate::build_guest_test_uefi::GuestTestUefiOutput>>,
38        /// Register OpenHCL IGVM files
39        pub register_openhcl_igvm_files: Option<
40            ReadVar<
41                Vec<(
42                    OpenhclIgvmRecipe,
43                    crate::run_igvmfilegen::IgvmOutput,
44                )>,
45            >,
46        >,
47        /// Register TMK VMM binaries.
48        pub register_tmks: Option<ReadVar<crate::build_tmks::TmksOutput>>,
49        /// Register a TMK VMM native binary
50        pub register_tmk_vmm: Option<ReadVar<crate::build_tmk_vmm::TmkVmmOutput>>,
51        /// Register a TMK VMM Linux musl binary
52        pub register_tmk_vmm_linux_musl: Option<ReadVar<crate::build_tmk_vmm::TmkVmmOutput>>,
53        /// Register a vmgstool binary
54        pub register_vmgstool: Option<ReadVar<crate::build_vmgstool::VmgstoolOutput>>,
55        /// Register a Windows tpm_guest_tests binary
56        pub register_tpm_guest_tests_windows: Option<ReadVar<TpmGuestTestsOutput>>,
57        /// Register a Linux tpm_guest_tests binary
58        pub register_tpm_guest_tests_linux: Option<ReadVar<TpmGuestTestsOutput>>,
59        /// Register a Windows test_igvm_agent_rpc_server binary
60        pub register_test_igvm_agent_rpc_server: Option<ReadVar<TestIgvmAgentRpcServerOutput>>,
61
62        /// Get the path to the folder containing various logs emitted VMM tests.
63        pub get_test_log_path: Option<WriteVar<PathBuf>>,
64        /// Get a map of env vars required to be set when running VMM tests
65        pub get_env: WriteVar<BTreeMap<String, String>>,
66        pub release_igvm_files: Option<ReadVar<crate::download_release_igvm_files_from_gh::ReleaseOutput>>,
67        /// Use paths relative to `test_content_dir` for environment variables
68        pub use_relative_paths: bool,
69    }
70}
71
72new_simple_flow_node!(struct Node);
73
74impl SimpleFlowNode for Node {
75    type Request = Request;
76
77    fn imports(ctx: &mut ImportCtx<'_>) {
78        ctx.import::<crate::resolve_openvmm_deps::Node>();
79        ctx.import::<crate::git_checkout_openvmm_repo::Node>();
80        ctx.import::<crate::download_uefi_mu_msvm::Node>();
81    }
82
83    fn process_request(request: Self::Request, ctx: &mut NodeCtx<'_>) -> anyhow::Result<()> {
84        let Request {
85            test_content_dir,
86            vmm_tests_target,
87            register_openvmm,
88            register_pipette_windows,
89            register_pipette_linux_musl,
90            register_guest_test_uefi,
91            register_tmks,
92            register_tmk_vmm,
93            register_tmk_vmm_linux_musl,
94            register_vmgstool,
95            register_tpm_guest_tests_windows,
96            register_tpm_guest_tests_linux,
97            register_test_igvm_agent_rpc_server,
98            disk_images_dir,
99            register_openhcl_igvm_files,
100            get_test_log_path,
101            get_env,
102            release_igvm_files,
103            use_relative_paths,
104        } = request;
105
106        let openvmm_deps_arch = match vmm_tests_target.architecture {
107            target_lexicon::Architecture::X86_64 => OpenvmmDepsArch::X86_64,
108            target_lexicon::Architecture::Aarch64(_) => OpenvmmDepsArch::Aarch64,
109            arch => anyhow::bail!("unsupported arch {arch}"),
110        };
111
112        let test_linux_initrd = ctx.reqv(|v| {
113            crate::resolve_openvmm_deps::Request::GetLinuxTestInitrd(openvmm_deps_arch, v)
114        });
115        let test_linux_kernel = ctx.reqv(|v| {
116            crate::resolve_openvmm_deps::Request::GetLinuxTestKernel(openvmm_deps_arch, v)
117        });
118
119        let mu_msvm_arch = match vmm_tests_target.architecture {
120            target_lexicon::Architecture::X86_64 => MuMsvmArch::X86_64,
121            target_lexicon::Architecture::Aarch64(_) => MuMsvmArch::Aarch64,
122            arch => anyhow::bail!("unsupported arch {arch}"),
123        };
124        let uefi = ctx.reqv(|v| crate::download_uefi_mu_msvm::Request::GetMsvmFd {
125            arch: mu_msvm_arch,
126            msvm_fd: v,
127        });
128
129        ctx.emit_rust_step("setting up vmm_tests env", |ctx| {
130            let test_content_dir = test_content_dir.claim(ctx);
131            let get_env = get_env.claim(ctx);
132            let get_test_log_path = get_test_log_path.claim(ctx);
133            let openvmm = register_openvmm.claim(ctx);
134            let pipette_win = register_pipette_windows.claim(ctx);
135            let pipette_linux = register_pipette_linux_musl.claim(ctx);
136            let guest_test_uefi = register_guest_test_uefi.claim(ctx);
137            let tmks = register_tmks.claim(ctx);
138            let tmk_vmm = register_tmk_vmm.claim(ctx);
139            let tmk_vmm_linux_musl = register_tmk_vmm_linux_musl.claim(ctx);
140            let vmgstool = register_vmgstool.claim(ctx);
141            let test_igvm_agent_rpc_server = register_test_igvm_agent_rpc_server.claim(ctx);
142            let tpm_guest_tests_windows = register_tpm_guest_tests_windows.claim(ctx);
143            let tpm_guest_tests_linux = register_tpm_guest_tests_linux.claim(ctx);
144            let disk_image_dir = disk_images_dir.claim(ctx);
145            let openhcl_igvm_files = register_openhcl_igvm_files.claim(ctx);
146            let test_linux_initrd = test_linux_initrd.claim(ctx);
147            let test_linux_kernel = test_linux_kernel.claim(ctx);
148            let uefi = uefi.claim(ctx);
149            let release_igvm_files_dir = release_igvm_files.claim(ctx);
150            move |rt| {
151                let test_linux_initrd = rt.read(test_linux_initrd);
152                let test_linux_kernel = rt.read(test_linux_kernel);
153                let uefi = rt.read(uefi);
154                let release_igvm_files_dir = rt.read(release_igvm_files_dir);
155                let test_content_dir = rt.read(test_content_dir);
156
157                let mut env = BTreeMap::new();
158
159                let windows_via_wsl2 = flowey_lib_common::_util::running_in_wsl(rt)
160                    && matches!(
161                        vmm_tests_target.operating_system,
162                        target_lexicon::OperatingSystem::Windows
163                    );
164
165                let working_dir_ref = test_content_dir.as_path();
166                let working_dir_win = windows_via_wsl2.then(|| {
167                    flowey_lib_common::_util::wslpath::linux_to_win(working_dir_ref)
168                        .display()
169                        .to_string()
170                });
171                let maybe_convert_path = |path: &Path| -> anyhow::Result<String> {
172                    let path = if windows_via_wsl2 {
173                        flowey_lib_common::_util::wslpath::linux_to_win(path)
174                    } else {
175                        path.absolute()
176                            .with_context(|| format!("invalid path {}", path.display()))?
177                    };
178                    let path = if use_relative_paths {
179                        if windows_via_wsl2 {
180                            let working_dir_trimmed =
181                                working_dir_win.as_ref().unwrap().trim_end_matches('\\');
182                            let path_win = path.display().to_string();
183                            let path_trimmed = path_win.trim_end_matches('\\');
184                            PathBuf::from(format!(
185                                "$PSScriptRoot{}",
186                                path_trimmed
187                                    .strip_prefix(working_dir_trimmed)
188                                    .with_context(|| format!(
189                                        "{} not in {}",
190                                        path_win, working_dir_trimmed
191                                    ),)?
192                            ))
193                        } else {
194                            path.strip_prefix(working_dir_ref)
195                                .with_context(|| {
196                                    format!(
197                                        "{} not in {}",
198                                        path.display(),
199                                        working_dir_ref.display()
200                                    )
201                                })?
202                                .to_path_buf()
203                        }
204                    } else {
205                        path
206                    };
207                    Ok(path.display().to_string())
208                };
209
210                env.insert(
211                    "VMM_TESTS_CONTENT_DIR".into(),
212                    maybe_convert_path(&test_content_dir)?,
213                );
214
215                // use a subdir for test logs
216                let test_log_dir = test_content_dir.join("test_results");
217                if !test_log_dir.exists() {
218                    fs_err::create_dir(&test_log_dir)?
219                };
220                env.insert(
221                    "TEST_OUTPUT_PATH".into(),
222                    maybe_convert_path(&test_log_dir)?,
223                );
224
225                if let Some(disk_image_dir) = disk_image_dir {
226                    env.insert(
227                        "VMM_TEST_IMAGES".into(),
228                        maybe_convert_path(&rt.read(disk_image_dir))?,
229                    );
230                }
231
232                if let Some(openvmm) = openvmm {
233                    // TODO OSS: update filenames to use openvmm naming (requires petri updates)
234                    match rt.read(openvmm) {
235                        crate::build_openvmm::OpenvmmOutput::WindowsBin { exe, pdb: _ } => {
236                            fs_err::copy(exe, test_content_dir.join("openvmm.exe"))?;
237                        }
238                        crate::build_openvmm::OpenvmmOutput::LinuxBin { bin, dbg: _ } => {
239                            let dst = test_content_dir.join("openvmm");
240                            fs_err::copy(bin, dst.clone())?;
241                            dst.make_executable()?;
242                        }
243                    }
244                }
245
246                if let Some(pipette_win) = pipette_win {
247                    match rt.read(pipette_win) {
248                        crate::build_pipette::PipetteOutput::WindowsBin { exe, pdb: _ } => {
249                            fs_err::copy(exe, test_content_dir.join("pipette.exe"))?;
250                        }
251                        _ => anyhow::bail!("did not find `pipette.exe` in RegisterPipetteWindows"),
252                    }
253                }
254
255                if let Some(pipette_linux) = pipette_linux {
256                    match rt.read(pipette_linux) {
257                        crate::build_pipette::PipetteOutput::LinuxBin { bin, dbg: _ } => {
258                            fs_err::copy(bin, test_content_dir.join("pipette"))?;
259                        }
260                        _ => {
261                            anyhow::bail!("did not find `pipette.exe` in RegisterPipetteLinuxMusl")
262                        }
263                    }
264                }
265
266                if let Some(guest_test_uefi) = guest_test_uefi {
267                    let crate::build_guest_test_uefi::GuestTestUefiOutput {
268                        efi: _,
269                        pdb: _,
270                        img,
271                    } = rt.read(guest_test_uefi);
272                    fs_err::copy(img, test_content_dir.join("guest_test_uefi.img"))?;
273                }
274
275                if let Some(tmks) = tmks {
276                    let crate::build_tmks::TmksOutput { bin, dbg: _ } = rt.read(tmks);
277                    fs_err::copy(bin, test_content_dir.join("simple_tmk"))?;
278                }
279
280                if let Some(tmk_vmm) = tmk_vmm {
281                    match rt.read(tmk_vmm) {
282                        crate::build_tmk_vmm::TmkVmmOutput::WindowsBin { exe, .. } => {
283                            fs_err::copy(exe, test_content_dir.join("tmk_vmm.exe"))?;
284                        }
285                        crate::build_tmk_vmm::TmkVmmOutput::LinuxBin { bin, .. } => {
286                            let dst = test_content_dir.join("tmk_vmm");
287                            fs_err::copy(bin, &dst)?;
288                            dst.make_executable()?;
289                        }
290                    }
291                }
292
293                if let Some(tmk_vmm_linux_musl) = tmk_vmm_linux_musl {
294                    let crate::build_tmk_vmm::TmkVmmOutput::LinuxBin { bin, dbg: _ } =
295                        rt.read(tmk_vmm_linux_musl)
296                    else {
297                        anyhow::bail!("invalid tmk_vmm output")
298                    };
299                    // Note that this overwrites the previous tmk_vmm. That's
300                    // OK, they should be the same. Fix this when the resolver
301                    // can handle multiple different outputs with the same name.
302                    fs_err::copy(bin, test_content_dir.join("tmk_vmm"))?;
303                }
304
305                if let Some(vmgstool) = vmgstool {
306                    match rt.read(vmgstool) {
307                        crate::build_vmgstool::VmgstoolOutput::WindowsBin { exe, .. } => {
308                            fs_err::copy(exe, test_content_dir.join("vmgstool.exe"))?;
309                        }
310                        crate::build_vmgstool::VmgstoolOutput::LinuxBin { bin, .. } => {
311                            let dst = test_content_dir.join("vmgstool");
312                            fs_err::copy(bin, &dst)?;
313                            dst.make_executable()?;
314                        }
315                    }
316                }
317
318                if let Some(tpm_guest_tests_windows) = tpm_guest_tests_windows {
319                    let TpmGuestTestsOutput::WindowsBin { exe, .. } =
320                        rt.read(tpm_guest_tests_windows)
321                    else {
322                        anyhow::bail!("expected Windows tpm_guest_tests artifact")
323                    };
324                    fs_err::copy(exe, test_content_dir.join("tpm_guest_tests.exe"))?;
325                }
326
327                if let Some(tpm_guest_tests_linux) = tpm_guest_tests_linux {
328                    let TpmGuestTestsOutput::LinuxBin { bin, .. } = rt.read(tpm_guest_tests_linux)
329                    else {
330                        anyhow::bail!("expected Linux tpm_guest_tests artifact")
331                    };
332                    let dst = test_content_dir.join("tpm_guest_tests");
333                    fs_err::copy(bin, &dst)?;
334                    dst.make_executable()?;
335                }
336
337                if let Some(test_igvm_agent_rpc_server) = test_igvm_agent_rpc_server {
338                    let TestIgvmAgentRpcServerOutput { exe, .. } =
339                        rt.read(test_igvm_agent_rpc_server);
340                    fs_err::copy(exe, test_content_dir.join("test_igvm_agent_rpc_server.exe"))?;
341                }
342
343                if let Some(openhcl_igvm_files) = openhcl_igvm_files {
344                    for (recipe, openhcl_igvm) in rt.read(openhcl_igvm_files) {
345                        let crate::run_igvmfilegen::IgvmOutput { igvm_bin, .. } = openhcl_igvm;
346
347                        let filename = match recipe {
348                            OpenhclIgvmRecipe::X64 => "openhcl-x64.bin",
349                            OpenhclIgvmRecipe::X64Devkern => "openhcl-x64-devkern.bin",
350                            OpenhclIgvmRecipe::X64Cvm => "openhcl-x64-cvm.bin",
351                            OpenhclIgvmRecipe::X64TestLinuxDirect => {
352                                "openhcl-x64-test-linux-direct.bin"
353                            }
354                            OpenhclIgvmRecipe::Aarch64 => "openhcl-aarch64.bin",
355                            OpenhclIgvmRecipe::Aarch64Devkern => "openhcl-aarch64-devkern.bin",
356                            _ => {
357                                log::info!("petri doesn't support this OpenHCL recipe: {recipe:?}");
358                                continue;
359                            }
360                        };
361
362                        fs_err::copy(igvm_bin, test_content_dir.join(filename))?;
363                    }
364                }
365
366                if let Some(release_igvm_files) = release_igvm_files_dir {
367                    let latest_release_version = OpenhclReleaseVersion::latest();
368
369                    if let Some(src) = &release_igvm_files.openhcl {
370                        let new_name = format!("{latest_release_version}-x64-openhcl.bin");
371                        fs_err::copy(src, test_content_dir.join(new_name))?;
372                    }
373
374                    if let Some(src) = &release_igvm_files.openhcl_aarch64 {
375                        let new_name = format!("{latest_release_version}-aarch64-openhcl.bin");
376                        fs_err::copy(src, test_content_dir.join(new_name))?;
377                    }
378
379                    if let Some(src) = &release_igvm_files.openhcl_direct {
380                        let new_name = format!("{latest_release_version}-x64-direct-openhcl.bin");
381                        fs_err::copy(src, test_content_dir.join(new_name))?;
382                    }
383                }
384
385                let (arch_dir, kernel_file_name) = match openvmm_deps_arch {
386                    OpenvmmDepsArch::X86_64 => ("x64", "vmlinux"),
387                    OpenvmmDepsArch::Aarch64 => ("aarch64", "Image"),
388                };
389                fs_err::create_dir_all(test_content_dir.join(arch_dir))?;
390                fs_err::copy(
391                    test_linux_initrd,
392                    test_content_dir.join(arch_dir).join("initrd"),
393                )?;
394                fs_err::copy(
395                    test_linux_kernel,
396                    test_content_dir.join(arch_dir).join(kernel_file_name),
397                )?;
398
399                let uefi_dir = test_content_dir
400                    .join(format!(
401                        "hyperv.uefi.mscoreuefi.{}.RELEASE",
402                        match mu_msvm_arch {
403                            MuMsvmArch::Aarch64 => "AARCH64",
404                            MuMsvmArch::X86_64 => "x64",
405                        }
406                    ))
407                    .join(format!(
408                        "Msvm{}",
409                        match mu_msvm_arch {
410                            MuMsvmArch::Aarch64 => "AARCH64",
411                            MuMsvmArch::X86_64 => "X64",
412                        }
413                    ))
414                    .join("RELEASE_VS2022")
415                    .join("FV");
416                fs_err::create_dir_all(&uefi_dir)?;
417                fs_err::copy(uefi, uefi_dir.join("MSVM.fd"))?;
418
419                // debug log the current contents of the dir
420                log::debug!("final folder content: {}", test_content_dir.display());
421                for entry in test_content_dir.read_dir()? {
422                    let entry = entry?;
423                    log::debug!("contains: {:?}", entry.file_name());
424                }
425
426                rt.write(get_env, &env);
427
428                if let Some(var) = get_test_log_path {
429                    rt.write(var, &test_log_dir)
430                }
431
432                Ok(())
433            }
434        });
435
436        Ok(())
437    }
438}
flowey_lib_hvlite/init_vmm_tests_env.rs

flowey_lib_hvlite/
init_vmm_tests_env.rs
