Allow ancestry checks beween two revs

[git-cache] / git_cache.py

diff --git a/git_cache.py b/git_cache.py
index d1923cd5a7ee287cfbc0da2625e91b1dfa670216..077406c63275d97d701e1e9498e1efca989045c1 100644 (file)
--- a/git_cache.py
+++ b/git_cache.py
@@ -8,13 +8,17 @@ import hashlib
 import logging
 import os
 import subprocess
+import sys
 
-from typing import Tuple
+from typing import Tuple, Union
+
+import backoff
 
 Path = str  # eg: "/home/user/.cache/git-cache/v1"
 Repo = str  # eg: "https://github.com/NixOS/nixpkgs.git"
 Ref = str   # eg: "master" or "v1.0.0"
 Rev = str   # eg: "53a27350551844e1ed1a9257690294767389ef0d"
+RefOrRev = Union[Ref, Rev]
 
 
 def git_cachedir(repo: Repo) -> Path:
@@ -28,24 +32,48 @@ def git_cachedir(repo: Repo) -> Path:
         hashlib.sha256(repo.encode()).hexdigest()))
 
 
-def verify_ancestry(repo: Repo, ref: Ref, rev: Rev) -> None:
+def is_ancestor(repo: Repo, descendant: RefOrRev, ancestor: RefOrRev) -> bool:
     cachedir = git_cachedir(repo)
-    logging.debug('Verifying rev %s is an ancestor of ref "%s"', rev, ref)
-    subprocess.run(['git', '-C', cachedir, 'merge-base', '--is-ancestor',
-                    rev, ref], check=True)
+    logging.debug('Checking if %s is an ancestor of %s', ancestor, descendant)
+    process = subprocess.run(['git',
+                              '-C',
+                              cachedir,
+                              'merge-base',
+                              '--is-ancestor',
+                              ancestor,
+                              descendant],
+                             check=False)
+    return process.returncode == 0
+
+
+def verify_ancestry(
+        repo: Repo,
+        descendant: RefOrRev,
+        ancestor: RefOrRev) -> None:
+    if not is_ancestor(repo, descendant, ancestor):
+        raise Exception('%s is not an ancestor of %s' % (ancestor, descendant))
+
+
+@backoff.on_exception(
+    backoff.expo,
+    subprocess.CalledProcessError,
+    max_time=lambda: int(os.environ.get('BACKOFF_MAX_TIME', '30')))
+def _git_fetch(cachedir: Path, repo: Repo, ref: Ref) -> None:
+    # We don't use --force here because we want to abort and freak out if forced
+    # updates are happening.
+    subprocess.run(['git', '-C', cachedir, 'fetch', repo,
+                    '%s:%s' % (ref, ref)], check=True)
 
 
 def fetch(repo: Repo, ref: Ref) -> Tuple[Path, Rev]:
     cachedir = git_cachedir(repo)
     if not os.path.exists(cachedir):
         logging.debug("Initializing git repo")
-        subprocess.run(['git', 'init', '--bare', cachedir], check=True)
+        subprocess.run(['git', 'init', '--bare', cachedir],
+                       check=True, stdout=sys.stderr)
 
     logging.debug('Fetching ref "%s" from %s', ref, repo)
-    # We don't use --force here because we want to abort and freak out if forced
-    # updates are happening.
-    subprocess.run(['git', '-C', cachedir, 'fetch', repo,
-                    '%s:%s' % (ref, ref)], check=True)
+    _git_fetch(cachedir, repo, ref)
 
     with open(os.path.join(cachedir, 'refs', 'heads', ref)) as rev_file:
         rev = Rev(rev_file.read(999).strip())
@@ -56,18 +84,8 @@ def fetch(repo: Repo, ref: Ref) -> Tuple[Path, Rev]:
 
 def ensure_rev_available(repo: Repo, ref: Ref, rev: Rev) -> Path:
     cachedir = git_cachedir(repo)
-    if os.path.exists(cachedir):
-        logging.debug('Checking if we already have rev %s', rev)
-        process = subprocess.run(
-            ['git', '-C', cachedir, 'cat-file', '-e', rev], check=False)
-        if process.returncode == 0:
-            logging.debug('We already have rev %s', rev)
-            verify_ancestry(repo, ref, rev)
-            return cachedir
-        if process.returncode != 1:
-            raise Exception(
-                'Could not test for presence of rev %s.  Is cache dir "%s" messed up?' %
-                (rev, cachedir))
+    if os.path.exists(cachedir) and is_ancestor(repo, ref, rev):
+        return cachedir
 
     logging.debug(
         'We do not have rev %s.  We will fetch ref "%s" and hope it appears.',
@@ -75,5 +93,19 @@ def ensure_rev_available(repo: Repo, ref: Ref, rev: Rev) -> Path:
     fetch(repo, ref)
     logging.debug('Verifying that fetch retrieved rev %s', rev)
     subprocess.run(['git', '-C', cachedir, 'cat-file', '-e', rev], check=True)
+    verify_ancestry(repo, ref, rev)
 
     return cachedir
+
+
+def _main() -> None:
+    if len(sys.argv) == 3:
+        print('{1} {0}'.format(*fetch(Repo(sys.argv[1]), Ref(sys.argv[2]))))
+    elif len(sys.argv) == 4:
+        print(ensure_rev_available(
+            Repo(sys.argv[1]), Ref(sys.argv[2]), Rev(sys.argv[3])))
+    else:
+        usage = '''usage: git-cache repo ref [rev]
+example: git-cache https://github.com/NixOS/nixpkgs.git master'''
+        print(usage, file=sys.stderr)
+        sys.exit(1)