handle testing of log outputs.

Author: francis-starlab

mythril/Cargo.lock

@@ -29,6 +29,9 @@ spin = "0.5"
 ux = { version = "0.1.3", default-features = false }
 managed = { version = "0.8.0", features = ["map", "alloc"], default-features = false }
 
+[dev-dependencies]
+testing_logger = "0.1.1"
+
 [dependencies.arrayvec]
 version = "0.5.2"
 default-features = false

mythril/Cargo.toml

@@ -643,6 +643,10 @@ impl From<IoRedTblEntry> for u64 {
 
 #[cfg(test)]
 mod test {
+
+    use log::Level;
+    extern crate testing_logger;
+
     use super::*;
 
     fn get_ioapic(buf: *mut u8) -> Result<IoApic> {
@@ -674,17 +678,22 @@ mod test {
 
     #[test]
     fn ioredtblentry_invalid_trigger_mode() {
+        testing_logger::setup();
         // ExtINT is invalid for level trigger mode.
         let invalid_for_level = 0x0f000000_00008700;
         let err = Error::InvalidValue;
-        //     (
-        //     "The delivery mode `0b111` is invalid for level trigger mode"
-        //         .to_string(),
-        // );
         assert_eq!(
             IoRedTblEntry::try_from(invalid_for_level).unwrap_err(),
             err
         );
+        testing_logger::validate(|captured_logs| {
+            assert_eq!(captured_logs.len(), 1);
+            assert_eq!(
+                captured_logs[0].body,
+                "The delivery mode `0b111` is invalid for level trigger mode"
+            );
+            assert_eq!(captured_logs[0].level, Level::Error);
+        })
     }
 
     #[test]
@@ -700,16 +709,23 @@ mod test {
     fn ioredtblentry_invalid_dest() {
         // Destination is a full byte but a physical destination mode
         // is used.
+        testing_logger::setup();
         let invalid_dest = 0xff000000_0000_0000;
         let err = Error::InvalidValue;
-        // (
-        // "Invalid Physical APIC ID destination: 0xff".to_string(),
-        // );
         assert_eq!(err, IoRedTblEntry::try_from(invalid_dest).unwrap_err());
+        testing_logger::validate(|captured_logs| {
+            assert_eq!(captured_logs.len(), 1);
+            assert_eq!(
+                captured_logs[0].body,
+                "Invalid Physical APIC ID destination: 0xff"
+            );
+            assert_eq!(captured_logs[0].level, Level::Error);
+        })
     }
 
     #[test]
     fn ioredtblentry_write_ro_bit() {
+        testing_logger::setup();
         let mut buf: [u8; 24] = [
             0x00,
             0x00,
@@ -741,11 +757,16 @@ mod test {
         let entry = IoRedTblEntry::try_from(bits).unwrap();
 
         let err = Error::InvalidValue;
-        //     (
-        //     "Read-only IO Redirect Table Entry bits set: 0x1000".to_string(),
-        // );
         // The delivery status is set, which should be read-only.
         assert_eq!(err, ioapic.write_ioredtbl(0, entry).unwrap_err());
+        testing_logger::validate(|captured_logs| {
+            assert_eq!(captured_logs.len(), 1);
+            assert_eq!(
+                captured_logs[0].body,
+                "Read-only IO Redirect Table Entry bits set: 0x1000"
+            );
+            assert_eq!(captured_logs[0].level, Level::Error);
+        })
     }
 
     #[test]

mythril/src/ioapic.rs

@@ -171,7 +171,7 @@ impl VCpu {
     /// Begin execution in the guest context for this core
     pub fn launch(&mut self) -> Result<!> {
         let rflags = unsafe { vmlaunch_wrapper() };
-        error::check_vm_instruction(rflags, ||error!("Failed to launch vm"))?;
+        error::check_vm_instruction(rflags, || error!("Failed to launch vm"))?;
 
         unreachable!()
     }

mythril/src/vcpu.rs

@@ -333,10 +333,9 @@ fn vmcs_write(field: VmcsField, value: u64) -> Result<()> {
         rflags
     };
 
-    error::check_vm_instruction(
-        rflags,
-        ||error!("Failed to write 0x{:x} to field {:?}", value, field),
-    )
+    error::check_vm_instruction(rflags, || {
+        error!("Failed to write 0x{:x} to field {:?}", value, field)
+    })
 }
 
 fn vmcs_read(field: VmcsField) -> Result<u64> {
@@ -369,7 +368,7 @@ fn vmcs_activate(vmcs: &mut Vmcs, _vmx: &vmx::Vmx) -> Result<()> {
         rflags
     };
 
-    error::check_vm_instruction(rflags, ||error!("Failed to activate VMCS"))
+    error::check_vm_instruction(rflags, || error!("Failed to activate VMCS"))
 }
 
 fn vmcs_clear(vmcs_page: &mut Raw4kPage) -> Result<()> {
@@ -382,7 +381,7 @@ fn vmcs_clear(vmcs_page: &mut Raw4kPage) -> Result<()> {
                   : "volatile");
         rflags
     };
-    error::check_vm_instruction(rflags, ||error!("Failed to clear VMCS"))
+    error::check_vm_instruction(rflags, || error!("Failed to clear VMCS"))
 }
 
 pub struct Vmcs {

mythril/src/vmcs.rs

@@ -54,7 +54,7 @@ pub extern "C" fn vmexit_handler(state: *mut GuestCpuState) {
 
 #[no_mangle]
 pub extern "C" fn vmresume_failure_handler(rflags: u64) {
-    error::check_vm_instruction(rflags,|| error!("Failed to vmresume"))
+    error::check_vm_instruction(rflags, || error!("Failed to vmresume"))
         .expect("vmresume failed");
 }
 

mythril/src/vmexit.rs

@@ -52,7 +52,7 @@ impl Vmx {
             rflags
         };
 
-        error::check_vm_instruction(rflags, ||error!("Failed to enable vmx"))?;
+        error::check_vm_instruction(rflags, || error!("Failed to enable vmx"))?;
         Ok(Vmx {
             _vmxon_region: vmxon_region,
         })
@@ -70,7 +70,7 @@ impl Vmx {
             rflags
         };
 
-        error::check_vm_instruction(rflags, ||error!("Failed to disable vmx"))
+        error::check_vm_instruction(rflags, || error!("Failed to disable vmx"))
     }
 
     pub fn revision() -> u32 {
@@ -90,7 +90,9 @@ impl Vmx {
                       : "m"(val), "r"(t));
             rflags
         };
-        error::check_vm_instruction(rflags, ||error!("Failed to execute invept"))
+        error::check_vm_instruction(rflags, || {
+            error!("Failed to execute invept")
+        })
     }
 
     pub fn invvpid(&self, mode: InvVpidMode) -> Result<()> {
@@ -112,7 +114,9 @@ impl Vmx {
                       : "m"(val), "r"(t));
             rflags
         };
-        error::check_vm_instruction(rflags, ||error!("Failed to execute invvpid"))
+        error::check_vm_instruction(rflags, || {
+            error!("Failed to execute invvpid")
+        })
     }
 }