tc_build: Introduce a common GitSourceManager

We will be adding Rust support in the future, so pull out common git
repository management code from LLVMSourceManager that can be shared
with a RustSourceManager.

Signed-off-by: Nathan Chancellor <[email protected]>

Author: nathanchance

tc_build/llvm.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
 
-import contextlib
 import os
 from pathlib import Path
 import platform
@@ -10,6 +9,7 @@
 import time
 
 from tc_build.builder import Builder
+from tc_build.source import GitSourceManager
 import tc_build.utils
 
 LLVM_VER_FOR_RUNTIMES = 20
@@ -572,10 +572,13 @@ class LLVMSlimInstrumentedBuilder(LLVMInstrumentedBuilder, LLVMSlimBuilder):
     pass
 
 
-class LLVMSourceManager:
+class LLVMSourceManager(GitSourceManager):
 
     def __init__(self, repo):
-        self.repo = repo
+        super().__init__(repo)
+
+        self._pretty_name = 'LLVM'
+        self._repo_url = 'https://github.com/llvm/llvm-project.git'
 
     def default_projects(self):
         return ['clang', 'compiler-rt', 'lld', 'polly']
@@ -591,57 +594,3 @@ def default_targets(self):
             targets.append('LoongArch')
 
         return targets
-
-    def download(self, ref, shallow=False):
-        if self.repo.exists():
-            return
-
-        tc_build.utils.print_header('Downloading LLVM')
-
-        git_clone = ['git', 'clone']
-        if shallow:
-            git_clone.append('--depth=1')
-            if ref != 'main':
-                git_clone.append('--no-single-branch')
-        git_clone += ['https://github.com/llvm/llvm-project', self.repo]
-
-        subprocess.run(git_clone, check=True)
-
-        self.git(['checkout', ref])
-
-    def git(self, cmd, capture_output=False):
-        return subprocess.run(['git', *cmd],
-                              capture_output=capture_output,
-                              check=True,
-                              cwd=self.repo,
-                              text=True)
-
-    def git_capture(self, cmd):
-        return self.git(cmd, capture_output=True).stdout.strip()
-
-    def is_shallow(self):
-        git_dir = self.git_capture(['rev-parse', '--git-dir'])
-        return Path(git_dir, 'shallow').exists()
-
-    def ref_exists(self, ref):
-        try:
-            self.git(['show-branch', ref])
-        except subprocess.CalledProcessError:
-            return False
-        return True
-
-    def update(self, ref):
-        tc_build.utils.print_header('Updating LLVM')
-
-        self.git(['fetch', 'origin'])
-
-        if self.is_shallow() and not self.ref_exists(ref):
-            raise RuntimeError(f"Repo is shallow and supplied ref ('{ref}') does not exist!")
-
-        self.git(['checkout', ref])
-
-        local_ref = None
-        with contextlib.suppress(subprocess.CalledProcessError):
-            local_ref = self.git_capture(['symbolic-ref', '-q', 'HEAD'])
-        if local_ref and local_ref.startswith('refs/heads/'):
-            self.git(['pull', '--rebase', 'origin', local_ref.replace('refs/heads/', '')])

tc_build/source.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python3
 
+import contextlib
 import hashlib
+from pathlib import Path
 import re
 import subprocess
 
@@ -86,3 +88,67 @@ class SourceManager:
     def __init__(self, location=None):
         self.location = location
         self.tarball = Tarball()
+
+
+class GitSourceManager:
+
+    def __init__(self, repo):
+        self.repo = repo
+
+        # Will be set by derived classes but used here
+        self._pretty_name = ''
+        self._repo_url = ''
+
+    def download(self, ref, shallow=False):
+        if self.repo.exists():
+            return
+
+        tc_build.utils.print_header(f"Downloading {self._pretty_name}")
+
+        git_clone = ['git', 'clone']
+        if shallow:
+            git_clone.append('--depth=1')
+            if ref != 'main':
+                git_clone.append('--no-single-branch')
+        git_clone += [self._repo_url, self.repo]
+
+        subprocess.run(git_clone, check=True)
+
+        self.git(['checkout', ref])
+
+    def git(self, cmd, capture_output=False):
+        return subprocess.run(['git', *cmd],
+                              capture_output=capture_output,
+                              check=True,
+                              cwd=self.repo,
+                              text=True)
+
+    def git_capture(self, cmd):
+        return self.git(cmd, capture_output=True).stdout.strip()
+
+    def is_shallow(self):
+        git_dir = self.git_capture(['rev-parse', '--git-dir'])
+        return Path(git_dir, 'shallow').exists()
+
+    def ref_exists(self, ref):
+        try:
+            self.git(['show-branch', ref])
+        except subprocess.CalledProcessError:
+            return False
+        return True
+
+    def update(self, ref):
+        tc_build.utils.print_header(f"Updating {self._pretty_name}")
+
+        self.git(['fetch', 'origin'])
+
+        if self.is_shallow() and not self.ref_exists(ref):
+            raise RuntimeError(f"Repo is shallow and supplied ref ('{ref}') does not exist!")
+
+        self.git(['checkout', ref])
+
+        local_ref = None
+        with contextlib.suppress(subprocess.CalledProcessError):
+            local_ref = self.git_capture(['symbolic-ref', '-q', 'HEAD'])
+        if local_ref and local_ref.startswith('refs/heads/'):
+            self.git(['pull', '--rebase', 'origin', local_ref.replace('refs/heads/', '')])