Compare commits
4 commits
3fd546f632
...
7fb12ca660
Author | SHA1 | Date | |
---|---|---|---|
7fb12ca660 | |||
9fbc2f79aa | |||
d46a52126c | |||
84640bb2dd |
11 changed files with 252 additions and 3 deletions
|
@ -31,6 +31,9 @@ thiserror = "1.0"
|
|||
# fs
|
||||
tempfile = "3.10"
|
||||
|
||||
# error handling
|
||||
derive_more = { version = "1.0.0-beta.6", features = ["from", "display"] }
|
||||
|
||||
[dev-dependencies]
|
||||
# testing
|
||||
assert2 = "0.3"
|
||||
|
|
35
README.md
35
README.md
|
@ -3,3 +3,38 @@
|
|||
[![status-badge](https://ci.kemitix.net/api/badges/53/status.svg)](https://ci.kemitix.net/repos/53)
|
||||
|
||||
Provides injectable Filesystem and Network resources to make code more testable.
|
||||
|
||||
### FileSystem
|
||||
|
||||
There are two FileSystem implementation: [filesystem] and [fs].
|
||||
|
||||
- [filesystem] is the legacy implementation and will be removed in a future version.
|
||||
- [fs] is the current version and is intended to stand-in for and extend the [std::fs] module from the Standard Library.
|
||||
|
||||
#### std::fs alternatives
|
||||
|
||||
| To Do | [std::fs] | [kxio::fs::FileSystem] | |
|
||||
| ----- | ---------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| [ ] | canonicalize | path_canonicalize | Returns the canonical, absolute form of a path with all intermediate components normalized and symbolic links resolved. |
|
||||
| [ ] | copy | file_copy | Copies the contents of one file to another. This function will also copy the permission bits of the original file to the destination file. |
|
||||
| [ ] | create_dir | dir_create | Creates a new, empty directory at the provided path |
|
||||
| [ ] | create_dir_all | dir_create_all | Recursively create a directory and all of its parent components if they are missing. |
|
||||
| [ ] | hard_link | link_create | Creates a new hard link on the filesystem. |
|
||||
| [ ] | metadata | path_metadata | Given a path, query the file system to get information about a file, directory, etc. |
|
||||
| [ ] | read | file_read | Read the entire contents of a file into a bytes vector. |
|
||||
| [ ] | read_dir | dir_read | Returns an iterator over the entries within a directory. |
|
||||
| [ ] | read_link | link_read | Reads a symbolic link, returning the file that the link points to. |
|
||||
| [x] | read_to_string | file_read_to_string | Read the entire contents of a file into a string. |
|
||||
| [ ] | remove_dir | dir_remove | Removes an empty directory. |
|
||||
| [ ] | remove_dir_all | dir_remove_all | Removes a directory at this path, after removing all its contents. Use carefully! |
|
||||
| [ ] | remove_file | file_remove | Removes a file from the filesystem. |
|
||||
| [ ] | rename | path_rename | Rename a file or directory to a new name, replacing the original file if to already exists. |
|
||||
| [ ] | set_permissions | path_set_permissions | Changes the permissions found on a file or a directory. |
|
||||
| [ ] | symlink_metadata | link_metadata | Query the metadata about a file without following symlinks. |
|
||||
| [x] | write | file_write | Write a slice as the entire contents of a file. |
|
||||
|
||||
### Network
|
||||
|
||||
The entire [network] module needs to be completly rewritten
|
||||
It's use is strongly discouraged.
|
||||
A new [net] module will likely be its replacement.
|
||||
|
|
5
justfile
5
justfile
|
@ -1,3 +1,8 @@
|
|||
install-hooks:
|
||||
@echo "Installing git hooks"
|
||||
git config core.hooksPath .git-hooks
|
||||
|
||||
validate-dev-branch:
|
||||
git rebase -i origin/main -x 'cargo build --features "fs,network"'
|
||||
git rebase -i origin/main -x 'cargo test --features "fs,network"'
|
||||
git rebase -i origin/main -x 'cargo clippy --features "fs,network" -- -D warnings -W clippy::nursery -W clippy::unwrap_used -W clippy::expect_used'
|
||||
|
|
|
@ -7,18 +7,28 @@ use std::{
|
|||
use tempfile::{tempdir, TempDir};
|
||||
use tracing::{debug, info};
|
||||
|
||||
pub fn real(cwd: Option<PathBuf>) -> FileSystem {
|
||||
let cwd = cwd.unwrap_or_default();
|
||||
FileSystem::Real(RealFileSystem::new(cwd))
|
||||
}
|
||||
pub fn temp() -> std::io::Result<FileSystem> {
|
||||
TempFileSystem::new().map(FileSystem::Temp)
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug)]
|
||||
#[deprecated(since = "1.1.0", note = "Use [kxio::fs::FileSystem] instead")]
|
||||
pub enum FileSystem {
|
||||
Real(RealFileSystem),
|
||||
Temp(TempFileSystem),
|
||||
}
|
||||
impl FileSystem {
|
||||
#[deprecated(since = "1.1.0", note = "Use [kxio::filesystem::real()] instead")]
|
||||
pub fn new_real(cwd: Option<PathBuf>) -> Self {
|
||||
let cwd = cwd.unwrap_or_default();
|
||||
Self::Real(RealFileSystem::new(cwd))
|
||||
real(cwd)
|
||||
}
|
||||
#[deprecated(since = "1.1.0", note = "Use [kxio::filesystem::temp()] instead")]
|
||||
pub fn new_temp() -> std::io::Result<Self> {
|
||||
TempFileSystem::new().map(Self::Temp)
|
||||
temp()
|
||||
}
|
||||
}
|
||||
impl Deref for FileSystem {
|
||||
|
|
50
src/fs/mod.rs
Normal file
50
src/fs/mod.rs
Normal file
|
@ -0,0 +1,50 @@
|
|||
use std::path::{Path, PathBuf};
|
||||
|
||||
use derive_more::From;
|
||||
|
||||
mod real;
|
||||
mod temp;
|
||||
|
||||
#[derive(Debug, From, derive_more::Display)]
|
||||
pub enum Error {
|
||||
Io(std::io::Error),
|
||||
|
||||
#[display("Path access attempted outside of base ({base:?}): {path:?}")]
|
||||
PathTraversal {
|
||||
base: PathBuf,
|
||||
path: PathBuf,
|
||||
},
|
||||
}
|
||||
pub type Result<T> = core::result::Result<T, Error>;
|
||||
|
||||
pub const fn new(base: PathBuf) -> FileSystem {
|
||||
FileSystem::Real(real::new(base))
|
||||
}
|
||||
|
||||
pub fn temp() -> Result<FileSystem> {
|
||||
temp::new().map(FileSystem::Temp)
|
||||
}
|
||||
|
||||
pub enum FileSystem {
|
||||
Real(real::RealFileSystem),
|
||||
Temp(temp::TempFileSystem),
|
||||
}
|
||||
|
||||
impl std::ops::Deref for FileSystem {
|
||||
type Target = dyn FileSystemLike;
|
||||
|
||||
fn deref(&self) -> &Self::Target {
|
||||
match self {
|
||||
Self::Real(fs) => fs,
|
||||
Self::Temp(fs) => fs,
|
||||
}
|
||||
}
|
||||
}
|
||||
pub trait FileSystemLike {
|
||||
fn base(&self) -> &Path;
|
||||
fn path_of(&self, path: PathBuf) -> Result<PathBuf>;
|
||||
fn file_write(&self, path: &Path, contents: &str) -> Result<()>;
|
||||
fn file_read_to_string(&self, path: &Path) -> Result<String>;
|
||||
fn path_exists(&self, path: &Path) -> Result<bool>;
|
||||
fn path_is_file(&self, path: &Path) -> Result<bool>;
|
||||
}
|
52
src/fs/real.rs
Normal file
52
src/fs/real.rs
Normal file
|
@ -0,0 +1,52 @@
|
|||
use std::path::{Path, PathBuf};
|
||||
|
||||
pub const fn new(base: PathBuf) -> RealFileSystem {
|
||||
RealFileSystem { base }
|
||||
}
|
||||
|
||||
pub struct RealFileSystem {
|
||||
base: PathBuf,
|
||||
}
|
||||
|
||||
impl super::FileSystemLike for RealFileSystem {
|
||||
fn base(&self) -> &Path {
|
||||
&self.base
|
||||
}
|
||||
fn path_of(&self, path: PathBuf) -> super::Result<PathBuf> {
|
||||
let path_of = self.base.as_path().join(path);
|
||||
self.validate(&path_of)?;
|
||||
Ok(path_of)
|
||||
}
|
||||
|
||||
fn file_write(&self, path: &Path, contents: &str) -> super::Result<()> {
|
||||
self.validate(path)?;
|
||||
std::fs::write(path, contents).map_err(Into::into)
|
||||
}
|
||||
|
||||
fn file_read_to_string(&self, path: &Path) -> super::Result<String> {
|
||||
self.validate(path)?;
|
||||
std::fs::read_to_string(path).map_err(Into::into)
|
||||
}
|
||||
|
||||
fn path_is_file(&self, path: &Path) -> super::Result<bool> {
|
||||
self.validate(path)?;
|
||||
Ok(path.is_file())
|
||||
}
|
||||
|
||||
fn path_exists(&self, path: &Path) -> super::Result<bool> {
|
||||
self.validate(path)?;
|
||||
Ok(path.exists())
|
||||
}
|
||||
}
|
||||
|
||||
impl RealFileSystem {
|
||||
fn validate(&self, path: &std::path::Path) -> super::Result<()> {
|
||||
if !path.starts_with(&self.base) {
|
||||
return Err(super::Error::PathTraversal {
|
||||
base: self.base.clone(),
|
||||
path: path.to_path_buf(),
|
||||
});
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
47
src/fs/temp.rs
Normal file
47
src/fs/temp.rs
Normal file
|
@ -0,0 +1,47 @@
|
|||
use std::{
|
||||
path::{Path, PathBuf},
|
||||
sync::{Arc, Mutex},
|
||||
};
|
||||
|
||||
use tempfile::TempDir;
|
||||
|
||||
pub(super) fn new() -> super::Result<TempFileSystem> {
|
||||
let temp_dir = tempfile::tempdir()?;
|
||||
let base = temp_dir.path().to_path_buf();
|
||||
let temp_dir = Arc::new(Mutex::new(temp_dir));
|
||||
let real = super::real::new(base);
|
||||
|
||||
Ok(TempFileSystem {
|
||||
real,
|
||||
_temp_dir: temp_dir,
|
||||
})
|
||||
}
|
||||
|
||||
pub struct TempFileSystem {
|
||||
real: super::real::RealFileSystem,
|
||||
_temp_dir: Arc<Mutex<TempDir>>,
|
||||
}
|
||||
|
||||
impl super::FileSystemLike for TempFileSystem {
|
||||
fn base(&self) -> &Path {
|
||||
self.real.base()
|
||||
}
|
||||
fn path_of(&self, path: PathBuf) -> super::Result<PathBuf> {
|
||||
self.real.path_of(path)
|
||||
}
|
||||
fn file_write(&self, path: &Path, contents: &str) -> super::Result<()> {
|
||||
self.real.file_write(path, contents)
|
||||
}
|
||||
|
||||
fn file_read_to_string(&self, path: &Path) -> super::Result<String> {
|
||||
self.real.file_read_to_string(path)
|
||||
}
|
||||
|
||||
fn path_exists(&self, path: &Path) -> super::Result<bool> {
|
||||
self.real.path_exists(path)
|
||||
}
|
||||
|
||||
fn path_is_file(&self, path: &Path) -> super::Result<bool> {
|
||||
self.real.path_is_file(path)
|
||||
}
|
||||
}
|
|
@ -1,4 +1,11 @@
|
|||
#[cfg(feature = "fs")]
|
||||
pub mod filesystem;
|
||||
|
||||
#[cfg(feature = "fs")]
|
||||
pub mod fs;
|
||||
|
||||
#[cfg(feature = "network")]
|
||||
pub mod network;
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
|
|
12
src/tests/filesystem.rs
Normal file
12
src/tests/filesystem.rs
Normal file
|
@ -0,0 +1,12 @@
|
|||
type TestResult = Result<(), Box<dyn std::error::Error>>;
|
||||
|
||||
#[test]
|
||||
fn write_read_file_exists() -> TestResult {
|
||||
let fs = crate::filesystem::temp()?;
|
||||
let pathbuf = fs.write_file("foo", "content")?;
|
||||
let c = fs.read_file("foo")?;
|
||||
assert_eq!(c, "content");
|
||||
assert!(fs.file_exists(&pathbuf));
|
||||
|
||||
Ok(())
|
||||
}
|
20
src/tests/fs.rs
Normal file
20
src/tests/fs.rs
Normal file
|
@ -0,0 +1,20 @@
|
|||
use std::path::PathBuf;
|
||||
|
||||
use crate::fs;
|
||||
|
||||
type TestResult = Result<(), crate::fs::Error>;
|
||||
|
||||
#[test]
|
||||
fn write_read_file_exists() -> TestResult {
|
||||
let temp_fs = fs::temp()?;
|
||||
let name: PathBuf = temp_fs.path_of("foo".into())?;
|
||||
temp_fs.file_write(&name, "content")?;
|
||||
let c = temp_fs.file_read_to_string(&name)?;
|
||||
assert_eq!(c, "content");
|
||||
let exists = temp_fs.path_exists(&name)?;
|
||||
assert!(exists);
|
||||
let is_file = temp_fs.path_is_file(&name)?;
|
||||
assert!(is_file);
|
||||
|
||||
Ok(())
|
||||
}
|
8
src/tests/mod.rs
Normal file
8
src/tests/mod.rs
Normal file
|
@ -0,0 +1,8 @@
|
|||
#[cfg(feature = "fs")]
|
||||
pub mod filesystem;
|
||||
|
||||
#[cfg(feature = "fs")]
|
||||
pub mod fs;
|
||||
|
||||
#[cfg(feature = "network")]
|
||||
pub mod network;
|
Loading…
Reference in a new issue