liboxen 0.48.0

Oxen is a fast, unstructured data version control, to help version large machine learning datasets written in Rust.
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
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
//! # oxen clone
//!
//! Clone data from a remote repository
//!

use std::path::Path;

use crate::api;
use crate::constants::DEFAULT_REMOTE_NAME;
use crate::core;
use crate::core::versions::MinOxenVersion;
use crate::error::OxenError;
use crate::model::{LocalRepository, Remote, RemoteRepository};
use crate::opts::CloneOpts;
use crate::opts::{FetchOpts, StorageOpts};

pub async fn clone(opts: &CloneOpts) -> Result<LocalRepository, OxenError> {
    clone_remote(opts).await
}

pub async fn clone_url(
    url: impl AsRef<str>,
    dst: impl AsRef<Path>,
) -> Result<LocalRepository, OxenError> {
    let fetch_opts = FetchOpts::new();
    _clone(url, dst, fetch_opts).await
}

pub async fn deep_clone_url(
    url: impl AsRef<str>,
    dst: impl AsRef<Path>,
) -> Result<LocalRepository, OxenError> {
    let fetch_opts = FetchOpts {
        all: true,
        ..FetchOpts::new()
    };

    _clone(url, dst, fetch_opts).await
}

async fn _clone(
    url: impl AsRef<str>,
    dst: impl AsRef<Path>,
    fetch_opts: FetchOpts,
) -> Result<LocalRepository, OxenError> {
    let opts = CloneOpts {
        url: url.as_ref().to_string(),
        dst: dst.as_ref().to_owned(),
        fetch_opts,
        storage_opts: StorageOpts::from_path(dst.as_ref(), true),
        is_vfs: false,
        is_remote: false,
    };
    clone(&opts).await
}

async fn clone_remote(opts: &CloneOpts) -> Result<LocalRepository, OxenError> {
    log::debug!(
        "clone_remote {} -> {:?} -> subtree? {:?} -> depth? {:?} -> all? {} -> storage backend? {:?} -> is vfs? {} -> is remote? {}",
        opts.url,
        opts.dst,
        opts.fetch_opts.subtree_paths,
        opts.fetch_opts.depth,
        opts.fetch_opts.all,
        opts.storage_opts.type_,
        opts.is_vfs,
        opts.is_remote,
    );

    let remote = Remote {
        name: String::from(DEFAULT_REMOTE_NAME),
        url: opts.url.to_owned(),
    };
    let remote_repo = api::client::repositories::get_by_remote(&remote).await?;

    if opts.is_remote {
        clone_repo_remote_mode(remote_repo, opts).await
    } else {
        clone_repo(remote_repo, opts).await
    }
}

async fn clone_repo(
    remote_repo: RemoteRepository,
    opts: &CloneOpts,
) -> Result<LocalRepository, OxenError> {
    println!("🐂 cloning repo {}", remote_repo.url());
    match remote_repo.min_version() {
        MinOxenVersion::V0_10_0 => panic!("v0.10.0 no longer supported"),
        _ => core::v_latest::clone::clone_repo(remote_repo, opts).await,
    }
}

async fn clone_repo_remote_mode(
    remote_repo: RemoteRepository,
    opts: &CloneOpts,
) -> Result<LocalRepository, OxenError> {
    println!("🐂 cloning repo {}", remote_repo.url());
    match remote_repo.min_version() {
        MinOxenVersion::V0_10_0 => panic!("v0.10.0 no longer supported"),
        _ => core::v_latest::clone::clone_repo_remote_mode(remote_repo, opts).await,
    }
}

#[cfg(test)]
mod tests {
    use std::path::PathBuf;

    use crate::api;
    use crate::command;
    use crate::constants;
    use crate::constants::DEFAULT_BRANCH_NAME;
    use crate::constants::DEFAULT_REMOTE_NAME;
    use crate::error::OxenError;
    use crate::model::RepoNew;
    use crate::opts::PushOpts;
    use crate::repositories;
    use crate::test;
    use crate::util;

    use super::*;

    #[tokio::test]
    async fn test_clone_remote() -> Result<(), OxenError> {
        test::run_empty_local_repo_test_async(|local_repo| async move {
            // Create remote repo
            let remote_repo = test::create_remote_repo(&local_repo).await?;

            log::debug!("created the remote repo");

            test::run_empty_dir_test_async(|dir| async move {
                let opts = CloneOpts::new(&remote_repo.remote.url, dir.join("new_repo"));

                log::debug!("about to clone the remote");
                let local_repo = clone_remote(&opts).await?;
                log::debug!("succeeded");
                let cfg_fname = ".oxen/config.toml".to_string();
                let config_path = local_repo.path.join(&cfg_fname);
                assert!(config_path.exists());

                let repository = LocalRepository::from_dir(&local_repo.path);
                assert!(repository.is_ok());

                let repository = repository.unwrap();
                let status = repositories::status(&repository)?;
                assert!(status.is_clean());

                // Cleanup
                api::client::repositories::delete(&remote_repo).await?;

                Ok(())
            })
            .await
        })
        .await
    }

    #[tokio::test]
    async fn test_move_local_repo_path_valid() -> Result<(), OxenError> {
        test::run_empty_local_repo_test_async(|local_repo| async move {
            // Create remote repo
            let remote_repo = test::create_remote_repo(&local_repo).await?;

            test::run_empty_dir_test_async(|dir| async move {
                let opts = CloneOpts::new(&remote_repo.remote.url, dir.join("new_repo"));
                let local_repo = clone_remote(&opts).await?;

                api::client::repositories::delete(&remote_repo).await?;

                repositories::status(&local_repo)?;

                let new_path = dir.join("new_path");

                core::staged::remove_from_cache_with_children(&local_repo.path)?;
                core::refs::remove_from_cache(&local_repo.path)?;
                util::fs::rename(&local_repo.path, &new_path)?;

                let new_repo = LocalRepository::from_dir(&new_path)?;
                repositories::status(&new_repo)?;
                assert_eq!(new_repo.path, new_path);

                Ok(())
            })
            .await
        })
        .await
    }

    #[tokio::test]
    async fn test_clone_root_subtree_depth_1() -> Result<(), OxenError> {
        test::run_training_data_fully_sync_remote(|_local_repo, remote_repo| async move {
            let cloned_remote = remote_repo.clone();
            test::run_empty_dir_test_async(|dir| async move {
                let mut opts = CloneOpts::new(&remote_repo.remote.url, dir.join("new_repo"));
                opts.fetch_opts.subtree_paths = Some(vec![PathBuf::from(".")]);
                opts.fetch_opts.depth = Some(1);
                let local_repo = clone_remote(&opts).await?;

                // Make sure we set the depth and subtree paths
                assert_eq!(local_repo.depth(), Some(1));
                assert_eq!(local_repo.subtree_paths(), Some(vec![PathBuf::from("")]));

                // All the files should be here
                assert!(local_repo.path.join("README.md").exists());
                assert!(local_repo.path.join("labels.txt").exists());
                assert!(local_repo.path.join("prompts.jsonl").exists());
                assert!(local_repo.path.join("LICENSE").exists());

                // But none of the subdirectories should be here
                assert!(!local_repo.path.join("nlp").exists());
                assert!(!local_repo.path.join("annotations").exists());
                assert!(!local_repo.path.join("train").exists());

                Ok(())
            })
            .await?;
            Ok(cloned_remote)
        })
        .await
    }

    #[tokio::test]
    async fn test_clone_annotations_subtree() -> Result<(), OxenError> {
        test::run_training_data_fully_sync_remote(|_local_repo, remote_repo| async move {
            let cloned_remote = remote_repo.clone();
            test::run_empty_dir_test_async(|dir| async move {
                let mut opts = CloneOpts::new(&remote_repo.remote.url, dir.join("new_repo"));
                opts.fetch_opts.subtree_paths = Some(vec![PathBuf::from("annotations")]);
                let local_repo = clone_remote(&opts).await?;

                // Make sure we set the depth and subtree paths
                assert_eq!(
                    local_repo.subtree_paths(),
                    Some(vec![PathBuf::from("annotations")])
                );

                assert!(local_repo.path.join("annotations").exists());
                assert!(local_repo.path.join("annotations").join("train").exists());
                assert!(
                    local_repo
                        .path
                        .join("annotations")
                        .join("train")
                        .join("one_shot.csv")
                        .exists()
                );
                assert!(
                    local_repo
                        .path
                        .join("annotations")
                        .join("train")
                        .join("two_shot.csv")
                        .exists()
                );
                assert!(local_repo.path.join("annotations").join("test").exists());
                assert!(
                    local_repo
                        .path
                        .join("annotations")
                        .join("test")
                        .join("annotations.csv")
                        .exists()
                );
                assert!(!local_repo.path.join("train").exists());

                Ok(())
            })
            .await?;
            Ok(cloned_remote)
        })
        .await
    }

    #[tokio::test]
    async fn test_clone_annotations_test_subtree() -> Result<(), OxenError> {
        test::run_training_data_fully_sync_remote(|_local_repo, remote_repo| async move {
            let cloned_remote = remote_repo.clone();
            test::run_empty_dir_test_async(|dir| async move {
                let mut opts = CloneOpts::new(&remote_repo.remote.url, dir.join("new_repo"));
                opts.fetch_opts.subtree_paths =
                    Some(vec![PathBuf::from("annotations").join("test")]);
                let local_repo = clone_remote(&opts).await?;

                assert!(local_repo.path.join("annotations").join("test").exists());
                assert!(
                    local_repo
                        .path
                        .join("annotations")
                        .join("test")
                        .join("annotations.csv")
                        .exists()
                );
                assert!(!local_repo.path.join("annotations").join("train").exists());
                assert!(!local_repo.path.join("train").exists());

                Ok(())
            })
            .await?;
            Ok(cloned_remote)
        })
        .await
    }

    #[tokio::test]
    async fn test_clone_multiple_subtrees() -> Result<(), OxenError> {
        test::run_training_data_fully_sync_remote(|_local_repo, remote_repo| async move {
            let cloned_remote = remote_repo.clone();
            test::run_empty_dir_test_async(|dir| async move {
                let mut opts = CloneOpts::new(&remote_repo.remote.url, dir.join("new_repo"));
                opts.fetch_opts.subtree_paths = Some(vec![
                    PathBuf::from("annotations").join("test"),
                    PathBuf::from("nlp"),
                ]);
                let local_repo = clone_remote(&opts).await?;

                assert!(local_repo.path.join("annotations").join("test").exists());
                assert!(local_repo.path.join("nlp").exists());
                assert!(
                    local_repo
                        .path
                        .join("annotations")
                        .join("test")
                        .join("annotations.csv")
                        .exists()
                );
                assert!(!local_repo.path.join("annotations").join("train").exists());
                assert!(!local_repo.path.join("train").exists());

                Ok(())
            })
            .await?;
            Ok(cloned_remote)
        })
        .await
    }

    // Test for clone --all that checks to make sure we have all commits, all deleted files, etc
    #[tokio::test]
    async fn test_clone_dash_all() -> Result<(), OxenError> {
        test::run_training_data_fully_sync_remote(|local_repo, remote_repo| async move {
            // Create additional branch on remote repo before clone
            let branch_name = "test-branch";
            api::client::branches::create_from_branch(
                &remote_repo,
                branch_name,
                DEFAULT_BRANCH_NAME,
            )
            .await?;

            let cloned_remote = remote_repo.clone();
            let og_commits = repositories::commits::list_all(&local_repo)?;

            // Clone with the --all flag
            test::run_empty_dir_test_async(|new_repo_dir| async move {
                let cloned_repo = repositories::deep_clone_url(
                    &remote_repo.remote.url,
                    &new_repo_dir.join("new_repo"),
                )
                .await?;

                // Make sure we have all the commit objects
                let cloned_commits = repositories::commits::list_all(&cloned_repo)?;
                assert_eq!(og_commits.len(), cloned_commits.len());

                // Make sure we set the HEAD file
                let head_commit = repositories::commits::head_commit(&cloned_repo);
                assert!(head_commit.is_ok());

                // We remove the test/ directory in one of the commits, so make sure we can go
                // back in the history to that commit
                let test_dir_path = cloned_repo.path.join("test");
                println!("test_clone_dash_all test_dir_path: {test_dir_path:?}");
                let commit = repositories::commits::first_by_message(&cloned_repo, "Adding test/")?;
                assert!(commit.is_some());
                assert!(!test_dir_path.exists());

                // checkout the commit
                repositories::checkout(&cloned_repo, &commit.unwrap().id).await?;
                // Make sure we restored the directory
                assert!(test_dir_path.exists());

                // list files in test_dir_path
                let test_dir_files = util::fs::list_files_in_dir(&test_dir_path).await?;
                println!("test_dir_files: {:?}", test_dir_files.len());
                for file in test_dir_files.iter() {
                    println!("file: {file:?}");
                }
                assert_eq!(test_dir_files.len(), 4);

                assert!(test_dir_path.join("1.jpg").exists());
                assert!(test_dir_path.join("2.jpg").exists());
                assert!(test_dir_path.join("3.jpg").exists());
                assert!(test_dir_path.join("4.jpg").exists());

                Ok(())
            })
            .await?;

            Ok(cloned_remote)
        })
        .await
    }

    // Test for clone --all that checks to make sure we have all commits, all deleted files, etc
    #[tokio::test]
    async fn test_clone_all_push_all_full_commit_history() -> Result<(), OxenError> {
        test::run_training_data_fully_sync_remote(|_local_repo, remote_repo| async move {
            let cloned_remote = remote_repo.clone();

            // Clone with the --all flag
            test::run_empty_dir_test_async(|new_repo_dir| async move {
                let new_repo_dir = new_repo_dir.join("repoo");
                let mut cloned_repo =
                    repositories::deep_clone_url(&remote_repo.remote.url, &new_repo_dir).await?;

                let repo_name = format!("new_remote_repo_name_{}", uuid::Uuid::new_v4());
                let remote_url = test::repo_remote_url_from(&repo_name);
                let remote_name = "different";

                // Create a different repo
                let repo_new = RepoNew::from_namespace_name_host(
                    constants::DEFAULT_NAMESPACE,
                    repo_name,
                    test::test_host(),
                    None,
                );
                api::client::repositories::create_from_local(&cloned_repo, repo_new).await?;

                command::config::set_remote(&mut cloned_repo, remote_name, &remote_url)?;

                let opts = PushOpts {
                    remote: remote_name.to_string(),
                    branch: "main".to_string(),
                    ..Default::default()
                };

                // Should be able to push all data successfully
                repositories::push::push_remote_branch(&cloned_repo, &opts).await?;

                Ok(())
            })
            .await?;

            Ok(cloned_remote)
        })
        .await
    }

    #[tokio::test]
    async fn test_clone_all_push_all_modified_deleted_files() -> Result<(), OxenError> {
        test::run_training_data_fully_sync_remote(|local_repo, remote_repo| async move {
            let cloned_remote = remote_repo.clone();

            // Create a new text file
            let filename = "file_to_modify.txt";
            let filepath = local_repo.path.join(filename);
            test::write_txt_file_to_path(&filepath, "Content before modification")?;
            repositories::add(&local_repo, &filepath).await?;
            repositories::commit(&local_repo, "Adding file_to_modify.txt")?;

            // Change the file's contents - different hash
            test::write_txt_file_to_path(&filepath, "A whole new hash now!")?;
            repositories::add(&local_repo, &filepath).await?;
            repositories::commit(&local_repo, "Modifying file_to_modify.txt")?;

            test::write_txt_file_to_path(&filepath, "Changing againnnnn")?;
            repositories::add(&local_repo, &filepath).await?;
            repositories::commit(&local_repo, "Modifying file_to_modify.txt")?;

            // Delete file
            std::fs::remove_file(&filepath)?;
            repositories::add(&local_repo, &filepath).await?;
            repositories::commit(&local_repo, "Deleting file_to_modify.txt")?;

            // Add back new
            test::write_txt_file_to_path(&filepath, "Adding back new")?;
            repositories::add(&local_repo, &filepath).await?;
            repositories::commit(&local_repo, "Adding back file_to_modify.txt")?;
            let opts = PushOpts {
                remote: DEFAULT_REMOTE_NAME.to_string(),
                branch: DEFAULT_BRANCH_NAME.to_string(),
                ..Default::default()
            };

            repositories::push::push_remote_branch(&local_repo, &opts).await?;

            // Clone with the --all flag
            test::run_empty_dir_test_async(|new_repo_dir| async move {
                let new_repo_dir = new_repo_dir.join("repoo");
                let mut cloned_repo =
                    repositories::deep_clone_url(&remote_repo.remote.url, &new_repo_dir).await?;

                let repo_name = format!("new_remote_repo_name_{}", uuid::Uuid::new_v4());
                let remote_url = test::repo_remote_url_from(&repo_name);
                let remote_name = "different";

                // Create a different repo
                let repo_new = RepoNew::from_namespace_name_host(
                    constants::DEFAULT_NAMESPACE,
                    repo_name,
                    test::test_host(),
                    None,
                );
                api::client::repositories::create_empty(repo_new).await?;

                command::config::set_remote(&mut cloned_repo, remote_name, &remote_url)?;

                let opts = PushOpts {
                    remote: remote_name.to_string(),
                    branch: "main".to_string(),
                    ..Default::default()
                };

                // Should be able to push all data successfully
                repositories::push::push_remote_branch(&cloned_repo, &opts).await?;

                Ok(())
            })
            .await?;

            Ok(cloned_remote)
        })
        .await
    }

    #[tokio::test]
    async fn test_clone_full() -> Result<(), OxenError> {
        test::run_training_data_repo_test_no_commits_async(|mut repo| async move {
            // Track a file
            let filename = "labels.txt";
            let file_path = repo.path.join(filename);
            repositories::add(&repo, &file_path).await?;
            repositories::commit(&repo, "Adding labels file")?;

            let train_path = repo.path.join("train");
            repositories::add(&repo, &train_path).await?;
            repositories::commit(&repo, "Adding train dir")?;

            let test_path = repo.path.join("test");
            repositories::add(&repo, &test_path).await?;
            repositories::commit(&repo, "Adding test dir")?;

            // Set the proper remote
            let remote = test::repo_remote_url_from(&repo.dirname());
            command::config::set_remote(&mut repo, constants::DEFAULT_REMOTE_NAME, &remote)?;

            // Create Remote
            let remote_repo = test::create_remote_repo(&repo).await?;

            // Push it
            repositories::push(&repo).await?;

            // run another test with a new repo dir that we are going to sync to
            test::run_empty_dir_test_async(|new_repo_dir| async move {
                let cloned_repo = repositories::clone_url(
                    &remote_repo.remote.url,
                    &new_repo_dir.join("new_repo"),
                )
                .await?;
                let cloned_num_files = util::fs::rcount_files_in_dir(&cloned_repo.path);
                // 4 test, 7 train, 1 labels
                assert_eq!(12, cloned_num_files);

                api::client::repositories::delete(&remote_repo).await?;

                Ok(())
            })
            .await
        })
        .await
    }

    #[tokio::test]
    async fn test_oxen_clone_empty_repo() -> Result<(), OxenError> {
        test::run_no_commit_remote_repo_test(|remote_repo| async move {
            let ret_repo = remote_repo.clone();

            // Create a new repo to clone to, then clean it up
            test::run_empty_dir_test_async(|new_repo_dir| async move {
                let cloned_repo = repositories::clone_url(
                    &remote_repo.remote.url,
                    &new_repo_dir.join("new_repo"),
                )
                .await?;

                let status = repositories::status(&cloned_repo);
                assert!(status.is_ok());

                Ok(())
            })
            .await?;

            Ok(ret_repo)
        })
        .await
    }

    #[tokio::test]
    async fn test_oxen_clone_empty_repo_then_push() -> Result<(), OxenError> {
        test::run_no_commit_remote_repo_test(|remote_repo| async move {
            let ret_repo = remote_repo.clone();

            // Create a new repo to clone to, then clean it up
            test::run_empty_dir_test_async(|new_repo_dir| async move {
                let cloned_repo = repositories::clone_url(
                    &remote_repo.remote.url,
                    &new_repo_dir.join("new_repo"),
                )
                .await?;

                let status = repositories::status(&cloned_repo);
                assert!(status.is_ok());

                // Add a file to the cloned repo
                let new_file = "new_file.txt";
                let new_file_path = cloned_repo.path.join(new_file);
                let new_file_path = test::write_txt_file_to_path(new_file_path, "new file")?;
                repositories::add(&cloned_repo, &new_file_path).await?;
                repositories::commit(&cloned_repo, "Adding new file path.")?;

                repositories::push(&cloned_repo).await?;

                Ok(())
            })
            .await?;

            Ok(ret_repo)
        })
        .await
    }

    #[tokio::test]
    async fn test_clone_subtree_and_checkout_branch() -> Result<(), OxenError> {
        test::run_training_data_fully_sync_remote(|local_repo, remote_repo| async move {
            let remote_repo_copy = remote_repo.clone();

            let feature_branch_name = "feature/subtree-checkout-test";
            repositories::branches::create_checkout(&local_repo, feature_branch_name)?;

            let new_file_relative_path = PathBuf::from("annotations")
                .join("test")
                .join("new_on_feature.txt");
            let new_file_full_path = local_repo.path.join(&new_file_relative_path);
            util::fs::create_dir_all(new_file_full_path.parent().unwrap())?;
            util::fs::write_to_path(
                &new_file_full_path,
                "This file is new on the feature branch.",
            )?;
            repositories::add(&local_repo, &new_file_full_path).await?;
            repositories::commit(&local_repo, "Added new_on_feature.txt to annotations/test")?;

            let opts = PushOpts {
                remote: DEFAULT_REMOTE_NAME.to_string(),
                branch: feature_branch_name.to_string(),
                ..Default::default()
            };
            repositories::push::push_remote_branch(&local_repo, &opts).await?;

            // Switch original_local_repo back to main for good measure, though not strictly necessary for this test's focus
            repositories::checkout(&local_repo, DEFAULT_BRANCH_NAME).await?;

            // 2. Clone ONLY the subtree "annotations/test" from the new feature branch.
            let remote_for_inner_closure = remote_repo_copy.clone();
            test::run_empty_dir_test_async(|dir_a| async move {
                let path_a = dir_a.join("repo_A_subtree");
                let subtree_to_clone = PathBuf::from("annotations").join("test");

                let mut clone_opts_subtree =
                    CloneOpts::new(remote_for_inner_closure.url(), &path_a);
                clone_opts_subtree.fetch_opts.branch = feature_branch_name.to_string();
                clone_opts_subtree.fetch_opts.subtree_paths = Some(vec![subtree_to_clone.clone()]);

                let cloned_repo_a = repositories::clone(&clone_opts_subtree).await?;

                // Verify initial clone state (feature branch, subtree only)
                let expected_new_file_in_a = cloned_repo_a.path.join(&new_file_relative_path);
                let expected_orig_file_in_a = cloned_repo_a
                    .path
                    .join("annotations")
                    .join("test")
                    .join("annotations.csv");

                assert!(
                    expected_new_file_in_a.exists(),
                    "new_on_feature.txt should exist in feature branch clone"
                );
                assert!(
                    expected_orig_file_in_a.exists(),
                    "annotations.csv should exist in feature branch clone"
                );

                // Verify other files/dirs are NOT present
                assert!(!cloned_repo_a.path.join("README.md").exists());
                assert!(!cloned_repo_a.path.join("train").exists());
                assert!(
                    !cloned_repo_a
                        .path
                        .join("annotations")
                        .join("train")
                        .exists()
                ); // only annotations/test

                let fetch_opts = FetchOpts {
                    branch: DEFAULT_BRANCH_NAME.to_string(),
                    ..FetchOpts::new()
                };
                core::v_latest::fetch::fetch_remote_branch(
                    &cloned_repo_a,
                    &remote_repo,
                    &fetch_opts,
                )
                .await?;
                repositories::checkout(&cloned_repo_a, DEFAULT_BRANCH_NAME).await?;

                assert!(
                    !expected_new_file_in_a.exists(),
                    "new_on_feature.txt should NOT exist on main branch after checkout"
                );

                assert!(
                    expected_orig_file_in_a.exists(),
                    "annotations.csv should still exist on main branch after checkout"
                );

                assert!(!cloned_repo_a.path.join("README.md").exists());
                assert!(!cloned_repo_a.path.join("train").exists());
                assert!(
                    !cloned_repo_a
                        .path
                        .join("annotations")
                        .join("train")
                        .exists()
                );

                Ok(())
            })
            .await?;

            Ok(remote_repo_copy)
        })
        .await
    }

    #[tokio::test]
    async fn test_cloned_repos_not_set_as_remote_mode_by_default() -> Result<(), OxenError> {
        test::run_one_commit_sync_repo_test(|mut _local_repo, remote_repo| async move {
            let remote_repo_copy = remote_repo.clone();
            test::run_empty_dir_test_async(|repo_dir| async move {
                let new_repo_dir = repo_dir.join(PathBuf::from("new"));
                let cloned_repo =
                    repositories::clone_url(&remote_repo.remote.url, &new_repo_dir).await?;
                assert!(!cloned_repo.is_remote_mode());

                Ok(())
            })
            .await?;

            Ok(remote_repo_copy)
        })
        .await
    }
}