uefi-test-runner: Added tests for EFI Shell cur_dir functions

This commit includes tests for the following EFI Shell Protocol functions:
get_cur_dir() and set_cur_dir().

Author: RenTrieu

uefi-test-runner/src/proto/shell.rs

@@ -1,13 +1,109 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 
-use uefi::boot;
+use uefi::boot::ScopedProtocol;
 use uefi::proto::shell::Shell;
+use uefi::{boot, cstr16};
+use uefi_raw::Status;
+
+/// Test `get_cur_dir()` and `set_cur_dir()`
+pub fn test_cur_dir(shell: &ScopedProtocol<Shell>) {
+    /* Test setting and getting current file system and current directory */
+    let fs_var = cstr16!("fs0:");
+    let dir_var = cstr16!("/");
+    let status = shell.set_cur_dir(Some(fs_var), Some(dir_var));
+    assert_eq!(status, Status::SUCCESS);
+
+    let cur_fs_str = shell
+        .get_cur_dir(Some(fs_var))
+        .expect("Could not get the current file system mapping");
+    let expected_fs_str = cstr16!("FS0:\\");
+    assert_eq!(cur_fs_str, expected_fs_str);
+
+    // Changing current file system
+    let fs_var = cstr16!("fs1:");
+    let dir_var = cstr16!("/");
+    let status = shell.set_cur_dir(Some(fs_var), Some(dir_var));
+    assert_eq!(status, Status::SUCCESS);
+
+    let cur_fs_str = shell
+        .get_cur_dir(Some(fs_var))
+        .expect("Could not get the current file system mapping");
+    assert_ne!(cur_fs_str, expected_fs_str);
+    let expected_fs_str = cstr16!("FS1:\\");
+    assert_eq!(cur_fs_str, expected_fs_str);
+
+    // Changing current file system and current directory
+    let fs_var = cstr16!("fs0:");
+    let dir_var = cstr16!("efi/");
+    let status = shell.set_cur_dir(Some(fs_var), Some(dir_var));
+    assert_eq!(status, Status::SUCCESS);
+
+    let cur_fs_str = shell
+        .get_cur_dir(Some(fs_var))
+        .expect("Could not get the current file system mapping");
+    assert_ne!(cur_fs_str, expected_fs_str);
+    let expected_fs_str = cstr16!("FS0:\\efi");
+    assert_eq!(cur_fs_str, expected_fs_str);
+
+    /* Test current working directory cases */
+
+    // At this point, the current working file system has not been set
+    // So we expect a NULL output
+    assert!(shell.get_cur_dir(None).is_none());
+
+    // Setting the current working file system and current working directory
+    let dir_var = cstr16!("fs0:/");
+    let status = shell.set_cur_dir(None, Some(dir_var));
+    assert_eq!(status, Status::SUCCESS);
+    let cur_fs_str = shell
+        .get_cur_dir(Some(fs_var))
+        .expect("Could not get the current file system mapping");
+    let expected_fs_str = cstr16!("FS0:");
+    assert_eq!(cur_fs_str, expected_fs_str);
+
+    let cur_fs_str = shell
+        .get_cur_dir(None)
+        .expect("Could not get the current file system mapping");
+    assert_eq!(cur_fs_str, expected_fs_str);
+
+    // Changing current working directory
+    let dir_var = cstr16!("/efi");
+    let status = shell.set_cur_dir(None, Some(dir_var));
+    assert_eq!(status, Status::SUCCESS);
+    let cur_fs_str = shell
+        .get_cur_dir(Some(fs_var))
+        .expect("Could not get the current file system mapping");
+    let expected_fs_str = cstr16!("FS0:\\efi");
+    assert_eq!(cur_fs_str, expected_fs_str);
+    let cur_fs_str = shell
+        .get_cur_dir(None)
+        .expect("Could not get the current file system mapping");
+    assert_eq!(cur_fs_str, expected_fs_str);
+
+    // Changing current directory in a non-current working file system
+    let fs_var = cstr16!("fs0:");
+    let dir_var = cstr16!("efi/tools");
+    let status = shell.set_cur_dir(Some(fs_var), Some(dir_var));
+    assert_eq!(status, Status::SUCCESS);
+    let cur_fs_str = shell
+        .get_cur_dir(None)
+        .expect("Could not get the current file system mapping");
+    assert_ne!(cur_fs_str, expected_fs_str);
+
+    let expected_fs_str = cstr16!("FS0:\\efi\\tools");
+    let cur_fs_str = shell
+        .get_cur_dir(Some(fs_var))
+        .expect("Could not get the current file system mapping");
+    assert_eq!(cur_fs_str, expected_fs_str);
+}
 
 pub fn test() {
     info!("Running shell protocol tests");
 
     let handle = boot::get_handle_for_protocol::<Shell>().expect("No Shell handles");
 
-    let mut _shell =
+    let shell =
         boot::open_protocol_exclusive::<Shell>(handle).expect("Failed to open Shell protocol");
+
+    test_cur_dir(&shell);
 }

uefi/src/proto/shell/mod.rs

@@ -7,15 +7,15 @@ use uefi_raw::Status;
 
 use core::ptr;
 
-pub use uefi_raw::protocol::shell::ShellProtocol;
+use uefi_raw::protocol::shell::ShellProtocol;
 
 use crate::{CStr16, Char16};
 
 /// Shell Protocol
 #[derive(Debug)]
 #[repr(transparent)]
-#[unsafe_protocol(uefi_raw::protocol::shell::ShellProtocol::GUID)]
-pub struct Shell(uefi_raw::protocol::shell::ShellProtocol);
+#[unsafe_protocol(ShellProtocol::GUID)]
+pub struct Shell(ShellProtocol);
 
 impl Shell {
     /// Returns the current directory on the specified device
@@ -24,12 +24,13 @@ impl Shell {
     ///
     /// * `file_system_mapping` - The file system mapping for which to get
     ///   the current directory
+    ///
     /// # Returns
     ///
     /// * `Some(cwd)` - CStr16 containing the current working directory
     /// * `None` - Could not retrieve current directory
     #[must_use]
-    pub fn get_cur_dir<'a>(&'a self, file_system_mapping: Option<&CStr16>) -> Option<&'a CStr16> {
+    pub fn get_cur_dir(&self, file_system_mapping: Option<&CStr16>) -> Option<&CStr16> {
         let mapping_ptr: *const Char16 = file_system_mapping.map_or(ptr::null(), |x| (x.as_ptr()));
         let cur_dir = unsafe { (self.0.get_cur_dir)(mapping_ptr.cast()) };
         if cur_dir.is_null() {
@@ -46,13 +47,14 @@ impl Shell {
     /// * `file_system` - Pointer to the file system's mapped name.
     /// * `directory` - Points to the directory on the device specified by
     ///   `file_system`.
+    ///
     /// # Returns
     ///
-    /// * `Status::SUCCESS` The directory was successfully set
+    /// * `Status::SUCCESS` - The directory was successfully set
     ///
     /// # Errors
     ///
-    /// * `Status::EFI_NOT_FOUND` The directory does not exist
+    /// * `Status::EFI_NOT_FOUND` - The directory does not exist
     pub fn set_cur_dir(&self, file_system: Option<&CStr16>, directory: Option<&CStr16>) -> Status {
         let fs_ptr: *const Char16 = file_system.map_or(ptr::null(), |x| (x.as_ptr()));
         let dir_ptr: *const Char16 = directory.map_or(ptr::null(), |x| (x.as_ptr()));