notes 0.2.108

A simple tool for taking notes. Work in progress. See: https://gitlab.com/remipassmoilesel/notes
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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337

use std::path::PathBuf;
use std::process::Command;
use std::str;

#[cfg(test)]
use mockall::automock;

use crate::config::Config;
use crate::default_error::DefaultError;

#[derive(Debug)]
pub struct CommandOutput {
    pub status: i32,
    pub stdout: String,
    pub stderr: String,
}

impl CommandOutput {
    pub fn new(code: i32, stdout: String, stderr: String) -> Self {
        CommandOutput { status: code, stdout, stderr }
    }
}

impl Default for CommandOutput {
    fn default() -> Self {
        CommandOutput::new(0, "".to_string(), "".to_string())
    }
}

#[cfg_attr(test, automock)]
pub trait Shell {
    /// Execute specified command in user shell, and capture outputs
    /// If command succeed, return a CommandOutput
    /// If command fail, return an error
    /// If command cannot be run, return an error
    fn execute(&self, command: &str, current_dir: &PathBuf) -> Result<CommandOutput, DefaultError>;

    /// Execute specified command in user shell, and capture outputs
    /// If command succeed, return a CommandOutput
    /// If command fail, return an error
    /// If command cannot be run, return an error
    fn execute_in_repo(&self, command: &str) -> Result<CommandOutput, DefaultError>;

    /// Execute specified command in user shell, and capture outputs
    /// If command succeed, return a CommandOutput
    /// If command fail, return an error
    /// If command cannot be run, return an error
    fn execute_interactive(&self, command: &str, current_dir: &PathBuf) -> Result<CommandOutput, DefaultError>;

    /// Execute specified command in user shell, and capture outputs
    /// If command succeed, return a CommandOutput
    /// If command fail, return an error
    /// If command cannot be run, return an error
    fn execute_interactive_in_repo(&self, command: &str) -> Result<CommandOutput, DefaultError>;
}

#[derive(Clone)]
pub struct ShellImpl<'a> {
    config: &'a Config,
    executor: fn(command: &str, current_dir: &PathBuf) -> Result<CommandOutput, DefaultError>,
    interactive_executor: fn(command: &str, current_dir: &PathBuf) -> Result<CommandOutput, DefaultError>,
}

impl<'a> ShellImpl<'a> {
    pub fn new(config: &'a Config) -> ShellImpl {
        ShellImpl {
            config,
            executor: command,
            interactive_executor: command_interactive,
        }
    }
}

impl<'a> Shell for ShellImpl<'a> {
    fn execute(&self, command: &str, current_dir: &PathBuf) -> Result<CommandOutput, DefaultError> {
        match (self.executor)(command, current_dir) {
            Ok(o) if o.status == 0 => Ok(o),
            Ok(o) if o.status != 0 => Err(DefaultError::new(format!(
                "Command failed: '{}'\n\n\tExit code: {}\n\tstdout: {}\n\tstderr: {}",
                command, o.status, o.stdout, o.stderr
            ))),
            Ok(_) => Err(DefaultError::new(String::from("Unexpected return value"))),
            Err(e) => Err(e),
        }
    }

    fn execute_in_repo(&self, command: &str) -> Result<CommandOutput, DefaultError> {
        self.execute(command, &self.config.storage_directory)
    }

    fn execute_interactive(&self, command: &str, current_dir: &PathBuf) -> Result<CommandOutput, DefaultError> {
        match (self.interactive_executor)(command, current_dir) {
            Ok(o) if o.status == 0 => Ok(o),
            Ok(o) if o.status != 0 => Err(DefaultError::new(format!("Command failed: '{}'\n\n\tExit code: {}\n", command, o.status))),
            Ok(_) => Err(DefaultError::new(String::from("Unexpected return value"))),
            Err(e) => Err(e),
        }
    }

    fn execute_interactive_in_repo(&self, command: &str) -> Result<CommandOutput, DefaultError> {
        self.execute_interactive(command, &self.config.storage_directory)
    }
}

/// Execute specified command in user shell, and capture outputs
/// If command succeed, return a CommandOutput
/// If command fail, return a CommandOutput
/// If command cannot be run, return an error
pub fn command(command: &str, current_dir: &PathBuf) -> Result<CommandOutput, DefaultError> {
    let mut s_comm = Command::new("sh");
    s_comm.args(&["-c", command]);
    s_comm.current_dir(current_dir);

    // println!("{}", command);

    if let Ok(out) = s_comm.output() {
        let stderr = str::from_utf8(&out.stderr[..]).unwrap_or_else(|_| "Bad stderr");
        let stdout = str::from_utf8(&out.stdout[..]).unwrap_or_else(|_| "Bad stdout");
        Ok(CommandOutput::new(
            out.status.code().unwrap_or_else(|| -1),
            String::from(stdout),
            String::from(stderr),
        ))
    } else {
        Err(DefaultError::new(format!("Cannot run command '{}'", command)))
    }
}

/// Execute specified command in user shell
/// If command succeed, return a CommandOutput
/// If command fail, return a CommandOutput
/// If command cannot be run, return an error
pub fn command_interactive(command: &str, current_dir: &PathBuf) -> Result<CommandOutput, DefaultError> {
    let mut s_comm = Command::new("sh");
    s_comm.args(&["-c", command]);
    s_comm.current_dir(current_dir);

    // println!("{}", command);

    if let Ok(out) = s_comm.status() {
        Ok(CommandOutput::new(out.code().unwrap_or_else(|| -1), "".to_string(), "".to_string()))
    } else {
        Err(DefaultError::new(format!("Cannot run command '{}'", command)))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    pub fn new_command_output() {
        let res = CommandOutput::new(5, "out".to_string(), "err".to_string());
        assert_eq!(res.status, 5);
        assert_eq!(res.stdout, "out");
        assert_eq!(res.stderr, "err");
    }

    #[test]
    pub fn correct_command() {
        let out = command("ls", &PathBuf::from("/")).unwrap();
        assert_eq!(out.status, 0);
        assert!(!out.stdout.is_empty());
        assert!(out.stderr.is_empty());
    }

    #[test]
    pub fn incorrect_command() {
        let out = command("aaaaa", &PathBuf::from("/")).unwrap();
        assert_ne!(out.status, 0);
        assert!(out.stdout.is_empty());
        assert!(!out.stderr.is_empty());
    }

    #[test]
    pub fn interactive_correct_command() {
        let out = command_interactive("ls", &PathBuf::from("/")).unwrap();
        assert_eq!(out.status, 0);
        assert!(out.stdout.is_empty());
        assert!(out.stderr.is_empty());
    }

    #[test]
    pub fn interactive_incorrect_command() {
        let out = command_interactive("aaaaa", &PathBuf::from("/")).unwrap();
        assert_ne!(out.status, 0);
        assert!(out.stdout.is_empty());
        assert!(out.stderr.is_empty());
    }

    #[test]
    pub fn shell_impl_execute_correct_command() {
        let config = Config {
            storage_directory: PathBuf::from("/storage"),
            template_path: PathBuf::from("/template.md"),
        };
        fn executor(c: &str, p: &PathBuf) -> Result<CommandOutput, DefaultError> {
            assert_eq!(p, &PathBuf::from("/storage"));
            assert_eq!(c, "test-command");
            Ok(CommandOutput {
                status: 0,
                stderr: "err".to_string(),
                stdout: "out".to_string(),
            })
        }
        let shell = ShellImpl {
            config: &config,
            executor,
            interactive_executor: command_interactive,
        };

        let res = shell.execute_in_repo("test-command").unwrap();
        assert_eq!(res.status, 0);
        assert_eq!(res.stderr, "err");
        assert_eq!(res.stdout, "out");
    }

    #[test]
    pub fn shell_impl_execute_bad_command() {
        let config = Config {
            storage_directory: PathBuf::from("/storage"),
            template_path: PathBuf::from("/template.md"),
        };
        fn executor(c: &str, p: &PathBuf) -> Result<CommandOutput, DefaultError> {
            assert_eq!(p, &PathBuf::from("/storage"));
            assert_eq!(c, "test-command");
            Ok(CommandOutput {
                status: 1,
                stderr: "err".to_string(),
                stdout: "out".to_string(),
            })
        }
        let shell = ShellImpl {
            config: &config,
            executor,
            interactive_executor: command_interactive,
        };

        let res = shell.execute_in_repo("test-command").unwrap_err();
        assert_eq!(res.message, "Command failed: \'test-command\'\n\n\tExit code: 1\n\tstdout: out\n\tstderr: err");
        print!("{}", res.message);
    }

    #[test]
    pub fn shell_impl_execute_error() {
        let config = Config {
            storage_directory: PathBuf::from("/storage"),
            template_path: PathBuf::from("/template.md"),
        };
        fn executor(c: &str, p: &PathBuf) -> Result<CommandOutput, DefaultError> {
            assert_eq!(p, &PathBuf::from("/storage"));
            assert_eq!(c, "test-command");
            Err(DefaultError::new("test error".to_string()))
        }
        let shell = ShellImpl {
            config: &config,
            executor,
            interactive_executor: command_interactive,
        };

        let res = shell.execute_in_repo("test-command").unwrap_err();
        assert_eq!(res.message, "test error");
    }

    #[test]
    pub fn shell_impl_execute_interactive_correct_command() {
        let config = Config {
            storage_directory: PathBuf::from("/storage"),
            template_path: PathBuf::from("/template.md"),
        };
        fn executor(c: &str, p: &PathBuf) -> Result<CommandOutput, DefaultError> {
            assert_eq!(p, &PathBuf::from("/storage"));
            assert_eq!(c, "test-command");
            Ok(CommandOutput {
                status: 0,
                stderr: "".to_string(),
                stdout: "".to_string(),
            })
        }
        let shell = ShellImpl {
            config: &config,
            executor: command,
            interactive_executor: executor,
        };

        let res = shell.execute_interactive_in_repo("test-command").unwrap();
        assert_eq!(res.status, 0);
        assert!(res.stderr.is_empty());
        assert!(res.stdout.is_empty());
    }

    #[test]
    pub fn shell_impl_execute_interactive_bad_command() {
        let config = Config {
            storage_directory: PathBuf::from("/storage"),
            template_path: PathBuf::from("/template.md"),
        };
        fn executor(c: &str, p: &PathBuf) -> Result<CommandOutput, DefaultError> {
            assert_eq!(p, &PathBuf::from("/storage"));
            assert_eq!(c, "test-command");
            Ok(CommandOutput {
                status: 1,
                stderr: "".to_string(),
                stdout: "".to_string(),
            })
        }
        let shell = ShellImpl {
            config: &config,
            executor: command,
            interactive_executor: executor,
        };

        let res = shell.execute_interactive_in_repo("test-command").unwrap_err();
        assert_eq!(res.message, "Command failed: \'test-command\'\n\n\tExit code: 1\n");
    }

    #[test]
    pub fn shell_impl_execute_interactive_error() {
        let config = Config {
            storage_directory: PathBuf::from("/storage"),
            template_path: PathBuf::from("/template.md"),
        };
        fn executor(c: &str, p: &PathBuf) -> Result<CommandOutput, DefaultError> {
            assert_eq!(p, &PathBuf::from("/storage"));
            assert_eq!(c, "test-command");
            Err(DefaultError::new("test error".to_string()))
        }
        let shell = ShellImpl {
            config: &config,
            executor: command,
            interactive_executor: executor,
        };

        let res = shell.execute_interactive_in_repo("test-command").unwrap_err();
        assert_eq!(res.message, "test error");
    }
}