hypervisor: extract some functions out of image module

Author: delan

monitor/hypervisor/src/impl_libvirt.rs

@@ -3,13 +3,14 @@ use std::{
     fs::{create_dir_all, rename},
     net::Ipv4Addr,
     path::Path,
+    time::Duration,
 };
 
-use cmd_lib::{run_fun, spawn_with_output};
-use jane_eyre::eyre;
+use cmd_lib::{run_cmd, run_fun, spawn_with_output};
+use jane_eyre::eyre::{self, bail};
 use settings::TOML;
 use shell::log_output_as_trace;
-use tracing::debug;
+use tracing::{debug, info};
 
 pub fn list_template_guests() -> eyre::Result<Vec<String>> {
     // Output is not filtered by prefix, so we must filter it ourselves.
@@ -71,6 +72,43 @@ pub fn get_ipv4_address(guest_name: &str) -> Option<Ipv4Addr> {
         .or_else(|| virsh_domifaddr(guest_name, "agent"))
 }
 
+pub fn start_guest(guest_name: &str) -> eyre::Result<()> {
+    info!(?guest_name, "Starting guest");
+    run_cmd!(virsh start -- $guest_name)?;
+
+    Ok(())
+}
+
+pub fn wait_for_guest(guest_name: &str, timeout: Duration) -> eyre::Result<()> {
+    let timeout = timeout.as_secs();
+    info!("Waiting for guest to shut down (max {timeout} seconds)");
+    if !run_cmd!(time virsh event --timeout $timeout -- $guest_name lifecycle).is_ok() {
+        bail!("`virsh event` failed or timed out!");
+    }
+    for _ in 0..100 {
+        if run_fun!(virsh domstate -- $guest_name)?.trim_ascii() == "shut off" {
+            return Ok(());
+        }
+    }
+
+    bail!("Guest did not shut down as expected")
+}
+
+pub fn rename_guest(old_guest_name: &str, new_guest_name: &str) -> eyre::Result<()> {
+    run_cmd!(virsh domrename -- $old_guest_name $new_guest_name)?;
+    Ok(())
+}
+
+pub fn delete_guest(guest_name: &str) -> eyre::Result<()> {
+    if run_cmd!(virsh domstate -- $guest_name).is_ok() {
+        // FIXME make this idempotent in a less noisy way?
+        let _ = run_cmd!(virsh destroy -- $guest_name);
+        run_cmd!(virsh undefine --nvram -- $guest_name)?;
+    }
+
+    Ok(())
+}
+
 fn virsh_domifaddr(guest_name: &str, source: &str) -> Option<Ipv4Addr> {
     let output = run_fun!(virsh domifaddr --source $source $guest_name 2> /dev/null);
     match output {

monitor/hypervisor/src/lib.rs

@@ -1,7 +1,9 @@
+pub mod libvirt;
+
 #[cfg_attr(target_os = "linux", path = "impl_libvirt.rs")]
 mod platform;
 
-use std::{net::Ipv4Addr, path::Path};
+use std::{net::Ipv4Addr, path::Path, time::Duration};
 
 use jane_eyre::eyre;
 
@@ -28,3 +30,19 @@ pub fn take_screenshot(guest_name: &str, output_path: &Path) -> eyre::Result<()>
 pub fn get_ipv4_address(guest_name: &str) -> Option<Ipv4Addr> {
     self::platform::get_ipv4_address(guest_name)
 }
+
+pub fn start_guest(guest_name: &str) -> eyre::Result<()> {
+    self::platform::start_guest(guest_name)
+}
+
+pub fn wait_for_guest(guest_name: &str, timeout: Duration) -> eyre::Result<()> {
+    self::platform::wait_for_guest(guest_name, timeout)
+}
+
+pub fn rename_guest(old_guest_name: &str, new_guest_name: &str) -> eyre::Result<()> {
+    self::platform::rename_guest(old_guest_name, new_guest_name)
+}
+
+pub fn delete_guest(guest_name: &str) -> eyre::Result<()> {
+    self::platform::delete_guest(guest_name)
+}

monitor/hypervisor/src/libvirt.rs

@@ -0,0 +1,40 @@
+use std::{ffi::OsStr, path::Path};
+
+use cmd_lib::run_cmd;
+use jane_eyre::eyre;
+
+pub fn define_libvirt_guest(
+    profile_name: &str,
+    guest_name: &str,
+    guest_xml_path: impl AsRef<Path>,
+    args: &[&dyn AsRef<OsStr>],
+    cdrom_images: &[CdromImage],
+) -> eyre::Result<()> {
+    // This dance is needed to randomise the MAC address of the guest.
+    let guest_xml_path = guest_xml_path.as_ref();
+    let args = args.iter().map(|x| x.as_ref()).collect::<Vec<_>>();
+    run_cmd!(virsh define -- $guest_xml_path)?;
+    run_cmd!(virt-clone --preserve-data --check path_in_use=off -o $profile_name.init -n $guest_name $[args])?;
+    libvirt_change_media(guest_name, cdrom_images)?;
+    run_cmd!(virsh undefine -- $profile_name.init)?;
+
+    Ok(())
+}
+
+pub fn libvirt_change_media(guest_name: &str, cdrom_images: &[CdromImage]) -> eyre::Result<()> {
+    for CdromImage { target_dev, path } in cdrom_images {
+        run_cmd!(virsh change-media -- $guest_name $target_dev $path)?;
+    }
+
+    Ok(())
+}
+
+pub struct CdromImage<'path> {
+    pub target_dev: &'static str,
+    pub path: &'path str,
+}
+impl<'path> CdromImage<'path> {
+    pub fn new(target_dev: &'static str, path: &'path str) -> Self {
+        Self { target_dev, path }
+    }
+}

monitor/src/image.rs

@@ -5,7 +5,6 @@ pub mod windows10;
 use core::str;
 use std::{
     collections::{BTreeMap, BTreeSet},
-    ffi::OsStr,
     fs::{create_dir_all, read_dir, remove_file, set_permissions, File},
     io::{Seek, Write},
     mem::take,
@@ -18,9 +17,9 @@ use std::{
 
 use bytesize::ByteSize;
 use chrono::{SecondsFormat, Utc};
-use cmd_lib::{run_cmd, run_fun, spawn_with_output};
-use hypervisor::{list_rebuild_guests, list_template_guests};
-use jane_eyre::eyre::{self, bail, OptionExt};
+use cmd_lib::spawn_with_output;
+use hypervisor::{delete_guest, list_rebuild_guests, list_template_guests};
+use jane_eyre::eyre::{self, OptionExt};
 use settings::{
     profile::{parse_rebuild_guest_name, parse_template_guest_name, Profile},
     TOML,
@@ -119,7 +118,7 @@ impl Rebuilds {
             .collect::<BTreeSet<_>>();
         for rebuild_guest_name in list_rebuild_guests()? {
             if !current_known_rebuild_guest_names.contains(&rebuild_guest_name) {
-                undefine_libvirt_guest(&rebuild_guest_name)?;
+                delete_guest(&rebuild_guest_name)?;
                 let (profile_key, snapshot_name) =
                     match parse_rebuild_guest_name(&rebuild_guest_name) {
                         Ok(result) => result,
@@ -344,7 +343,7 @@ pub(self) fn prune_templates(profile: &Profile) -> eyre::Result<()> {
                 snapshot_names.push(snapshot_name.to_owned());
             }
         } else {
-            undefine_libvirt_guest(&template_guest_name)?;
+            delete_guest(&template_guest_name)?;
         }
     }
     snapshot_names.sort();
@@ -423,78 +422,3 @@ pub(self) fn create_disk_image<'icp>(
 
     Ok(base_image_path)
 }
-
-pub(self) fn define_libvirt_guest(
-    profile_name: &str,
-    guest_name: &str,
-    guest_xml_path: impl AsRef<Path>,
-    args: &[&dyn AsRef<OsStr>],
-    cdrom_images: &[CdromImage],
-) -> eyre::Result<()> {
-    // This dance is needed to randomise the MAC address of the guest.
-    let guest_xml_path = guest_xml_path.as_ref();
-    let args = args.iter().map(|x| x.as_ref()).collect::<Vec<_>>();
-    run_cmd!(virsh define -- $guest_xml_path)?;
-    run_cmd!(virt-clone --preserve-data --check path_in_use=off -o $profile_name.init -n $guest_name $[args])?;
-    libvirt_change_media(guest_name, cdrom_images)?;
-    run_cmd!(virsh undefine -- $profile_name.init)?;
-
-    Ok(())
-}
-
-pub(self) fn libvirt_change_media(
-    guest_name: &str,
-    cdrom_images: &[CdromImage],
-) -> eyre::Result<()> {
-    for CdromImage { target_dev, path } in cdrom_images {
-        run_cmd!(virsh change-media -- $guest_name $target_dev $path)?;
-    }
-
-    Ok(())
-}
-
-pub(self) fn undefine_libvirt_guest(guest_name: &str) -> eyre::Result<()> {
-    if run_cmd!(virsh domstate -- $guest_name).is_ok() {
-        // FIXME make this idempotent in a less noisy way?
-        let _ = run_cmd!(virsh destroy -- $guest_name);
-        run_cmd!(virsh undefine --nvram -- $guest_name)?;
-    }
-
-    Ok(())
-}
-
-pub struct CdromImage<'path> {
-    pub target_dev: &'static str,
-    pub path: &'path str,
-}
-impl<'path> CdromImage<'path> {
-    pub fn new(target_dev: &'static str, path: &'path str) -> Self {
-        Self { target_dev, path }
-    }
-}
-pub fn start_libvirt_guest(guest_name: &str) -> eyre::Result<()> {
-    info!(?guest_name, "Starting guest");
-    run_cmd!(virsh start -- $guest_name)?;
-
-    Ok(())
-}
-
-pub(self) fn wait_for_guest(guest_name: &str, timeout: Duration) -> eyre::Result<()> {
-    let timeout = timeout.as_secs();
-    info!("Waiting for guest to shut down (max {timeout} seconds)");
-    if !run_cmd!(time virsh event --timeout $timeout -- $guest_name lifecycle).is_ok() {
-        bail!("`virsh event` failed or timed out!");
-    }
-    for _ in 0..100 {
-        if run_fun!(virsh domstate -- $guest_name)?.trim_ascii() == "shut off" {
-            return Ok(());
-        }
-    }
-
-    bail!("Guest did not shut down as expected")
-}
-
-pub(self) fn rename_guest(old_guest_name: &str, new_guest_name: &str) -> eyre::Result<()> {
-    run_cmd!(virsh domrename -- $old_guest_name $new_guest_name)?;
-    Ok(())
-}

monitor/src/image/macos13.rs

@@ -7,6 +7,12 @@ use std::time::Duration;
 use bytesize::ByteSize;
 use cmd_lib::run_cmd;
 use cmd_lib::spawn_with_output;
+use hypervisor::delete_guest;
+use hypervisor::libvirt::libvirt_change_media;
+use hypervisor::libvirt::CdromImage;
+use hypervisor::rename_guest;
+use hypervisor::start_guest;
+use hypervisor::wait_for_guest;
 use jane_eyre::eyre;
 use jane_eyre::eyre::OptionExt;
 use settings::profile::Profile;
@@ -19,17 +25,11 @@ use crate::data::get_profile_data_path;
 use crate::image::create_runner_images_dir;
 use crate::image::create_template_or_rebuild_images_dir;
 use crate::image::delete_template_or_rebuild_image_file;
-use crate::image::libvirt_change_media;
-use crate::image::rename_guest;
-use crate::image::undefine_libvirt_guest;
-use crate::image::CdromImage;
 use crate::image::Image;
 use crate::policy::runner_image_path;
 use crate::policy::template_or_rebuild_image_path;
 
 use super::create_disk_image;
-use super::start_libvirt_guest;
-use super::wait_for_guest;
 
 pub struct Macos13 {
     base_image_size: ByteSize,
@@ -99,7 +99,7 @@ pub(super) fn rebuild(
     let ovmf_vars_path =
         format!("/var/lib/libvirt/images/OSX-KVM/OVMF_VARS.{snapshot_path_slug}.fd");
     copy(ovmf_vars_clean_path, ovmf_vars_path)?;
-    start_libvirt_guest(rebuild_guest_name)?;
+    start_guest(rebuild_guest_name)?;
     wait_for_guest(rebuild_guest_name, wait_duration)?;
 
     let template_guest_name = &profile.template_guest_name(snapshot_name);
@@ -131,7 +131,7 @@ fn define_base_guest(
 }
 
 pub(super) fn delete_template(profile: &Profile, snapshot_name: &str) -> eyre::Result<()> {
-    undefine_libvirt_guest(&profile.template_guest_name(snapshot_name))?;
+    delete_guest(&profile.template_guest_name(snapshot_name))?;
     delete_template_or_rebuild_image_file(profile, &format!("base.img@{snapshot_name}"));
     Ok(())
 }

monitor/src/image/ubuntu2204.rs

@@ -6,6 +6,12 @@ use std::time::Duration;
 use bytesize::ByteSize;
 use cmd_lib::run_cmd;
 use cmd_lib::spawn_with_output;
+use hypervisor::delete_guest;
+use hypervisor::libvirt::define_libvirt_guest;
+use hypervisor::libvirt::CdromImage;
+use hypervisor::rename_guest;
+use hypervisor::start_guest;
+use hypervisor::wait_for_guest;
 use jane_eyre::eyre;
 use settings::profile::Profile;
 use shell::atomic_symlink;
@@ -19,18 +25,12 @@ use crate::data::get_profile_data_path;
 use crate::image::create_runner_images_dir;
 use crate::image::create_template_or_rebuild_images_dir;
 use crate::image::delete_template_or_rebuild_image_file;
-use crate::image::rename_guest;
-use crate::image::undefine_libvirt_guest;
 use crate::image::Image;
 use crate::policy::runner_image_path;
 use crate::policy::template_or_rebuild_image_path;
 use crate::IMAGE_DEPS_DIR;
 
 use super::create_disk_image;
-use super::define_libvirt_guest;
-use super::start_libvirt_guest;
-use super::wait_for_guest;
-use super::CdromImage;
 
 pub struct Ubuntu2204 {
     base_image_size: ByteSize,
@@ -107,7 +107,7 @@ pub(super) fn rebuild(
         &base_image_path,
         &[CdromImage::new("sda", config_iso_path)],
     )?;
-    start_libvirt_guest(rebuild_guest_name)?;
+    start_guest(rebuild_guest_name)?;
     wait_for_guest(rebuild_guest_name, wait_duration)?;
 
     let template_guest_name = &profile.template_guest_name(snapshot_name);
@@ -139,7 +139,7 @@ fn define_base_guest(
 }
 
 pub(super) fn delete_template(profile: &Profile, snapshot_name: &str) -> eyre::Result<()> {
-    undefine_libvirt_guest(&profile.template_guest_name(snapshot_name))?;
+    delete_guest(&profile.template_guest_name(snapshot_name))?;
     delete_template_or_rebuild_image_file(profile, &format!("config.iso@{snapshot_name}"));
     delete_template_or_rebuild_image_file(profile, &format!("base.img@{snapshot_name}"));
     Ok(())