geist_supervisor 0.1.28

Generic OTA supervisor for field devices
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
//! Integration tests for the geist_supervisor CLI

use assert_cmd::Command;
use assert_fs::prelude::*;
use assert_fs::TempDir;
use predicates::prelude::*;

#[test]
fn test_version_command() -> Result<(), Box<dyn std::error::Error>> {
    let mut cmd = Command::new(env!("CARGO_BIN_EXE_geist_supervisor"));

    cmd.arg("--version");
    cmd.assert()
        .success()
        .stdout(predicate::str::contains(env!("CARGO_PKG_VERSION")));

    Ok(())
}

#[test]
fn test_rollback_list_backups() -> Result<(), Box<dyn std::error::Error>> {
    let temp = TempDir::new()?;
    let backup_dir = temp.child(".local/share/geist-supervisor/backups");
    backup_dir.create_dir_all()?;

    let backup1 = backup_dir.child("geist_supervisor.backup.v1.0.0.1700000000");
    let backup2 = backup_dir.child("geist_supervisor.backup.v1.1.0.1700000100");
    backup1.touch()?;
    backup2.touch()?;

    let mut cmd = Command::new(env!("CARGO_BIN_EXE_geist_supervisor"));
    cmd.env("HOME", temp.path());
    cmd.env("GEIST_APP_BINARY_PATH_TEST", "/tmp/test"); // Ensure test environment

    cmd.arg("rollback");
    cmd.assert().success().stdout(
        predicate::str::contains("geist_supervisor.backup.v1.0.0.1700000000").and(
            predicate::str::contains("geist_supervisor.backup.v1.1.0.1700000100"),
        ),
    );

    Ok(())
}

#[test]
fn test_check_update_json_offline() -> Result<(), Box<dyn std::error::Error>> {
    let temp = TempDir::new()?;

    // Set a dummy config file with a known version
    let config_dir = temp.child(".local/share/geist-supervisor");
    config_dir.create_dir_all()?;
    let _config_file = config_dir.child("config.json");
    // The config logic uses the HOME env var to find the config, so we must set it.
    let config_path = temp.child(".local/share/geist-supervisor/current_version");
    config_path.write_str("v1.0.0")?;

    let mut cmd = Command::new(env!("CARGO_BIN_EXE_geist_supervisor"));
    cmd.env("HOME", temp.path()); // Point to our temp home dir
    cmd.env("RUST_LOG", "off"); // Suppress logs for clean JSON output
    cmd.env("GEIST_REGISTRY_URL_TEST", "http://127.0.0.1:1"); // Force network error
    cmd.env("GEIST_APP_BINARY_PATH_TEST", "/tmp/test"); // Ensure test environment

    cmd.arg("check-update").arg("--json");
    cmd.assert().success().stdout(
        predicate::str::contains(r#""update_available":false"#)
            .and(predicate::str::contains(r#""current_version":"v1.0.0""#))
            .and(predicate::str::contains(r#""error":"#)), // Check that an error is reported
    );

    Ok(())
}

#[test]
fn test_check_update_json_stdout_clean_with_rust_log_info() -> Result<(), Box<dyn std::error::Error>>
{
    // Regression test: when RUST_LOG=info is inherited from the cage session,
    // tracing output must go to stderr — NOT stdout. If tracing leaks into stdout,
    // the JSON output gets corrupted and the caller can't parse it.
    let temp = TempDir::new()?;
    let config_dir = temp.child(".local/share/geist-supervisor");
    config_dir.create_dir_all()?;
    temp.child(".local/share/geist-supervisor/current_version")
        .write_str("v1.0.0")?;

    let mut cmd = Command::new(env!("CARGO_BIN_EXE_geist_supervisor"));
    cmd.env("HOME", temp.path());
    cmd.env("RUST_LOG", "info"); // This is what cage-session.sh sets
    cmd.env("GEIST_REGISTRY_URL_TEST", "http://127.0.0.1:1");
    cmd.env("GEIST_APP_BINARY_PATH_TEST", "/tmp/test");
    cmd.arg("check-update").arg("--json");

    let output = cmd.output()?;
    assert!(output.status.success());

    let stdout = String::from_utf8_lossy(&output.stdout);
    let stderr = String::from_utf8_lossy(&output.stderr);

    // stdout must be valid JSON (no tracing lines mixed in)
    let parsed: Result<serde_json::Value, _> = serde_json::from_str(stdout.trim());
    assert!(
        parsed.is_ok(),
        "stdout must be parseable as JSON, got: {stdout}"
    );

    // tracing output should be on stderr, not stdout
    assert!(
        !stdout.contains("INFO"),
        "Tracing INFO lines must not appear on stdout: {stdout}"
    );
    assert!(
        stderr.contains("INFO") || stderr.is_empty(),
        "Tracing output should go to stderr"
    );

    Ok(())
}

#[test]
fn test_status_command() -> Result<(), Box<dyn std::error::Error>> {
    let mut cmd = Command::new(env!("CARGO_BIN_EXE_geist_supervisor"));

    // Set test environment variable to ensure systemctl commands are mocked
    cmd.env("GEIST_APP_BINARY_PATH_TEST", "/tmp/test");
    cmd.arg("status");
    cmd.assert()
        .success()
        .stdout(predicate::str::contains("Service status: running"));

    Ok(())
}

#[test]
fn test_update_from_local_bundle() -> Result<(), Box<dyn std::error::Error>> {
    // 1. Setup
    let temp = TempDir::new()?;

    // Create a fake application directory for the "installation"
    let app_dir = temp.child("app");
    app_dir.create_dir_all()?;
    let app_binary_path = app_dir.child("geist_supervisor");

    // Create a fake home directory for config files
    let home_dir = temp.child("home");
    home_dir.create_dir_all()?;

    // Create the bundle source directory
    let bundle_src_dir = temp.child("bundle_src");
    bundle_src_dir.create_dir_all()?;

    // Create a dummy binary that will be in the bundle
    let new_binary_content = b"#!/bin/sh\necho 'new binary v99'";
    let binary_in_bundle = bundle_src_dir.child("geist_supervisor");
    binary_in_bundle.write_binary(new_binary_content)?;
    // Make it executable
    #[cfg(unix)]
    {
        use std::os::unix::fs::PermissionsExt;
        let mut perms = std::fs::metadata(&binary_in_bundle)?.permissions();
        perms.set_mode(0o755);
        std::fs::set_permissions(&binary_in_bundle, perms)?;
    }

    // Create a dummy install script
    let install_script_content = format!(
        "#!/bin/sh\n/bin/cp -f ./geist_supervisor {}",
        app_binary_path.path().to_str().unwrap()
    );
    let install_script = bundle_src_dir.child("install.sh");
    install_script.write_str(&install_script_content)?;
    #[cfg(unix)]
    {
        use std::os::unix::fs::PermissionsExt;
        let mut perms = std::fs::metadata(&install_script)?.permissions();
        perms.set_mode(0o755);
        std::fs::set_permissions(&install_script, perms)?;
    }

    // Create dummy metadata
    let metadata_content = r#"{"version": "v99.9.9"}"#;
    bundle_src_dir
        .child("ota_metadata.json")
        .write_str(metadata_content)?;

    // Create the .tar.gz bundle
    let bundle_archive_path = temp.child("test_bundle.tar.gz");
    let tar_gz = std::fs::File::create(&bundle_archive_path)?;
    let enc = flate2::write::GzEncoder::new(tar_gz, flate2::Compression::default());
    let mut tar = tar::Builder::new(enc);
    tar.append_dir_all(".", bundle_src_dir.path())?;
    // Finish archiving
    let enc = tar.into_inner()?;
    enc.finish()?;

    // 2. Execution
    let mut cmd = Command::new(env!("CARGO_BIN_EXE_geist_supervisor"));
    cmd.env("GEIST_APP_BINARY_PATH_TEST", app_binary_path.path());
    cmd.env("GEIST_SKIP_DEPENDENCY_CHECK", "1"); // Skip dependency checks in CLI tests
    cmd.env("HOME", home_dir.path());
    cmd.arg("update").arg(bundle_archive_path.path());

    // 3. Assertions
    cmd.assert()
        .success()
        .stdout(predicate::str::contains("Update completed successfully!"));

    // Check that the "new" binary was installed
    let installed_content = std::fs::read(app_binary_path.path())?;
    assert_eq!(installed_content, new_binary_content);

    Ok(())
}

#[test]
fn test_update_dry_run_with_local_bundle() -> Result<(), Box<dyn std::error::Error>> {
    // Setup
    let temp = TempDir::new()?;
    let home_dir = temp.child("home");
    home_dir.create_dir_all()?;

    // Set current version
    let config_dir = home_dir.child(".local/share/geist-supervisor");
    config_dir.create_dir_all()?;
    let version_file = config_dir.child("current_version");
    version_file.write_str("v1.0.0")?;

    // Create bundle source directory
    let bundle_src_dir = temp.child("bundle_src");
    bundle_src_dir.create_dir_all()?;

    // Create dummy binary and metadata
    let binary_in_bundle = bundle_src_dir.child("geist_supervisor");
    binary_in_bundle.write_binary(b"#!/bin/sh\necho 'new binary v2.0.0'")?;

    let metadata_content = r#"{"version": "v2.0.0"}"#;
    bundle_src_dir
        .child("ota_metadata.json")
        .write_str(metadata_content)?;

    let install_script = bundle_src_dir.child("install.sh");
    install_script.write_str("#!/bin/sh\necho 'install script'")?;

    // Create .tar.gz bundle
    let bundle_archive_path = temp.child("test_bundle.tar.gz");
    let tar_gz = std::fs::File::create(&bundle_archive_path)?;
    let enc = flate2::write::GzEncoder::new(tar_gz, flate2::Compression::default());
    let mut tar = tar::Builder::new(enc);
    tar.append_dir_all(".", bundle_src_dir.path())?;
    let enc = tar.into_inner()?;
    enc.finish()?;

    // Run dry-run update
    let mut cmd = Command::new(env!("CARGO_BIN_EXE_geist_supervisor"));
    cmd.env("HOME", home_dir.path());
    cmd.env("GEIST_APP_BINARY_PATH_TEST", "/tmp/test");
    cmd.arg("update")
        .arg("--dry-run")
        .arg(bundle_archive_path.path());

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("=== DRY RUN MODE ==="))
        .stdout(predicate::str::contains("Current version: v1.0.0"))
        .stdout(predicate::str::contains("Target version: v2.0.0"))
        .stdout(predicate::str::contains(
            "Would update from v1.0.0 to v2.0.0",
        ))
        .stdout(predicate::str::contains("✓ install.sh script found"))
        .stdout(predicate::str::contains("✓ ota_metadata.json found"))
        .stdout(predicate::str::contains("Execute install.sh script"))
        .stdout(predicate::str::contains(
            "No changes were made to the system",
        ));

    // Verify no actual changes were made
    let version_content = std::fs::read_to_string(version_file.path())?;
    assert_eq!(version_content, "v1.0.0"); // Version should remain unchanged

    Ok(())
}

#[test]
fn test_update_dry_run_same_version() -> Result<(), Box<dyn std::error::Error>> {
    let temp = TempDir::new()?;
    let home_dir = temp.child("home");
    home_dir.create_dir_all()?;

    // Set current version
    let config_dir = home_dir.child(".local/share/geist-supervisor");
    config_dir.create_dir_all()?;
    let version_file = config_dir.child("current_version");
    version_file.write_str("v1.0.0")?;

    // Create bundle with same version
    let bundle_src_dir = temp.child("bundle_src");
    bundle_src_dir.create_dir_all()?;

    let metadata_content = r#"{"version": "v1.0.0"}"#;
    bundle_src_dir
        .child("ota_metadata.json")
        .write_str(metadata_content)?;

    let binary_in_bundle = bundle_src_dir.child("geist_supervisor");
    binary_in_bundle.write_binary(b"#!/bin/sh\necho 'same version'")?;

    // Create bundle
    let bundle_archive_path = temp.child("test_bundle.tar.gz");
    let tar_gz = std::fs::File::create(&bundle_archive_path)?;
    let enc = flate2::write::GzEncoder::new(tar_gz, flate2::Compression::default());
    let mut tar = tar::Builder::new(enc);
    tar.append_dir_all(".", bundle_src_dir.path())?;
    let enc = tar.into_inner()?;
    enc.finish()?;

    let mut cmd = Command::new(env!("CARGO_BIN_EXE_geist_supervisor"));
    cmd.env("HOME", home_dir.path());
    cmd.env("GEIST_APP_BINARY_PATH_TEST", "/tmp/test");
    cmd.arg("update")
        .arg("--dry-run")
        .arg(bundle_archive_path.path());

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("=== DRY RUN MODE ==="))
        .stdout(predicate::str::contains(
            "Already on target version v1.0.0, no update needed",
        ));

    Ok(())
}

#[test]
fn test_update_dry_run_remote_latest() -> Result<(), Box<dyn std::error::Error>> {
    let temp = TempDir::new()?;
    let home_dir = temp.child("home");
    home_dir.create_dir_all()?;

    // Set current version
    let config_dir = home_dir.child(".local/share/geist-supervisor");
    config_dir.create_dir_all()?;
    let version_file = config_dir.child("current_version");
    version_file.write_str("v1.0.0")?;

    let mut cmd = Command::new(env!("CARGO_BIN_EXE_geist_supervisor"));
    cmd.env("HOME", home_dir.path());
    cmd.env("GEIST_APP_BINARY_PATH_TEST", "/tmp/test");
    cmd.env("GEIST_REGISTRY_URL_TEST", "http://127.0.0.1:1"); // Force network error for offline test
    cmd.arg("update").arg("--dry-run").arg("latest");

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("=== DRY RUN MODE ==="))
        .stdout(predicate::str::contains("Current version: v1.0.0"))
        .stdout(predicate::str::contains(
            "Error: Failed to fetch latest version",
        ));

    Ok(())
}

#[test]
fn test_update_dry_run_without_install_script() -> Result<(), Box<dyn std::error::Error>> {
    let temp = TempDir::new()?;
    let home_dir = temp.child("home");
    home_dir.create_dir_all()?;

    // Set current version
    let config_dir = home_dir.child(".local/share/geist-supervisor");
    config_dir.create_dir_all()?;
    let version_file = config_dir.child("current_version");
    version_file.write_str("v1.0.0")?;

    // Create bundle without install.sh
    let bundle_src_dir = temp.child("bundle_src");
    bundle_src_dir.create_dir_all()?;

    let binary_in_bundle = bundle_src_dir.child("geist_supervisor");
    binary_in_bundle.write_binary(b"#!/bin/sh\necho 'binary only'")?;

    let metadata_content = r#"{"version": "v2.0.0"}"#;
    bundle_src_dir
        .child("ota_metadata.json")
        .write_str(metadata_content)?;
    // Note: No install.sh created

    // Create bundle
    let bundle_archive_path = temp.child("test_bundle.tar.gz");
    let tar_gz = std::fs::File::create(&bundle_archive_path)?;
    let enc = flate2::write::GzEncoder::new(tar_gz, flate2::Compression::default());
    let mut tar = tar::Builder::new(enc);
    tar.append_dir_all(".", bundle_src_dir.path())?;
    let enc = tar.into_inner()?;
    enc.finish()?;

    let mut cmd = Command::new(env!("CARGO_BIN_EXE_geist_supervisor"));
    cmd.env("HOME", home_dir.path());
    cmd.env("GEIST_APP_BINARY_PATH_TEST", "/tmp/test");
    cmd.arg("update")
        .arg("--dry-run")
        .arg(bundle_archive_path.path());

    cmd.assert()
        .success()
        .stdout(predicate::str::contains(
            "✗ No install.sh script - binary-only update mode",
        ))
        .stdout(predicate::str::contains("5. Replace binary only"));

    Ok(())
}