systemg 0.37.1

A simple process 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
633
634
#[path = "common/mod.rs"]
mod common;

#[cfg(unix)]
use std::os::unix::net::UnixListener;
#[cfg(target_os = "linux")]
use std::process::Command as StdCommand;
use std::{
    fs, thread,
    time::{Duration, Instant},
};

use assert_cmd::Command;
use common::HomeEnvGuard;
#[cfg(target_os = "linux")]
use common::{is_process_alive, wait_for_path};
use systemg::daemon::PidFile;
use tempfile::tempdir;

#[test]
fn logs_help_reports_combined_default() {
    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("logs")
        .arg("--help")
        .assert()
        .success()
        .stdout(predicates::str::contains("Defaults to stdout+stderr"))
        .stdout(predicates::str::contains("Tail stored service output logs"));
}

#[cfg(unix)]
#[test]
fn stale_socket_doesnt_block_commands() {
    let temp = tempdir().expect("failed to create tempdir");
    let dir = temp.path();
    let home = dir.join("home");
    fs::create_dir_all(&home).expect("failed to create home dir");
    let _home = HomeEnvGuard::set(&home);

    let config_path = dir.join("systemg.yaml");
    fs::write(
        &config_path,
        r#"version: "1"
services:
  test_service:
    command: "sleep 5"
"#,
    )
    .expect("failed to write config");

    let runtime_dir = home.join(".local/share/systemg");
    fs::create_dir_all(&runtime_dir).expect("failed to create runtime dir");

    let socket_path = runtime_dir.join("control.sock");
    let listener = match UnixListener::bind(&socket_path) {
        Ok(listener) => listener,
        Err(err) if err.kind() == std::io::ErrorKind::PermissionDenied => {
            eprintln!(
                "Skipping stale_socket_doesnt_block_commands: cannot bind stale socket ({err})"
            );
            return;
        }
        Err(err) => panic!("failed to create socket: {err}"),
    };
    drop(listener);

    let pid_file = runtime_dir.join("sysg.pid");
    fs::write(&pid_file, "999999").expect("failed to write stale pid");

    let output = Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("stop")
        .arg("--config")
        .arg(config_path.to_str().unwrap())
        .output()
        .expect("failed to execute stop");

    let stderr = String::from_utf8_lossy(&output.stderr);
    assert!(
        !stderr.contains("Connection refused"),
        "Should not get 'Connection refused' with stale socket. stderr: {}",
        stderr
    );

    assert!(
        !socket_path.exists() || !pid_file.exists(),
        "Stale socket or PID file should be cleaned up"
    );
}

#[test]
fn purge_removes_all_state() {
    let temp = tempdir().expect("failed to create tempdir");
    let dir = temp.path();
    let home = dir.join("home");
    fs::create_dir_all(&home).expect("failed to create home dir");
    let _home = HomeEnvGuard::set(&home);

    let config_path = dir.join("systemg.yaml");
    fs::write(
        &config_path,
        r#"version: "1"
services:
  test_service:
    command: "sleep 2"
"#,
    )
    .expect("failed to write config");

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("start")
        .arg("--config")
        .arg(config_path.to_str().unwrap())
        .arg("--daemonize")
        .assert()
        .success();

    thread::sleep(Duration::from_secs(3));

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("stop")
        .assert()
        .success();

    thread::sleep(Duration::from_millis(500));

    let runtime_dir = home.join(".local/share/systemg");
    let state_file = runtime_dir.join("state.xml");
    let pid_file = runtime_dir.join("pid.xml");
    let lock_file = runtime_dir.join("pid.xml.lock");
    let supervisor_log = runtime_dir.join("logs/supervisor.log");

    assert!(state_file.exists(), "state.xml should exist before purge");
    assert!(
        pid_file.exists() || lock_file.exists() || supervisor_log.exists(),
        "At least one runtime file should exist before purge"
    );

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("purge")
        .assert()
        .success();

    assert!(
        !state_file.exists(),
        "state.xml should be removed after purge"
    );
    assert!(!pid_file.exists(), "pid.xml should be removed after purge");
    assert!(
        !lock_file.exists(),
        "pid.xml.lock should be removed after purge"
    );
    assert!(
        !supervisor_log.exists(),
        "supervisor.log should be removed after purge"
    );
    assert!(
        !runtime_dir.exists(),
        "Runtime directory should be completely removed after purge"
    );
}

#[cfg(target_os = "linux")]
#[test]
fn purge_stops_running_supervisor() {
    let temp = tempdir().expect("failed to create tempdir");
    let dir = temp.path();
    let home = dir.join("home");
    fs::create_dir_all(&home).expect("failed to create home dir");
    let _home = HomeEnvGuard::set(&home);

    let mut sleeper = StdCommand::new("sleep")
        .arg("30")
        .spawn()
        .expect("failed to spawn sleeper");
    let pid = sleeper.id();

    assert!(is_process_alive(pid), "sleeper should be running");

    let runtime_dir = home.join(".local/share/systemg");
    fs::create_dir_all(&runtime_dir).expect("failed to create runtime dir");
    let pid_path = runtime_dir.join("sysg.pid");
    fs::write(&pid_path, pid.to_string()).expect("failed to write pid file");

    wait_for_path(&pid_path);

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("purge")
        .assert()
        .success();

    let kill_result = unsafe { libc::kill(pid as libc::pid_t, 0) };
    if kill_result == 0 {
        // Process still responds to signal 0; purge should still have attempted termination.
    }

    let _ = sleeper.wait();

    assert!(
        !runtime_dir.exists(),
        "runtime directory should be removed after purge"
    );
}

#[test]
fn sys_flag_requires_root_privileges() {
    if nix::unistd::Uid::effective().is_root() {
        return;
    }

    let output = Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("--sys")
        .arg("status")
        .output()
        .expect("failed to invoke sysg");

    assert!(
        !output.status.success(),
        "--sys should fail when invoked without root"
    );
    let stderr = String::from_utf8_lossy(&output.stderr);
    assert!(
        stderr.contains("--sys requires root"),
        "stderr should mention missing root privileges: {stderr}"
    );
}

#[test]
fn inspect_requires_service_flag_not_positional_arg() {
    let output = Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("inspect")
        .arg("demo-service")
        .output()
        .expect("failed to invoke sysg inspect");

    assert!(
        !output.status.success(),
        "inspect should reject positional service arguments"
    );

    let stderr = String::from_utf8_lossy(&output.stderr);
    assert!(
        stderr.contains("unexpected argument") && stderr.contains("--service"),
        "stderr should direct usage to --service: {stderr}"
    );
}

#[test]
fn restart_daemonize_returns_without_waiting_for_supervisor_restart() {
    let temp = tempdir().expect("failed to create tempdir");
    let dir = temp.path();
    let home = dir.join("home");
    fs::create_dir_all(&home).expect("failed to create home dir");
    let _home = HomeEnvGuard::set(&home);

    let config_path = dir.join("systemg.yaml");
    fs::write(
        &config_path,
        r#"version: "1"
services:
  test_service:
    command: "sleep 30"
"#,
    )
    .expect("failed to write initial config");

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("start")
        .arg("--config")
        .arg(config_path.to_str().unwrap())
        .arg("--daemonize")
        .assert()
        .success();

    thread::sleep(Duration::from_secs(1));

    fs::write(
        &config_path,
        r#"version: "1"
services:
  test_service:
    command: "sleep 30"
    deployment:
      strategy: "immediate"
      pre_start: "sleep 3"
"#,
    )
    .expect("failed to write updated config");

    let start = Instant::now();
    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("restart")
        .arg("--config")
        .arg(config_path.to_str().unwrap())
        .arg("--daemonize")
        .assert()
        .success();
    let elapsed = start.elapsed();

    assert!(
        elapsed < Duration::from_secs(2),
        "daemonized restart should return promptly, took {:?}",
        elapsed
    );

    thread::sleep(Duration::from_secs(5));

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("status")
        .arg("--config")
        .arg(config_path.to_str().unwrap())
        .arg("--service")
        .arg("test_service")
        .assert()
        .success();

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("stop")
        .assert()
        .success();
}

#[cfg(unix)]
#[test]
fn rolling_restart_cli_does_not_leave_duplicate_long_lived_processes() {
    use std::os::unix::fs::PermissionsExt;

    let temp = tempdir().expect("failed to create tempdir");
    let dir = temp.path();
    let home = dir.join("home");
    fs::create_dir_all(&home).expect("failed to create home dir");
    let _home = HomeEnvGuard::set(&home);

    let pid_log = dir.join("service-pids.txt");
    let service_script = dir.join("long-lived-service.sh");
    fs::write(
        &service_script,
        format!(
            "#!/bin/sh\n\
echo $$ >> '{}'\n\
trap 'exit 0' TERM INT\n\
while true; do sleep 1; done\n",
            pid_log.display()
        ),
    )
    .expect("failed to write service script");
    let mut perms = fs::metadata(&service_script)
        .expect("failed to stat service script")
        .permissions();
    perms.set_mode(0o755);
    fs::set_permissions(&service_script, perms).expect("failed to chmod service script");

    let config_path = dir.join("systemg.yaml");
    fs::write(
        &config_path,
        format!(
            r#"version: "1"
services:
  long_lived:
    command: "{}"
    restart_policy: "always"
    deployment:
      strategy: "rolling"
      grace_period: "100ms"
"#,
            service_script.display()
        ),
    )
    .expect("failed to write config");

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("start")
        .arg("--config")
        .arg(config_path.to_str().unwrap())
        .arg("--daemonize")
        .assert()
        .success();

    let initial_pids = common::wait_for_lines(&pid_log, 1);
    let first_pid: u32 = initial_pids[0]
        .trim()
        .parse()
        .expect("first service pid should parse");
    assert!(
        common::is_process_alive(first_pid),
        "initial service pid {first_pid} should be alive"
    );

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("restart")
        .arg("--config")
        .arg(config_path.to_str().unwrap())
        .arg("--daemonize")
        .assert()
        .success();

    let restarted_pids = common::wait_for_lines(&pid_log, 2);
    let latest_pid: u32 = restarted_pids
        .last()
        .expect("latest pid line")
        .trim()
        .parse()
        .expect("latest service pid should parse");

    thread::sleep(Duration::from_secs(1));

    let alive: Vec<u32> = restarted_pids
        .iter()
        .filter_map(|line| line.trim().parse::<u32>().ok())
        .filter(|pid| common::is_process_alive(*pid))
        .collect();

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("stop")
        .arg("--config")
        .arg(config_path.to_str().unwrap())
        .assert()
        .success();

    assert_eq!(
        alive,
        vec![latest_pid],
        "rolling restart should retire the old long-lived process; pids={restarted_pids:?}"
    );
}

#[cfg(unix)]
#[test]
fn restart_daemonize_does_not_start_second_supervisor_when_pidfile_is_missing() {
    use std::os::unix::fs::PermissionsExt;

    let temp = tempdir().expect("failed to create tempdir");
    let dir = temp.path();
    let home = dir.join("home");
    fs::create_dir_all(&home).expect("failed to create home dir");
    let _home = HomeEnvGuard::set(&home);

    let pid_log = dir.join("service-pids.txt");
    let service_script = dir.join("long-lived-service.sh");
    fs::write(
        &service_script,
        format!(
            "#!/bin/sh\n\
echo $$ >> '{}'\n\
trap 'exit 0' TERM INT\n\
while true; do sleep 1; done\n",
            pid_log.display()
        ),
    )
    .expect("failed to write service script");
    let mut perms = fs::metadata(&service_script)
        .expect("failed to stat service script")
        .permissions();
    perms.set_mode(0o755);
    fs::set_permissions(&service_script, perms).expect("failed to chmod service script");

    let config_path = dir.join("systemg.yaml");
    fs::write(
        &config_path,
        format!(
            r#"version: "1"
services:
  long_lived:
    command: "{}"
    restart_policy: "always"
    deployment:
      strategy: "rolling"
      grace_period: "100ms"
"#,
            service_script.display()
        ),
    )
    .expect("failed to write config");

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("start")
        .arg("--config")
        .arg(config_path.to_str().unwrap())
        .arg("--daemonize")
        .assert()
        .success();

    let initial_pids = common::wait_for_lines(&pid_log, 1);
    let first_pid: u32 = initial_pids[0]
        .trim()
        .parse()
        .expect("first service pid should parse");
    assert!(
        common::is_process_alive(first_pid),
        "initial service pid {first_pid} should be alive"
    );

    let old_supervisor_pid = systemg::ipc::read_supervisor_pid()
        .expect("read supervisor pid")
        .expect("supervisor pid should be recorded");
    let pid_path = systemg::ipc::supervisor_pid_path().expect("supervisor pid path");
    fs::remove_file(&pid_path).expect("remove supervisor pid file");

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("restart")
        .arg("--config")
        .arg(config_path.to_str().unwrap())
        .arg("--daemonize")
        .assert()
        .success();

    let restarted_pids = common::wait_for_lines(&pid_log, 2);
    thread::sleep(Duration::from_secs(1));
    let alive: Vec<u32> = restarted_pids
        .iter()
        .filter_map(|line| line.trim().parse::<u32>().ok())
        .filter(|pid| common::is_process_alive(*pid))
        .collect();

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("stop")
        .arg("--config")
        .arg(config_path.to_str().unwrap())
        .assert()
        .success();

    unsafe {
        libc::kill(old_supervisor_pid, libc::SIGTERM);
    }
    thread::sleep(Duration::from_secs(1));

    assert_eq!(
        alive.len(),
        1,
        "restart --daemonize should not start a second supervisor and duplicate services; pids={restarted_pids:?}"
    );
}

#[test]
fn start_daemonize_accepts_unit_command_without_config() {
    let temp = tempdir().expect("failed to create tempdir");
    let dir = temp.path();
    let home = dir.join("home");
    fs::create_dir_all(&home).expect("failed to create home dir");
    let _home = HomeEnvGuard::set(&home);

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("start")
        .arg("--daemonize")
        .arg("sleep")
        .arg("30")
        .assert()
        .success();

    thread::sleep(Duration::from_secs(1));

    let units_dir = home.join(".local/share/systemg/units");
    assert!(units_dir.exists(), "units config directory should exist");

    let mut yaml_files = fs::read_dir(&units_dir)
        .expect("failed to read units directory")
        .filter_map(Result::ok)
        .map(|entry| entry.path())
        .filter(|path| path.extension().and_then(|ext| ext.to_str()) == Some("yaml"))
        .collect::<Vec<_>>();
    yaml_files.sort();
    assert!(
        !yaml_files.is_empty(),
        "expected at least one generated unit config"
    );

    let generated_yaml =
        fs::read_to_string(&yaml_files[0]).expect("failed to read generated unit yaml");
    assert!(
        generated_yaml.contains("command: 'sleep 30'"),
        "generated unit config should include command; got:\n{}",
        generated_yaml
    );

    let pid_file = PidFile::load().expect("pid file should load");
    assert!(
        !pid_file.services().is_empty(),
        "expected at least one supervised service in pid file"
    );

    Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("stop")
        .assert()
        .success();
}

#[test]
fn drop_privileges_warns_for_non_spawn_commands() {
    let temp = tempdir().expect("failed to create tempdir");
    let home = temp.path().join("home");
    fs::create_dir_all(&home).expect("failed to create home dir");
    let _home = HomeEnvGuard::set(&home);

    let output = Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("status")
        .arg("--drop-privileges")
        .output()
        .expect("failed to invoke sysg status");

    let stderr = String::from_utf8_lossy(&output.stderr);
    let expected_non_root = "--drop-privileges has no effect when not running as root";
    let expected_non_spawn = "--drop-privileges only applies when spawning child services during start/restart; this command will ignore it";
    assert!(
        stderr.contains(expected_non_root) || stderr.contains(expected_non_spawn),
        "expected drop-privileges warning in stderr: {stderr}"
    );
}

#[test]
fn spawn_command_prints_deprecation_warning() {
    let temp = tempdir().expect("failed to create tempdir");
    let home = temp.path().join("home");
    fs::create_dir_all(&home).expect("failed to create home dir");
    let _home = HomeEnvGuard::set(&home);

    let output = Command::new(assert_cmd::cargo::cargo_bin!("sysg"))
        .arg("spawn")
        .arg("--name")
        .arg("worker-1")
        .arg("--")
        .arg("sleep")
        .arg("1")
        .output()
        .expect("failed to invoke sysg spawn");

    assert!(
        !output.status.success(),
        "spawn should fail without a running supervisor in this test"
    );
    let stderr = String::from_utf8_lossy(&output.stderr);
    assert!(
        stderr.contains("deprecated"),
        "spawn stderr should include deprecation warning: {stderr}"
    );
}