Intruduce an E2E testing framework

Add a tests directory containing an E2E testing framework.
The tests are E2E in the sense that they use the public API of libkrun to
start a VM and run a test program in the guest.
Note that currently this is limited that there are no userspace program or
libraries (not even libc) in the guest apart from `guest-agent`, which is
part of the testing framework.

`guest-agent` is a statically linked Rust executable, that executes the guest
part of each test.

In the future this can be extended to run tests with specific images and allow
the use of system libraries by the test program.

Signed-off-by: Matej Hrica <[email protected]>

Author: mtjhrc

Cargo.lock

@@ -1,5 +1,5 @@
 [workspace]
-members = [ "krun-sys","src/libkrun"]
+members = ["krun-sys", "src/libkrun"]
 resolver = "2"
 
 [profile.dev]
@@ -8,3 +8,4 @@ resolver = "2"
 [profile.release]
 #panic = "abort"
 lto = true
+debug = true

Cargo.toml

@@ -74,7 +74,7 @@ ifeq ($(PREFIX),)
     PREFIX := /usr/local
 endif
 
-.PHONY: install clean
+.PHONY: install clean $(LIBRARY_RELEASE_$(OS))
 
 all: $(LIBRARY_RELEASE_$(OS)) libkrun.pc
 

Makefile

@@ -8,7 +8,7 @@ use polly::event_manager::{EventManager, Subscriber};
 use utils::epoll::{EpollEvent, EventSet};
 use utils::tempfile::TempFile;
 
-/// Create a default Block instance to be used in tests.
+/// Create a default Block instance to be used in test_cases.
 pub fn default_block() -> Block {
     // Create backing file.
     let f = TempFile::new().unwrap();
@@ -17,7 +17,7 @@ pub fn default_block() -> Block {
     default_block_with_path(f.as_path().to_str().unwrap().to_string())
 }
 
-/// Create a default Block instance using file at the specified path to be used in tests.
+/// Create a default Block instance using file at the specified path to be used in test_cases.
 pub fn default_block_with_path(path: String) -> Block {
     let id = "test".to_string();
     // The default block device is read-write and non-root.

src/devices/src/virtio/block/test_utils.rs

@@ -859,9 +859,12 @@ pub unsafe extern "C" fn krun_set_exec(
             }
         }
     } else {
-        env::vars()
+        let env = env::vars()
             .map(|(key, value)| format!(" {key}=\"{value}\""))
-            .collect()
+            .take(45)
+            .collect();
+        eprintln!("env is {env}");
+        env
     };
 
     match CTX_MAP.lock().unwrap().entry(ctx_id) {

src/libkrun/src/lib.rs

@@ -1,7 +1,7 @@
 /*
  * automatically generated by rust-bindgen
  * $ bindgen /usr/include/stdio.h \
- *       --no-layout-tests \
+ *       --no-layout-test_cases \
  *       --allowlist-function vsnprintf \
  *       -- \
  *       -target <target>

src/rutabaga_gfx/src/generated/virgl_debug_callback_bindings.rs

@@ -227,8 +227,8 @@ impl RutabagaGralloc {
 
         #[cfg(feature = "minigbm")]
         {
-            // crosvm integration tests build with the "wl-dmabuf" feature, which translates in
-            // rutabaga to the "minigbm" feature.  These tests run on hosts where a rendernode is
+            // crosvm integration test_cases build with the "wl-dmabuf" feature, which translates in
+            // rutabaga to the "minigbm" feature.  These test_cases run on hosts where a rendernode is
             // not present, and minigbm can not be initialized.
             //
             // Thus, to keep kokoro happy, allow minigbm initialization to fail silently for now.

src/rutabaga_gfx/src/rutabaga_gralloc/gralloc.rs

@@ -1381,7 +1381,7 @@ impl Vcpu {
     }
 
     #[cfg(test)]
-    // In tests the main/vmm thread exits without 'exit()'ing the whole process.
+    // In test_cases the main/vmm thread exits without 'exit()'ing the whole process.
     // All channels get closed on the other side while this Vcpu thread is still running.
     // This Vcpu thread should just do a clean finish without reporting back to the main thread.
     fn exit(&mut self, _: u8) -> StateMachine<Self> {
@@ -1439,7 +1439,7 @@ pub struct VcpuHandle {
     event_sender: Sender<VcpuEvent>,
     response_receiver: Receiver<VcpuResponse>,
     // Rust JoinHandles have to be wrapped in Option if you ever plan on 'join()'ing them.
-    // We want to be able to join these threads in tests.
+    // We want to be able to join these threads in test_cases.
     vcpu_thread: Option<thread::JoinHandle<()>>,
 }
 
@@ -1492,7 +1492,7 @@ mod tests {
 
     use utils::signal::validate_signal_num;
 
-    // In tests we need to close any pending Vcpu threads on test completion.
+    // In test_cases we need to close any pending Vcpu threads on test completion.
     impl Drop for VcpuHandle {
         fn drop(&mut self) {
             // Make sure the Vcpu is out of KVM_RUN.
@@ -1505,7 +1505,7 @@ mod tests {
         }
     }
 
-    // Auxiliary function being used throughout the tests.
+    // Auxiliary function being used throughout the test_cases.
     fn setup_vcpu(mem_size: usize) -> (Vm, Vcpu, GuestMemoryMmap) {
         let kvm = KvmContext::new().unwrap();
         let gm = GuestMemoryMmap::from_ranges(&[(GuestAddress(0), mem_size)]).unwrap();

src/vmm/src/linux/vstate.rs

@@ -632,7 +632,7 @@ mod tests {
 
     use utils::signal::validate_signal_num;
 
-    // In tests we need to close any pending Vcpu threads on test completion.
+    // In test_cases we need to close any pending Vcpu threads on test completion.
     impl Drop for VcpuHandle {
         fn drop(&mut self) {
             // Make sure the Vcpu is out of KVM_RUN.
@@ -645,7 +645,7 @@ mod tests {
         }
     }
 
-    // Auxiliary function being used throughout the tests.
+    // Auxiliary function being used throughout the test_cases.
     fn setup_vcpu(mem_size: usize) -> (Vm, Vcpu, GuestMemoryMmap) {
         let kvm = KvmContext::new().unwrap();
         let gm = GuestMemoryMmap::from_ranges(&[(GuestAddress(0), mem_size)]).unwrap();

src/vmm/src/macos/vstate.rs

@@ -42,7 +42,7 @@ extern "C" fn sigsys_handler(num: c_int, info: *mut siginfo_t, _unused: *mut c_v
         syscall
     );
     // Safe because we're terminating the process anyway. We don't actually do anything when
-    // running unit tests.
+    // running unit test_cases.
     #[cfg(not(test))]
     unsafe {
         _exit(i32::from(super::FC_EXIT_CODE_BAD_SYSCALL))
@@ -69,7 +69,7 @@ extern "C" fn sigbus_sigsegv_handler(num: c_int, info: *mut siginfo_t, _unused:
     );
 
     // Safe because we're terminating the process anyway. We don't actually do anything when
-    // running unit tests.
+    // running unit test_cases.
     #[cfg(not(test))]
     unsafe {
         _exit(i32::from(match si_signo {