use gitconfig user.signingKey to sign commit

Author: yanganto

Cargo.lock

@@ -14,6 +14,7 @@ keywords = ["git"]
 [dependencies]
 bitflags = "2"
 crossbeam-channel = "0.5"
+dirs = "5.0"
 easy-cast = "0.5"
 fuzzy-matcher = "0.3"
 git2 = "0.18"

asyncgit/Cargo.toml

@@ -175,7 +175,7 @@ mod tests {
 		File::create(root.join(file_path))?.write_all(b"line 1\n")?;
 
 		stage_add_file(repo_path, file_path)?;
-		commit(repo_path, "first commit", None)?;
+		commit(repo_path, "first commit")?;
 
 		let blame = blame_file(repo_path, "foo", None)?;
 
@@ -199,7 +199,7 @@ mod tests {
 		file.write(b"line 2\n")?;
 
 		stage_add_file(repo_path, file_path)?;
-		commit(repo_path, "second commit", None)?;
+		commit(repo_path, "second commit")?;
 
 		let blame = blame_file(repo_path, "foo", None)?;
 
@@ -233,7 +233,7 @@ mod tests {
 		assert_eq!(blame.lines.len(), 2);
 
 		stage_add_file(repo_path, file_path)?;
-		commit(repo_path, "third commit", None)?;
+		commit(repo_path, "third commit")?;
 
 		let blame = blame_file(repo_path, "foo", None)?;
 
@@ -258,7 +258,7 @@ mod tests {
 			.unwrap();
 
 		stage_add_file(repo_path, file_path).unwrap();
-		commit(repo_path, "first commit", None).unwrap();
+		commit(repo_path, "first commit").unwrap();
 
 		assert!(blame_file(repo_path, "bar\\foo", None).is_ok());
 	}

asyncgit/src/sync/blame.rs

@@ -6,6 +6,7 @@ use crate::{
 use git2::{ErrorCode, ObjectType, Repository, Signature};
 use scopetime::scope_time;
 use ssh_key::{HashAlg, LineEnding, PrivateKey};
+use std::path::PathBuf;
 
 ///
 pub fn amend(
@@ -62,15 +63,42 @@ pub(crate) fn signature_allow_undefined_name(
 }
 
 /// this does not run any git hooks, git-hooks have to be executed manually, checkout `hooks_commit_msg` for example
-/// If ssh private key is provided, the commit will be signed.
-pub fn commit(
-	repo_path: &RepoPath,
-	msg: &str,
-	sk: Option<&PrivateKey>,
-) -> Result<CommitId> {
+pub fn commit(repo_path: &RepoPath, msg: &str) -> Result<CommitId> {
 	scope_time!("commit");
 
 	let repo = repo(repo_path)?;
+	let ssh_secret_key = {
+		let config = repo.config()?;
+		config
+			.get_entry("user.signingKey")
+			.ok()
+			.and_then(|entry| {
+				entry.value().map(|key_path| {
+					key_path.strip_prefix('~').map_or_else(
+						|| Some(PathBuf::from(&key_path)),
+						|ssh_key_path| {
+							dirs::home_dir().map(|home| {
+								home.join(
+									ssh_key_path
+										.strip_prefix('/')
+										.unwrap_or(ssh_key_path),
+								)
+							})
+						},
+					)
+				})
+			})
+			.and_then(|key_file| {
+				key_file
+					.and_then(|mut p| {
+						p.set_extension("");
+						std::fs::read(p).ok()
+					})
+					.and_then(|bytes| {
+						PrivateKey::from_openssh(bytes).ok()
+					})
+			})
+	};
 
 	let signature = signature_allow_undefined_name(&repo)?;
 	let mut index = repo.index()?;
@@ -84,7 +112,7 @@ pub fn commit(
 	};
 
 	let parents = parents.iter().collect::<Vec<_>>();
-	if let Some(sk) = sk {
+	if let Some(sk) = ssh_secret_key {
 		let buffer = repo.commit_create_buffer(
 			&signature,
 			&signature,
@@ -197,7 +225,7 @@ mod tests {
 
 		assert_eq!(get_statuses(repo_path), (0, 1));
 
-		commit(repo_path, "commit msg", None).unwrap();
+		commit(repo_path, "commit msg").unwrap();
 
 		assert_eq!(get_statuses(repo_path), (0, 0));
 	}
@@ -223,7 +251,7 @@ mod tests {
 
 		assert_eq!(get_statuses(repo_path), (0, 1));
 
-		commit(repo_path, "commit msg", None).unwrap();
+		commit(repo_path, "commit msg").unwrap();
 
 		assert_eq!(get_statuses(repo_path), (0, 0));
 	}
@@ -240,7 +268,7 @@ mod tests {
 		File::create(root.join(file_path1))?.write_all(b"test1")?;
 
 		stage_add_file(repo_path, file_path1)?;
-		let id = commit(repo_path, "commit msg", None)?;
+		let id = commit(repo_path, "commit msg")?;
 
 		assert_eq!(count_commits(&repo, 10), 1);
 
@@ -279,7 +307,7 @@ mod tests {
 
 		stage_add_file(repo_path, file_path)?;
 
-		let new_id = commit(repo_path, "commit msg", None)?;
+		let new_id = commit(repo_path, "commit msg")?;
 
 		tag_commit(repo_path, &new_id, "tag", None)?;
 
@@ -321,7 +349,7 @@ mod tests {
 
 		stage_add_file(repo_path, file_path)?;
 
-		let new_id = commit(repo_path, "commit msg", None)?;
+		let new_id = commit(repo_path, "commit msg")?;
 
 		tag_commit(repo_path, &new_id, "tag", Some("tag-message"))?;
 
@@ -357,13 +385,13 @@ mod tests {
 
 		repo.config()?.remove("user.email")?;
 
-		let error = commit(repo_path, "commit msg", None);
+		let error = commit(repo_path, "commit msg");
 
 		assert!(matches!(error, Err(_)));
 
 		repo.config()?.set_str("user.email", "email")?;
 
-		let success = commit(repo_path, "commit msg", None);
+		let success = commit(repo_path, "commit msg");
 
 		assert!(matches!(success, Ok(_)));
 		assert_eq!(count_commits(&repo, 10), 1);
@@ -393,7 +421,7 @@ mod tests {
 
 		repo.config()?.remove("user.name")?;
 
-		let mut success = commit(repo_path, "commit msg", None);
+		let mut success = commit(repo_path, "commit msg");
 
 		assert!(matches!(success, Ok(_)));
 		assert_eq!(count_commits(&repo, 10), 1);
@@ -406,7 +434,7 @@ mod tests {
 
 		repo.config()?.set_str("user.name", "name")?;
 
-		success = commit(repo_path, "commit msg", None);
+		success = commit(repo_path, "commit msg");
 
 		assert!(matches!(success, Ok(_)));
 		assert_eq!(count_commits(&repo, 10), 2);

asyncgit/src/sync/commit.rs

@@ -144,7 +144,7 @@ mod tests {
 		stage_add_file(repo_path, file_path).unwrap();
 
 		let msg = invalidstring::invalid_utf8("test msg");
-		let id = commit(repo_path, msg.as_str(), None).unwrap();
+		let id = commit(repo_path, msg.as_str()).unwrap();
 
 		let res = get_commit_details(repo_path, id).unwrap();
 

asyncgit/src/sync/commit_details.rs

@@ -209,7 +209,7 @@ mod tests {
 
 		stage_add_file(repo_path, file_path)?;
 
-		let id = commit(repo_path, "commit msg", None)?;
+		let id = commit(repo_path, "commit msg")?;
 
 		let diff = get_commit_files(repo_path, id, None)?;
 
@@ -251,7 +251,7 @@ mod tests {
 
 		File::create(root.join(file_path1))?.write_all(b"test")?;
 		stage_add_file(repo_path, file_path1)?;
-		commit(repo_path, "c1", None)?;
+		commit(repo_path, "c1")?;
 
 		File::create(root.join(file_path1))?
 			.write_all(b"modified")?;

asyncgit/src/sync/commit_files.rs

@@ -4,7 +4,6 @@ use crate::{
 	sync::{repository::repo, utils::read_file},
 };
 use scopetime::scope_time;
-use ssh_key::PrivateKey;
 
 const GIT_REVERT_HEAD_FILE: &str = "REVERT_HEAD";
 
@@ -41,11 +40,10 @@ pub fn revert_head(repo_path: &RepoPath) -> Result<CommitId> {
 pub fn commit_revert(
 	repo_path: &RepoPath,
 	msg: &str,
-	sk: Option<&PrivateKey>,
 ) -> Result<CommitId> {
 	scope_time!("commit_revert");
 
-	let id = crate::sync::commit(repo_path, msg, sk)?;
+	let id = crate::sync::commit(repo_path, msg)?;
 
 	repo(repo_path)?.cleanup_state()?;
 

asyncgit/src/sync/commit_revert.rs

@@ -172,10 +172,10 @@ mod tests {
 
 		File::create(root.join(file_path))?.write_all(b"a")?;
 		stage_add_file(repo_path, file_path).unwrap();
-		let c1 = commit(repo_path, "commit1", None).unwrap();
+		let c1 = commit(repo_path, "commit1").unwrap();
 		File::create(root.join(file_path))?.write_all(b"a")?;
 		stage_add_file(repo_path, file_path).unwrap();
-		let c2 = commit(repo_path, "commit2", None).unwrap();
+		let c2 = commit(repo_path, "commit2").unwrap();
 
 		let res = get_commits_info(repo_path, &[c2, c1], 50).unwrap();
 
@@ -197,7 +197,7 @@ mod tests {
 
 		File::create(root.join(file_path))?.write_all(b"a")?;
 		stage_add_file(repo_path, file_path).unwrap();
-		let c1 = commit(repo_path, "subject\nbody", None).unwrap();
+		let c1 = commit(repo_path, "subject\nbody").unwrap();
 
 		let res = get_commits_info(repo_path, &[c1], 50).unwrap();
 
@@ -219,7 +219,7 @@ mod tests {
 		stage_add_file(repo_path, file_path).unwrap();
 
 		let msg = invalidstring::invalid_utf8("test msg");
-		commit(repo_path, msg.as_str(), None).unwrap();
+		commit(repo_path, msg.as_str()).unwrap();
 
 		let res = get_commits_info(
 			repo_path,
@@ -245,8 +245,7 @@ mod tests {
 		let foo_file = Path::new("foo");
 		File::create(root.join(foo_file))?.write_all(b"a")?;
 		stage_add_file(repo_path, foo_file).unwrap();
-		let c1 =
-			commit(repo_path, "subject: foo\nbody", None).unwrap();
+		let c1 = commit(repo_path, "subject: foo\nbody").unwrap();
 		let c1_rev = c1.get_short_string();
 
 		assert_eq!(

asyncgit/src/sync/commits_info.rs

@@ -597,7 +597,7 @@ mod tests {
 
 		stage_add_file(repo_path, file_path).unwrap();
 
-		commit(repo_path, "commit", None).unwrap();
+		commit(repo_path, "commit").unwrap();
 
 		File::create(root.join(file_path))?.write_all(b"\x00\x02")?;
 
@@ -653,13 +653,13 @@ mod tests {
 
 		stage_add_file(repo_path, file_path).unwrap();
 
-		commit(repo_path, "", None).unwrap();
+		commit(repo_path, "").unwrap();
 
 		File::create(root.join(file_path))?.write_all(b"\x00\x02")?;
 
 		stage_add_file(repo_path, file_path).unwrap();
 
-		let id = commit(repo_path, "", None).unwrap();
+		let id = commit(repo_path, "").unwrap();
 
 		let diff =
 			get_diff_commit(repo_path, id, String::new(), None)

asyncgit/src/sync/diff.rs

@@ -135,10 +135,10 @@ mod tests {
 
 		File::create(root.join(file_path))?.write_all(b"a")?;
 		stage_add_file(repo_path, file_path).unwrap();
-		commit(repo_path, "commit1", None).unwrap();
+		commit(repo_path, "commit1").unwrap();
 		File::create(root.join(file_path))?.write_all(b"a")?;
 		stage_add_file(repo_path, file_path).unwrap();
-		let oid2 = commit(repo_path, "commit2", None).unwrap();
+		let oid2 = commit(repo_path, "commit2").unwrap();
 
 		let mut items = Vec::new();
 		let mut walk = LogWalker::new(&repo, 1)?;
@@ -160,10 +160,10 @@ mod tests {
 
 		File::create(root.join(file_path))?.write_all(b"a")?;
 		stage_add_file(repo_path, file_path).unwrap();
-		commit(repo_path, "commit1", None).unwrap();
+		commit(repo_path, "commit1").unwrap();
 		File::create(root.join(file_path))?.write_all(b"a")?;
 		stage_add_file(repo_path, file_path).unwrap();
-		let oid2 = commit(repo_path, "commit2", None).unwrap();
+		let oid2 = commit(repo_path, "commit2").unwrap();
 
 		let mut items = Vec::new();
 		let mut walk = LogWalker::new(&repo, 100)?;
@@ -195,20 +195,17 @@ mod tests {
 		File::create(root.join(file_path))?.write_all(b"a")?;
 		stage_add_file(&repo_path, file_path).unwrap();
 
-		let _first_commit_id =
-			commit(&repo_path, "commit1", None).unwrap();
+		let _first_commit_id = commit(&repo_path, "commit1").unwrap();
 
 		File::create(root.join(second_file_path))?.write_all(b"a")?;
 		stage_add_file(&repo_path, second_file_path).unwrap();
 
-		let second_commit_id =
-			commit(&repo_path, "commit2", None).unwrap();
+		let second_commit_id = commit(&repo_path, "commit2").unwrap();
 
 		File::create(root.join(file_path))?.write_all(b"b")?;
 		stage_add_file(&repo_path, file_path).unwrap();
 
-		let _third_commit_id =
-			commit(&repo_path, "commit3", None).unwrap();
+		let _third_commit_id = commit(&repo_path, "commit3").unwrap();
 
 		let diff_contains_baz = diff_contains_file("baz".into());