Struct PetriVmBuilder

pub struct PetriVmBuilder<T: PetriVmmBackend> { /* private fields */ }

Petri VM builder

Implementations

impl<T: PetriVmmBackend> PetriVmBuilder<T>

pub fn new( params: &PetriTestParams<'_>, artifacts: PetriVmArtifacts<T>, driver: &DefaultDriver, ) -> Result<Self>

Create a new VM configuration.

impl<T: PetriVmmBackend> PetriVmBuilder<T>

pub async fn run_without_agent(self) -> Result<PetriVm<T>>

Build and run the VM, then wait for the VM to emit the expected boot event (if configured). Does not configure and start pipette. Should only be used for testing platforms that pipette does not support.

pub async fn run(self) -> Result<(PetriVm<T>, PipetteClient)>

Build and run the VM, then wait for the VM to emit the expected boot event (if configured). Launches pipette and returns a client to it.

pub fn with_expect_boot_failure(self) -> Self

Configure the test to expect a boot failure from the VM. Useful for negative tests.

pub fn with_expect_no_boot_event(self) -> Self

Configure the test to not expect any boot event. Useful for tests that do not boot a VTL0 guest.

pub fn with_expect_reset(self) -> Self

Allow the VM to reset once at the beginning of the test. Should only be used if you are using a special VM configuration that causes the guest to reboot when it usually wouldn’t.

pub fn with_secure_boot(self) -> Self

Set the VM to enable secure boot and inject the templates per OS flavor.

pub fn with_windows_secure_boot_template(self) -> Self

Inject Windows secure boot templates into the VM’s UEFI.

pub fn with_uefi_ca_secure_boot_template(self) -> Self

Inject UEFI CA secure boot templates into the VM’s UEFI.

pub fn with_processor_topology(self, topology: ProcessorTopology) -> Self

Set the VM to use the specified processor topology.

pub fn with_memory(self, memory: MemoryConfig) -> Self

Set the VM to use the specified processor topology.

pub fn with_vtl2_base_address_type( self, address_type: Vtl2BaseAddressType, ) -> Self

Sets a custom OpenHCL IGVM VTL2 address type. This controls the behavior of where VTL2 is placed in address space, and also the total size of memory allocated for VTL2. VTL2 start will fail if address_type is specified and leads to the loader allocating less memory than what is in the IGVM file.

pub fn with_custom_openhcl( self, artifact: ResolvedArtifact<impl IsOpenhclIgvm>, ) -> Self

Sets a custom OpenHCL IGVM file to use.

pub fn with_openhcl_command_line(self, additional_command_line: &str) -> Self

Sets the command line for the paravisor.

pub fn with_confidential_filtering(self) -> Self

Enable confidential filtering, even if the VM is not confidential.

pub fn with_openhcl_log_levels(self, levels: OpenHclLogConfig) -> Self

Sets the command line parameters passed to OpenHCL related to logging.

pub fn with_agent_file(self, name: &str, artifact: ResolvedArtifact) -> Self

Adds a file to the VM’s pipette agent image.

pub fn with_openhcl_agent_file( self, name: &str, artifact: ResolvedArtifact, ) -> Self

Adds a file to the paravisor’s pipette agent image.

pub fn with_uefi_frontpage(self, enable: bool) -> Self

Sets whether UEFI frontpage is enabled.

pub fn with_default_boot_always_attempt(self, enable: bool) -> Self

Sets whether UEFI should always attempt a default boot.

pub fn with_vmbus_redirect(self, enable: bool) -> Self

Run the VM with Enable VMBus relay enabled

pub fn with_guest_state_lifetime( self, guest_state_lifetime: PetriGuestStateLifetime, ) -> Self

Specify the guest state lifetime for the VM

pub fn with_guest_state_encryption( self, policy: GuestStateEncryptionPolicy, ) -> Self

Specify the guest state encryption policy for the VM

pub fn with_initial_vmgs(self, disk: ResolvedArtifact<impl IsTestVmgs>) -> Self

Use the specified backing VMGS file

pub fn with_persistent_vmgs(self, disk: impl AsRef<Path>) -> Self

Use the specified backing VMGS file

pub fn with_boot_device_type(self, boot: BootDeviceType) -> Self

Set the boot device type for the VM.

This overrides the default, which is determined by the firmware type.

pub fn with_tpm_state_persistence(self, tpm_state_persistence: bool) -> Self

Enable or disable the TPM state persistence for the VM.

pub fn os_flavor(&self) -> OsFlavor

Get VM’s guest OS flavor

pub fn is_openhcl(&self) -> bool

Get whether the VM will use OpenHCL

pub fn isolation(&self) -> Option<IsolationType>

Get the isolation type of the VM

pub fn arch(&self) -> MachineArch

Get the machine architecture

pub fn modify_backend( self, f: impl FnOnce(T::VmmConfig) -> T::VmmConfig + 'static + Send, ) -> Self

Get the backend-specific config builder