thot-local 0.10.0-intermediate

Local functionality for Thot data management and analysis software.
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use super::*;
use crate::project::resources::container::Container;
use crate::project::resources::script::Scripts;
use crate::project::{container, project};
use dev_utils::temp_dir::TempDir;
use fake::faker::filesystem::raw::FileName;
use fake::locales::EN;
use fake::Fake;
use std::path::PathBuf;

// **************
// *** Script ***
// **************

#[test]
fn init_with_default_project_should_work() {
    // setup
    let mut _dir = init_project().expect("setup should work");
    let s_path = _dir
        .mkfile_with_extension("py")
        .expect("mkfile should work");

    // test
    let rid = init(s_path.as_path(), None).expect("init should work");
    let scripts = Scripts::load(_dir.path()).expect("load scripts should work");
    assert!(scripts.contains(&rid), "script should be registered");
}

#[test]
fn init_with_specified_project_should_work() {
    // setup
    let mut _dir = TempDir::new().expect("setup should work");
    let p_dir = _dir
        .mkdir()
        .expect("creating project directory should work");
    let s_dir = _dir.mkdir().expect("creating script directory should work");

    project::init(&p_dir).expect("init project should work");
    let mut s_path = s_dir.join(FileName(EN).fake::<String>());
    s_path.set_extension(".py");

    // test
    let rid = init(&s_path, Some(&p_dir)).expect("init should work");
    let scripts = Scripts::load(&p_dir).expect("load scripts should work");
    assert!(scripts.contains(&rid), "script should be registered");
}

#[test]
fn init_should_do_nothing_if_path_already_initialized_as_script() {
    // setup
    let mut _dir = init_project().expect("setup should work");
    let s_path = _dir
        .mkfile_with_extension("py")
        .expect("mkfile should work");
    let rid = init(&s_path, None).expect("initial script init should work");

    // test
    let found = init(&s_path, None).expect("second script init should work");
    assert_eq!(rid, found, "resource ids should match");
}

#[test]
#[should_panic(expected = "PathNotInProject")]
fn init_with_default_project_but_not_in_project_should_error() {
    // setup
    let _dir = TempDir::new().expect("setup should work");
    let s_path = _dir.path().join(FileName(EN).fake::<String>());

    // test
    init(&s_path, None).unwrap();
}

#[test]
#[should_panic(expected = "PathNotAProjectRoot")]
fn init_if_project_root_is_invalid_should_error() {
    // setup
    let _dir = TempDir::new().expect("setup should work");
    let s_path = create_path_in(_dir.path());

    // test
    init(&s_path.as_path(), Some(_dir.path())).unwrap();
}

// **************************
// *** Script Association ***
// **************************

#[test]
fn add_association_should_work() {
    // setup
    let mut _dir = init_project().expect("setup should work");
    let s_path = _dir
        .mkfile_with_extension("py")
        .expect("mkfile should work");
    let _cid = container::init(_dir.path()).expect("init as container should work");
    let _sid = init(&s_path, None).expect("init script should work");

    // test
    let _rid = add_association(&s_path, _dir.path()).expect("add association should work");
    let container = Container::load(_dir.path()).expect("load container should work");
    assert_eq!(
        1,
        container.scripts.len(),
        "container should has script association added"
    );
}

#[test]
#[should_panic(expected = "PathNotAContainer")]
fn add_association_outside_container_should_error() {
    // setup
    let _dir = init_project().expect("setup should work");
    let s_path = create_path_in(_dir.path());

    // test
    add_association(&s_path, _dir.path()).unwrap();
}

// ************************
// *** helper functions ***
// ************************

/// Initialize a project in a new temporary directory.
fn init_project() -> Result<TempDir> {
    let _dir = TempDir::new().expect("temp dir should work");
    project::init(_dir.path()).expect("init project should work");

    Ok(_dir)
}

/// Create a random path in the given directory.
fn create_path_in(dir: &Path) -> PathBuf {
    dir.join(FileName(EN).fake::<String>())
}