lsp-cli 0.1.6

Command-line tool for talking to Language Server Protocol (LSP) servers from the terminal.
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

use std::path::Path;

use super::E2eContext;

impl E2eContext {
    pub(super) fn isolated_roots(&self) -> [std::path::PathBuf; 2] {
        [
            self.home
                .parent()
                .expect("isolated home should have a sandbox parent")
                .to_path_buf(),
            self.runtime_dir.clone(),
        ]
    }

    pub(crate) fn run_cleaned(
        operation: impl FnOnce(&Self) -> Result<(), String>,
    ) -> Result<(), String> {
        let context = Self::new()
            .map_err(|error| format!("failed to create an isolated E2E context: {error}"))?;
        let [cache_root, runtime_root] = context.isolated_roots();
        let result = operation(&context);
        let retained = context.retained_failure_state();

        // Drop here, instead of at function exit, so every real-server case verifies that its
        // downloaded packages, compiler caches, temporary build output, and runtime state vanish.
        drop(context);
        let roots = [
            ("sandbox", cache_root.as_path()),
            ("runtime", runtime_root.as_path()),
        ];
        let cleanup_state = roots
            .iter()
            .map(|(label, path)| {
                let status = if path.exists() {
                    "not removed"
                } else {
                    "removed"
                };
                format!("{label} root: {status} ({})", path.display())
            })
            .collect::<Vec<_>>()
            .join("\n");
        let leftovers = roots
            .into_iter()
            .filter(|(_, path)| path.exists())
            .map(|(_, path)| Path::display(path).to_string())
            .collect::<Vec<_>>();
        let cleanup = leftovers.is_empty().then_some(()).ok_or_else(|| {
            format!(
                "isolated E2E download cache was not removed: {}",
                leftovers.join(", ")
            )
        });

        match (result, cleanup) {
            (Err(case), cleanup) => {
                let cleanup_error = cleanup
                    .err()
                    .map(|error| format!("\n{error}"))
                    .unwrap_or_default();
                Err(format!(
                    "{case}\nretained E2E failure context:\n{retained}\ncleanup state:\n{cleanup_state}{cleanup_error}"
                ))
            }
            (Ok(()), Err(error)) => Err(format!(
                "{error}\nretained E2E failure context:\n{retained}\ncleanup state:\n{cleanup_state}"
            )),
            (Ok(()), Ok(())) => Ok(()),
        }
    }
}

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

    #[test]
    fn removes_all_case_cache_roots_before_returning() {
        let mut roots = Vec::new();
        E2eContext::run_cleaned(|context| {
            roots.extend(context.isolated_roots());
            std::fs::write(context.home.join("download-cache"), b"cache")
                .expect("cache fixture should be created");
            Ok(())
        })
        .expect("case cleanup should succeed");

        assert!(roots.into_iter().all(|root| !root.exists()));
    }
}