stratum/
lib.rs

1use std::path::Path;
2
3// For now include everything as pub mod to get errors in IDE
4use git_url_parse::GitUrlParseError;
5use thiserror::Error;
6
7mod domain;
8mod repository;
9mod url;
10
11pub use domain::{actor::Actor, commit::Commit};
12pub use repository::{Local, Remote, Repository};
13pub use url::GitUrl;
14
15/// Helper function for opening a local repository given a path P
16pub fn open_repository<P: AsRef<Path>>(p: P) -> Result<Repository<Local>, Error> {
17    Repository::<Local>::new(p)
18}
19
20/// Helper function for cloning a remote repository given a url
21pub fn clone_repository<P: AsRef<Path>>(
22    url: &str,
23    dest: Option<P>,
24) -> Result<Repository<Local>, Error> {
25    Repository::<Remote>::new(url, dest)
26}
27
28#[derive(Debug, Error)]
29pub enum Error {
30    /// An abstraction of git2::Error to raise the error effectively
31    #[error(transparent)]
32    Git(#[from] git2::Error),
33
34    /// An abstraction of git-url-parse::GitUrlParseError
35    #[error(transparent)]
36    GitUrlError(#[from] GitUrlParseError),
37
38    /// If a URL can be parsed but is not a valid GitUrl schem
39    #[error("URL scheme was {0}, cannot clone URL.")]
40    UrlScheme(String),
41
42    /// An error associated with a bad path
43    #[error("{0}")]
44    PathError(String),
45}
46
47/// Common functionality that can be imported into any and all unit tests
48/// throughout the library
49#[cfg(test)]
50mod common {
51    use once_cell::sync::Lazy;
52    use std::{fs, path::Path};
53    use tempfile::TempDir;
54
55    use super::{Local, Repository};
56
57    pub const EXPECTED_MSG: &str = "commit msg";
58    pub const EXPECTED_ACTOR_NAME: &str = "test";
59    pub const EXPECTED_ACTOR_EMAIL: &str = "test@example.com";
60
61    /// Write to a file that exists within a temp directory root
62    fn write_fp(root: &TempDir, path: &str, content: &str) {
63        let fp = root.path().join(path);
64        fs::write(&fp, content).expect("Failed to write to file");
65    }
66
67    /// Write a file to a git index
68    fn write_to_index(index: &mut git2::Index, file: &str) {
69        index
70            .add_path(Path::new(file))
71            .expect("Failed to add file to index");
72        index.write().expect("Failed to write index");
73    }
74
75    /// Write an index to a repository tree
76    fn write_tree<'a>(
77        repo: &'a git2::Repository,
78        index: &mut git2::Index,
79        file: &str,
80    ) -> git2::Tree<'a> {
81        write_to_index(index, file);
82
83        let tree_id = index.write_tree().expect("Failed to write tree");
84        repo.find_tree(tree_id).expect("Failed to find tree")
85    }
86
87    /// Commit a file that has been modified
88    fn commit_file(
89        repo: &git2::Repository,
90        sig: &git2::Signature,
91        file: &str,
92        parent: Option<&git2::Commit<'_>>,
93    ) -> git2::Oid {
94        // Stage file for commit
95        let mut index = repo.index().expect("Failed to get index");
96        let tree = write_tree(repo, &mut index, file);
97
98        let parents = match parent {
99            Some(v) => vec![v],
100            None => vec![],
101        };
102
103        repo.commit(Some("HEAD"), sig, sig, EXPECTED_MSG, &tree, &parents)
104            .expect("Failed to create commit")
105    }
106
107    /// Make a repository with a very basic histroy.
108    fn make_repo(tmpdir: &TempDir) {
109        let repo = git2::Repository::init(tmpdir.path()).expect("Failed to init repo");
110        let sig = git2::Signature::now(EXPECTED_ACTOR_NAME, EXPECTED_ACTOR_EMAIL)
111            .expect("Failed to create actor signature");
112
113        let file = "file.txt";
114        write_fp(tmpdir, file, "Hello World\n");
115        let first_commit_id = commit_file(&repo, &sig, file, None);
116
117        write_fp(tmpdir, file, "Hello World\nFile Update\n");
118        let parent = repo
119            .find_commit(first_commit_id)
120            .expect("Failed to find first commit");
121        commit_file(&repo, &sig, file, Some(&parent));
122    }
123
124    /// Lazily construct the test data into a temp dir that will last the length of
125    /// a single modules test span
126    static TEST_DATA_DIR: Lazy<TempDir> = Lazy::new(|| {
127        let dir = TempDir::new().expect("Create temp dir");
128        make_repo(&dir);
129        dir
130    });
131
132    /// The path to the test data directory
133    fn test_data_dir() -> &'static Path {
134        TEST_DATA_DIR.path()
135    }
136
137    /// Init a repository object using the lazily constructed git2 repo
138    ///
139    /// The repository exists in a temporary diectory and is made with some
140    /// expected values that are public constants.
141    ///
142    /// The commit history is two commits long, two commits so that 2/3 of the
143    /// diff creation methods can be tested, this removes the need to mock
144    /// git2::Diff, which may not even be possible.
145    ///
146    /// ## Commit 1
147    ///
148    /// - One file was added, `file.txt`
149    ///     - The string "Hello World\n" was written to this file
150    /// - The commit is authored and committed by: test <test@example.com>
151    /// - The commit message is: "commit msg"
152    ///
153    /// ## Commit 2
154    ///
155    /// - The same file, file.txt is updated
156    ///     - The file now contains the string "Hello World\nFile Update\n"
157    /// - The commit is authored and committed by: test <test@example.com>
158    /// - The commit message is: "commit msg"
159    pub fn init_repo() -> Repository<Local> {
160        Repository::<Local>::new(test_data_dir()).expect("Failed to init local repository")
161    }
162}
stratum/lib.rs

stratum/
lib.rs
