vm-pool-client 0.1.0-alpha.1

Client library for communicating with the vm-pool service
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
//! Client library for communicating with the vm-pool service.
//!
//! Provides a high-level async API over the Unix socket protocol.
//!
//! # Example
//!
//! ```no_run
//! # async fn example() -> Result<(), vm_pool_client::ClientError> {
//! use vm_pool_client::Client;
//! use vm_pool_protocol::VmConfig;
//!
//! let mut client = Client::connect("/tmp/vm-pool.sock").await?;
//!
//! let status = client.status().await?;
//! println!("available: {}", status.available);
//!
//! let vm_id = client.allocate("agent:v1.0.0", VmConfig::default()).await?;
//! println!("allocated: {}", vm_id);
//!
//! client.deallocate(&vm_id).await?;
//! # Ok(())
//! # }
//! ```

use std::path::Path;

use vm_pool_protocol::{
    LogLine, ServiceCommand, ServiceEvent, VmCommand, VmConfig, VmId,
};
use thiserror::Error;
use tokio::io::{AsyncBufReadExt, AsyncWriteExt, BufReader};
use tokio::net::UnixStream;
use tokio::sync::mpsc;
use tracing::debug;

#[derive(Debug, Error)]
pub enum ClientError {
    #[error("connection failed: {0}")]
    Connect(#[from] std::io::Error),
    #[error("JSON error: {0}")]
    Json(#[from] serde_json::Error),
    #[error("connection closed")]
    Closed,
    #[error("service error: {0}")]
    Service(String),
    #[error("unexpected response: {0:?}")]
    UnexpectedResponse(ServiceEvent),
}

/// Pool status information.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PoolStatus {
    pub total: usize,
    pub available: usize,
    pub allocated: usize,
}

/// Client for communicating with the vm-pool service.
pub struct Client {
    /// Channel for sending serialized commands to the writer task.
    cmd_tx: mpsc::Sender<String>,
    /// Channel for receiving parsed responses from the reader task.
    resp_rx: mpsc::Receiver<ServiceEvent>,
}

impl Client {
    /// Connect to the vm-pool service at the given Unix socket path.
    pub async fn connect(path: impl AsRef<Path>) -> Result<Self, ClientError> {
        let stream = UnixStream::connect(path.as_ref()).await?;
        let (reader, writer) = stream.into_split();

        let (cmd_tx, mut cmd_rx) = mpsc::channel::<String>(64);
        let (resp_tx, resp_rx) = mpsc::channel::<ServiceEvent>(64);

        // Writer task
        tokio::spawn(async move {
            let mut writer = writer;
            while let Some(line) = cmd_rx.recv().await {
                if writer.write_all(line.as_bytes()).await.is_err() {
                    break;
                }
                if writer.write_all(b"\n").await.is_err() {
                    break;
                }
                let _ = writer.flush().await;
            }
        });

        // Reader task
        tokio::spawn(async move {
            let mut reader = BufReader::new(reader);
            let mut line = String::new();
            loop {
                line.clear();
                match reader.read_line(&mut line).await {
                    Ok(0) => break,
                    Ok(_) => {
                        if let Ok(event) = serde_json::from_str::<ServiceEvent>(line.trim()) {
                            if resp_tx.send(event).await.is_err() {
                                break;
                            }
                        }
                    }
                    Err(_) => break,
                }
            }
        });

        Ok(Self { cmd_tx, resp_rx })
    }

    /// Send a command and wait for the next response.
    async fn request(&mut self, command: ServiceCommand) -> Result<ServiceEvent, ClientError> {
        let json = serde_json::to_string(&command)?;
        debug!("sending: {}", json);
        self.cmd_tx
            .send(json)
            .await
            .map_err(|_| ClientError::Closed)?;

        self.resp_rx.recv().await.ok_or(ClientError::Closed)
    }

    /// Convert a ServiceEvent::Error into a ClientError, or return the event.
    fn check_error(event: ServiceEvent) -> Result<ServiceEvent, ClientError> {
        match event {
            ServiceEvent::Error { message } => Err(ClientError::Service(message)),
            other => Ok(other),
        }
    }

    /// Get pool status.
    pub async fn status(&mut self) -> Result<PoolStatus, ClientError> {
        let resp = self.request(ServiceCommand::Status).await?;
        match Self::check_error(resp)? {
            ServiceEvent::PoolStatus {
                total,
                available,
                allocated,
            } => Ok(PoolStatus {
                total,
                available,
                allocated,
            }),
            other => Err(ClientError::UnexpectedResponse(other)),
        }
    }

    /// Allocate a new VM. Returns the VM ID.
    pub async fn allocate(
        &mut self,
        image: &str,
        config: VmConfig,
    ) -> Result<VmId, ClientError> {
        let resp = self
            .request(ServiceCommand::Allocate {
                image: image.to_string(),
                config,
            })
            .await?;
        match Self::check_error(resp)? {
            ServiceEvent::VmAllocated { vm_id, .. } => Ok(vm_id),
            other => Err(ClientError::UnexpectedResponse(other)),
        }
    }

    /// Deallocate a VM.
    pub async fn deallocate(&mut self, vm_id: &VmId) -> Result<(), ClientError> {
        let resp = self
            .request(ServiceCommand::Deallocate {
                vm_id: vm_id.clone(),
            })
            .await?;
        match Self::check_error(resp)? {
            ServiceEvent::VmStopped { .. } => Ok(()),
            other => Err(ClientError::UnexpectedResponse(other)),
        }
    }

    /// Send a command to a VM.
    pub async fn send_command(
        &mut self,
        vm_id: &VmId,
        command: VmCommand,
    ) -> Result<ServiceEvent, ClientError> {
        let resp = self
            .request(ServiceCommand::Send {
                vm_id: vm_id.clone(),
                command,
            })
            .await?;
        Self::check_error(resp)
    }

    /// Save a snapshot of a VM.
    pub async fn snapshot(&mut self, vm_id: &VmId, name: &str) -> Result<(), ClientError> {
        let resp = self
            .request(ServiceCommand::Snapshot {
                vm_id: vm_id.clone(),
                name: name.to_string(),
            })
            .await?;
        match Self::check_error(resp)? {
            ServiceEvent::VmStopped { .. } => Ok(()),
            other => Err(ClientError::UnexpectedResponse(other)),
        }
    }

    /// Restore a VM from a snapshot.
    pub async fn restore(&mut self, vm_id: &VmId, snapshot: &str) -> Result<(), ClientError> {
        let resp = self
            .request(ServiceCommand::Restore {
                vm_id: vm_id.clone(),
                snapshot: snapshot.to_string(),
            })
            .await?;
        match Self::check_error(resp)? {
            ServiceEvent::VmReady { .. } => Ok(()),
            other => Err(ClientError::UnexpectedResponse(other)),
        }
    }

    /// Tail log lines from a VM.
    pub async fn tail_logs(
        &mut self,
        vm_id: &VmId,
        lines: usize,
    ) -> Result<Vec<LogLine>, ClientError> {
        let resp = self
            .request(ServiceCommand::TailLogs {
                vm_id: vm_id.clone(),
                lines,
            })
            .await?;
        match Self::check_error(resp)? {
            ServiceEvent::LogTail { lines, .. } => Ok(lines),
            other => Err(ClientError::UnexpectedResponse(other)),
        }
    }

    /// Subscribe to logs from a specific VM (or all VMs if None).
    pub async fn subscribe_logs(
        &mut self,
        vm_id: Option<&VmId>,
    ) -> Result<(), ClientError> {
        let resp = self
            .request(ServiceCommand::SubscribeLogs {
                vm_id: vm_id.cloned(),
            })
            .await?;
        match Self::check_error(resp)? {
            ServiceEvent::LogsSubscribed { .. } => Ok(()),
            other => Err(ClientError::UnexpectedResponse(other)),
        }
    }

    /// Unsubscribe from log streaming.
    pub async fn unsubscribe_logs(&mut self) -> Result<(), ClientError> {
        let resp = self.request(ServiceCommand::UnsubscribeLogs).await?;
        match Self::check_error(resp)? {
            ServiceEvent::LogsSubscribed { .. } => Ok(()),
            other => Err(ClientError::UnexpectedResponse(other)),
        }
    }

    /// Receive the next event (for streaming/subscriptions).
    /// Returns None if the connection is closed.
    pub async fn next_event(&mut self) -> Option<ServiceEvent> {
        self.resp_rx.recv().await
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::Arc;
    use vm_pool_manager::PoolConfig;
    use vm_pool_service::{Service, ServiceConfig};

    /// Start a service on a temp socket and return a connected client.
    async fn test_client() -> (Client, Arc<Service>, tempfile::TempDir) {
        let dir = tempfile::tempdir().unwrap();
        let socket_path = dir.path().join("test.sock");

        let config = ServiceConfig {
            socket_path: socket_path.clone(),
            snapshot_dir: dir.path().join("snapshots"),
            pool: PoolConfig {
                max_vms: 3,
                health_check_interval: 300,
                vm_timeout: 7200,
            },
        };

        let service = Service::new(config).await.unwrap();
        let svc = service.clone();

        // Run service in background
        tokio::spawn(async move { svc.run().await });

        // Wait for socket to be ready
        for _ in 0..50 {
            if socket_path.exists() {
                break;
            }
            tokio::time::sleep(std::time::Duration::from_millis(10)).await;
        }

        let client = Client::connect(&socket_path).await.unwrap();
        (client, service, dir)
    }

    #[tokio::test]
    async fn client_status() {
        let (mut client, _svc, _dir) = test_client().await;

        let status = client.status().await.unwrap();
        assert_eq!(status.total, 3);
        assert_eq!(status.available, 3);
        assert_eq!(status.allocated, 0);
    }

    #[tokio::test]
    async fn client_allocate_and_deallocate() {
        let (mut client, _svc, _dir) = test_client().await;

        let vm_id = client
            .allocate("agent:v1", VmConfig::default())
            .await
            .unwrap();

        let status = client.status().await.unwrap();
        assert_eq!(status.allocated, 1);

        client.deallocate(&vm_id).await.unwrap();

        let status = client.status().await.unwrap();
        assert_eq!(status.allocated, 0);
    }

    #[tokio::test]
    async fn client_allocate_error() {
        let dir = tempfile::tempdir().unwrap();
        let socket_path = dir.path().join("test.sock");

        let config = ServiceConfig {
            socket_path: socket_path.clone(),
            snapshot_dir: dir.path().join("snapshots"),
            pool: PoolConfig {
                max_vms: 0, // No VMs allowed
                health_check_interval: 300,
                vm_timeout: 7200,
            },
        };

        let service = Service::new(config).await.unwrap();
        let svc = service.clone();
        tokio::spawn(async move { svc.run().await });

        for _ in 0..50 {
            if socket_path.exists() {
                break;
            }
            tokio::time::sleep(std::time::Duration::from_millis(10)).await;
        }

        let mut client = Client::connect(&socket_path).await.unwrap();
        let result = client.allocate("agent:v1", VmConfig::default()).await;
        assert!(matches!(result, Err(ClientError::Service(_))));
    }

    #[tokio::test]
    async fn client_tail_logs() {
        let (mut client, _svc, _dir) = test_client().await;

        let vm_id = VmId::new("vm-nonexistent");
        let logs = client.tail_logs(&vm_id, 10).await.unwrap();
        assert!(logs.is_empty());
    }

    #[tokio::test]
    async fn client_subscribe_unsubscribe() {
        let (mut client, _svc, _dir) = test_client().await;

        client.subscribe_logs(None).await.unwrap();
        client.unsubscribe_logs().await.unwrap();
    }

    #[tokio::test]
    async fn client_full_lifecycle() {
        let (mut client, _svc, _dir) = test_client().await;

        // Check initial status
        let status = client.status().await.unwrap();
        assert_eq!(status.available, 3);

        // Allocate two VMs
        let vm1 = client
            .allocate("agent:v1", VmConfig::default())
            .await
            .unwrap();
        let vm2 = client
            .allocate("automation:v1", VmConfig::default())
            .await
            .unwrap();

        let status = client.status().await.unwrap();
        assert_eq!(status.allocated, 2);
        assert_eq!(status.available, 1);

        // Deallocate one
        client.deallocate(&vm1).await.unwrap();

        let status = client.status().await.unwrap();
        assert_eq!(status.allocated, 1);
        assert_eq!(status.available, 2);

        // Deallocate the other
        client.deallocate(&vm2).await.unwrap();

        let status = client.status().await.unwrap();
        assert_eq!(status.allocated, 0);
    }
}