liboxen 0.46.8

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

//! # oxen workspace ls
//!
//! List files in a remote repository branch
//!

use std::path::Path;

use crate::api;
use crate::error::OxenError;
use crate::model::{Branch, RemoteRepository};
use crate::opts::PaginateOpts;
use crate::view::PaginatedDirEntries;

pub async fn ls(
    remote_repo: &RemoteRepository,
    branch: &Branch,
    directory: &Path,
    opts: &PaginateOpts,
) -> Result<PaginatedDirEntries, OxenError> {
    api::client::dir::list(
        remote_repo,
        &branch.name,
        directory,
        opts.page_num,
        opts.page_size,
    )
    .await
}

#[cfg(test)]
mod tests {
    use crate::api;
    use crate::command;
    use crate::constants;
    use crate::error::OxenError;
    use crate::opts::PaginateOpts;
    use crate::test;
    use crate::util;
    use crate::view::DataTypeCount;

    use std::path::Path;

    #[tokio::test]
    async fn test_remote_ls_ten_items() -> Result<(), OxenError> {
        test::run_empty_local_repo_test_async(|mut repo| async move {
            // Create 8 directories
            for n in 0..8 {
                let dirname = format!("dir_{}", n);
                let dir_path = repo.path.join(dirname);
                util::fs::create_dir_all(&dir_path)?;
                let filename = "data.txt";
                let filepath = dir_path.join(filename);
                util::fs::write(&filepath, format!("Hi {}", n))?;
            }
            // Create 2 files
            let filename = "labels.txt";
            let filepath = repo.path.join(filename);
            util::fs::write(&filepath, "hello world")?;

            let filename = "README.md";
            let filepath = repo.path.join(filename);
            util::fs::write(&filepath, "readme....")?;

            // Add and commit all the dirs and files
            repositories::add(&repo, &repo.path).await?;
            repositories::commit(&repo, "Adding all the data")?;

            // 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 real good
            repositories::push(&repo).await?;

            // Now list the remote
            let branch = repositories::branches::current_branch(&repo)?.unwrap();
            let dir = Path::new(".");
            let opts = PaginateOpts {
                page_num: 1,
                page_size: 10,
            };
            let paginated = repositories::workspaces::ls(&remote_repo, &branch, dir, &opts).await?;
            assert_eq!(paginated.entries.len(), 10);
            assert_eq!(paginated.page_number, 1);
            assert_eq!(paginated.page_size, 10);
            assert_eq!(paginated.total_pages, 1);

            Ok(())
        })
        .await
    }

    #[tokio::test]
    async fn test_remote_ls_return_data_types() -> Result<(), OxenError> {
        test::run_empty_local_repo_test_async(|mut repo| async move {
            // Add one video, one markdown file, and one text file
            let video_path = test::test_video_file_with_name("basketball.mp4");
            let markdown_path = test::test_text_file_with_name("README.md");
            let text_path = test::test_text_file_with_name("hello.txt");
            util::fs::copy(video_path, repo.path.join("basketball.mp4"))?;
            util::fs::copy(markdown_path, repo.path.join("README.md"))?;
            util::fs::copy(text_path, repo.path.join("hello.txt"))?;

            // Add and commit all the dirs and files
            repositories::add(&repo, &repo.path).await?;
            repositories::commit(&repo, "Adding all the data")?;

            // 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 real good
            repositories::push(&repo).await?;

            // Now list the remote
            let branch = repositories::branches::current_branch(&repo)?.unwrap();
            let dir = Path::new("");
            let opts = PaginateOpts {
                page_num: 1,
                page_size: 10,
            };
            let paginated = repositories::workspaces::ls(&remote_repo, &branch, dir, &opts).await?;

            // serialize into an array of DataTypeCount
            let metadata = paginated.metadata.unwrap();
            let data_type_counts: Vec<DataTypeCount> = metadata.dir.data_types;

            let data_type_count_text = data_type_counts
                .iter()
                .find(|&x| x.data_type == "text")
                .unwrap();
            let data_type_count_video = data_type_counts
                .iter()
                .find(|&x| x.data_type == "video")
                .unwrap();

            assert_eq!(data_type_count_text.count, 2);
            assert_eq!(data_type_count_video.count, 1);

            // serialize into an array of MimeDataTypeCount
            /*
            let mime_type_counts: Vec<MimeTypeCount> = metadata.mime_types).unwrap();

            let count_markdown = mime_type_counts
                .iter()
                .find(|&x| x.mime_type == "text/markdown")
                .unwrap();
            let count_video = mime_type_counts
                .iter()
                .find(|&x| x.mime_type == "video/mp4")
                .unwrap();
            let count_text = mime_type_counts
                .iter()
                .find(|&x| x.mime_type == "text/plain")
                .unwrap();

            assert_eq!(count_markdown.count, 1);
            assert_eq!(count_video.count, 1);
            assert_eq!(count_text.count, 1);
            */

            Ok(())
        })
        .await
    }

    #[tokio::test]
    async fn test_remote_ls_return_data_types_just_top_level_dir() -> Result<(), OxenError> {
        test::run_empty_local_repo_test_async(|mut repo| async move {
            // write text files to dir
            let dir = repo.path.join("train");
            util::fs::create_dir_all(&dir)?;
            let num_files = 33;
            for i in 0..num_files {
                let path = dir.join(format!("file_{}.txt", i));
                util::fs::write_to_path(&path, format!("lol hi {}", i))?;
            }
            repositories::add(&repo, &dir).await?;
            repositories::commit(&repo, "adding text files")?;

            // 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 real good
            repositories::push(&repo).await?;

            // Now list the remote
            let branch = repositories::branches::current_branch(&repo)?.unwrap();
            let dir = Path::new("");
            let opts = PaginateOpts {
                page_num: 1,
                page_size: 10,
            };
            let paginated = repositories::workspaces::ls(&remote_repo, &branch, dir, &opts).await?;

            // serialize into an array of DataTypeCount
            let metadata = paginated.metadata.unwrap();
            let data_type_counts: Vec<DataTypeCount> = metadata.dir.data_types;

            let data_type_count_text = data_type_counts
                .iter()
                .find(|&x| x.data_type == "text")
                .unwrap();

            assert_eq!(data_type_count_text.count, num_files);

            /*
            // serialize into an array of MimeDataTypeCount
            let mime_type_counts: Vec<MimeTypeCount> =
                serde_json::from_value(metadata.mime_types.data).unwrap();

            let count_text = mime_type_counts
                .iter()
                .find(|&x| x.mime_type == "text/plain")
                .unwrap();

            assert_eq!(count_text.count, num_files);
            */

            Ok(())
        })
        .await
    }
}