sova-fs 0.1.0

Local filesystem plugin for Sova (jail root, async CRUD, walk)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

use sova_core::{App, ResponseAssert, TestClient};
use sova_fs::{Fs, FsError, FsExt};

#[tokio::test]
async fn jail_rejects_escape() {
    let dir = tempfile::tempdir().unwrap();
    let fs = Fs::new(dir.path()).into_fs().await.unwrap();
    assert!(matches!(
        fs.read("../outside.txt").await,
        Err(FsError::Forbidden)
    ));
    assert!(matches!(
        fs.write("/tmp/x", b"no").await,
        Err(FsError::Forbidden)
    ));
}

#[tokio::test]
async fn crud_and_walk() {
    let dir = tempfile::tempdir().unwrap();
    let fs = Fs::new(dir.path())
        .max_walk_entries(100)
        .into_fs()
        .await
        .unwrap();

    fs.create_dir("notes/nested").await.unwrap();
    fs.write("notes/a.txt", b"hi").await.unwrap();
    fs.write_string("notes/nested/b.txt", "bye").await.unwrap();
    assert_eq!(fs.read_to_string("notes/a.txt").await.unwrap(), "hi");
    assert!(fs.exists("notes/a.txt").await.unwrap());

    let kids = fs.read_dir("notes").await.unwrap();
    assert!(kids.iter().any(|e| e.name == "a.txt"));
    assert!(kids.iter().any(|e| e.name == "nested" && e.is_dir));

    let tree = fs.walk("notes").await.unwrap();
    assert!(tree.len() >= 3);

    fs.copy("notes/a.txt", "notes/a.copy.txt").await.unwrap();
    fs.rename("notes/a.copy.txt", "notes/a2.txt")
        .await
        .unwrap();
    fs.append("notes/a2.txt", b"!").await.unwrap();
    assert_eq!(fs.read_to_string("notes/a2.txt").await.unwrap(), "hi!");

    fs.remove_file("notes/a2.txt").await.unwrap();
    fs.remove_dir("notes/nested").await.unwrap();
    assert!(!fs.exists("notes/nested").await.unwrap());
}

#[tokio::test]
async fn plugin_req_fs() {
    let dir = tempfile::tempdir().unwrap();
    let mut app = App::new();
    app.install(Fs::new(dir.path()));
    app.get("/w", |req: sova_core::Request| async move {
        req.fs().write("x.txt", b"ok").await?;
        let s = req.fs().read_to_string("x.txt").await?;
        Ok::<_, sova_core::Error>(s)
    });

    let client = TestClient::new(app).unwrap();
    let res = client.get("/w").await;
    res.assert_status(200);
    let body = String::from_utf8_lossy(res.body_bytes().expect("body"));
    assert_eq!(body, "ok");
}