refactor(vmm): remove test_utils/test_utils

ShadowCurse · ShadowCurse · commit 1bbe0a0de32c · 2024-09-16T16:23:09.000+01:00
Move content of `test_utils/test_utils/mod.rs` into
`test_utils/mod.rs`. This remove the duplication of
module names and makes clippy happy.

Signed-off-by: Egor Lazarchuk &lt;yegorlz@amazon.co.uk&gt;
diff --git a/src/vmm/benches/block_request.rs b/src/vmm/benches/block_request.rs
@@ -11,7 +11,7 @@ use vm_memory::GuestAddress;
 use vmm::devices::virtio::block::virtio::test_utils::RequestDescriptorChain;
 use vmm::devices::virtio::block::virtio::{Request, RequestHeader, VIRTIO_BLK_T_IN};
 use vmm::devices::virtio::test_utils::VirtQueue;
-use vmm::test_utils::test_utils::single_region_mem;
+use vmm::test_utils::single_region_mem;
 
 pub fn block_request_benchmark(c: &mut Criterion) {
     let mem = single_region_mem(2 * 65562);
diff --git a/src/vmm/benches/queue.rs b/src/vmm/benches/queue.rs
@@ -12,7 +12,7 @@ use criterion::{criterion_group, criterion_main, Criterion};
 use vm_memory::GuestAddress;
 use vmm::devices::virtio::queue::{VIRTQ_DESC_F_NEXT, VIRTQ_DESC_F_WRITE};
 use vmm::devices::virtio::test_utils::VirtQueue;
-use vmm::test_utils::test_utils::single_region_mem;
+use vmm::test_utils::single_region_mem;
 
 /// Create one chain with n descriptors
 /// Descriptor buffers will leave at the offset of 2048 bytes
diff --git a/src/vmm/src/acpi/mod.rs b/src/vmm/src/acpi/mod.rs
@@ -186,7 +186,7 @@ pub mod tests {
     use crate::acpi::{AcpiError, AcpiTableWriter};
     use crate::arch::x86_64::layout::{SYSTEM_MEM_SIZE, SYSTEM_MEM_START};
     use crate::builder::tests::default_vmm;
-    use crate::test_utils::test_utils::arch_mem;
+    use crate::test_utils::arch_mem;
 
     struct MockSdt(Vec<u8>);
 
diff --git a/src/vmm/src/arch/aarch64/fdt.rs b/src/vmm/src/arch/aarch64/fdt.rs
@@ -460,7 +460,7 @@ mod tests {
     use crate::arch::aarch64::gic::create_gic;
     use crate::arch::aarch64::layout;
     use crate::device_manager::resources::ResourceAllocator;
-    use crate::test_utils::test_utils::arch_mem;
+    use crate::test_utils::arch_mem;
 
     const LEN: u64 = 4096;
 
diff --git a/src/vmm/src/arch/aarch64/mod.rs b/src/vmm/src/arch/aarch64/mod.rs
@@ -117,7 +117,7 @@ fn get_fdt_addr(mem: &GuestMemoryMmap) -> u64 {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::test_utils::test_utils::arch_mem;
+    use crate::test_utils::arch_mem;
 
     #[test]
     fn test_regions_lt_1024gb() {
diff --git a/src/vmm/src/arch/aarch64/vcpu.rs b/src/vmm/src/arch/aarch64/vcpu.rs
@@ -218,7 +218,7 @@ mod tests {
 
     use super::*;
     use crate::arch::aarch64::layout;
-    use crate::test_utils::test_utils::arch_mem;
+    use crate::test_utils::arch_mem;
 
     #[test]
     fn test_setup_regs() {
diff --git a/src/vmm/src/arch/x86_64/mod.rs b/src/vmm/src/arch/x86_64/mod.rs
@@ -222,7 +222,7 @@ mod tests {
     use linux_loader::loader::bootparam::boot_e820_entry;
 
     use super::*;
-    use crate::test_utils::test_utils::{arch_mem, single_region_mem};
+    use crate::test_utils::{arch_mem, single_region_mem};
 
     #[test]
     fn regions_lt_4gb() {
diff --git a/src/vmm/src/arch/x86_64/mptable.rs b/src/vmm/src/arch/x86_64/mptable.rs
@@ -316,7 +316,7 @@ mod tests {
 
     use super::*;
     use crate::arch::SYSTEM_MEM_START;
-    use crate::test_utils::test_utils::single_region_mem_at;
+    use crate::test_utils::single_region_mem_at;
     use crate::vstate::memory::Bytes;
 
     fn table_entry_size(type_: u8) -> usize {
diff --git a/src/vmm/src/arch/x86_64/regs.rs b/src/vmm/src/arch/x86_64/regs.rs
@@ -243,7 +243,7 @@ mod tests {
     use kvm_ioctls::Kvm;
 
     use super::*;
-    use crate::test_utils::test_utils::single_region_mem;
+    use crate::test_utils::single_region_mem;
     use crate::vstate::memory::{Bytes, GuestAddress, GuestMemoryMmap};
 
     fn read_u64(gm: &GuestMemoryMmap, offset: u64) -> u64 {
diff --git a/src/vmm/src/builder.rs b/src/vmm/src/builder.rs
@@ -1033,7 +1033,7 @@ pub mod tests {
     use crate::devices::virtio::{TYPE_BALLOON, TYPE_BLOCK, TYPE_RNG};
     use crate::mmds::data_store::{Mmds, MmdsVersion};
     use crate::mmds::ns::MmdsNetworkStack;
-    use crate::test_utils::test_utils::{arch_mem, single_region_mem, single_region_mem_at};
+    use crate::test_utils::{arch_mem, single_region_mem, single_region_mem_at};
     use crate::vmm_config::balloon::{BalloonBuilder, BalloonDeviceConfig, BALLOON_DEV_ID};
     use crate::vmm_config::boot_source::DEFAULT_KERNEL_CMDLINE;
     use crate::vmm_config::drive::{BlockBuilder, BlockDeviceConfig};
diff --git a/src/vmm/src/device_manager/legacy.rs b/src/vmm/src/device_manager/legacy.rs
@@ -238,7 +238,7 @@ impl PortIODeviceManager {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::test_utils::test_utils::single_region_mem;
+    use crate::test_utils::single_region_mem;
     use crate::Vm;
 
     #[test]
diff --git a/src/vmm/src/device_manager/mmio.rs b/src/vmm/src/device_manager/mmio.rs
@@ -535,7 +535,7 @@ mod tests {
     use crate::devices::virtio::device::{IrqTrigger, VirtioDevice};
     use crate::devices::virtio::queue::Queue;
     use crate::devices::virtio::ActivateError;
-    use crate::test_utils::test_utils::multi_region_mem;
+    use crate::test_utils::multi_region_mem;
     use crate::vstate::memory::{GuestAddress, GuestMemoryMmap};
     use crate::{builder, Vm};
 
diff --git a/src/vmm/src/devices/virtio/balloon/device.rs b/src/vmm/src/devices/virtio/balloon/device.rs
@@ -637,7 +637,7 @@ pub(crate) mod tests {
     };
     use crate::devices::virtio::queue::{VIRTQ_DESC_F_NEXT, VIRTQ_DESC_F_WRITE};
     use crate::devices::virtio::test_utils::{default_mem, VirtQueue};
-    use crate::test_utils::test_utils::single_region_mem;
+    use crate::test_utils::single_region_mem;
     use crate::vstate::memory::GuestAddress;
 
     impl Balloon {
diff --git a/src/vmm/src/devices/virtio/balloon/util.rs b/src/vmm/src/devices/virtio/balloon/util.rs
@@ -263,7 +263,7 @@ mod tests {
     /// BEGIN PROPERTY BASED TESTING
     use proptest::prelude::*;
 
-    use crate::test_utils::test_utils::single_region_mem;
+    use crate::test_utils::single_region_mem;
 
     #[allow(clippy::let_with_type_underscore)]
     fn random_pfn_u32_max() -> impl Strategy<Value = Vec<u32>> {
diff --git a/src/vmm/src/devices/virtio/block/vhost_user/device.rs b/src/vmm/src/devices/virtio/block/vhost_user/device.rs
@@ -376,7 +376,7 @@ mod tests {
     use super::*;
     use crate::devices::virtio::block::virtio::device::FileEngineType;
     use crate::devices::virtio::mmio::VIRTIO_MMIO_INT_CONFIG;
-    use crate::test_utils::test_utils::create_tmp_socket;
+    use crate::test_utils::create_tmp_socket;
     use crate::vstate::memory::{FileOffset, GuestAddress, GuestMemoryExtension};
 
     #[test]
diff --git a/src/vmm/src/devices/virtio/block/virtio/request.rs b/src/vmm/src/devices/virtio/block/virtio/request.rs
@@ -667,7 +667,7 @@ mod tests {
     use proptest::strategy::{Map, Strategy, TupleUnion};
 
     use crate::devices::virtio::block::virtio::test_utils::RequestDescriptorChain;
-    use crate::test_utils::test_utils::{multi_region_mem, single_region_mem};
+    use crate::test_utils::{multi_region_mem, single_region_mem};
 
     // Implements a "strategy" for producing arbitrary values of RequestType.
     // This can also be generated by a derive macro from `proptest_derive`, but the crate
diff --git a/src/vmm/src/devices/virtio/iovec.rs b/src/vmm/src/devices/virtio/iovec.rs
@@ -393,7 +393,7 @@ mod tests {
     use super::{IoVecBuffer, IoVecBufferMut};
     use crate::devices::virtio::queue::{Queue, VIRTQ_DESC_F_NEXT, VIRTQ_DESC_F_WRITE};
     use crate::devices::virtio::test_utils::VirtQueue;
-    use crate::test_utils::test_utils::multi_region_mem;
+    use crate::test_utils::multi_region_mem;
     use crate::vstate::memory::{Bytes, GuestAddress, GuestMemoryMmap};
 
     impl<'a> From<&'a [u8]> for IoVecBuffer {
diff --git a/src/vmm/src/devices/virtio/mmio.rs b/src/vmm/src/devices/virtio/mmio.rs
@@ -382,7 +382,7 @@ pub(crate) mod tests {
     use crate::devices::virtio::device::IrqTrigger;
     use crate::devices::virtio::device_status::DEVICE_NEEDS_RESET;
     use crate::devices::virtio::ActivateError;
-    use crate::test_utils::test_utils::single_region_mem;
+    use crate::test_utils::single_region_mem;
     use crate::vstate::memory::GuestMemoryMmap;
 
     #[derive(Debug)]
diff --git a/src/vmm/src/devices/virtio/net/device.rs b/src/vmm/src/devices/virtio/net/device.rs
@@ -956,7 +956,7 @@ pub mod tests {
     use crate::dumbo::EthernetFrame;
     use crate::logger::IncMetric;
     use crate::rate_limiter::{BucketUpdate, RateLimiter, TokenBucket, TokenType};
-    use crate::test_utils::test_utils::single_region_mem;
+    use crate::test_utils::single_region_mem;
     use crate::vstate::memory::{Address, GuestMemory};
 
     #[test]
diff --git a/src/vmm/src/devices/virtio/net/event_handler.rs b/src/vmm/src/devices/virtio/net/event_handler.rs
@@ -135,7 +135,7 @@ pub mod tests {
     use crate::devices::virtio::net::test_utils::test::TestHelper;
     use crate::devices::virtio::net::test_utils::NetQueue;
     use crate::devices::virtio::net::{MAX_BUFFER_SIZE, TX_INDEX};
-    use crate::test_utils::test_utils::single_region_mem;
+    use crate::test_utils::single_region_mem;
 
     #[test]
     fn test_event_handler() {
diff --git a/src/vmm/src/devices/virtio/queue.rs b/src/vmm/src/devices/virtio/queue.rs
@@ -1231,7 +1231,7 @@ mod tests {
     pub use super::*;
     use crate::devices::virtio::queue::QueueError::DescIndexOutOfBounds;
     use crate::devices::virtio::test_utils::{default_mem, VirtQueue};
-    use crate::test_utils::test_utils::{multi_region_mem, single_region_mem};
+    use crate::test_utils::{multi_region_mem, single_region_mem};
     use crate::vstate::memory::GuestAddress;
 
     #[test]
diff --git a/src/vmm/src/devices/virtio/test_utils.rs b/src/vmm/src/devices/virtio/test_utils.rs
@@ -11,7 +11,7 @@ use std::sync::atomic::{AtomicUsize, Ordering};
 use utils::u64_to_usize;
 
 use crate::devices::virtio::queue::Queue;
-use crate::test_utils::test_utils::single_region_mem;
+use crate::test_utils::single_region_mem;
 use crate::vstate::memory::{Address, Bytes, GuestAddress, GuestMemoryMmap};
 
 #[macro_export]
@@ -325,7 +325,7 @@ pub(crate) mod test {
     use crate::devices::virtio::net::MAX_BUFFER_SIZE;
     use crate::devices::virtio::queue::{Queue, VIRTQ_DESC_F_NEXT};
     use crate::devices::virtio::test_utils::{VirtQueue, VirtqDesc};
-    use crate::test_utils::test_utils::single_region_mem;
+    use crate::test_utils::single_region_mem;
     use crate::vstate::memory::{Address, GuestAddress, GuestMemoryMmap};
 
     pub fn create_virtio_mem() -> GuestMemoryMmap {
diff --git a/src/vmm/src/devices/virtio/vhost_user.rs b/src/vmm/src/devices/virtio/vhost_user.rs
@@ -465,7 +465,7 @@ mod tests {
     use utils::tempfile::TempFile;
 
     use super::*;
-    use crate::test_utils::test_utils::create_tmp_socket;
+    use crate::test_utils::create_tmp_socket;
     use crate::vstate::memory::{FileOffset, GuestAddress, GuestMemoryExtension};
 
     #[test]
diff --git a/src/vmm/src/devices/virtio/vsock/event_handler.rs b/src/vmm/src/devices/virtio/vsock/event_handler.rs
@@ -225,7 +225,7 @@ mod tests {
     use super::*;
     use crate::devices::virtio::vsock::packet::VSOCK_PKT_HDR_SIZE;
     use crate::devices::virtio::vsock::test_utils::{EventHandlerContext, TestContext};
-    use crate::test_utils::test_utils::multi_region_mem;
+    use crate::test_utils::multi_region_mem;
     use crate::vstate::memory::Bytes;
 
     #[test]
diff --git a/src/vmm/src/devices/virtio/vsock/test_utils.rs b/src/vmm/src/devices/virtio/vsock/test_utils.rs
@@ -17,7 +17,7 @@ use crate::devices::virtio::vsock::packet::{VsockPacket, VSOCK_PKT_HDR_SIZE};
 use crate::devices::virtio::vsock::{
     Vsock, VsockBackend, VsockChannel, VsockEpollListener, VsockError,
 };
-use crate::test_utils::test_utils::single_region_mem;
+use crate::test_utils::single_region_mem;
 use crate::vstate::memory::{GuestAddress, GuestMemoryMmap};
 
 #[derive(Debug)]
diff --git a/src/vmm/src/test_utils/mod.rs b/src/vmm/src/test_utils/mod.rs
@@ -3,5 +3,137 @@
 
 #![allow(missing_docs)]
 
+use std::sync::{Arc, Mutex};
+
+use utils::tempdir::TempDir;
+use vm_memory::GuestAddress;
+
+use crate::builder::build_microvm_for_boot;
+use crate::resources::VmResources;
+use crate::seccomp_filters::get_empty_filters;
+use crate::test_utils::mock_resources::{MockBootSourceConfig, MockVmConfig, MockVmResources};
+use crate::vmm_config::boot_source::BootSourceConfig;
+use crate::vmm_config::instance_info::InstanceInfo;
+use crate::vmm_config::machine_config::HugePageConfig;
+use crate::vstate::memory::{GuestMemoryExtension, GuestMemoryMmap};
+use crate::{EventManager, Vmm};
+
 pub mod mock_resources;
-pub mod test_utils;
+
+/// Creates a [`GuestMemoryMmap`] with a single region of the given size starting at guest
+/// physical address 0 and without dirty tracking.
+pub fn single_region_mem(region_size: usize) -> GuestMemoryMmap {
+    single_region_mem_at(0, region_size)
+}
+
+/// Creates a [`GuestMemoryMmap`] with a single region of the given size starting at the given
+/// guest physical address `at` and without dirty tracking.
+pub fn single_region_mem_at(at: u64, size: usize) -> GuestMemoryMmap {
+    multi_region_mem(&[(GuestAddress(at), size)])
+}
+
+/// Creates a [`GuestMemoryMmap`] with multiple regions and without dirty page tracking.
+pub fn multi_region_mem(regions: &[(GuestAddress, usize)]) -> GuestMemoryMmap {
+    GuestMemoryMmap::from_raw_regions(regions, false, HugePageConfig::None)
+        .expect("Cannot initialize memory")
+}
+
+/// Creates a [`GuestMemoryMmap`] of the given size with the contained regions laid out in
+/// accordance with the requirements of the architecture on which the tests are being run.
+pub fn arch_mem(mem_size_bytes: usize) -> GuestMemoryMmap {
+    multi_region_mem(&crate::arch::arch_memory_regions(mem_size_bytes))
+}
+
+pub fn create_vmm(
+    _kernel_image: Option<&str>,
+    is_diff: bool,
+    boot_microvm: bool,
+) -> (Arc<Mutex<Vmm>>, EventManager) {
+    let mut event_manager = EventManager::new().unwrap();
+    let empty_seccomp_filters = get_empty_filters();
+
+    let boot_source_cfg = MockBootSourceConfig::new().with_default_boot_args();
+    #[cfg(target_arch = "aarch64")]
+    let boot_source_cfg: BootSourceConfig = boot_source_cfg.into();
+    #[cfg(target_arch = "x86_64")]
+    let boot_source_cfg: BootSourceConfig = match _kernel_image {
+        Some(kernel) => boot_source_cfg.with_kernel(kernel).into(),
+        None => boot_source_cfg.into(),
+    };
+    let mock_vm_res = MockVmResources::new().with_boot_source(boot_source_cfg);
+    let resources: VmResources = if is_diff {
+        mock_vm_res
+            .with_vm_config(MockVmConfig::new().with_dirty_page_tracking().into())
+            .into()
+    } else {
+        mock_vm_res.into()
+    };
+
+    let vmm = build_microvm_for_boot(
+        &InstanceInfo::default(),
+        &resources,
+        &mut event_manager,
+        &empty_seccomp_filters,
+    )
+    .unwrap();
+
+    if boot_microvm {
+        vmm.lock().unwrap().resume_vm().unwrap();
+    }
+
+    (vmm, event_manager)
+}
+
+pub fn default_vmm(kernel_image: Option<&str>) -> (Arc<Mutex<Vmm>>, EventManager) {
+    create_vmm(kernel_image, false, true)
+}
+
+pub fn default_vmm_no_boot(kernel_image: Option<&str>) -> (Arc<Mutex<Vmm>>, EventManager) {
+    create_vmm(kernel_image, false, false)
+}
+
+#[cfg(target_arch = "x86_64")]
+pub fn dirty_tracking_vmm(kernel_image: Option<&str>) -> (Arc<Mutex<Vmm>>, EventManager) {
+    create_vmm(kernel_image, true, true)
+}
+
+#[allow(clippy::undocumented_unsafe_blocks)]
+#[allow(clippy::cast_possible_truncation)]
+pub fn create_tmp_socket() -> (TempDir, String) {
+    let tmp_dir = TempDir::new().unwrap();
+    let tmp_dir_path_str = tmp_dir.as_path().to_str().unwrap();
+    let tmp_socket_path = format!("{tmp_dir_path_str}/tmp_socket");
+
+    unsafe {
+        let socketfd = libc::socket(libc::AF_UNIX, libc::SOCK_STREAM, 0);
+        if socketfd < 0 {
+            panic!("Cannot create socket");
+        }
+        let mut socket_addr = libc::sockaddr_un {
+            sun_family: libc::AF_UNIX as u16,
+            sun_path: [0; 108],
+        };
+
+        std::ptr::copy(
+            tmp_socket_path.as_ptr().cast(),
+            socket_addr.sun_path.as_mut_ptr(),
+            tmp_socket_path.as_bytes().len(),
+        );
+
+        let bind = libc::bind(
+            socketfd,
+            (&socket_addr as *const libc::sockaddr_un).cast(),
+            std::mem::size_of::<libc::sockaddr_un>() as u32,
+        );
+        if bind < 0 {
+            panic!("Cannot bind socket");
+        }
+
+        let listen = libc::listen(socketfd, 1);
+        if listen < 0 {
+            panic!("Cannot listen on socket");
+        }
+    }
+
+    (tmp_dir, tmp_socket_path)
+}
diff --git a/src/vmm/src/test_utils/test_utils/mod.rs b/src/vmm/src/test_utils/test_utils/mod.rs
diff --git a/src/vmm/src/vstate/vm.rs b/src/vmm/src/vstate/vm.rs
diff --git a/src/vmm/tests/integration_tests.rs b/src/vmm/tests/integration_tests.rs
