cubic 0.14.0

Cubic is a lightweight command line manager for virtual machines. It has a simple, daemon-less and rootless design. All Cubic virtual machines run isolated in the user context. Cubic is built on top of QEMU, KVM and cloud-init. Show all supported images: $ cubic images Create a new virtual machine instance: $ cubic create mymachine --image ubuntu:noble List all virtual machine instances: $ cubic instances Start an instance: $ cubic start <instance name> Stop an instance: $ cubic stop <instance name> Open a shell in the instance: $ cubic ssh <machine name> Copy a file from the host to the instance: $ cubic scp <path/to/host/file> <machine>:<path/to/guest/file> Copy a file from the instance to the hots: $ cubic scp <machine>:<path/to/guest/file> <path/to/host/file> 
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

#[derive(Clone)]
pub struct Environment {
    data_dir: String,
    cache_dir: String,
    runtime_dir: String,
}

impl Environment {
    pub fn new(data_dir: String, cache_dir: String, runtime_dir: String) -> Self {
        Self {
            data_dir,
            cache_dir,
            runtime_dir,
        }
    }

    pub fn get_cache_dir(&self) -> &str {
        &self.cache_dir
    }

    pub fn get_runtime_dir(&self) -> &str {
        &self.runtime_dir
    }

    pub fn get_instance_dir(&self) -> String {
        format!("{}/machines", self.data_dir)
    }

    pub fn get_image_dir(&self) -> String {
        format!("{}/images", self.cache_dir)
    }

    pub fn get_image_file(&self, image: &str) -> String {
        format!("{}/{image}", self.get_image_dir())
    }

    pub fn get_image_cache_file(&self) -> String {
        format!("{}/images.cache", self.cache_dir)
    }

    pub fn get_instance_dir2(&self, instance: &str) -> String {
        format!("{}/{instance}", &self.get_instance_dir())
    }

    pub fn get_instance_config_file(&self, instance: &str) -> String {
        format!("{}/machine.yaml", &self.get_instance_dir2(instance))
    }

    pub fn get_instance_image_file(&self, instance: &str) -> String {
        format!("{}/machine.img", &self.get_instance_dir2(instance))
    }

    pub fn get_instance_cache_dir(&self, instance: &str) -> String {
        format!("{}/instances/{instance}", &self.get_cache_dir())
    }

    pub fn get_user_data_image_file(&self, instance: &str) -> String {
        format!("{}/user-data.img", &self.get_instance_cache_dir(instance))
    }

    pub fn get_meta_data_file(&self, instance: &str) -> String {
        format!("{}/meta-data", &self.get_instance_cache_dir(instance))
    }

    pub fn get_user_data_file(&self, instance: &str) -> String {
        format!("{}/user-data", &self.get_instance_cache_dir(instance))
    }

    pub fn get_instance_runtime_dir(&self, instance: &str) -> String {
        format!("{}/instances/{instance}", self.runtime_dir)
    }

    pub fn get_qemu_pid_file(&self, instance: &str) -> String {
        format!("{}/qemu.pid", self.get_instance_runtime_dir(instance))
    }

    pub fn get_console_file(&self, instance: &str) -> String {
        format!("{}/console", self.get_instance_runtime_dir(instance))
    }

    pub fn get_monitor_file(&self, instance: &str) -> String {
        format!("{}/monitor.socket", self.get_instance_runtime_dir(instance))
    }

    pub fn get_guest_agent_file(&self, instance: &str) -> String {
        format!(
            "{}/guest-agent.socket",
            self.get_instance_runtime_dir(instance)
        )
    }
}

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

    #[test]
    fn test_paths() {
        let env = Environment::new(
            "/data/cubic".to_string(),
            "/cache/cubic".to_string(),
            "/runtime/cubic".to_string(),
        );

        assert_eq!(env.get_cache_dir(), "/cache/cubic");
        assert_eq!(env.get_runtime_dir(), "/runtime/cubic");
        assert_eq!(env.get_instance_dir(), "/data/cubic/machines");
        assert_eq!(env.get_image_dir(), "/cache/cubic/images");
        assert_eq!(
            env.get_image_file("debian_bookworm_amd64"),
            "/cache/cubic/images/debian_bookworm_amd64"
        );
        assert_eq!(env.get_image_cache_file(), "/cache/cubic/images.cache");
        assert_eq!(
            env.get_instance_dir2("mymachine"),
            "/data/cubic/machines/mymachine"
        );
        assert_eq!(
            env.get_instance_config_file("mymachine"),
            "/data/cubic/machines/mymachine/machine.yaml"
        );
        assert_eq!(
            env.get_instance_image_file("mymachine"),
            "/data/cubic/machines/mymachine/machine.img"
        );
        assert_eq!(
            env.get_instance_cache_dir("mymachine"),
            "/cache/cubic/instances/mymachine"
        );
        assert_eq!(
            env.get_user_data_image_file("mymachine"),
            "/cache/cubic/instances/mymachine/user-data.img"
        );
        assert_eq!(
            env.get_meta_data_file("mymachine"),
            "/cache/cubic/instances/mymachine/meta-data"
        );
        assert_eq!(
            env.get_user_data_file("mymachine"),
            "/cache/cubic/instances/mymachine/user-data"
        );
        assert_eq!(
            env.get_instance_runtime_dir("mymachine"),
            "/runtime/cubic/instances/mymachine"
        );
        assert_eq!(
            env.get_qemu_pid_file("mymachine"),
            "/runtime/cubic/instances/mymachine/qemu.pid"
        );
        assert_eq!(
            env.get_console_file("mymachine"),
            "/runtime/cubic/instances/mymachine/console"
        );
        assert_eq!(
            env.get_monitor_file("mymachine"),
            "/runtime/cubic/instances/mymachine/monitor.socket"
        );
        assert_eq!(
            env.get_guest_agent_file("mymachine"),
            "/runtime/cubic/instances/mymachine/guest-agent.socket"
        );
    }
}