a3s-box-runtime 2.3.0

MicroVM runtime engine — VM lifecycle, OCI images, attestation, networking
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

//! Guest filesystem layout constants.
//!
//! Defines the directory structure inside the guest VM.

/// Working directory inside the guest VM.
pub const GUEST_WORKDIR: &str = "/workspace";

/// Guest filesystem layout.
#[derive(Debug, Clone)]
pub struct GuestLayout {
    /// Workspace mount point (virtio-fs).
    pub workspace_dir: &'static str,

    /// Temporary directory.
    pub tmp_dir: &'static str,

    /// Run directory for runtime files.
    pub run_dir: &'static str,
}

impl Default for GuestLayout {
    fn default() -> Self {
        Self {
            workspace_dir: "/workspace",
            tmp_dir: "/tmp",
            run_dir: "/run",
        }
    }
}

impl GuestLayout {
    /// Get the standard guest layout.
    pub fn standard() -> Self {
        Self::default()
    }

    /// Get all directories that need to be created in the rootfs.
    pub fn required_dirs(&self) -> Vec<&str> {
        vec![
            self.workspace_dir,
            self.tmp_dir,
            self.run_dir,
            "/dev",
            "/proc",
            "/sys",
            "/etc",
            "/var",
            "/var/tmp",
            "/var/log",
        ]
    }
}

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

    #[test]
    fn test_guest_layout_defaults() {
        let layout = GuestLayout::default();
        assert_eq!(layout.workspace_dir, "/workspace");
        assert_eq!(layout.tmp_dir, "/tmp");
        assert_eq!(layout.run_dir, "/run");
    }

    #[test]
    fn test_guest_layout_standard_equals_default() {
        let standard = GuestLayout::standard();
        let default = GuestLayout::default();
        assert_eq!(standard.workspace_dir, default.workspace_dir);
        assert_eq!(standard.tmp_dir, default.tmp_dir);
    }

    #[test]
    fn test_required_dirs_contains_all_layout_dirs() {
        let layout = GuestLayout::standard();
        let dirs = layout.required_dirs();

        assert!(dirs.contains(&layout.workspace_dir));
        assert!(dirs.contains(&layout.tmp_dir));
        assert!(dirs.contains(&layout.run_dir));
    }

    #[test]
    fn test_required_dirs_contains_system_dirs() {
        let layout = GuestLayout::standard();
        let dirs = layout.required_dirs();

        assert!(dirs.contains(&"/dev"));
        assert!(dirs.contains(&"/proc"));
        assert!(dirs.contains(&"/sys"));
        assert!(dirs.contains(&"/etc"));
        assert!(dirs.contains(&"/var"));
        assert!(dirs.contains(&"/var/tmp"));
        assert!(dirs.contains(&"/var/log"));
    }

    #[test]
    fn test_guest_workdir_constant() {
        assert_eq!(GUEST_WORKDIR, "/workspace");
        let layout = GuestLayout::default();
        assert_eq!(GUEST_WORKDIR, layout.workspace_dir);
    }

    #[test]
    fn test_guest_layout_clone() {
        let layout = GuestLayout::default();
        let cloned = layout.clone();
        assert_eq!(layout.workspace_dir, cloned.workspace_dir);
        assert_eq!(layout.tmp_dir, cloned.tmp_dir);
    }
}