flodl-cli 0.8.0

libtorch manager and GPU diagnostic tool for Rust deep learning
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
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
//! Cluster-config tests: overlay parsing, ClusterConfig::validate
//! invariants, LocalDevices Marker/Explicit serialization, canonical
//! JSON round-trip, and `resolve_cluster_dispatch` /
//! `cluster_dispatch_enabled` chain semantics.

use super::*;

#[test]
fn cluster_overlay_parses() {
    let mut cfg: ProjectConfig =
        serde_yaml_ng::from_str(canonical_cluster_yaml()).expect("parse cluster overlay");
    // Simulate fdl-cli's post-probe rank population. Ranks aren't in the
    // user YAML schema anymore — see `ClusterWorker::ranks` doc.
    populate_canonical_ranks(cfg.cluster.as_mut().unwrap());
    let cluster = cfg.cluster.as_ref().expect("cluster: block present");
    assert_eq!(cluster.controller.host, "192.168.122.1");
    assert_eq!(cluster.controller.port, 29500);
    assert_eq!(cluster.world_size(), 3);
    assert_eq!(cluster.workers.len(), 2);
    assert!(cluster.spans_multiple_hosts());

    let worker = &cluster.workers[1];
    assert_eq!(worker.host, "host-b");
    assert_eq!(worker.ranks, vec![1, 2]);
    assert_eq!(worker.local_devices, LocalDevices::Explicit(vec![0, 1]));
    assert_eq!(worker.nccl_socket_ifname, "enp1s0");
    assert_eq!(worker.path, "/srv/flodl");
    assert_eq!(
        worker.ssh.as_ref().and_then(|s| s.target.as_deref()),
        Some("host-b"),
    );

    // CommandSpec cluster: true survives the custom Deserialize.
    let test_cmd = cfg.commands.get("cuda-test").expect("cuda-test command");
    assert_eq!(test_cmd.cluster, Some(true));
    let train_cmd = cfg.commands.get("train").expect("train command");
    assert_eq!(train_cmd.cluster, Some(true));
    assert_eq!(
        train_cmd.run.as_deref(),
        Some("cargo run --release --bin my-training-app")
    );
}

#[test]
fn cluster_block_optional() {
    let yaml = "commands: { foo: { run: \"echo hi\" } }\n";
    let cfg: ProjectConfig = serde_yaml_ng::from_str(yaml).expect("parse without cluster");
    assert!(cfg.cluster.is_none());
    // CommandSpec cluster defaults to None.
    assert_eq!(cfg.commands.get("foo").and_then(|c| c.cluster), None);
}

#[test]
fn cluster_overlay_merges_via_deep_merge() {
    // The canonical author pattern: `cluster:` lives in `fdl.vm.yml`
    // (the overlay), not the base `fdl.yml`. deep_merge stitches them.
    let base_yaml = "commands:\n  train:\n    run: cargo run --release\n";
    let overlay_yaml = "\
cluster:
  controller:
    host: 127.0.0.1
    port: 29500
    path: /tmp/test-solo
  workers:
    - host: solo
      local_devices: [0]
      nccl_socket_ifname: lo
      path: /tmp/test-solo
commands:
  train:
    cluster: true
";
    let base: serde_yaml_ng::Value = serde_yaml_ng::from_str(base_yaml).unwrap();
    let overlay: serde_yaml_ng::Value = serde_yaml_ng::from_str(overlay_yaml).unwrap();
    let merged = crate::overlay::deep_merge(base, overlay);
    let merged_yaml = serde_yaml_ng::to_string(&merged).unwrap();
    let mut cfg: ProjectConfig =
        serde_yaml_ng::from_str(&merged_yaml).expect("merged config parses");
    // Post-probe: solo has 1 device → 1 rank.
    cfg.cluster.as_mut().unwrap().populate_ranks(&[1]).unwrap();
    let cluster = cfg.cluster.as_ref().expect("cluster: from overlay");
    assert_eq!(cluster.world_size(), 1);
    assert_eq!(cluster.workers[0].host, "solo");
    // Overlay added `cluster: true` to the train command; the base's
    // `run:` survived the merge.
    let train = cfg.commands.get("train").expect("train command");
    assert_eq!(train.cluster, Some(true));
    assert_eq!(train.run.as_deref(), Some("cargo run --release"));
}

#[test]
fn validate_rejects_duplicate_ranks() {
    // Post-probe shape: corrupt to a duplicate to exercise the
    // cross-worker `0..world_size` check. Pre-probe (all empty) skips
    // this branch; the corruption simulates a populate_ranks bug.
    let mut cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    populate_canonical_ranks(cfg.cluster.as_mut().unwrap());
    cfg.cluster.as_mut().unwrap().workers[1].ranks = vec![1, 1];
    let err = cfg.cluster.as_ref().unwrap().validate().unwrap_err();
    assert!(err.contains("duplicates or gaps"), "got: {err}");
}

#[test]
fn validate_rejects_rank_gap() {
    let mut cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    populate_canonical_ranks(cfg.cluster.as_mut().unwrap());
    cfg.cluster.as_mut().unwrap().workers[1].ranks = vec![2, 3];
    let err = cfg.cluster.as_ref().unwrap().validate().unwrap_err();
    assert!(err.contains("duplicates or gaps"), "got: {err}");
}

#[test]
fn validate_rejects_len_mismatch() {
    // Post-probe: shrink local_devices to mismatch the populated ranks
    // count. Real-world this would surface a populate_ranks bug.
    let mut cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    populate_canonical_ranks(cfg.cluster.as_mut().unwrap());
    cfg.cluster.as_mut().unwrap().workers[1].local_devices = LocalDevices::Explicit(vec![0]);
    let err = cfg.cluster.as_ref().unwrap().validate().unwrap_err();
    assert!(err.contains("length mismatch"), "got: {err}");
}

#[test]
fn validate_rejects_reserved_cluster_env_key() {
    let mut cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    cfg.cluster
        .as_mut()
        .unwrap()
        .env
        .insert("CUDA_VISIBLE_DEVICES".into(), "3".into());
    let err = cfg.cluster.as_ref().unwrap().validate().unwrap_err();
    assert!(err.contains("reserved"), "got: {err}");
    assert!(err.contains("CUDA_VISIBLE_DEVICES"), "got: {err}");
}

#[test]
fn validate_rejects_reserved_worker_env_key() {
    let mut cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    cfg.cluster.as_mut().unwrap().workers[0]
        .env
        .insert("FLODL_INTERNAL_LOCAL_RANK".into(), "0".into());
    let err = cfg.cluster.as_ref().unwrap().validate().unwrap_err();
    assert!(err.contains("reserved"), "got: {err}");
}

#[test]
fn validate_allows_non_reserved_env_key() {
    // NCCL tuning + a user-facing FLODL_ var (no FLODL_INTERNAL_
    // prefix) are legitimate cluster env entries.
    let mut cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    let c = cfg.cluster.as_mut().unwrap();
    c.env.insert("NCCL_P2P_DISABLE".into(), "1".into());
    c.env
        .insert("FLODL_DASHBOARD_BIND".into(), "0.0.0.0".into());
    cfg.cluster
        .as_ref()
        .unwrap()
        .validate()
        .expect("non-reserved env must pass");
}

#[test]
fn validate_rejects_empty_hosts() {
    let mut cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    cfg.cluster.as_mut().unwrap().workers.clear();
    let err = cfg.cluster.as_ref().unwrap().validate().unwrap_err();
    assert!(err.contains("non-empty"), "got: {err}");
}

#[test]
fn discovery_allows_empty_workers_and_parses_its_knobs() {
    // A roster-free controller block: discovery mode, join
    // credential, loopback-only bind — the C2 cloud shape.
    let yaml = "\
cluster:
  controller:
    host: 127.0.0.1
    port: 1337
    path: /tmp/test-discovery
    join:
      discovery: true
      min_rank_start: 2
      token: 0123456789abcdef0123456789abcdef
      tunnel_only: true
  workers: []
";
    let cfg: ProjectConfig = serde_yaml_ng::from_str(yaml).unwrap();
    let cluster = cfg.cluster.as_ref().unwrap();
    cluster
        .validate()
        .expect("empty workers must pass under discovery");
    let join = cluster.controller.join.as_ref().expect("join block");
    assert_eq!(join.discovery, Some(true));
    assert_eq!(join.min_rank_start, Some(2));
    assert_eq!(
        join.token.as_deref(),
        Some("0123456789abcdef0123456789abcdef")
    );
    assert_eq!(join.tunnel_only, Some(true));
    // The knobs survive the canonical JSON hand-off to the launcher.
    let json = serde_json::to_value(cluster).unwrap();
    assert_eq!(json["controller"]["join"]["discovery"], true);
    assert_eq!(json["controller"]["join"]["tunnel_only"], true);
    assert_eq!(
        json["controller"]["join"]["token"],
        "0123456789abcdef0123456789abcdef"
    );
}

#[test]
fn join_start_value_is_validated() {
    let yaml_for = |start: &str| {
        format!(
            "\
cluster:
  controller:
    host: 127.0.0.1
    port: 1337
    path: /tmp/test-start
    join:
      start: {start}
  workers:
    - host: solo
      local_devices: [0]
      nccl_socket_ifname: \"\"
      path: /tmp/test-start
"
        )
    };
    for ok in ["auto", "manual", "hybrid"] {
        let cfg: ProjectConfig = serde_yaml_ng::from_str(&yaml_for(ok)).unwrap();
        cfg.cluster.as_ref().unwrap().validate().expect(ok);
    }
    let cfg: ProjectConfig = serde_yaml_ng::from_str(&yaml_for("operator")).unwrap();
    let err = cfg.cluster.as_ref().unwrap().validate().unwrap_err();
    assert!(err.contains("auto | manual | hybrid"), "got: {err}");
    // The value rides the hand-off verbatim (flodl re-validates).
    let cfg: ProjectConfig = serde_yaml_ng::from_str(&yaml_for("manual")).unwrap();
    let json = serde_json::to_value(cfg.cluster.as_ref().unwrap()).unwrap();
    assert_eq!(json["controller"]["join"]["start"], "manual");
}

#[test]
fn worker_join_block_parses_and_defaults() {
    // Full shape — the golden-image recipe.
    let cfg: ProjectConfig = serde_yaml_ng::from_str(
        "\
join:
  controller: 127.0.0.1:1337
  ssh:
    target: ctrl.example.com
    user: flodl-join
    identity_file: /etc/flodl/join_key
  token: 0123456789abcdef0123456789abcdef
  bin: target/release/train
  host: worker-7
  devices: [0, 1]
  persist: true
  args: [\"--model\", \"lenet\"]
",
    )
    .unwrap();
    let join = cfg.join.expect("join block parsed");
    assert_eq!(join.controller.as_deref(), Some("127.0.0.1:1337"));
    let ssh = join.ssh.as_ref().unwrap();
    assert_eq!(ssh.target.as_deref(), Some("ctrl.example.com"));
    assert_eq!(ssh.user.as_deref(), Some("flodl-join"));
    assert_eq!(join.bin.as_deref(), Some("target/release/train"));
    assert_eq!(join.devices, Some(vec![0, 1]));
    assert!(join.persist);
    assert_eq!(join.args, vec!["--model".to_string(), "lenet".into()]);

    // Minimal shape: everything defaulted, persist off, no args.
    let cfg: ProjectConfig = serde_yaml_ng::from_str("join:\n  bin: t/bin\n").unwrap();
    let join = cfg.join.expect("minimal join block");
    assert_eq!(join.bin.as_deref(), Some("t/bin"));
    assert!(join.controller.is_none() && join.ssh.is_none());
    assert!(!join.persist && join.args.is_empty());

    // Typo'd keys die loudly (deny_unknown_fields).
    let err = serde_yaml_ng::from_str::<ProjectConfig>("join:\n  binn: t/bin\n")
        .unwrap_err()
        .to_string();
    assert!(err.contains("binn"), "got: {err}");
}

#[test]
fn validate_rejects_missing_socket_ifname_when_multi_host() {
    let mut cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    cfg.cluster.as_mut().unwrap().workers[0].nccl_socket_ifname = String::new();
    let err = cfg.cluster.as_ref().unwrap().validate().unwrap_err();
    assert!(err.contains("nccl_socket_ifname"), "got: {err}");
    assert!(err.contains("multiple workers"), "got: {err}");
}

#[test]
fn validate_rejects_empty_path() {
    let mut cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    cfg.cluster.as_mut().unwrap().workers[0].path = String::new();
    let err = cfg.cluster.as_ref().unwrap().validate().unwrap_err();
    assert!(err.contains("path"), "got: {err}");
    assert!(err.contains("host-a"), "got: {err}");
}

#[test]
fn validate_allows_empty_socket_ifname_when_single_host() {
    // Single-host clusters don't go through NCCL TCP, so the ifname
    // requirement doesn't apply.
    let yaml = "\
cluster:
  controller:
    host: 127.0.0.1
    port: 29500
    path: /tmp/test-solo
  workers:
    - host: solo
      local_devices: [0]
      nccl_socket_ifname: \"\"
      path: /tmp/test-solo
";
    let cfg: ProjectConfig = serde_yaml_ng::from_str(yaml).unwrap();
    cfg.cluster
        .as_ref()
        .unwrap()
        .validate()
        .expect("single-host with empty ifname must pass");
}

#[test]
fn validate_passes_canonical() {
    let cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    cfg.cluster
        .as_ref()
        .unwrap()
        .validate()
        .expect("canonical topology must validate");
}

#[test]
fn canonical_json_stable_and_round_trips() {
    let cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    let cluster = cfg.cluster.as_ref().unwrap();
    let json = cluster.canonical_json().expect("serialize");

    // Stability: serialization twice produces identical output.
    let json2 = cluster.canonical_json().unwrap();
    assert_eq!(json, json2);

    // Round-trip: parsing back gives the same observable state.
    let parsed: ClusterConfig = serde_json::from_str(&json).expect("round-trip");
    assert_eq!(parsed.controller.host, cluster.controller.host);
    assert_eq!(parsed.controller.port, cluster.controller.port);
    assert_eq!(parsed.workers.len(), cluster.workers.len());
    assert_eq!(parsed.world_size(), cluster.world_size());
    assert_eq!(
        parsed.workers[1]
            .ssh
            .as_ref()
            .and_then(|s| s.target.as_deref()),
        Some("host-b"),
    );
}

#[test]
fn local_devices_all_yaml_parses_as_marker() {
    let yaml = "\
cluster:
  controller:
    host: 127.0.0.1
    port: 29500
    path: /tmp/solo
  workers:
    - host: solo
      local_devices: all
      nccl_socket_ifname: lo
      path: /tmp/solo
";
    let cfg: ProjectConfig = serde_yaml_ng::from_str(yaml).unwrap();
    let host = &cfg.cluster.unwrap().workers[0];
    assert_eq!(host.local_devices, LocalDevices::All);
    assert!(host.local_devices.is_all());
    assert!(host.local_devices.as_explicit().is_none());
}

#[test]
fn local_devices_explicit_parses_as_explicit() {
    let yaml = "\
cluster:
  controller:
    host: 127.0.0.1
    port: 29500
    path: /tmp/solo
  workers:
    - host: solo
      local_devices: [3]
      nccl_socket_ifname: lo
      path: /tmp/solo
";
    let cfg: ProjectConfig = serde_yaml_ng::from_str(yaml).unwrap();
    let host = &cfg.cluster.unwrap().workers[0];
    assert_eq!(host.local_devices, LocalDevices::Explicit(vec![3]));
    assert!(!host.local_devices.is_all());
    assert_eq!(host.local_devices.as_explicit(), Some(&[3u8][..]));
}

#[test]
fn local_devices_all_skips_length_check_in_validate() {
    // With `all`, ranks.len() vs local_devices length is NOT checked at
    // validate-time (resolution is deferred to startup on the target
    // host). Verifies the controller-side validate passes a config with
    // 5 ranks + local_devices: all even though no explicit list exists.
    let yaml = "\
cluster:
  controller:
    host: 127.0.0.1
    port: 29500
    path: /tmp/solo
  workers:
    - host: solo
      local_devices: all
      nccl_socket_ifname: lo
      path: /tmp/solo
";
    let cfg: ProjectConfig = serde_yaml_ng::from_str(yaml).unwrap();
    cfg.cluster
        .as_ref()
        .unwrap()
        .validate()
        .expect("validate must pass for local_devices: all");
}

#[test]
fn local_envelope_for_all_emits_all_string() {
    let yaml = "\
cluster:
  controller:
    host: 127.0.0.1
    port: 29500
    path: /tmp/solo
  workers:
    - host: solo
      local_devices: all
      nccl_socket_ifname: lo
      path: /tmp/solo
";
    let cfg: ProjectConfig = serde_yaml_ng::from_str(yaml).unwrap();
    let cluster = cfg.cluster.unwrap();
    let env = cluster.local_envelope_for(&cluster.workers[0]);
    assert_eq!(env["worker"]["local_devices"], serde_json::json!("all"));
}

#[test]
fn local_devices_all_round_trips_through_canonical_json() {
    let yaml = "\
cluster:
  controller:
    host: 127.0.0.1
    port: 29500
    path: /tmp/solo
  workers:
    - host: solo
      local_devices: all
      nccl_socket_ifname: lo
      path: /tmp/solo
";
    let cfg: ProjectConfig = serde_yaml_ng::from_str(yaml).unwrap();
    let cluster = cfg.cluster.unwrap();
    let json = cluster.canonical_json().unwrap();
    let parsed: ClusterConfig = serde_json::from_str(&json).unwrap();
    assert_eq!(parsed.workers[0].local_devices, LocalDevices::All);
}

/// The per-rank envelope carries a DECLARED `data_path:` and stays
/// silent otherwise.
///
/// Load-bearing in the negative direction. The rank now consumes
/// this field (it reaches `--data-dir` via
/// `LocalCluster::data_path`), so reverting to
/// `effective_data_path()` would hand every cluster that never
/// mentioned data the convention default `/flodl/data`, a path most
/// hosts do not have. A silent host must stay silent so the
/// training binary keeps its own default.
#[test]
fn local_envelope_carries_data_path_only_when_declared() {
    let yaml = "\
cluster:
  controller:
    host: 127.0.0.1
    port: 29500
    path: /tmp/solo
  workers:
    - host: declares
      local_devices: all
      nccl_socket_ifname: lo
      path: /tmp/solo
      data_path: /mnt/corpus
    - host: silent
      local_devices: all
      nccl_socket_ifname: lo
      path: /tmp/solo
";
    let cfg: ProjectConfig = serde_yaml_ng::from_str(yaml).unwrap();
    let cluster = cfg.cluster.unwrap();

    let declares = cluster.local_envelope_for(&cluster.workers[0]);
    let silent = cluster.local_envelope_for(&cluster.workers[1]);

    assert_eq!(declares["worker"]["data_path"], "/mnt/corpus");
    assert!(
        silent["worker"].get("data_path").is_none(),
        "an undeclared host must not receive the convention default: {}",
        silent["worker"]
    );
}

#[test]
fn local_devices_rejects_unknown_string() {
    let yaml = "\
cluster:
  controller:
    host: 127.0.0.1
    port: 29500
    path: /tmp/solo
  workers:
    - host: solo
      local_devices: every
      nccl_socket_ifname: lo
      path: /tmp/solo
";
    let err = serde_yaml_ng::from_str::<ProjectConfig>(yaml).unwrap_err();
    let msg = err.to_string();
    assert!(
        msg.contains("local_devices") && msg.contains("every"),
        "expected loud error mentioning the bad value, got: {msg}"
    );
}

#[test]
fn local_envelope_strips_ssh_adds_world_metadata() {
    let mut cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    populate_canonical_ranks(cfg.cluster.as_mut().unwrap());
    let cluster = cfg.cluster.as_ref().unwrap();
    let worker = &cluster.workers[1];
    let env = cluster.local_envelope_for(worker);

    // Top-level: controller coords + world metadata.
    assert_eq!(env["controller"]["host"], "192.168.122.1");
    assert_eq!(env["controller"]["port"], 29500);
    assert_eq!(env["world_size"], 3); // 1 + 2 ranks
    assert_eq!(env["num_workers"], 2);

    // Worker slice: only this worker's fields.
    let w = &env["worker"];
    assert_eq!(w["host"], "host-b");
    assert_eq!(w["ranks"], serde_json::json!([1, 2]));
    assert_eq!(w["local_devices"], serde_json::json!([0, 1]));
    assert_eq!(w["nccl_socket_ifname"], "enp1s0");
    assert_eq!(w["path"], "/srv/flodl");
    assert_eq!(w["arch"], "builds/sm61-sm120");

    // ssh: stripped (launcher-only).
    assert!(w.get("ssh").is_none(), "ssh must not appear in envelope");
}

#[test]
fn local_envelope_omits_optional_arch() {
    let cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    let mut cluster = cfg.cluster.unwrap();
    cluster.workers[0].arch = None;
    let env = cluster.local_envelope_for(&cluster.workers[0]);
    assert!(
        env["worker"].get("arch").is_none(),
        "arch should be omitted when None"
    );
}

#[test]
fn local_envelope_first_worker_carries_rank_zero() {
    let mut cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    populate_canonical_ranks(cfg.cluster.as_mut().unwrap());
    let cluster = cfg.cluster.as_ref().unwrap();
    let host_a = &cluster.workers[0];
    let env = cluster.local_envelope_for(host_a);
    let ranks = env["worker"]["ranks"].as_array().unwrap();
    assert!(
        ranks.iter().any(|r| r.as_u64() == Some(0)),
        "first worker's envelope must include rank 0"
    );
}

#[test]
fn ssh_target_defaults_to_name() {
    let cfg: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    let cluster = cfg.cluster.as_ref().unwrap();
    assert_eq!(cluster.ssh_target(&cluster.workers[0]), "host-a"); // no ssh: → name
    assert_eq!(cluster.ssh_target(&cluster.workers[1]), "host-b"); // explicit
}

// ── Path-inheritance cluster-dispatch resolver ──────────────────

#[test]
fn cluster_dispatch_empty_chain_is_false() {
    // No command directives anywhere → default false.
    assert!(!resolve_cluster_dispatch(&[]));
}

#[test]
fn cluster_dispatch_all_unset_is_false() {
    // Every level along the path declined to set cluster: → false.
    assert!(!resolve_cluster_dispatch(&[None, None, None]));
}

#[test]
fn cluster_dispatch_leaf_true_wins_over_unset_ancestors() {
    // root unset, leaf cluster: true → fan out.
    assert!(resolve_cluster_dispatch(&[None, Some(true)]));
}

#[test]
fn cluster_dispatch_leaf_false_wins_over_unset_ancestors() {
    // root unset, leaf cluster: false → explicit local.
    assert!(!resolve_cluster_dispatch(&[None, Some(false)]));
}

#[test]
fn cluster_dispatch_inherits_from_path_command_at_root() {
    // commands.ddp-bench in root: cluster: true. ddp-bench/fdl.yml's
    // leaf command leaves it unset → inherits parent's true.
    assert!(resolve_cluster_dispatch(&[Some(true), None]));
}

#[test]
fn cluster_dispatch_leaf_overrides_ancestor_true_to_false() {
    // root: ddp-bench cluster: true. ddp-bench/cuda: cluster: false
    // (e.g. for a single-host quick smoke test) → stays local despite
    // ancestor saying yes.
    assert!(!resolve_cluster_dispatch(&[Some(true), Some(false)]));
}

#[test]
fn cluster_dispatch_leaf_overrides_ancestor_false_to_true() {
    // root: research/ cluster: false (everything stays local).
    // research/multi-host-experiment: cluster: true (opt back in).
    assert!(resolve_cluster_dispatch(&[Some(false), Some(true)]));
}

#[test]
fn cluster_dispatch_intermediate_override_wins_at_sub_sub_depth() {
    // 4-level chain: root → ddp-bench → sweep → experiment.
    // root true, ddp-bench false (turns ddp-bench off wholesale),
    // sweep unset, experiment unset → effective false. The deepest
    // explicit value (ddp-bench's false) outranks root's true; sweep
    // and experiment inherit from there.
    assert!(!resolve_cluster_dispatch(&[
        Some(true),
        Some(false),
        None,
        None
    ]));
}

#[test]
fn cluster_dispatch_deepest_override_wins_through_chain() {
    // Same 4-level chain but the experiment opts back in: effective true.
    // Resolution walks leaf-first, finds Some(true) immediately.
    assert!(resolve_cluster_dispatch(&[
        Some(true),
        Some(false),
        None,
        Some(true)
    ]));
}

#[test]
fn cluster_dispatch_enabled_requires_cluster_block() {
    // Even with leaf cluster: true, dispatching is disabled when no
    // cluster topology is declared at root.
    let no_cluster: ProjectConfig =
        serde_yaml_ng::from_str("commands: { foo: { run: \"echo hi\" } }\n").unwrap();
    assert!(!cluster_dispatch_enabled(&no_cluster, &[Some(true)]));
    assert!(!cluster_dispatch_enabled(
        &no_cluster,
        &[Some(true), Some(true)]
    ));
}

#[test]
fn cluster_dispatch_enabled_when_block_and_chain_agree() {
    let with_cluster: ProjectConfig = serde_yaml_ng::from_str(canonical_cluster_yaml()).unwrap();
    assert!(cluster_dispatch_enabled(&with_cluster, &[Some(true)]));
    assert!(cluster_dispatch_enabled(&with_cluster, &[Some(true), None]));
    // Cluster block present but chain says false → not enabled.
    assert!(!cluster_dispatch_enabled(&with_cluster, &[Some(false)]));
    assert!(!cluster_dispatch_enabled(
        &with_cluster,
        &[None, Some(false)]
    ));
    // Cluster block present but no directives anywhere → not enabled.
    assert!(!cluster_dispatch_enabled(&with_cluster, &[]));
    assert!(!cluster_dispatch_enabled(&with_cluster, &[None, None]));
}