support opening submodule (#1298)

Author: extrawurst

Cargo.lock

@@ -51,6 +51,7 @@
 - Browse commit log, diff committed changes
 - Scalable terminal UI layout
 - Async git API for fluid control
+- Submodule support
 
 ## 2. <a name="motivation"></a> Motivation <small><sup>[Top ▲](#table-of-contents)</sup></small>
 

README.md

@@ -28,6 +28,7 @@ unicode-truncate = "0.2.0"
 url = "2.2"
 
 [dev-dependencies]
+env_logger = "0.9"
 invalidstring = { path = "../invalidstring", version = "0.1" }
 pretty_assertions = "1.3"
 serial_test = "0.9"

asyncgit/Cargo.toml

@@ -1,6 +1,9 @@
 #![allow(renamed_and_removed_lints, clippy::unknown_clippy_lints)]
 
-use std::{num::TryFromIntError, string::FromUtf8Error};
+use std::{
+	num::TryFromIntError, path::StripPrefixError,
+	string::FromUtf8Error,
+};
 use thiserror::Error;
 
 ///
@@ -50,6 +53,10 @@ pub enum Error {
 	#[error("git error:{0}")]
 	Git(#[from] git2::Error),
 
+	///
+	#[error("strip prefix error: {0}")]
+	StripPrefix(#[from] StripPrefixError),
+
 	///
 	#[error("utf8 error:{0}")]
 	Utf8Conversion(#[from] FromUtf8Error),

asyncgit/src/error.rs

@@ -82,7 +82,8 @@ pub use stash::{
 pub use state::{repo_state, RepoState};
 pub use status::is_workdir_clean;
 pub use submodules::{
-	get_submodules, update_submodule, SubmoduleInfo, SubmoduleStatus,
+	get_submodules, submodule_parent_info, update_submodule,
+	SubmoduleInfo, SubmoduleParentInfo, SubmoduleStatus,
 };
 pub use tags::{
 	delete_tag, get_tags, get_tags_with_metadata, CommitTags, Tag,
@@ -209,6 +210,8 @@ mod tests {
 
 	///
 	pub fn repo_init_empty() -> Result<(TempDir, Repository)> {
+		init_log();
+
 		sandbox_config_files();
 
 		let td = TempDir::new()?;
@@ -223,6 +226,8 @@ mod tests {
 
 	///
 	pub fn repo_init() -> Result<(TempDir, Repository)> {
+		init_log();
+
 		sandbox_config_files();
 
 		let td = TempDir::new()?;
@@ -266,8 +271,18 @@ mod tests {
 		Ok((td, repo))
 	}
 
+	// init log
+	fn init_log() {
+		let _ = env_logger::builder()
+			.is_test(true)
+			.filter_level(log::LevelFilter::Trace)
+			.try_init();
+	}
+
 	/// Same as repo_init, but the repo is a bare repo (--bare)
 	pub fn repo_init_bare() -> Result<(TempDir, Repository)> {
+		init_log();
+
 		let tmp_repo_dir = TempDir::new()?;
 		let bare_repo = Repository::init_bare(tmp_repo_dir.path())?;
 		Ok((tmp_repo_dir, bare_repo))

asyncgit/src/sync/mod.rs

@@ -11,7 +11,7 @@ use crate::error::Result;
 pub type RepoPathRef = RefCell<RepoPath>;
 
 ///
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub enum RepoPath {
 	///
 	Path(PathBuf),

asyncgit/src/sync/repository.rs

@@ -1,15 +1,24 @@
-use std::path::PathBuf;
+//TODO:
+// #![allow(unused_variables, dead_code)]
 
-use git2::SubmoduleUpdateOptions;
+use std::path::{Path, PathBuf};
+
+use git2::{
+	Repository, RepositoryOpenFlags, Submodule,
+	SubmoduleUpdateOptions,
+};
 use scopetime::scope_time;
 
 use super::{repo, CommitId, RepoPath};
-use crate::{error::Result, Error};
+use crate::{error::Result, sync::utils::work_dir, Error};
 
 pub use git2::SubmoduleStatus;
 
 ///
+#[derive(Debug)]
 pub struct SubmoduleInfo {
+	///
+	pub name: String,
 	///
 	pub path: PathBuf,
 	///
@@ -22,6 +31,17 @@ pub struct SubmoduleInfo {
 	pub status: SubmoduleStatus,
 }
 
+///
+#[derive(Debug)]
+pub struct SubmoduleParentInfo {
+	/// where to find parent repo
+	pub parent_gitpath: PathBuf,
+	/// where to find submodule git path
+	pub submodule_gitpath: PathBuf,
+	/// `submodule_info` from perspective of parent repo
+	pub submodule_info: SubmoduleInfo,
+}
+
 impl SubmoduleInfo {
 	///
 	pub fn get_repo_path(
@@ -35,6 +55,24 @@ impl SubmoduleInfo {
 	}
 }
 
+fn submodule_to_info(s: &Submodule, r: &Repository) -> SubmoduleInfo {
+	let status = r
+		.submodule_status(
+			s.name().unwrap_or_default(),
+			git2::SubmoduleIgnore::None,
+		)
+		.unwrap_or(SubmoduleStatus::empty());
+
+	SubmoduleInfo {
+		name: s.name().unwrap_or_default().into(),
+		path: s.path().to_path_buf(),
+		id: s.workdir_id().map(CommitId::from),
+		head_id: s.head_id().map(CommitId::from),
+		url: s.url().map(String::from),
+		status,
+	}
+}
+
 ///
 pub fn get_submodules(
 	repo_path: &RepoPath,
@@ -46,22 +84,7 @@ pub fn get_submodules(
 	let res = r
 		.submodules()?
 		.iter()
-		.map(|s| {
-			let status = repo2
-				.submodule_status(
-					s.name().unwrap_or_default(),
-					git2::SubmoduleIgnore::None,
-				)
-				.unwrap_or(SubmoduleStatus::empty());
-
-			SubmoduleInfo {
-				path: s.path().to_path_buf(),
-				id: s.workdir_id().map(CommitId::from),
-				head_id: s.head_id().map(CommitId::from),
-				url: s.url().map(String::from),
-				status,
-			}
-		})
+		.map(|s| submodule_to_info(s, &repo2))
 		.collect();
 
 	Ok(res)
@@ -82,3 +105,97 @@ pub fn update_submodule(
 
 	Ok(())
 }
+
+/// query whether `repo_path` points to a repo that is part of a parent git which contains it as a submodule
+pub fn submodule_parent_info(
+	repo_path: &RepoPath,
+) -> Result<Option<SubmoduleParentInfo>> {
+	scope_time!("submodule_parent_info");
+
+	let repo = repo(repo_path)?;
+	let repo_wd = work_dir(&repo)?.to_path_buf();
+
+	log::trace!("[sub] repo_wd: {:?}", repo_wd);
+	log::trace!("[sub] repo_path: {:?}", repo.path());
+
+	if let Some(parent_path) = repo_wd.parent() {
+		log::trace!("[sub] parent_path: {:?}", parent_path);
+
+		if let Ok(parent) = Repository::open_ext(
+			parent_path,
+			RepositoryOpenFlags::empty(),
+			Vec::<&Path>::new(),
+		) {
+			let parent_wd = work_dir(&parent)?.to_path_buf();
+			log::trace!("[sub] parent_wd: {:?}", parent_wd);
+
+			let submodule_name = repo_wd
+				.strip_prefix(parent_wd)?
+				.to_string_lossy()
+				.to_string();
+
+			log::trace!("[sub] submodule_name: {:?}", submodule_name);
+
+			if let Ok(submodule) =
+				parent.find_submodule(&submodule_name)
+			{
+				return Ok(Some(SubmoduleParentInfo {
+					parent_gitpath: parent.path().to_path_buf(),
+					submodule_gitpath: repo.path().to_path_buf(),
+					submodule_info: submodule_to_info(
+						&submodule, &parent,
+					),
+				}));
+			}
+		}
+	}
+
+	Ok(None)
+}
+
+#[cfg(test)]
+mod tests {
+	use super::get_submodules;
+	use crate::sync::{
+		submodules::submodule_parent_info, tests::repo_init, RepoPath,
+	};
+	use git2::Repository;
+	use pretty_assertions::assert_eq;
+	use std::path::Path;
+
+	#[test]
+	fn test_smoke() {
+		let (dir, _r) = repo_init().unwrap();
+
+		{
+			let r = Repository::open(dir.path()).unwrap();
+			let mut s = r
+				.submodule(
+					//TODO: use local git
+					"https://github.com/extrawurst/brewdump.git",
+					Path::new("foo/bar"),
+					false,
+				)
+				.unwrap();
+
+			let _sub_r = s.clone(None).unwrap();
+			s.add_finalize().unwrap();
+		}
+
+		let repo_p = RepoPath::Path(dir.into_path());
+		let subs = get_submodules(&repo_p).unwrap();
+
+		assert_eq!(subs.len(), 1);
+		assert_eq!(&subs[0].name, "foo/bar");
+
+		let info = submodule_parent_info(
+			&subs[0].get_repo_path(&repo_p).unwrap(),
+		)
+		.unwrap()
+		.unwrap();
+
+		dbg!(&info);
+
+		assert_eq!(&info.submodule_info.name, "foo/bar");
+	}
+}