pluginlab 0.6.0

Command-line interface host for Terminal REPL with plugin system (using WebAssembly Component Model)
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314

mod utils;

#[cfg(test)]
mod e2e_rust_plugins {

    use crate::utils::*;

    use rexpect::spawn;

    const TEST_TIMEOUT: u64 = 10000;

    /**
     * Lets us change the target directory for the plugins and repl logic.
     *
     * See the justfile for examples where we switch to testing both plugins from the filesystem and from the HTTP server.
     */
    fn build_command(plugin_files: &[&str], repl_logic_file: &str) -> String {
        let prefix =
            std::env::var("WASM_TARGET_DIR").unwrap_or("target/wasm32-wasip1/debug".to_string());
        let mut command = String::from("target/debug/pluginlab");
        command.push_str(format!(" --repl-logic {}/{}", prefix, repl_logic_file).as_str());
        plugin_files.iter().for_each(|file| {
            command.push_str(format!(" --plugins {}/{}", prefix, file).as_str());
        });
        println!("Running command: {}", command);
        command
    }

    #[test]
    fn test_echo_plugin() {
        let project_root = find_project_root();
        println!("Setting current directory to: {:?}", project_root);
        std::env::set_current_dir(&project_root).unwrap();
        let mut session = spawn(
            &format!(
                "{} --dir tmp/filesystem --allow-read",
                &build_command(&["plugin_echo.wasm"], "repl_logic_guest.wasm")
            ),
            Some(TEST_TIMEOUT),
        )
        .expect("Can't launch pluginlab with plugin greet");

        session
            .exp_string("[Host] Starting REPL host...")
            .expect("Didn't see startup message");
        session
            .exp_string("[Host] Loading plugin:")
            .expect("Didn't see plugin loading message");
        session
            .exp_string("repl(0)>")
            .expect("Didn't see REPL prompt");
        session
            .send_line("echo hello")
            .expect("Failed to send command");
        session
            .exp_string("hello\r\nrepl(0)>")
            .expect("Didn't get expected output from echo plugin");
    }

    #[test]
    fn test_greet_plugin() {
        let project_root = find_project_root();
        println!("Setting current directory to: {:?}", project_root);
        std::env::set_current_dir(&project_root).unwrap();
        let mut session = spawn(
            &format!(
                "{} --dir tmp/filesystem --allow-read",
                &build_command(&["plugin_greet.wasm"], "repl_logic_guest.wasm")
            ),
            Some(TEST_TIMEOUT),
        )
        .expect("Can't launch pluginlab with plugin greet");

        session
            .exp_string("[Host] Starting REPL host...")
            .expect("Didn't see startup message");
        session
            .exp_string("[Host] Loading plugin:")
            .expect("Didn't see plugin loading message");
        session
            .exp_string("repl(0)>")
            .expect("Didn't see REPL prompt");
        session
            .send_line("greet World")
            .expect("Failed to send command");
        session
            .exp_string("Hello, World!\r\nrepl(0)>")
            .expect("Didn't get expected output from greet plugin");
    }

    #[test]
    fn test_ls_plugin() {
        let project_root = find_project_root();
        println!("Setting current directory to: {:?}", project_root);
        std::env::set_current_dir(&project_root).unwrap();
        let mut session = spawn(
            &format!(
                "{} --dir tmp/filesystem --allow-read",
                &build_command(&["plugin_ls.wasm"], "repl_logic_guest.wasm")
            ),
            Some(TEST_TIMEOUT),
        )
        .expect("Can't launch pluginlab with plugin greet");

        session
            .exp_string("[Host] Starting REPL host...")
            .expect("Didn't see startup message");
        session
            .exp_string("[Host] Loading plugin:")
            .expect("Didn't see plugin loading message");
        session
            .exp_string("repl(0)>")
            .expect("Didn't see REPL prompt");
        session.send_line("ls").expect("Failed to send command");
        session
            .exp_string(
                "D\tdata\r\nD\tdocuments\r\nD\tlogs\r\nF\t.config\r\nF\t.hidden_file\r\nF\tREADME.md\r\n",
            )
            .expect("Didn't get listing of current directory");
        session
            .send_line("ls documents")
            .expect("Failed to send command");
        session
            .exp_string("D\tdocuments/work\r\nF\tdocuments/README.md\r\nF\tdocuments/config.json\r\nF\tdocuments/notes.txt\r\n")
            .expect("Didn't get listing of documents directory");
        session
            .send_line("ls documents/work/projects")
            .expect("Failed to send command");
        session
            .exp_string("D\tdocuments/work/projects/alpha\r\nD\tdocuments/work/projects/beta\r\nF\tdocuments/work/projects/.gitkeep\r\n")
            .expect("Didn't get listing of projects directory");
        session
            .send_line("ls data/sample.csv")
            .expect("Failed to send command");
        session
            .exp_string("F\tdata/sample.csv\r\n")
            .expect("Didn't get listing for a single file");
    }

    #[test]
    fn test_cat_plugin() {
        let project_root = find_project_root();
        println!("Setting current directory to: {:?}", project_root);
        std::env::set_current_dir(&project_root).unwrap();
        let mut session = spawn(
            &format!(
                "{} --dir tmp/filesystem --allow-read",
                &build_command(&["plugin_cat.wasm"], "repl_logic_guest.wasm")
            ),
            Some(TEST_TIMEOUT),
        )
        .expect("Can't launch pluginlab with plugin greet");

        session
            .exp_string("[Host] Starting REPL host...")
            .expect("Didn't see startup message");
        session
            .exp_string("[Host] Loading plugin:")
            .expect("Didn't see plugin loading message");
        session
            .exp_string("repl(0)>")
            .expect("Didn't see REPL prompt");
        session
            .send_line("cat documents")
            .expect("Failed to send command");
        session
            .exp_string("cat: documents: Is a directory")
            .expect("Didn't get expected error output for trying to cat a directory");
        session
            .send_line("cat documents/README.md")
            .expect("Failed to send command");
        session
            .exp_string("# Documents")
            .expect("Didn't get expected contents of README.md");
    }

    #[test]
    fn test_tee_plugin_new_file() {
        let project_root = find_project_root();
        println!("Setting current directory to: {:?}", project_root);
        std::env::set_current_dir(&project_root).unwrap();
        let mut session = spawn(
            &format!(
                "{} --dir tmp/filesystem --allow-all",
                &build_command(
                    &["plugin_tee.wasm", "plugin_echo.wasm", "plugin_cat.wasm"],
                    "repl_logic_guest.wasm"
                )
            ),
            Some(TEST_TIMEOUT),
        )
        .expect("Can't launch pluginlab with plugin greet");

        session
            .exp_string("[Host] Starting REPL host...")
            .expect("Didn't see startup message");
        session
            .exp_string("[Host] Loading plugin:")
            .expect("Didn't see plugin loading message");
        session
            .exp_string("repl(0)>")
            .expect("Didn't see REPL prompt");
        session
            .send_line("echo hello")
            .expect("Failed to send command");
        session
            .exp_string("hello\r\nrepl(0)>")
            .expect("Didn't get expected output from echo plugin");
        session
            .send_line("tee hello.txt")
            .expect("Failed to send command");
        session
            .exp_string("hello\r\nrepl(0)>")
            .expect("Didn't get expected output from tee plugin");
        session
            .send_line("cat hello.txt")
            .expect("Failed to send command");
        session
            .exp_string("hello\r\nrepl(0)>")
            .expect("Didn't get expected contents of hello.txt");
    }

    #[test]
    fn test_tee_plugin_replace_file() {
        let project_root = find_project_root();
        println!("Setting current directory to: {:?}", project_root);
        std::env::set_current_dir(&project_root).unwrap();
        let mut session = spawn(
            &format!(
                "{} --dir tmp/filesystem --allow-all",
                &build_command(
                    &["plugin_tee.wasm", "plugin_echo.wasm", "plugin_cat.wasm"],
                    "repl_logic_guest.wasm"
                )
            ),
            Some(TEST_TIMEOUT),
        )
        .expect("Can't launch pluginlab with plugin greet");

        session
            .exp_string("[Host] Starting REPL host...")
            .expect("Didn't see startup message");
        session
            .exp_string("[Host] Loading plugin:")
            .expect("Didn't see plugin loading message");
        session
            .exp_string("repl(0)>")
            .expect("Didn't see REPL prompt");
        session
            .send_line("echo hello")
            .expect("Failed to send command");
        session
            .exp_string("hello\r\nrepl(0)>")
            .expect("Didn't get expected output from echo plugin");
        session
            .send_line("tee documents/notes.txt")
            .expect("Failed to send command");
        session
            .exp_string("hello\r\nrepl(0)>")
            .expect("Didn't get expected output from tee plugin");
        session
            .send_line("cat documents/notes.txt")
            .expect("Failed to send command");
        session
            .exp_string("hello\r\nrepl(0)>")
            .expect("Didn't get expected contents of hello.txt");
    }

    #[test]
    fn test_tee_plugin_append_file() {
        let project_root = find_project_root();
        println!("Setting current directory to: {:?}", project_root);
        std::env::set_current_dir(&project_root).unwrap();
        let mut session = spawn(
            &format!(
                "{} --dir tmp/filesystem --allow-all",
                &build_command(
                    &["plugin_tee.wasm", "plugin_echo.wasm", "plugin_cat.wasm"],
                    "repl_logic_guest.wasm"
                )
            ),
            Some(TEST_TIMEOUT),
        )
        .expect("Can't launch pluginlab with plugin greet");

        session
            .exp_string("[Host] Starting REPL host...")
            .expect("Didn't see startup message");
        session
            .exp_string("[Host] Loading plugin:")
            .expect("Didn't see plugin loading message");
        session
            .exp_string("repl(0)>")
            .expect("Didn't see REPL prompt");
        session
            .send_line("echo hello")
            .expect("Failed to send command");
        session
            .exp_string("hello\r\nrepl(0)>")
            .expect("Didn't get expected output from echo plugin");
        session
            .send_line("tee -a documents/work/projects/alpha/.gitkeep")
            .expect("Failed to send command");
        session
            .exp_string("hello\r\nrepl(0)>")
            .expect("Didn't get expected output from tee plugin");
        session
            .send_line("cat documents/work/projects/alpha/.gitkeep")
            .expect("Failed to send command");
        session
            .exp_string("# This file ensures the alpha directory is tracked in git\r\n# Deep nested directory for testing\r\n\r\nhello\r\nrepl(0)>")
            .expect("Didn't get expected contents of .gitkeep");
    }
}