Compare commits
No commits in common. "6227089a106e0d55dc38f54942b63d18727bd412" and "6354681ac17f9826d50904d1c93348c9a8f19ac3" have entirely different histories.
6227089a10
...
6354681ac1
13 changed files with 32 additions and 271 deletions
|
@ -1,4 +1,5 @@
|
|||
steps:
|
||||
|
||||
update-builder-image:
|
||||
when:
|
||||
- event: cron
|
||||
|
@ -21,7 +22,7 @@ steps:
|
|||
branch: [main, next]
|
||||
settings:
|
||||
# kxio-woodpecker-todo-checker - read:issue
|
||||
repository_token: "4acf14f93747e044aa2d1397367741b53f3d4f8f"
|
||||
repository_token: '4acf14f93747e044aa2d1397367741b53f3d4f8f'
|
||||
prefix_regex: "(#|//) (TODO|FIXME): "
|
||||
debug: false
|
||||
|
||||
|
@ -36,9 +37,9 @@ steps:
|
|||
CARGO_TERM_COLOR: always
|
||||
commands:
|
||||
- ls -l /usr/local/cargo/bin/
|
||||
- cargo fmt --features "fs,network" --all -- --check
|
||||
- cargo clippy --features "fs,network" -- -D warnings -W clippy::nursery -W clippy::unwrap_used -W clippy::expect_used
|
||||
- cargo build --features "fs,network"
|
||||
- cargo fmt --all -- --check
|
||||
- cargo clippy -- -D warnings -W clippy::nursery -W clippy::unwrap_used -W clippy::expect_used
|
||||
- cargo build
|
||||
|
||||
test:
|
||||
when:
|
||||
|
@ -50,7 +51,7 @@ steps:
|
|||
environment:
|
||||
CARGO_TERM_COLOR: always
|
||||
commands:
|
||||
- cargo test --features "fs,network"
|
||||
- cargo test
|
||||
|
||||
publish_to_crates_io:
|
||||
when:
|
||||
|
|
|
@ -31,9 +31,6 @@ 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,38 +3,3 @@
|
|||
[![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,8 +1,3 @@
|
|||
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'
|
||||
|
|
|
@ -1,10 +1,6 @@
|
|||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"extends": ["config:recommended"],
|
||||
"packageRules": [
|
||||
{
|
||||
"matchManagers": ["cargo"],
|
||||
"rangeStrategy": "replace"
|
||||
}
|
||||
"extends": [
|
||||
"config:recommended"
|
||||
]
|
||||
}
|
|
@ -1,4 +1,4 @@
|
|||
#![allow(deprecated)]
|
||||
#![allow(unused)]
|
||||
|
||||
use std::{
|
||||
ops::Deref,
|
||||
|
@ -9,32 +9,22 @@ 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),
|
||||
Real(RealFileSystemEnv),
|
||||
Temp(TempFileSystemEnv),
|
||||
}
|
||||
impl FileSystem {
|
||||
#[deprecated(since = "1.1.0", note = "Use [kxio::filesystem::real()] instead")]
|
||||
pub fn new_real(cwd: Option<PathBuf>) -> Self {
|
||||
real(cwd)
|
||||
let cwd = cwd.unwrap_or_default();
|
||||
Self::Real(RealFileSystemEnv::new(cwd))
|
||||
}
|
||||
#[deprecated(since = "1.1.0", note = "Use [kxio::filesystem::temp()] instead")]
|
||||
pub fn new_temp() -> std::io::Result<Self> {
|
||||
temp()
|
||||
TempFileSystemEnv::new().map(Self::Temp)
|
||||
}
|
||||
}
|
||||
impl Deref for FileSystem {
|
||||
type Target = dyn FileSystemLike;
|
||||
type Target = dyn FileSystemEnv;
|
||||
|
||||
fn deref(&self) -> &Self::Target {
|
||||
match self {
|
||||
|
@ -44,7 +34,7 @@ impl Deref for FileSystem {
|
|||
}
|
||||
}
|
||||
|
||||
pub trait FileSystemLike: Sync + Send + std::fmt::Debug {
|
||||
pub trait FileSystemEnv: Sync + Send + std::fmt::Debug {
|
||||
fn cwd(&self) -> &PathBuf;
|
||||
|
||||
fn in_cwd(&self, name: &str) -> PathBuf {
|
||||
|
@ -82,47 +72,41 @@ pub trait FileSystemLike: Sync + Send + std::fmt::Debug {
|
|||
}
|
||||
|
||||
#[derive(Clone, Debug, Default)]
|
||||
pub struct RealFileSystem {
|
||||
pub struct RealFileSystemEnv {
|
||||
cwd: PathBuf,
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug)]
|
||||
pub struct TempFileSystem {
|
||||
pub struct TempFileSystemEnv {
|
||||
cwd: PathBuf,
|
||||
|
||||
// Handle to the temporary directory
|
||||
// When this handle is dropped the directory is deleted
|
||||
_temp_dir: Arc<Mutex<TempDir>>,
|
||||
temp_dir: Arc<Mutex<TempDir>>,
|
||||
}
|
||||
|
||||
impl FileSystemLike for TempFileSystem {
|
||||
impl FileSystemEnv for TempFileSystemEnv {
|
||||
fn cwd(&self) -> &PathBuf {
|
||||
&self.cwd
|
||||
}
|
||||
}
|
||||
|
||||
impl FileSystemLike for RealFileSystem {
|
||||
impl FileSystemEnv for RealFileSystemEnv {
|
||||
fn cwd(&self) -> &PathBuf {
|
||||
&self.cwd
|
||||
}
|
||||
}
|
||||
|
||||
impl RealFileSystem {
|
||||
impl RealFileSystemEnv {
|
||||
const fn new(cwd: PathBuf) -> Self {
|
||||
Self { cwd }
|
||||
}
|
||||
}
|
||||
|
||||
impl TempFileSystem {
|
||||
impl TempFileSystemEnv {
|
||||
fn new() -> std::io::Result<Self> {
|
||||
let temp_dir = tempdir()?;
|
||||
info!("temp dir: {:?}", temp_dir.path());
|
||||
let cwd = temp_dir.path().to_path_buf();
|
||||
let temp_dir = Arc::new(Mutex::new(temp_dir));
|
||||
Ok(Self {
|
||||
cwd,
|
||||
_temp_dir: temp_dir,
|
||||
})
|
||||
Ok(Self { cwd, temp_dir })
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -136,13 +120,13 @@ mod tests {
|
|||
#[test_log::test]
|
||||
fn test_cwd() {
|
||||
let cwd = PathBuf::from("/tmp");
|
||||
let env = RealFileSystem::new(cwd.clone());
|
||||
let env = RealFileSystemEnv::new(cwd.clone());
|
||||
assert_eq!(env.cwd(), &cwd);
|
||||
}
|
||||
|
||||
#[test_log::test]
|
||||
fn test_create_on_temp_fs() -> std::io::Result<()> {
|
||||
let env = TempFileSystem::new()?;
|
||||
let env = TempFileSystemEnv::new()?;
|
||||
assert!(env.cwd().exists());
|
||||
Ok(())
|
||||
}
|
||||
|
@ -150,13 +134,13 @@ mod tests {
|
|||
#[test_log::test]
|
||||
fn test_create_on_real_fs() {
|
||||
let cwd = PathBuf::from("/tmp");
|
||||
let env = RealFileSystem::new(cwd.clone());
|
||||
let env = RealFileSystemEnv::new(cwd.clone());
|
||||
assert_eq!(env.cwd(), &cwd);
|
||||
}
|
||||
|
||||
#[test_log::test]
|
||||
fn test_write_and_read_file() -> std::io::Result<()> {
|
||||
let env = TempFileSystem::new()?;
|
||||
let env = TempFileSystemEnv::new()?;
|
||||
let file_name = "test.txt";
|
||||
let content = "Hello, World!";
|
||||
let path = env.write_file(file_name, content)?;
|
||||
|
|
|
@ -1,50 +0,0 @@
|
|||
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.deref(),
|
||||
}
|
||||
}
|
||||
}
|
||||
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>;
|
||||
}
|
|
@ -1,52 +0,0 @@
|
|||
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(())
|
||||
}
|
||||
}
|
|
@ -1,28 +0,0 @@
|
|||
use std::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 std::ops::Deref for TempFileSystem {
|
||||
type Target = dyn super::FileSystemLike;
|
||||
|
||||
fn deref(&self) -> &Self::Target {
|
||||
&self.real
|
||||
}
|
||||
}
|
|
@ -1,11 +1,4 @@
|
|||
#[cfg(feature = "fs")]
|
||||
pub mod filesystem;
|
||||
|
||||
#[cfg(feature = "fs")]
|
||||
pub mod fs;
|
||||
|
||||
#[cfg(feature = "network")]
|
||||
pub mod network;
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests;
|
||||
|
|
|
@ -1,12 +0,0 @@
|
|||
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(())
|
||||
}
|
|
@ -1,20 +0,0 @@
|
|||
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(())
|
||||
}
|
|
@ -1,8 +0,0 @@
|
|||
#[cfg(feature = "fs")]
|
||||
pub mod filesystem;
|
||||
|
||||
#[cfg(feature = "fs")]
|
||||
pub mod fs;
|
||||
|
||||
// #[cfg(feature = "network")]
|
||||
// pub mod network;
|
Loading…
Reference in a new issue