Use GpgEnvironment pattern

lib/tests/test_gpg.rs

@@ -3,76 +3,92 @@ use std::fs::Permissions;
 use std::io::Write;
 #[cfg(unix)]
 use std::os::unix::prelude::PermissionsExt;
-use std::path::PathBuf;
 use std::process::Stdio;
 
 use assert_matches::assert_matches;
 use insta::assert_debug_snapshot;
 use jj_lib::gpg_signing::GpgBackend;
 use jj_lib::signing::{SigStatus, SignError, SigningBackend};
-use once_cell::sync::Lazy;
-
-static GPG_HOME: Lazy<PathBuf> = Lazy::new(|| {
-    let dir = tempfile::Builder::new()
-        .prefix("jj-test-")
-        .tempdir()
-        .unwrap()
-        .into_path();
-
-    #[cfg(unix)]
-    std::fs::set_permissions(&dir, Permissions::from_mode(0o700)).unwrap();
-
-    let mut gpg = std::process::Command::new("gpg")
-        .arg("--homedir")
-        .arg(&dir)
-        .arg("--import")
-        .stdin(Stdio::piped())
-        .stdout(Stdio::null())
-        .stderr(Stdio::null())
-        .spawn()
-        .unwrap();
-    gpg.stdin
-        .as_mut()
-        .unwrap()
-        .write_all(
-            br#"-----BEGIN PGP PRIVATE KEY BLOCK-----
-
-            lFgEZWI3pBYJKwYBBAHaRw8BAQdAaPLTNADvDWapjAPlxaUnx3HXQNIlwSz4EZrW
-            3Z7hxSwAAP9liwHZWJCGI2xW+XNqMT36qpIvoRcd5YPaKYwvnlkG1w+UtDNTb21l
-            b25lIChqaiB0ZXN0IHNpZ25pbmcga2V5KSA8c29tZW9uZUBleGFtcGxlLmNvbT6I
-            kwQTFgoAOxYhBKWOXukGcVPI9eXp6WOHhcsW/qBhBQJlYjekAhsDBQsJCAcCAiIC
-            BhUKCQgLAgQWAgMBAh4HAheAAAoJEGOHhcsW/qBhyBgBAMph1HkBkKlrZmsun+3i
-            kTEaOsWmaW/D6NEdMFiw0S/jAP9G3jOYGiZbUN3dWWB2246Oi7SaMTX8Xb2BrLP2
-            axCbC5RYBGVjxv8WCSsGAQQB2kcPAQEHQE8Oa4ahtVG29gIRssPxjqF4utn8iHPz
-            m5z/8lX/nl3eAAD5AZ6H2pNhiy2gnGkbPLHw3ZyY4d0NXzCa7qc9EXqOj+sRrLQ9
-            U29tZW9uZSBFbHNlIChqaiB0ZXN0IHNpZ25pbmcga2V5KSA8c29tZW9uZS1lbHNl
-            QGV4YW1wbGUuY29tPoiTBBMWCgA7FiEER1BAaEpU3TKUiUvFTtVW6XKeAA8FAmVj
-            xv8CGwMFCwkIBwICIgIGFQoJCAsCBBYCAwECHgcCF4AACgkQTtVW6XKeAA/6TQEA
-            2DkPm3LmH8uG6qLirtf62kbG7T+qljIsarQKFw3CGakA/AveCtrL7wVSpINiu1Rz
-            lBqJFFP2PqzT0CRfh94HSIMM
-            =6JC8
-            -----END PGP PRIVATE KEY BLOCK-----"#,
-        )
-        .unwrap();
-    gpg.stdin.as_mut().unwrap().flush().unwrap();
-    gpg.wait().unwrap();
-
-    dir
-});
-
-fn backend() -> GpgBackend {
+
+static PRIVATE_KEY: &str = r#"-----BEGIN PGP PRIVATE KEY BLOCK-----
+
+lFgEZWI3pBYJKwYBBAHaRw8BAQdAaPLTNADvDWapjAPlxaUnx3HXQNIlwSz4EZrW
+3Z7hxSwAAP9liwHZWJCGI2xW+XNqMT36qpIvoRcd5YPaKYwvnlkG1w+UtDNTb21l
+b25lIChqaiB0ZXN0IHNpZ25pbmcga2V5KSA8c29tZW9uZUBleGFtcGxlLmNvbT6I
+kwQTFgoAOxYhBKWOXukGcVPI9eXp6WOHhcsW/qBhBQJlYjekAhsDBQsJCAcCAiIC
+BhUKCQgLAgQWAgMBAh4HAheAAAoJEGOHhcsW/qBhyBgBAMph1HkBkKlrZmsun+3i
+kTEaOsWmaW/D6NEdMFiw0S/jAP9G3jOYGiZbUN3dWWB2246Oi7SaMTX8Xb2BrLP2
+axCbC5RYBGVjxv8WCSsGAQQB2kcPAQEHQE8Oa4ahtVG29gIRssPxjqF4utn8iHPz
+m5z/8lX/nl3eAAD5AZ6H2pNhiy2gnGkbPLHw3ZyY4d0NXzCa7qc9EXqOj+sRrLQ9
+U29tZW9uZSBFbHNlIChqaiB0ZXN0IHNpZ25pbmcga2V5KSA8c29tZW9uZS1lbHNl
+QGV4YW1wbGUuY29tPoiTBBMWCgA7FiEER1BAaEpU3TKUiUvFTtVW6XKeAA8FAmVj
+xv8CGwMFCwkIBwICIgIGFQoJCAsCBBYCAwECHgcCF4AACgkQTtVW6XKeAA/6TQEA
+2DkPm3LmH8uG6qLirtf62kbG7T+qljIsarQKFw3CGakA/AveCtrL7wVSpINiu1Rz
+lBqJFFP2PqzT0CRfh94HSIMM
+=6JC8
+-----END PGP PRIVATE KEY BLOCK-----
+"#;
+
+struct GpgEnvironment {
+    homedir: Option<tempfile::TempDir>,
+}
+
+impl GpgEnvironment {
+    fn new() -> Result<Self, std::process::Output> {
+        let dir = tempfile::Builder::new()
+            .prefix("jj-gpg-signing-test-")
+            .tempdir()
+            .unwrap();
+
+        let path = dir.path().as_os_str();
+
+        #[cfg(unix)]
+        std::fs::set_permissions(&path, Permissions::from_mode(0o700)).unwrap();
+
+        let mut gpg = std::process::Command::new("gpg")
+            .arg("--homedir")
+            .arg(&path)
+            .arg("--import")
+            .stdin(Stdio::piped())
+            .stdout(Stdio::piped())
+            .stderr(Stdio::piped())
+            .spawn()
+            .unwrap();
+
+        gpg.stdin
+            .as_mut()
+            .unwrap()
+            .write_all(PRIVATE_KEY.as_bytes())
+            .unwrap();
+
+        gpg.stdin.as_mut().unwrap().flush().unwrap();
+
+        let res = gpg.wait_with_output().unwrap();
+
+        if !res.status.success() {
+            println!("Failed to add private key to gpg-agent. Make sure it is running!");
+            println!("{}", String::from_utf8_lossy(&res.stderr));
+            return Err(res);
+        }
+
+        Ok(GpgEnvironment { homedir: Some(dir) })
+    }
+}
+
+fn backend(env: &GpgEnvironment) -> GpgBackend {
     // don't really need faked time for current tests,
     // but probably will need it for end-to-end cli tests
     GpgBackend::new("gpg".into(), false).with_extra_args(&[
         "--homedir".into(),
-        GPG_HOME.to_path_buf().into(),
+        env.homedir.as_ref().unwrap().path().as_os_str().into(),
         "--faked-system-time=1701042000!".into(),
     ])
 }
 
 #[test]
-fn roundtrip() {
-    let backend = backend();
+fn gpg_singing_roundtrip() {
+    let env = GpgEnvironment::new().unwrap();
+    let backend = backend(&env);
     let data = b"hello world";
     let signature = backend.sign(data, None).unwrap();
 
@@ -96,8 +112,9 @@ fn roundtrip() {
 }
 
 #[test]
-fn roundtrip_explicit_key() {
-    let backend = backend();
+fn gpg_signing_roundtrip_explicit_key() {
+    let env = GpgEnvironment::new().unwrap();
+    let backend = backend(&env);
     let data = b"hello world";
     let signature = backend.sign(data, Some("Someone Else")).unwrap();
 
@@ -129,7 +146,8 @@ fn roundtrip_explicit_key() {
 
 #[test]
 fn unknown_key() {
-    let backend = backend();
+    let env = GpgEnvironment::new().unwrap();
+    let backend = backend(&env);
     let signature = br"-----BEGIN PGP SIGNATURE-----
 
     iHUEABYKAB0WIQQs238pU7eC/ROoPJ0HH+PjJN1zMwUCZWPa5AAKCRAHH+PjJN1z
@@ -161,7 +179,8 @@ fn unknown_key() {
 
 #[test]
 fn invalid_signature() {
-    let backend = backend();
+    let env = GpgEnvironment::new().unwrap();
+    let backend = backend(&env);
     let signature = br"-----BEGIN PGP SIGNATURE-----
 
     super duper invalid