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

stratum/
lib.rs
