Added tests for set_cur_dir and get_cur_dir

Author: RenTrieu

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

@@ -1,7 +1,7 @@
 use uefi::boot;
-use uefi::data_types::Char16;
-use uefi::proto::shell::{Shell, ShellFileHandle};
+use uefi::proto::shell::Shell;
 use uefi::CStr16;
+use uefi_raw::Status;
 
 pub fn test() {
     info!("Running shell protocol tests");
@@ -15,13 +15,14 @@ pub fn test() {
     // let mut test_buf = [0u16; 12];
     // let test_str = CStr16::from_str_with_buf("test", &mut test_buf).unwrap();
 
+    let mut test_buf = [0u16; 128];
+
     /* Test retrieving list of environment variable names (null input) */
     let cur_env_vec = shell
         .get_env(None)
         .expect("Could not get environment variable")
         .vec()
         .unwrap();
-    let mut test_buf = [0u16; 128];
     assert_eq!(
         *cur_env_vec.get(0).unwrap(),
         CStr16::from_str_with_buf("path", &mut test_buf).unwrap()
@@ -52,23 +53,18 @@ pub fn test() {
         .unwrap();
     assert_eq!(cur_env_str, test_val);
 
-    // let mut cur_fs_buf = [0u16; 32];
-    // let cur_fs_str = CStr16::from_str_with_buf("", &mut cur_fs_buf).unwrap();
-    // info!("cur_fs_str size 1: {}", cur_fs_str.num_chars());
+    /* Test setting and getting current directory */
+    let mut fs_buf = [0u16; 16];
+    let fs_var = CStr16::from_str_with_buf("fs0:", &mut fs_buf).unwrap();
+    let mut dir_buf = [0u16; 32];
+    let dir_var = CStr16::from_str_with_buf("/", &mut dir_buf).unwrap();
+    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");
-    // info!("cur_fs_str size: {}", cur_fs_str.num_chars());
-    // info!("cur_fs_str: {}", cur_fs_str);
-
-    // for (i, c) in cur_fs_str.iter().enumerate() {
-    //     info!("cur_fs_str: i: {}, c: {}", i, c);
-    // }
+    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::from_str_with_buf("FS0:\\", &mut test_buf).unwrap();
+    assert_eq!(cur_fs_str, expected_fs_str);
 
-    // unsafe {
-    // info!("cur_fs_str: {}", cur_fs_str);
-    // let mut expected_fs_str_buf = [0u16; 32];
-    // assert_eq!(cur_fs_str, CStr16::from_str_with_buf("", &mut expected_fs_str_buf).unwrap());
-    // //
     // Create a file
     // let status = shell.create_file(test_str, 0).expect("Could not create file");
     // let mut size: u64 = 0;

uefi/src/proto/shell/mod.rs

@@ -35,7 +35,7 @@ pub struct Shell {
     set_map: usize,
 
     get_cur_dir: extern "efiapi" fn(file_system_mapping: *const Char16) -> *const Char16,
-    set_cur_dir: usize,
+    set_cur_dir: extern "efiapi" fn(file_system: *const Char16, directory: *const Char16) -> Status,
     open_file_list: usize,
     free_file_list: extern "efiapi" fn(file_list: *mut *mut ShellFileInfo),
     remove_dup_in_file_list: usize,
@@ -221,11 +221,20 @@ impl Shell {
         (self.set_env)(name_ptr, value_ptr, volatile)
     }
 
-    /// TODO
+    /// Returns the current directory on the specified device
+    ///
+    /// # Arguments
+    ///
+    /// * `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> {
         let mapping_ptr: *const Char16 =
-            file_system_mapping.map_or(core::ptr::null(), |x| (x as *const CStr16).cast());
+            file_system_mapping.map_or(ptr::null(), |x| (x.as_ptr()));
         let cur_dir = (self.get_cur_dir)(mapping_ptr);
         if cur_dir.is_null() {
             None
@@ -234,6 +243,26 @@ impl Shell {
         }
     }
 
+    /// Changes the current directory on the specified device
+    ///
+    /// # Arguments
+    ///
+    /// * `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
+    ///
+    /// # Errors
+    ///
+    /// * `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()));
+        (self.set_cur_dir)(fs_ptr, dir_ptr)
+    }
+
     /// Returns `true` if any script files are currently being processed.
     #[must_use]
     pub fn batch_is_active(&self) -> bool {