proto_core 0.56.0

Core proto APIs.
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
use proto_core::{
    Id, LockRecord, ProtoConfig, ProtoEnvironment, ProtoLock, Tool, ToolContext, ToolSpec,
    flow::lock::Locker, load_tool_from_locator,
};
use proto_pdk_api::Checksum;
use starbase_sandbox::create_empty_sandbox;
use std::path::Path;
use system_env::{SystemArch, SystemOS};
use version_spec::{UnresolvedVersionSpec, VersionSpec};

async fn create_tool_in_sandbox(sandbox_path: &Path) -> Tool {
    let mut proto = ProtoEnvironment::new_testing(sandbox_path).unwrap();
    proto.working_dir = sandbox_path.to_path_buf();

    load_tool_from_locator(
        ToolContext::parse("node").unwrap(),
        proto,
        ProtoConfig::default()
            .builtin_plugins()
            .tools
            .get("node")
            .unwrap(),
    )
    .await
    .unwrap()
}

fn make_record(
    version: &str,
    spec: &str,
    os: Option<SystemOS>,
    arch: Option<SystemArch>,
) -> LockRecord {
    LockRecord {
        version: Some(VersionSpec::parse(version).unwrap()),
        spec: Some(UnresolvedVersionSpec::parse(spec).unwrap()),
        os,
        arch,
        ..Default::default()
    }
}

mod locker {
    use super::*;

    mod resolve_locked_record {
        use super::*;

        #[tokio::test(flavor = "multi_thread")]
        async fn returns_none_when_no_lockfile() {
            let sandbox = create_empty_sandbox();
            // No lockfile setting, so load_lock returns None
            sandbox.create_file(".prototools", "");

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let spec = ToolSpec::parse("20.0.0").unwrap();
            let result = locker.resolve_locked_record(&spec).unwrap();

            assert!(result.is_none());
        }

        #[tokio::test(flavor = "multi_thread")]
        async fn returns_matching_record() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "[settings]\nlockfile = true");

            // Pre-create a lockfile with a record
            let os = SystemOS::default();
            let arch = SystemArch::default();
            let mut lock = ProtoLock::default();
            lock.tools
                .entry(Id::raw("node"))
                .or_default()
                .push(LockRecord {
                    version: Some(VersionSpec::parse("20.0.0").unwrap()),
                    spec: Some(UnresolvedVersionSpec::parse("20.0.0").unwrap()),
                    os: Some(os),
                    arch: Some(arch),
                    ..Default::default()
                });
            lock.path = sandbox.path().join(".protolock");
            lock.save().unwrap();

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let spec = ToolSpec::parse("20.0.0").unwrap();
            let result = locker.resolve_locked_record(&spec).unwrap();

            assert!(result.is_some());
            let record = result.unwrap();
            assert_eq!(record.version, Some(VersionSpec::parse("20.0.0").unwrap()));
        }

        #[tokio::test(flavor = "multi_thread")]
        async fn returns_none_when_no_matching_record() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "[settings]\nlockfile = true");

            // Create lockfile with a different version
            let mut lock = ProtoLock::default();
            lock.tools
                .entry(Id::raw("node"))
                .or_default()
                .push(LockRecord {
                    version: Some(VersionSpec::parse("18.0.0").unwrap()),
                    spec: Some(UnresolvedVersionSpec::parse("18.0.0").unwrap()),
                    os: Some(SystemOS::default()),
                    arch: Some(SystemArch::default()),
                    ..Default::default()
                });
            lock.path = sandbox.path().join(".protolock");
            lock.save().unwrap();

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let spec = ToolSpec::parse("20.0.0").unwrap();
            let result = locker.resolve_locked_record(&spec).unwrap();

            assert!(result.is_none());
        }
    }

    mod insert_record {
        use super::*;

        #[tokio::test(flavor = "multi_thread")]
        async fn inserts_new_record() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "[settings]\nlockfile = true");

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let record = make_record(
                "20.0.0",
                "20.0.0",
                Some(SystemOS::default()),
                Some(SystemArch::default()),
            );

            locker.insert_record_into_lockfile(&record).unwrap();

            // Verify it was persisted
            let lock = ProtoLock::load_from(sandbox.path()).unwrap();
            let records = lock.tools.get(&Id::raw("node")).unwrap();
            assert_eq!(records.len(), 1);
            assert_eq!(
                records[0].version,
                Some(VersionSpec::parse("20.0.0").unwrap())
            );
        }

        #[tokio::test(flavor = "multi_thread")]
        async fn replaces_record_with_higher_version() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "[settings]\nlockfile = true");

            // Pre-create lockfile with v20.0.0
            let os = SystemOS::default();
            let arch = SystemArch::default();
            let mut lock = ProtoLock::default();
            lock.tools
                .entry(Id::raw("node"))
                .or_default()
                .push(LockRecord {
                    version: Some(VersionSpec::parse("20.0.0").unwrap()),
                    spec: Some(UnresolvedVersionSpec::parse("20.0.0").unwrap()),
                    os: Some(os),
                    arch: Some(arch),
                    ..Default::default()
                });
            lock.path = sandbox.path().join(".protolock");
            lock.save().unwrap();

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            // Insert higher version with same spec
            let record = make_record("20.1.0", "20.0.0", Some(os), Some(arch));
            locker.insert_record_into_lockfile(&record).unwrap();

            // Should have replaced (still 1 record)
            let lock = ProtoLock::load_from(sandbox.path()).unwrap();
            let records = lock.tools.get(&Id::raw("node")).unwrap();
            assert_eq!(records.len(), 1);
            assert_eq!(
                records[0].version,
                Some(VersionSpec::parse("20.1.0").unwrap())
            );
        }

        #[tokio::test(flavor = "multi_thread")]
        async fn no_op_when_no_lockfile_config() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "");

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let record = make_record(
                "20.0.0",
                "20.0.0",
                Some(SystemOS::default()),
                Some(SystemArch::default()),
            );

            // Should not error, just no-op
            locker.insert_record_into_lockfile(&record).unwrap();

            // No lockfile should exist
            assert!(!sandbox.path().join(".protolock").exists());
        }
    }

    mod remove_version {
        use super::*;

        #[tokio::test(flavor = "multi_thread")]
        async fn removes_matching_version() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "[settings]\nlockfile = true");

            // Create lockfile with two records
            let os = SystemOS::default();
            let arch = SystemArch::default();
            let mut lock = ProtoLock::default();
            let records = lock.tools.entry(Id::raw("node")).or_default();
            records.push(LockRecord {
                version: Some(VersionSpec::parse("18.0.0").unwrap()),
                spec: Some(UnresolvedVersionSpec::parse("18.0.0").unwrap()),
                os: Some(os),
                arch: Some(arch),
                ..Default::default()
            });
            records.push(LockRecord {
                version: Some(VersionSpec::parse("20.0.0").unwrap()),
                spec: Some(UnresolvedVersionSpec::parse("20.0.0").unwrap()),
                os: Some(os),
                arch: Some(arch),
                ..Default::default()
            });
            lock.path = sandbox.path().join(".protolock");
            lock.save().unwrap();

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            locker
                .remove_version_from_lockfile(&VersionSpec::parse("18.0.0").unwrap())
                .unwrap();

            // Only v20 should remain
            let lock = ProtoLock::load_from(sandbox.path()).unwrap();
            let records = lock.tools.get(&Id::raw("node")).unwrap();
            assert_eq!(records.len(), 1);
            assert_eq!(
                records[0].version,
                Some(VersionSpec::parse("20.0.0").unwrap())
            );
        }

        #[tokio::test(flavor = "multi_thread")]
        async fn removes_tool_entry_when_last_version() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "[settings]\nlockfile = true");

            let os = SystemOS::default();
            let arch = SystemArch::default();
            let mut lock = ProtoLock::default();
            lock.tools
                .entry(Id::raw("node"))
                .or_default()
                .push(LockRecord {
                    version: Some(VersionSpec::parse("20.0.0").unwrap()),
                    spec: Some(UnresolvedVersionSpec::parse("20.0.0").unwrap()),
                    os: Some(os),
                    arch: Some(arch),
                    ..Default::default()
                });
            lock.path = sandbox.path().join(".protolock");
            lock.save().unwrap();

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            locker
                .remove_version_from_lockfile(&VersionSpec::parse("20.0.0").unwrap())
                .unwrap();

            // Tool entry should be gone, and lockfile deleted since empty
            assert!(!sandbox.path().join(".protolock").exists());
        }

        #[tokio::test(flavor = "multi_thread")]
        async fn no_op_when_version_not_found() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "[settings]\nlockfile = true");

            let os = SystemOS::default();
            let arch = SystemArch::default();
            let mut lock = ProtoLock::default();
            lock.tools
                .entry(Id::raw("node"))
                .or_default()
                .push(LockRecord {
                    version: Some(VersionSpec::parse("20.0.0").unwrap()),
                    spec: Some(UnresolvedVersionSpec::parse("20.0.0").unwrap()),
                    os: Some(os),
                    arch: Some(arch),
                    ..Default::default()
                });
            lock.path = sandbox.path().join(".protolock");
            lock.save().unwrap();

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            // Remove a version that doesn't exist
            locker
                .remove_version_from_lockfile(&VersionSpec::parse("16.0.0").unwrap())
                .unwrap();

            // Original record still exists
            let lock = ProtoLock::load_from(sandbox.path()).unwrap();
            let records = lock.tools.get(&Id::raw("node")).unwrap();
            assert_eq!(records.len(), 1);
        }
    }

    mod remove_from_lockfile {
        use super::*;

        #[tokio::test(flavor = "multi_thread")]
        async fn removes_entire_tool() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "[settings]\nlockfile = true");

            let os = SystemOS::default();
            let arch = SystemArch::default();
            let mut lock = ProtoLock::default();
            lock.tools
                .entry(Id::raw("node"))
                .or_default()
                .push(LockRecord {
                    version: Some(VersionSpec::parse("20.0.0").unwrap()),
                    spec: Some(UnresolvedVersionSpec::parse("20.0.0").unwrap()),
                    os: Some(os),
                    arch: Some(arch),
                    ..Default::default()
                });
            // Add another tool to keep the file around
            lock.tools
                .entry(Id::raw("bun"))
                .or_default()
                .push(LockRecord {
                    version: Some(VersionSpec::parse("1.0.0").unwrap()),
                    spec: Some(UnresolvedVersionSpec::parse("1.0.0").unwrap()),
                    ..Default::default()
                });
            lock.path = sandbox.path().join(".protolock");
            lock.save().unwrap();

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            locker.remove_from_lockfile().unwrap();

            // Node should be gone, bun should remain
            let lock = ProtoLock::load_from(sandbox.path()).unwrap();
            assert!(!lock.tools.contains_key(&Id::raw("node")));
            assert!(lock.tools.contains_key(&Id::raw("bun")));
        }
    }

    mod verify_locked_record {
        use super::*;

        #[tokio::test(flavor = "multi_thread")]
        async fn passes_when_no_locked_record() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "");

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let spec = ToolSpec::parse("20.0.0").unwrap();
            let install_record = make_record("20.0.0", "20.0.0", None, None);

            // No locked record means verification passes
            locker.verify_locked_record(&spec, &install_record).unwrap();
        }

        #[tokio::test(flavor = "multi_thread")]
        async fn passes_when_checksums_match() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "");

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let checksum = Checksum::sha256("abc123".into());

            // Set up a spec with version_locked containing a checksum
            let mut spec = ToolSpec::parse("20.0.0").unwrap();
            spec.version_locked = Some(LockRecord {
                checksum: Some(checksum.clone()),
                ..Default::default()
            });

            let install_record = LockRecord {
                checksum: Some(checksum),
                ..Default::default()
            };

            locker.verify_locked_record(&spec, &install_record).unwrap();
        }

        #[tokio::test(flavor = "multi_thread")]
        async fn fails_when_checksums_mismatch() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "");

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let mut spec = ToolSpec::parse("20.0.0").unwrap();
            spec.version_locked = Some(LockRecord {
                checksum: Some(Checksum::sha256("expected_hash".into())),
                ..Default::default()
            });

            let install_record = LockRecord {
                checksum: Some(Checksum::sha256("actual_hash".into())),
                ..Default::default()
            };

            let result = locker.verify_locked_record(&spec, &install_record);
            assert!(result.is_err());
        }

        #[tokio::test(flavor = "multi_thread")]
        async fn skips_verification_when_different_backends() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "");

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let mut spec = ToolSpec::parse("20.0.0").unwrap();
            spec.version_locked = Some(LockRecord {
                backend: Some(Id::raw("proto")),
                checksum: Some(Checksum::sha256("expected_hash".into())),
                ..Default::default()
            });

            let install_record = LockRecord {
                backend: Some(Id::raw("asdf")),
                checksum: Some(Checksum::sha256("different_hash".into())),
                ..Default::default()
            };

            // Different backends, should skip verification
            locker.verify_locked_record(&spec, &install_record).unwrap();
        }

        #[tokio::test(flavor = "multi_thread")]
        async fn fails_on_os_mismatch() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "");

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let mut spec = ToolSpec::parse("20.0.0").unwrap();
            spec.version_locked = Some(LockRecord {
                os: Some(SystemOS::Linux),
                ..Default::default()
            });

            let install_record = LockRecord {
                os: Some(SystemOS::MacOS),
                ..Default::default()
            };

            let result = locker.verify_locked_record(&spec, &install_record);
            assert!(result.is_err());
        }

        #[tokio::test(flavor = "multi_thread")]
        async fn fails_on_arch_mismatch() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "");

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let mut spec = ToolSpec::parse("20.0.0").unwrap();
            spec.version_locked = Some(LockRecord {
                arch: Some(SystemArch::X64),
                ..Default::default()
            });

            let install_record = LockRecord {
                arch: Some(SystemArch::Arm64),
                ..Default::default()
            };

            let result = locker.verify_locked_record(&spec, &install_record);
            assert!(result.is_err());
        }
    }

    mod get_resolved_locked_record {
        use super::*;

        #[tokio::test(flavor = "multi_thread")]
        async fn returns_version_locked_from_spec() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "");

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let record = LockRecord {
                version: Some(VersionSpec::parse("20.0.0").unwrap()),
                checksum: Some(Checksum::sha256("test".into())),
                ..Default::default()
            };

            let mut spec = ToolSpec::parse("20.0.0").unwrap();
            spec.version_locked = Some(record.clone());

            let result = locker.get_resolved_locked_record(&spec);
            assert!(result.is_some());
            assert_eq!(
                result.unwrap().checksum,
                Some(Checksum::sha256("test".into()))
            );
        }

        #[tokio::test(flavor = "multi_thread")]
        async fn returns_none_when_no_locked_data() {
            let sandbox = create_empty_sandbox();
            sandbox.create_file(".prototools", "");

            let tool = create_tool_in_sandbox(sandbox.path()).await;
            let locker = Locker::new(&tool);

            let spec = ToolSpec::parse("20.0.0").unwrap();
            let result = locker.get_resolved_locked_record(&spec);

            assert!(result.is_none());
        }
    }
}