zinit-client 0.4.0

A Rust client library for interacting with Zinit service manager
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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
use serde_json::json;
use std::collections::HashMap;
use std::time::Duration;
use tempfile::tempdir;
use zinit_client::{ClientConfig, Result, ServiceState, StreamExt, ZinitClient};

// Import the mock server
mod mock_server;
use mock_server::{MockService, MockServiceState, MockServiceTarget, MockZinitServer};

#[tokio::test]
async fn test_client_list_services() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Add some mock services
    server.add_service(MockService {
        name: "web-server".to_string(),
        pid: 1001,
        state: MockServiceState::Running,
        target: MockServiceTarget::Up,
        after: HashMap::new(),
    });

    server.add_service(MockService {
        name: "database".to_string(),
        pid: 1002,
        state: MockServiceState::Running,
        target: MockServiceTarget::Up,
        after: HashMap::new(),
    });

    // Create a client to connect to the mock server
    let client = ZinitClient::new(&socket_path);

    // List services
    let services = client.list().await?;
    println!("Found {} services", services.len());

    // Verify we got some services
    assert!(!services.is_empty(), "No services found");
    assert_eq!(services.len(), 2, "Expected 2 services");
    assert!(
        services.contains_key("web-server"),
        "Expected web-server service"
    );
    assert!(
        services.contains_key("database"),
        "Expected database service"
    );

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_client_service_lifecycle() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Add a test service
    let service_name = "test-service";
    server.add_service(MockService {
        name: service_name.to_string(),
        pid: 1001,
        state: MockServiceState::Running,
        target: MockServiceTarget::Up,
        after: HashMap::new(),
    });

    // Create a client to connect to the mock server
    let client = ZinitClient::new(&socket_path);

    // Get initial status
    let status = client.status(service_name).await?;
    assert_eq!(
        status.state,
        ServiceState::Running,
        "Service should be running"
    );
    assert!(status.pid > 0, "Service should have a valid PID");

    // Stop the service
    client.stop(service_name).await?;

    // Get status again
    let status = client.status(service_name).await?;
    assert_ne!(
        status.state,
        ServiceState::Running,
        "Service should not be running"
    );

    // Start the service again
    client.start(service_name).await?;

    // Get status again
    let status = client.status(service_name).await?;
    assert_eq!(
        status.state,
        ServiceState::Running,
        "Service should be running again"
    );

    // Stop the service for forget test
    client.stop(service_name).await?;

    // Forget the service
    client.forget(service_name).await?;

    // Verify the service is forgotten
    let services = client.list().await?;
    assert!(
        !services.contains_key(service_name),
        "Service should be forgotten"
    );

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_client_reconnection() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Add a test service
    server.add_service(MockService {
        name: "test-service".to_string(),
        pid: 1001,
        state: MockServiceState::Running,
        target: MockServiceTarget::Up,
        after: HashMap::new(),
    });

    // Create a client with custom configuration for quick retries
    let config = ClientConfig {
        socket_path: socket_path.to_str().unwrap().to_string().into(),
        connection_timeout: Duration::from_secs(1),
        operation_timeout: Duration::from_secs(5),
        max_retries: 3,
        retry_delay: Duration::from_millis(100),
        max_retry_delay: Duration::from_secs(1),
        retry_jitter: false,
    };

    let client = ZinitClient::with_config(config);

    // List services
    let services = client.list().await?;
    println!("Found {} services", services.len());
    assert_eq!(services.len(), 1, "Expected 1 service");

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_client_logs() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Add a test service
    server.add_service(MockService {
        name: "test-service".to_string(),
        pid: 1001,
        state: MockServiceState::Running,
        target: MockServiceTarget::Up,
        after: HashMap::new(),
    });

    // Create a client to connect to the mock server
    let client = ZinitClient::new(&socket_path);

    // Get a snapshot of logs
    let mut logs = client.logs(false, None::<&str>).await?;

    // Count log entries
    let mut count = 0;
    while let Some(log_result) = logs.next().await {
        let _ = log_result?;
        count += 1;
        if count >= 10 {
            break; // Limit to 10 entries for the test
        }
    }

    println!("Received {} log entries", count);

    // The mock server returns 2 log entries
    assert!(count > 0, "Expected at least one log entry");

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_client_custom_config() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Add a test service
    server.add_service(MockService {
        name: "test-service".to_string(),
        pid: 1001,
        state: MockServiceState::Running,
        target: MockServiceTarget::Up,
        after: HashMap::new(),
    });

    // Create a client with custom configuration
    let config = ClientConfig {
        socket_path: socket_path.to_str().unwrap().to_string().into(),
        connection_timeout: Duration::from_secs(2),
        operation_timeout: Duration::from_secs(10),
        max_retries: 5,
        retry_delay: Duration::from_millis(200),
        max_retry_delay: Duration::from_secs(2),
        retry_jitter: true,
    };

    let client = ZinitClient::with_config(config);

    // Test that the client works with the custom configuration
    let services = client.list().await?;
    assert_eq!(services.len(), 1, "Expected 1 service");

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_create_service() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Create a client to connect to the mock server
    let client = ZinitClient::new(&socket_path);

    // Test creating a simple service
    let service_config = json!({
        "exec": "/usr/bin/test-app",
        "args": ["--port", "8080"],
        "oneshot": false
    });

    // Create the service
    client.create_service("test-app", service_config).await?;

    // Verify the service was created by listing services
    let services = client.list().await?;
    assert!(
        services.contains_key("test-app"),
        "Service should be created"
    );

    // Verify the service is in Unknown state initially
    assert_eq!(services["test-app"], ServiceState::Unknown);

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_create_service_already_exists() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Add an existing service
    server.add_service(MockService {
        name: "existing-service".to_string(),
        pid: 1001,
        state: MockServiceState::Running,
        target: MockServiceTarget::Up,
        after: HashMap::new(),
    });

    // Create a client to connect to the mock server
    let client = ZinitClient::new(&socket_path);

    // Try to create a service with the same name
    let service_config = json!({
        "exec": "/usr/bin/test-app",
        "oneshot": false
    });

    // This should fail
    let result = client
        .create_service("existing-service", service_config)
        .await;
    assert!(result.is_err(), "Creating duplicate service should fail");

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_create_service_invalid_config() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Create a client to connect to the mock server
    let client = ZinitClient::new(&socket_path);

    // Try to create a service with invalid JSON (this will be caught by serde_json)
    let invalid_config = json!("invalid");

    // This should work at the client level but might fail at the server level
    // depending on how the mock server validates the config
    let result = client
        .create_service("invalid-service", invalid_config)
        .await;

    // The mock server should accept any valid JSON, so this should succeed
    // but the service will be created with default values
    assert!(result.is_ok(), "Valid JSON should be accepted");

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_get_service() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Add a test service
    server.add_service(MockService {
        name: "test-service".to_string(),
        pid: 1001,
        state: MockServiceState::Running,
        target: MockServiceTarget::Up,
        after: HashMap::new(),
    });

    // Create a client to connect to the mock server
    let client = ZinitClient::new(&socket_path);

    // Get the service configuration
    let service_info = client.get_service("test-service").await?;

    // Verify the service information
    assert!(
        service_info.is_object(),
        "Service info should be a JSON object"
    );

    let service_obj = service_info.as_object().unwrap();
    assert_eq!(service_obj["name"], "test-service");
    assert_eq!(service_obj["pid"], 1001);
    assert_eq!(service_obj["state"], "Running");
    assert_eq!(service_obj["target"], "Up");

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_get_service_not_found() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Create a client to connect to the mock server
    let client = ZinitClient::new(&socket_path);

    // Try to get a non-existent service
    let result = client.get_service("non-existent-service").await;
    assert!(result.is_err(), "Getting non-existent service should fail");

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_delete_service() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Add a test service that's stopped (so it can be deleted)
    server.add_service(MockService {
        name: "test-service".to_string(),
        pid: 0,
        state: MockServiceState::Success,
        target: MockServiceTarget::Down,
        after: HashMap::new(),
    });

    // Create a client to connect to the mock server
    let client = ZinitClient::new(&socket_path);

    // Verify the service exists
    let services = client.list().await?;
    assert!(
        services.contains_key("test-service"),
        "Service should exist"
    );

    // Delete the service
    client.delete_service("test-service").await?;

    // Verify the service is gone
    let services = client.list().await?;
    assert!(
        !services.contains_key("test-service"),
        "Service should be deleted"
    );

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_delete_running_service() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Add a running test service
    server.add_service(MockService {
        name: "running-service".to_string(),
        pid: 1001,
        state: MockServiceState::Running,
        target: MockServiceTarget::Up,
        after: HashMap::new(),
    });

    // Create a client to connect to the mock server
    let client = ZinitClient::new(&socket_path);

    // Verify the service exists and is running
    let status = client.status("running-service").await?;
    assert_eq!(status.state, ServiceState::Running);

    // Delete the service (should stop it first, then delete)
    client.delete_service("running-service").await?;

    // Verify the service is gone
    let services = client.list().await?;
    assert!(
        !services.contains_key("running-service"),
        "Service should be deleted"
    );

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_delete_service_not_found() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Create a client to connect to the mock server
    let client = ZinitClient::new(&socket_path);

    // Try to delete a non-existent service
    let result = client.delete_service("non-existent-service").await;
    assert!(result.is_err(), "Deleting non-existent service should fail");

    // Stop the mock server
    server.stop().await;

    Ok(())
}

#[tokio::test]
async fn test_service_crud_lifecycle() -> Result<()> {
    // Create a temporary directory for the socket
    let temp_dir = tempdir().expect("Failed to create temp dir");
    let socket_path = temp_dir.path().join("mock-zinit.sock");

    // Create and start the mock server
    let mut server = MockZinitServer::new(&socket_path).await;
    server.start().await.expect("Failed to start mock server");

    // Create a client to connect to the mock server
    let client = ZinitClient::new(&socket_path);

    let service_name = "lifecycle-test-service";

    // 1. CREATE: Create a new service
    let service_config = json!({
        "exec": "/usr/bin/test-app",
        "args": ["--config", "/etc/test.conf"],
        "env": {
            "PORT": "8080",
            "ENV": "test"
        },
        "oneshot": false,
        "working_dir": "/opt/test"
    });

    client.create_service(service_name, service_config).await?;

    // Verify service was created
    let services = client.list().await?;
    assert!(
        services.contains_key(service_name),
        "Service should be created"
    );
    assert_eq!(services[service_name], ServiceState::Unknown);

    // 2. READ: Get service information
    let service_info = client.get_service(service_name).await?;
    assert!(
        service_info.is_object(),
        "Service info should be a JSON object"
    );

    let service_obj = service_info.as_object().unwrap();
    assert_eq!(service_obj["name"], service_name);
    assert_eq!(service_obj["state"], "Unknown");
    assert_eq!(service_obj["target"], "Down");
    assert_eq!(service_obj["pid"], 0);

    // 3. UPDATE: Start the service (this changes its state)
    client.start(service_name).await?;

    // Verify the service is now running
    let updated_info = client.get_service(service_name).await?;
    let updated_obj = updated_info.as_object().unwrap();
    assert_eq!(updated_obj["state"], "Running");
    assert_eq!(updated_obj["target"], "Up");
    assert!(updated_obj["pid"].as_u64().unwrap() > 0);

    // 4. DELETE: Delete the service
    client.delete_service(service_name).await?;

    // Verify the service is gone
    let services = client.list().await?;
    assert!(
        !services.contains_key(service_name),
        "Service should be deleted"
    );

    // Verify we can't get the deleted service
    let result = client.get_service(service_name).await;
    assert!(result.is_err(), "Getting deleted service should fail");

    // Stop the mock server
    server.stop().await;

    Ok(())
}