Struct PetriVmOpenVmm

pub struct PetriVmOpenVmm { /* private fields */ }

A running VM that tests can interact with.

Implementations

impl PetriVmOpenVmm

pub fn vtl2_vsock_path(&self) -> Result<&Path>

Get the path to the VTL 2 vsock socket, if the VM is configured with OpenHCL.

pub async fn wait_for_halt(&mut self) -> Result<HaltReason>

Wait for the VM to halt, returning the reason for the halt.

pub async fn wait_for_teardown(self) -> Result<HaltReason>

Wait for the VM to halt, returning the reason for the halt, and cleanly tear down the VM.

pub async fn openhcl_core_dump(&mut self, name: &str, path: &Path) -> Result<()>

Gets a live core dump of the OpenHCL process specified by ‘name’ and writes it to ‘path’

pub async fn openhcl_crash(&mut self, name: &str) -> Result<()>

Crashes the specified openhcl process

pub async fn wait_for_successful_boot_event(&mut self) -> Result<()>

Waits for an event emitted by the firmware about its boot status, and verifies that it is the expected success value.

• Linux Direct guests do not emit a boot event, so this method immediately returns Ok.
• PCAT guests may not emit an event depending on the PCAT version, this method is best effort for them.

pub async fn wait_for_enlightened_shutdown_ready( &mut self, ) -> Result<OneshotReceiver<()>>

Waits for the Hyper-V shutdown IC to be ready, returning a receiver that will be closed when it is no longer ready.

pub async fn send_enlightened_shutdown( &mut self, kind: ShutdownKind, ) -> Result<()>

Instruct the guest to shutdown via the Hyper-V shutdown IC.

pub async fn wait_for_kvp(&mut self) -> Result<Sender<KvpRpc>>

Waits for the KVP IC to be ready, returning a sender that can be used to send requests to it.

pub async fn restart_openhcl( &mut self, new_openhcl: ResolvedArtifact<impl IsOpenhclIgvm>, flags: OpenHclServicingFlags, ) -> Result<()>

Restarts OpenHCL.

pub async fn reset(&mut self) -> Result<()>

Resets the hardware state of the VM, simulating a power cycle.

pub async fn test_inspect_openhcl(&mut self) -> Result<()>

Test that we are able to inspect OpenHCL.

pub async fn wait_for_agent(&mut self) -> Result<PipetteClient>

Wait for a connection from a pipette agent running in the guest. Useful if you’ve rebooted the vm or are otherwise expecting a fresh connection.

pub async fn wait_for_vtl2_ready(&mut self) -> Result<()>

Wait for VTL 2 to report that it is ready to respond to commands. Will fail if the VM is not running OpenHCL.

This should only be necessary if you’re doing something manual. All Petri-provided methods will wait for VTL 2 to be ready automatically.

pub async fn wait_for_vtl2_agent(&mut self) -> Result<PipetteClient>

Wait for a connection from a pipette agent running in VTL 2. Useful if you’ve reset VTL 2 or are otherwise expecting a fresh connection. Will fail if the VM is not running OpenHCL.

pub async fn modify_vtl2_settings( &mut self, settings: &Vtl2Settings, ) -> Result<()>

Modifies OpenHCL VTL2 settings.

pub async fn wait_for_halt_or<T, F: Future<Output = Result<T>>>( &mut self, future: F, ) -> Result<T>

Wrap the provided future in a race with the worker process’s halt notification channel. This is useful for preventing a future from waiting indefinitely if the VM dies for any reason. If the worker process crashes the halt notification channel will return an error, and if the VM halts for any other reason the future will complete with that reason.

Trait Implementations

impl PetriVm for PetriVmOpenVmm

fn wait_for_halt<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<HaltReason>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Wait for the VM to halt, returning the reason for the halt.

fn wait_for_teardown<'async_trait>( self: Box<Self>, ) -> Pin<Box<dyn Future<Output = Result<HaltReason>> + Send + 'async_trait>>

where Self: 'async_trait,

Wait for the VM to halt, returning the reason for the halt, and cleanly tear down the VM.

fn test_inspect_openhcl<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Test that we are able to inspect OpenHCL.

fn wait_for_agent<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<PipetteClient>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Wait for a connection from a pipette agent running in the guest. Useful if you’ve rebooted the vm or are otherwise expecting a fresh connection.

fn wait_for_vtl2_ready<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Wait for VTL 2 to report that it is ready to respond to commands. Will fail if the VM is not running OpenHCL.

fn wait_for_successful_boot_event<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Waits for an event emitted by the firmware about its boot status, and verifies that it is the expected success value.

fn send_enlightened_shutdown<'life0, 'async_trait>( &'life0 mut self, kind: ShutdownKind, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Instruct the guest to shutdown via the Hyper-V shutdown IC.