Struct wildland_dfs::MockDfsFrontend

pub struct MockDfsFrontend { /* private fields */ }

Interface that DFS exposes towards filesystem-like frontend providers

DFS methods may return error that are not related with particular operation but rather with wildland system in general. Those errors could be:

• PathResolutionError - happens when path resolving failed, e.g. due to the catlib error.
• StorageNotResponsive - happens when none of storages that operation involves returns an answer.
• Generic - unanticipated errors.

Implementations

impl MockDfsFrontend

pub fn checkpoint(&mut self)

Validate that all current expectations for all methods have been satisfied, and discard them.

pub fn new() -> MockDfsFrontend

Create a new mock object with no expectations.

This method will not be generated if the real struct already has a new method. However, it will be generated if the struct implements a trait with a new method. The trait’s new method can still be called like <MockX as TraitY>::new

impl MockDfsFrontend

pub fn expect_read_dir(&mut self) -> &mut Expectation

Create an Expectation for mocking the read_dir method

pub fn expect_metadata(&mut self) -> &mut Expectation

Create an Expectation for mocking the metadata method

pub fn expect_remove_file(&mut self) -> &mut Expectation

Create an Expectation for mocking the remove_file method

pub fn expect_rename(&mut self) -> &mut Expectation

Create an Expectation for mocking the rename method

pub fn expect_set_permissions(&mut self) -> &mut Expectation

Create an Expectation for mocking the set_permissions method

pub fn expect_set_owner(&mut self) -> &mut Expectation

Create an Expectation for mocking the set_owner method

pub fn expect_create_dir(&mut self) -> &mut Expectation

Create an Expectation for mocking the create_dir method

pub fn expect_remove_dir(&mut self) -> &mut Expectation

Create an Expectation for mocking the remove_dir method

pub fn expect_stat_fs(&mut self) -> &mut Expectation

Create an Expectation for mocking the stat_fs method

pub fn expect_get_receiver(&mut self) -> &mut Expectation

Create an Expectation for mocking the get_receiver method

pub fn expect_mount(&mut self) -> &mut Expectation

Create an Expectation for mocking the mount method

pub fn expect_get_space_usage(&mut self) -> &mut Expectation

Create an Expectation for mocking the get_space_usage method

pub fn expect_is_accessible(&mut self) -> &mut Expectation

Create an Expectation for mocking the is_accessible method

pub fn expect_download(&mut self) -> &mut Expectation

Create an Expectation for mocking the download method

pub fn expect_upload(&mut self) -> &mut Expectation

Create an Expectation for mocking the upload method

pub fn expect_get_path(&mut self) -> &mut Expectation

Create an Expectation for mocking the get_path method

Trait Implementations

impl Debug for MockDfsFrontend

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for MockDfsFrontend

fn default() -> MockDfsFrontend

Returns the “default value” for a type.

impl DfsFrontend for MockDfsFrontend

Interface that DFS exposes towards filesystem-like frontend providers

DFS methods may return error that are not related with particular operation but rather with wildland system in general. Those errors could be:

• PathResolutionError - happens when path resolving failed, e.g. due to the catlib error.
• StorageNotResponsive - happens when none of storages that operation involves returns an answer.
• Generic - unanticipated errors.

fn read_dir( &self, path: String ) -> Result<Vec<DirEntry, Global>, DfsFrontendError>

Returns vector of entries found under the provided path. It may merge entries from multiple containers.

Errors:

• NotADirectory - for paths that don’t represent directories
• NoSuchPath - requested path does not exist

fn metadata(&self, path: String) -> Result<NodeStat, DfsFrontendError>

Returns metadata of a node.

Errors:

• NoSuchPath - requested path does not exist

fn remove_file(&self, path: String) -> Result<(), DfsFrontendError>

Removes a file

Errors:

• NoSuchPath - requested path does not exist
• NotAFile - provided path represents a node that is not a file

fn rename( &self, old_path: String, new_path: String ) -> Result<(), DfsFrontendError>

Rename a file or directory to a new path, if new path does not exist yet. In contrast to POSIX-like rename operation, it returns error in case of new path existence in all cases, so it is up to a caller whether to remove a node under new path or not.

Errors:

NoSuchPath - source not found SourceIsParentOfTarget - new directory would be a subdirectory of itself MoveBetweenContainers - new_path is in different Container than old_path PathAlreadyExists - new_path already exists

fn set_permissions( &self, path: String, permissions: WlPermissions ) -> Result<(), DfsFrontendError>

Changes the permissions of the underlying file.

fn set_owner(&self, path: String) -> Result<(), DfsFrontendError>

Not supported yet - it always returns DfsFrontendError::Generic(_)

fn create_dir(&self, path: String) -> Result<(), DfsFrontendError>

Creates a new, empty directory at the provided path

Errors:

InvalidParent - a parent of the given path doesn’t exist. PathAlreadyExists - path already exists.

fn remove_dir( &self, path: String, is_recursive: bool ) -> Result<(), DfsFrontendError>

Removes a directory If is_recursive is set to true, it will remove all the children of the directory

Errors:

NotADirectory - path does not represent a directory NoSuchPath - no such path exists DirNotEmpty - directory is not empty

fn stat_fs(&self, path: String) -> Result<FsStat, DfsFrontendError>

Returns information about a mounted filesystem. Path is the pathname of any file within the mounted filesystem.

Errors:

NoSuchPath - no such path exists

fn get_receiver(&self) -> Arc<Mutex<dyn EventReceiver>>

Returns receiver that can listen to DFS events. Events may be split between different EventReceiver.

fn mount(&self, storage: &Storage) -> Result<(), DfsFrontendError>

Attempts to mount given Storage. This method’s state should not be considered emphemeral.

This functionality may be used during container mount to ensure storage being healthy, before any FS operations are performed.

fn get_space_usage( &self, storage: &Storage ) -> Result<SpaceUsage, DfsFrontendError>

Returns (used, total) space in bytes

fn is_accessible(&self, storage: &Storage) -> Result<bool, DfsFrontendError>

Checks whether the Storage is accessible

fn download( &self, path: String, output: Box<dyn OStream, Global>, progress_reporter: Box<dyn ProgressReporter, Global>, abort_flag: &AbortFlag ) -> Result<(), DfsFrontendError>

Downloads a file and writes it to the provided output stream

fn upload( &self, path: String, input: Box<dyn IStream, Global>, progress_reporter: Box<dyn ProgressReporter, Global>, abort_flag: &AbortFlag, creation_time: Option<UnixTimestamp> ) -> Result<(), DfsFrontendError>

Reads a file from the provided input stream and uploads it to the backend

fn get_path(&self, identifier: String) -> Result<String, DfsFrontendError>

Finds path of object which matches the uuid