sync: Remove dependency on ssh if not needed

When running on a machine without the `ssh` command, repo sync would fail even if no ssh or ssh proxy was required. Use exception handling inside ssh.ProxyManager to more gracefully handle the case where ssh is not installed.

Bug: 467714011
Change-Id: I602a0819638ead4d02de88b750839bc3d70549ce
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/535141
Reviewed-by: Mike Frysinger <vapier@google.com>
Reviewed-by: Gavin Mak <gavinmak@google.com>
Tested-by: Jordan Esh <esh.jordan@gmail.com>
Commit-Queue: Jordan Esh <esh.jordan@gmail.com>

Author: eshjordan

ssh.py

@@ -52,12 +52,12 @@ def _parse_ssh_version(ver_str=None):
 
 @functools.lru_cache(maxsize=None)
 def version():
-    """return ssh version as a tuple"""
+    """Return ssh version as a tuple.
+
+    If ssh is not available, a FileNotFoundError will be raised.
+    """
     try:
         return _parse_ssh_version()
-    except FileNotFoundError:
-        print("fatal: ssh not installed", file=sys.stderr)
-        sys.exit(1)
     except subprocess.CalledProcessError as e:
         print(
             "fatal: unable to detect ssh version"
@@ -102,9 +102,18 @@ def __init__(self, manager):
         self._clients = manager.list()
         # Path to directory for holding master sockets.
         self._sock_path = None
+        # See if ssh is usable.
+        self._ssh_installed = False
 
     def __enter__(self):
         """Enter a new context."""
+        # Check which version of ssh is available.
+        try:
+            version()
+            self._ssh_installed = True
+        except FileNotFoundError:
+            self._ssh_installed = False
+
         return self
 
     def __exit__(self, exc_type, exc_value, traceback):
@@ -282,6 +291,9 @@ def _open(self, host, port=None):
 
     def preconnect(self, url):
         """If |uri| will create a ssh connection, setup the ssh master for it."""  # noqa: E501
+        if not self._ssh_installed:
+            return False
+
         m = URI_ALL.match(url)
         if m:
             scheme = m.group(1)
@@ -306,6 +318,9 @@ def sock(self, create=True):
 
         This has all the master sockets so clients can talk to them.
         """
+        if not self._ssh_installed:
+            return None
+
         if self._sock_path is None:
             if not create:
                 return None

tests/test_ssh.py

@@ -25,6 +25,10 @@
 class SshTests(unittest.TestCase):
     """Tests the ssh functions."""
 
+    def setUp(self) -> None:
+        super().setUp()
+        ssh.version.cache_clear()
+
     def test_parse_ssh_version(self):
         """Check _parse_ssh_version() handling."""
         ver = ssh._parse_ssh_version("Unknown\n")
@@ -56,11 +60,12 @@ def test_context_manager_empty(self):
     def test_context_manager_child_cleanup(self):
         """Verify orphaned clients & masters get cleaned up."""
         with multiprocessing.Manager() as manager:
-            with ssh.ProxyManager(manager) as ssh_proxy:
-                client = subprocess.Popen(["sleep", "964853320"])
-                ssh_proxy.add_client(client)
-                master = subprocess.Popen(["sleep", "964853321"])
-                ssh_proxy.add_master(master)
+            with mock.patch("ssh.version", return_value=(1, 2)):
+                with ssh.ProxyManager(manager) as ssh_proxy:
+                    client = subprocess.Popen(["sleep", "964853320"])
+                    ssh_proxy.add_client(client)
+                    master = subprocess.Popen(["sleep", "964853321"])
+                    ssh_proxy.add_master(master)
         # If the process still exists, these will throw timeout errors.
         client.wait(0)
         master.wait(0)
@@ -72,9 +77,11 @@ def test_ssh_sock(self):
         with mock.patch("tempfile.mkdtemp", return_value="/tmp/foo"):
             # Old ssh version uses port.
             with mock.patch("ssh.version", return_value=(6, 6)):
-                self.assertTrue(proxy.sock().endswith("%p"))
+                with proxy as ssh_proxy:
+                    self.assertTrue(ssh_proxy.sock().endswith("%p"))
 
             proxy._sock_path = None
             # New ssh version uses hash.
             with mock.patch("ssh.version", return_value=(6, 7)):
-                self.assertTrue(proxy.sock().endswith("%C"))
+                with proxy as ssh_proxy:
+                    self.assertTrue(ssh_proxy.sock().endswith("%C"))