newgit-core 0.2.0

Core domain model for newgit: branch instances, tracker lanes, and resource lifecycles
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
use std::process::Command;

use camino::{Utf8Path, Utf8PathBuf};
use newgit_core::config::WorkspaceSection;
use newgit_core::manager::{BindOrigin, BranchManager};
use newgit_core::store::MetadataStore;
use newgit_core::tracker::Storage;
use newgit_core::{NewgitError, SourceSubstrate};

fn git(dir: &Utf8Path, args: &[&str]) {
    let output = Command::new("git")
        .arg("-C")
        .arg(dir.as_str())
        .args(args)
        .env("GIT_AUTHOR_NAME", "test")
        .env("GIT_AUTHOR_EMAIL", "test@example.com")
        .env("GIT_COMMITTER_NAME", "test")
        .env("GIT_COMMITTER_EMAIL", "test@example.com")
        .output()
        .expect("git runs");
    assert!(
        output.status.success(),
        "git {args:?} failed: {}",
        String::from_utf8_lossy(&output.stderr)
    );
}

fn setup(temp: &Utf8Path) -> MetadataStore {
    let repo = temp.join("store");
    std::fs::create_dir_all(&repo).expect("mkdir");
    git(&repo, &["init", "-q", "-b", "main"]);
    std::fs::write(repo.join("README.md"), "hello\n").expect("write");
    git(&repo, &["add", "."]);
    git(&repo, &["commit", "-q", "-m", "initial"]);

    let store = MetadataStore::init(&repo, "proj", SourceSubstrate::Git).expect("init");
    let mut config = store.load_config().expect("config");
    config.workspace = Some(WorkspaceSection {
        root: Some(temp.join("workspaces")),
        materializer: None,
    });
    store.write_config(&config).expect("write config");
    store
}

fn tempdir() -> (tempfile::TempDir, Utf8PathBuf) {
    let temp = tempfile::tempdir().expect("tempdir");
    let path = Utf8PathBuf::from_path_buf(temp.path().canonicalize().expect("canonicalize"))
        .expect("utf8 tempdir");
    (temp, path)
}

fn manager(store: MetadataStore) -> BranchManager {
    BranchManager::open(store).expect("manager")
}

#[test]
fn tracker_create_and_track_write_definition_and_gitignore() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let repo = store.paths().project_root.clone();
    let m = manager(store);

    let outcome = m
        .create_tracker("runtime-env", "user", Storage::Local, false)
        .expect("create");
    assert!(outcome.path.is_file());
    assert!(outcome.ignored_patterns.is_empty());

    let tracked = m
        .track_paths("runtime-env", &[Utf8PathBuf::from(".env.local")])
        .expect("track");
    assert_eq!(tracked.ignored_patterns, vec!["/.env.local".to_owned()]);

    let gitignore = std::fs::read_to_string(repo.join(".gitignore")).expect("gitignore");
    assert!(gitignore.contains("# newgit tracker: runtime-env"));
    assert!(gitignore.contains("/.env.local"));

    // Re-opening validates the definition and reports no gitignore warnings.
    let m = manager(MetadataStore::at(repo));
    assert_eq!(m.tracker_definitions().len(), 1);
    assert_eq!(
        m.tracker_definitions()[0].paths,
        vec![Utf8PathBuf::from(".env.local")]
    );
    assert!(!m.tracker_definitions()[0].merge_with_source);
    assert!(m.gitignore_warnings().is_empty());

    let duplicate = m.create_tracker("runtime-env", "user", Storage::Local, false);
    assert!(matches!(duplicate, Err(NewgitError::AlreadyExists(_))));
}

#[test]
fn captured_lane_stays_branch_local_until_merged() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let repo = store.paths().project_root.clone();
    let m = manager(store);
    m.create_tracker("runtime-env", "user", Storage::Local, false)
        .expect("create");
    m.track_paths("runtime-env", &[Utf8PathBuf::from(".env.local")])
        .expect("track");

    let m = manager(MetadataStore::at(repo));
    let first = m.spawn("feature-a", None).expect("spawn");
    assert_eq!(first.trackers[0].origin, BindOrigin::Nothing);
    assert!(!first.branch.workspace_path.join(".env.local").exists());

    let env = first.branch.workspace_path.join(".env.local");
    std::fs::write(&env, "API_KEY=abc\n").expect("write env");
    let captured = m
        .capture_tracker("feature-a", "runtime-env")
        .expect("capture");
    assert_eq!(
        m.store().find_branch("feature-a").expect("reload").trackers["runtime-env"]
            .content_rev
            .as_deref(),
        Some(captured.rev.as_str())
    );

    // Capture alone does not move the lane head/default.
    let second = m.spawn("feature-b", None).expect("spawn b");
    assert_eq!(second.trackers[0].origin, BindOrigin::Nothing);
    assert!(!second.branch.workspace_path.join(".env.local").exists());

    // Merging the tracker promotes this branch-local rev to the default for
    // future branches and explicit pulls.
    let merged = m
        .merge_tracker("feature-a", "runtime-env")
        .expect("merge tracker");
    assert_eq!(merged.rev, captured.rev);

    let third = m.spawn("feature-c", None).expect("spawn c");
    assert_eq!(third.trackers[0].origin, BindOrigin::LaneHead);
    assert_eq!(third.trackers[0].content_rev, Some(merged.rev));
    assert_eq!(
        std::fs::read_to_string(third.branch.workspace_path.join(".env.local")).expect("read"),
        "API_KEY=abc\n"
    );
}

#[test]
fn capture_and_restore_roundtrip_with_safety_capture() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let repo = store.paths().project_root.clone();
    let m = manager(store);
    m.create_tracker("runtime-env", "user", Storage::Local, false)
        .expect("create");
    m.track_paths("runtime-env", &[Utf8PathBuf::from(".env.local")])
        .expect("track");
    let m = manager(MetadataStore::at(repo));
    let spawned = m.spawn("feature-a", None).expect("spawn");
    let env = spawned.branch.workspace_path.join(".env.local");

    // Edit and capture: new rev, binding updated.
    std::fs::write(&env, "API_KEY=abc\n").expect("edit");
    let captured = m
        .capture_tracker("feature-a", "runtime-env")
        .expect("capture");
    assert!(captured.changed);

    // Recapture without changes dedupes.
    let again = m
        .capture_tracker("feature-a", "runtime-env")
        .expect("recapture");
    assert!(!again.changed);
    assert_eq!(again.rev, captured.rev);

    // Diverge, then check out the captured rev: divergence is auto-saved.
    std::fs::write(&env, "API_KEY=oops\n").expect("diverge");
    let restored = m
        .checkout_tracker("feature-a", "runtime-env", None)
        .expect("checkout");
    assert_eq!(restored.rev, captured.rev);
    let safety = restored.safety_rev.expect("divergence saved");
    assert_eq!(
        std::fs::read_to_string(&env).expect("read"),
        "API_KEY=abc\n"
    );

    // The safety rev is itself available for checkout.
    let back = m
        .checkout_tracker("feature-a", "runtime-env", Some(&safety))
        .expect("checkout safety");
    assert_eq!(back.rev, safety);
    assert_eq!(
        std::fs::read_to_string(&env).expect("read"),
        "API_KEY=oops\n"
    );
}

#[test]
fn merge_and_pull_flow_to_new_and_existing_instances() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let repo = store.paths().project_root.clone();

    // A tracker owning a config file that should travel with source merges.
    std::fs::write(
        store.paths().trackers.join("shared-config.toml"),
        r#"audience = "project-devs"
storage = "local"
merge_with_source = true
paths = ["config/shared.json"]
"#,
    )
    .expect("write def");
    std::fs::write(repo.join(".gitignore"), "/config/shared.json\n").expect("gitignore");

    let m = manager(MetadataStore::at(repo.clone()));
    let a = m.spawn("feature-a", None).expect("spawn a");
    // No lane head and no template: bound without content.
    assert_eq!(a.trackers[0].origin, BindOrigin::Nothing);

    assert!(m.tracker_definitions()[0].merge_with_source);

    // A creates content and captures; the lane head does not move until merge.
    let config_a = a.branch.workspace_path.join("config/shared.json");
    std::fs::create_dir_all(config_a.parent().expect("has parent")).expect("mkdir");
    std::fs::write(&config_a, "{\"v\":1}\n").expect("write");
    let captured = m
        .capture_tracker("feature-a", "shared-config")
        .expect("capture");

    let b_empty = m
        .spawn("feature-b-empty", None)
        .expect("spawn b before merge");
    assert_eq!(b_empty.trackers[0].origin, BindOrigin::Nothing);

    let merged = m
        .merge_tracker("feature-a", "shared-config")
        .expect("merge tracker");
    assert_eq!(merged.rev, captured.rev);

    // A new spawn projects from the lane head.
    let b = m.spawn("feature-b", None).expect("spawn b");
    assert_eq!(b.trackers[0].origin, BindOrigin::LaneHead);
    assert_eq!(
        b.trackers[0].content_rev.as_deref(),
        Some(captured.rev.as_str())
    );
    assert_eq!(
        std::fs::read_to_string(b.branch.workspace_path.join("config/shared.json")).expect("read"),
        "{\"v\":1}\n"
    );

    // A captures and merges again; B is now behind, and pull catches up.
    std::fs::write(&config_a, "{\"v\":2}\n").expect("write v2");
    m.capture_tracker("feature-a", "shared-config")
        .expect("capture v2");
    m.merge_tracker("feature-a", "shared-config")
        .expect("merge v2");
    let statuses = m.statuses().expect("statuses");
    let b_report = statuses
        .iter()
        .find(|r| r.branch.name == "feature-b")
        .expect("b");
    assert!(b_report.trackers[0].never_pulled() || b_report.trackers[0].diverged());

    m.pull_tracker("feature-b", "shared-config").expect("pull");
    assert_eq!(
        std::fs::read_to_string(b_report.branch.workspace_path.join("config/shared.json"))
            .expect("read"),
        "{\"v\":2}\n"
    );
    let statuses = m.statuses().expect("statuses");
    let b_report = statuses
        .iter()
        .find(|r| r.branch.name == "feature-b")
        .expect("b");
    assert!(!b_report.trackers[0].never_pulled() && !b_report.trackers[0].diverged());
}

#[test]
fn workspace_marker_is_invisible_to_git() {
    let (_guard, temp) = tempdir();
    let m = manager(setup(&temp));
    let outcome = m.spawn("feature-a", None).expect("spawn");

    let status = Command::new("git")
        .args([
            "-C",
            outcome.branch.workspace_path.as_str(),
            "status",
            "--porcelain",
        ])
        .output()
        .expect("git status");
    assert!(
        status.stdout.is_empty(),
        "workspace not clean: {}",
        String::from_utf8_lossy(&status.stdout)
    );
}

#[test]
fn dual_tracked_paths_warn_loudly() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let repo = store.paths().project_root.clone();

    // README.md is committed; a tracker owning it is dual-tracked.
    std::fs::write(
        store.paths().trackers.join("readme.toml"),
        "audience = \"project-devs\"\nstorage = \"local\"\nmerge_with_source = true\npaths = [\"README.md\"]\n",
    )
    .expect("write def");

    let m = manager(MetadataStore::at(repo));
    let warnings = m.gitignore_warnings();
    assert_eq!(warnings.len(), 1);
    assert!(warnings[0].contains("dual-tracked"), "{}", warnings[0]);
}

#[test]
fn disjoint_lanes_and_empty_pull_are_enforced() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let repo = store.paths().project_root.clone();

    for (name, path) in [("a", "src/generated"), ("b", "src/generated/sdk")] {
        std::fs::write(
            store.paths().trackers.join(format!("{name}.toml")),
            format!(
                "audience = \"project-devs\"\nstorage = \"local\"\nmerge_with_source = false\npaths = [\"{path}\"]\n"
            ),
        )
        .expect("write def");
    }
    assert!(matches!(
        BranchManager::open(MetadataStore::at(repo.clone())),
        Err(NewgitError::TrackerPathConflict { .. })
    ));

    std::fs::remove_file(store.paths().trackers.join("b.toml")).expect("rm");
    let m = manager(MetadataStore::at(repo));
    m.spawn("feature-a", None).expect("spawn");
    assert!(matches!(
        m.pull_tracker("feature-a", "a"),
        Err(NewgitError::Unsupported(_))
    ));
}

/// M6's SQLite case. The claim is that it needs no special support: a
/// database that is just a file on disk is a tracker, and binary content has
/// to survive capture and restore byte-for-byte.
#[test]
fn a_binary_database_file_round_trips_through_a_plain_file_tracker() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let repo = store.paths().project_root.clone();
    let m = manager(store);
    m.create_tracker("dev-db", "project-devs", Storage::Local, false)
        .expect("create");
    m.track_paths("dev-db", &[Utf8PathBuf::from("data/dev.sqlite")])
        .expect("track");

    let m = manager(MetadataStore::at(repo));
    let spawned = m.spawn("feature-a", None).expect("spawn");
    let db = spawned.branch.workspace_path.join("data/dev.sqlite");
    std::fs::create_dir_all(db.parent().expect("parent")).expect("mkdir");

    // A SQLite header, a NUL-heavy page, and a high byte: nothing here
    // survives being treated as text.
    let mut original = b"SQLite format 3\0".to_vec();
    original.extend(std::iter::repeat_n(0u8, 200));
    original.extend([0xff, 0x00, 0x80, b'r', b'o', b'w']);
    std::fs::write(&db, &original).expect("write db");

    m.capture_tracker("feature-a", "dev-db").expect("capture");
    let checkpoint = m
        .checkpoint("feature-a", Some("seeded"))
        .expect("checkpoint");

    // The agent corrupts the database, as agents do.
    std::fs::write(&db, b"truncated garbage").expect("clobber");
    m.undo("feature-a", Some(&checkpoint.record.id))
        .expect("undo");

    assert_eq!(
        std::fs::read(&db).expect("read db"),
        original,
        "a binary database must come back byte-for-byte"
    );

    // And a later instance projects the merged lane content the same way.
    m.merge_tracker("feature-a", "dev-db").expect("merge");
    let later = m.spawn("feature-b", None).expect("spawn b");
    assert_eq!(
        std::fs::read(later.branch.workspace_path.join("data/dev.sqlite")).expect("read"),
        original
    );
}

/// Tracker-owned content must be invisible to the workspace's Git even when
/// the store's `.gitignore` edit has not been committed yet — otherwise an
/// agent running `git add -A` commits a lane's content into source history,
/// which is exactly what audience is supposed to prevent by construction.
#[test]
fn tracker_paths_are_ignored_in_a_workspace_before_gitignore_is_committed() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let repo = store.paths().project_root.clone();
    let m = manager(store);
    m.create_tracker("runtime-env", "user", Storage::Local, false)
        .expect("create");
    m.track_paths("runtime-env", &[Utf8PathBuf::from(".env.local")])
        .expect("track");
    m.create_tracker("generated-sdk", "public", Storage::Local, false)
        .expect("create");
    m.track_paths("generated-sdk", &[Utf8PathBuf::from("src/generated")])
        .expect("track");

    // Deliberately do NOT commit the store's .gitignore: this is the state a
    // user is in immediately after `newgit tracker track`.
    let m = manager(MetadataStore::at(repo));
    let spawned = m.spawn("feature-a", None).expect("spawn");
    let workspace = spawned.branch.workspace_path.clone();

    std::fs::write(workspace.join(".env.local"), "SECRET=hunter2\n").expect("write");
    std::fs::create_dir_all(workspace.join("src/generated")).expect("mkdir");
    std::fs::write(workspace.join("src/generated/api.ts"), "export {};\n").expect("write");

    let status = Command::new("git")
        .args(["-C", workspace.as_str(), "status", "--porcelain"])
        .output()
        .expect("git status");
    let porcelain = String::from_utf8_lossy(&status.stdout);
    assert!(
        porcelain.trim().is_empty(),
        "tracker-owned content must not appear in git status, got: {porcelain}"
    );

    // The strong form: even `git add -A` cannot pick it up.
    git(&workspace, &["add", "-A"]);
    let staged = Command::new("git")
        .args(["-C", workspace.as_str(), "diff", "--cached", "--name-only"])
        .output()
        .expect("git diff");
    assert!(
        String::from_utf8_lossy(&staged.stdout).trim().is_empty(),
        "a lane's content must not be stageable into source history"
    );
}

/// A lane starts empty and `capture` reads from an instance workspace, so the
/// first spawn of an env-carrying tracker used to come up without its files:
/// you had to spawn, `cp` the content in, capture, merge, and re-run prepare.
/// Seeding from the store repo makes the first spawn work instead.
#[test]
fn a_lane_seeded_from_the_store_repo_reaches_the_first_instance() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let repo = store.paths().project_root.clone();

    // The content an adopting project already has on disk.
    std::fs::create_dir_all(repo.join("packages/db")).expect("mkdir");
    std::fs::write(repo.join("packages/db/.env"), "DB=local\n").expect("write");
    std::fs::write(repo.join(".env.local"), "API=local\n").expect("write");

    let m = manager(store);
    m.create_tracker("runtime-env", "user", Storage::Local, false)
        .expect("create");
    let tracked = m
        .track_paths(
            "runtime-env",
            &[
                Utf8PathBuf::from("packages/db/.env"),
                Utf8PathBuf::from(".env.local"),
            ],
        )
        .expect("track");
    assert!(
        tracked.seedable,
        "content is on disk, so the lane can be seeded without an instance"
    );

    let seeded = m.seed_tracker_from_store("runtime-env").expect("seed");
    assert_eq!(seeded.files, 2);
    assert!(seeded.changed);
    assert!(seeded.missing_paths.is_empty());

    // The whole point: the first instance comes up with the content.
    // Reopened because each CLI invocation loads definitions fresh.
    let m = manager(MetadataStore::at(repo));
    let spawned = m.spawn("bootstrap", None).expect("spawn");
    let workspace = &spawned.branch.workspace_path;
    assert_eq!(
        std::fs::read_to_string(workspace.join("packages/db/.env")).expect("read"),
        "DB=local\n"
    );
    assert_eq!(
        std::fs::read_to_string(workspace.join(".env.local")).expect("read"),
        "API=local\n"
    );
    assert_eq!(
        spawned.branch.trackers["runtime-env"]
            .content_rev
            .as_deref(),
        Some(seeded.rev.as_str())
    );

    // Re-seeding unchanged content is a no-op against the lane head.
    let again = m.seed_tracker_from_store("runtime-env").expect("reseed");
    assert_eq!(again.rev, seeded.rev);
    assert!(!again.changed);
}

/// Seeding reports declared paths with nothing behind them rather than
/// quietly capturing a partial lane, and refuses outright when none exist.
#[test]
fn seeding_reports_paths_that_are_not_on_disk() {
    let (_guard, temp) = tempdir();
    let store = setup(&temp);
    let repo = store.paths().project_root.clone();
    let m = manager(store);

    m.create_tracker("runtime-env", "user", Storage::Local, false)
        .expect("create");
    let tracked = m
        .track_paths(
            "runtime-env",
            &[
                Utf8PathBuf::from(".env.local"),
                Utf8PathBuf::from(".env.ci"),
            ],
        )
        .expect("track");
    assert!(
        !tracked.seedable,
        "nothing on disk yet, so do not advertise seeding"
    );

    assert!(matches!(
        m.seed_tracker_from_store("runtime-env"),
        Err(NewgitError::NothingToSeed { .. })
    ));

    std::fs::write(repo.join(".env.local"), "API=local\n").expect("write");
    let seeded = m.seed_tracker_from_store("runtime-env").expect("seed");
    assert_eq!(seeded.files, 1);
    assert_eq!(seeded.missing_paths, vec![Utf8PathBuf::from(".env.ci")]);
}