]> git.scottworley.com Git - pinch/blobdiff - pinch.py
Prefer more type-safe NamedTuple over SimpleNamespace
[pinch] / pinch.py
index 5e6aab9f6dcaab63bcbd936069b51654a7cd6182..8fe7df16c10958ccaa6c0edfd8c7a834d444faa4 100644 (file)
--- a/pinch.py
+++ b/pinch.py
@@ -25,6 +25,7 @@ from typing import (
     Mapping,
     NamedTuple,
     NewType,
+    Optional,
     Tuple,
     Type,
     Union,
@@ -33,7 +34,7 @@ from typing import (
 # Use xdg module when it's less painful to have as a dependency
 
 
-class XDG(types.SimpleNamespace):
+class XDG(NamedTuple):
     XDG_CACHE_HOME: str
 
 
@@ -132,19 +133,19 @@ class TarrableSearchPath(SearchPath, ABC):  # pylint: disable=abstract-method
     forwarded_url: str
     git_ref: str
     git_repo: str
-    old_git_revision: str
     table: Dict[str, ChannelTableEntry]
 
 
 class GitSearchPath(TarrableSearchPath):
     def pin(self, v: Verification) -> GitPin:
+        old_revision = (
+            self.git_revision if hasattr(self, 'git_revision') else None)
         if hasattr(self, 'git_revision'):
-            self.old_git_revision = self.git_revision
             del self.git_revision
 
-        git_fetch(v, self)
-        return GitPin(release_name=git_revision_name(v, self),
-                      git_revision=self.git_revision)
+        new_revision = git_fetch(v, self, None, old_revision)
+        return GitPin(release_name=git_revision_name(v, self, new_revision),
+                      git_revision=new_revision)
 
     def fetch(self, v: Verification, section: str,
               conf: configparser.SectionProxy) -> str:
@@ -156,26 +157,27 @@ class GitSearchPath(TarrableSearchPath):
             release_name=conf['release_name'],
             git_revision=conf['git_revision'])
 
-        ensure_git_rev_available(v, self, the_pin)
+        ensure_git_rev_available(v, self, the_pin, None)
         return git_get_tarball(v, self, the_pin)
 
 
 class ChannelSearchPath(TarrableSearchPath):
     def pin(self, v: Verification) -> ChannelPin:
+        old_revision = (
+            self.git_revision if hasattr(self, 'git_revision') else None)
         if hasattr(self, 'git_revision'):
-            self.old_git_revision = self.git_revision
             del self.git_revision
 
         fetch(v, self)
         new_gitpin = parse_channel(v, self)
         fetch_resources(v, self, new_gitpin)
-        ensure_git_rev_available(v, self, new_gitpin)
-        check_channel_contents(v, self)
+        ensure_git_rev_available(v, self, new_gitpin, old_revision)
+        check_channel_contents(v, self, new_gitpin)
         return ChannelPin(
-            release_name=self.release_name,
+            release_name=new_gitpin.release_name,
             tarball_url=self.table['nixexprs.tar.xz'].absolute_url,
             tarball_sha256=self.table['nixexprs.tar.xz'].digest,
-            git_revision=self.git_revision)
+            git_revision=new_gitpin.git_revision)
 
     # Lint TODO: Put tarball_url and tarball_sha256 in ChannelSearchPath
     # pylint: disable=no-self-use
@@ -239,12 +241,11 @@ def parse_channel(v: Verification, channel: TarrableSearchPath) -> GitPin:
     h1_name = d.getElementsByTagName('h1')[0].firstChild.nodeValue.split()[2]
     v.status(title_name)
     v.result(title_name == h1_name)
-    channel.release_name = title_name
 
     v.status('Extracting git commit:')
     git_commit_node = d.getElementsByTagName('tt')[0]
-    channel.git_revision = git_commit_node.firstChild.nodeValue
-    v.status(channel.git_revision)
+    git_revision = git_commit_node.firstChild.nodeValue
+    v.status(git_revision)
     v.ok()
     v.status('Verifying git commit label')
     v.result(git_commit_node.previousSibling.nodeValue == 'Git commit ')
@@ -259,7 +260,7 @@ def parse_channel(v: Verification, channel: TarrableSearchPath) -> GitPin:
         channel.table[name] = ChannelTableEntry(
             url=url, digest=digest, size=size)
     v.ok()
-    return GitPin(release_name=title_name, git_revision=channel.git_revision)
+    return GitPin(release_name=title_name, git_revision=git_revision)
 
 
 def digest_string(s: bytes) -> Digest16:
@@ -332,17 +333,21 @@ def git_cachedir(git_repo: str) -> str:
         digest_string(git_repo.encode()))
 
 
-def tarball_cache_file(channel: TarrableSearchPath) -> str:
+def tarball_cache_file(channel: TarrableSearchPath, pin: GitPin) -> str:
     return os.path.join(
         xdg.XDG_CACHE_HOME,
         'pinch/git-tarball',
         '%s-%s-%s' %
         (digest_string(channel.git_repo.encode()),
-         channel.git_revision,
-         channel.release_name))
+         pin.git_revision,
+         pin.release_name))
 
 
-def verify_git_ancestry(v: Verification, channel: TarrableSearchPath) -> None:
+def verify_git_ancestry(
+        v: Verification,
+        channel: TarrableSearchPath,
+        new_revision: str,
+        old_revision: Optional[str]) -> None:
     cachedir = git_cachedir(channel.git_repo)
     v.status('Verifying rev is an ancestor of ref')
     process = subprocess.run(['git',
@@ -350,25 +355,29 @@ def verify_git_ancestry(v: Verification, channel: TarrableSearchPath) -> None:
                               cachedir,
                               'merge-base',
                               '--is-ancestor',
-                              channel.git_revision,
+                              new_revision,
                               channel.git_ref])
     v.result(process.returncode == 0)
 
-    if hasattr(channel, 'old_git_revision'):
+    if old_revision is not None:
         v.status(
             'Verifying rev is an ancestor of previous rev %s' %
-            channel.old_git_revision)
+            old_revision)
         process = subprocess.run(['git',
                                   '-C',
                                   cachedir,
                                   'merge-base',
                                   '--is-ancestor',
-                                  channel.old_git_revision,
-                                  channel.git_revision])
+                                  old_revision,
+                                  new_revision])
         v.result(process.returncode == 0)
 
 
-def git_fetch(v: Verification, channel: TarrableSearchPath) -> None:
+def git_fetch(
+        v: Verification,
+        channel: TarrableSearchPath,
+        desired_revision: Optional[str],
+        old_revision: Optional[str]) -> str:
     # It would be nice if we could share the nix git cache, but as of the time
     # of writing it is transitioning from gitv2 (deprecated) to gitv3 (not ready
     # yet), and trying to straddle them both is too far into nix implementation
@@ -394,26 +403,29 @@ def git_fetch(v: Verification, channel: TarrableSearchPath) -> None:
                                          channel.git_ref)])
     v.result(process.returncode == 0)
 
-    if hasattr(channel, 'git_revision'):
+    if desired_revision is not None:
         v.status('Verifying that fetch retrieved this rev')
         process = subprocess.run(
-            ['git', '-C', cachedir, 'cat-file', '-e', channel.git_revision])
+            ['git', '-C', cachedir, 'cat-file', '-e', desired_revision])
         v.result(process.returncode == 0)
-    else:
-        channel.git_revision = open(
-            os.path.join(
-                cachedir,
-                'refs',
-                'heads',
-                channel.git_ref)).read(999).strip()
 
-    verify_git_ancestry(v, channel)
+    new_revision = open(
+        os.path.join(
+            cachedir,
+            'refs',
+            'heads',
+            channel.git_ref)).read(999).strip()
+
+    verify_git_ancestry(v, channel, new_revision, old_revision)
+
+    return new_revision
 
 
 def ensure_git_rev_available(
         v: Verification,
         channel: TarrableSearchPath,
-        pin: GitPin) -> None:
+        pin: GitPin,
+        old_revision: Optional[str]) -> None:
     cachedir = git_cachedir(channel.git_repo)
     if os.path.exists(cachedir):
         v.status('Checking if we already have this rev:')
@@ -425,19 +437,19 @@ def ensure_git_rev_available(
             v.status('no')
         v.result(process.returncode == 0 or process.returncode == 1)
         if process.returncode == 0:
-            verify_git_ancestry(v, channel)
+            verify_git_ancestry(v, channel, pin.git_revision, old_revision)
             return
-    git_fetch(v, channel)
+    git_fetch(v, channel, pin.git_revision, old_revision)
 
 
 def compare_tarball_and_git(
         v: Verification,
-        channel: TarrableSearchPath,
+        pin: GitPin,
         channel_contents: str,
         git_contents: str) -> None:
     v.status('Comparing channel tarball with git checkout')
     match, mismatch, errors = compare(os.path.join(
-        channel_contents, channel.release_name), git_contents)
+        channel_contents, pin.release_name), git_contents)
     v.ok()
     v.check('%d files match' % len(match), len(match) > 0)
     v.check('%d files differ' % len(mismatch), len(mismatch) == 0)
@@ -478,13 +490,14 @@ def extract_tarball(
 def git_checkout(
         v: Verification,
         channel: TarrableSearchPath,
+        pin: GitPin,
         dest: str) -> None:
     v.status('Checking out corresponding git revision')
     git = subprocess.Popen(['git',
                             '-C',
                             git_cachedir(channel.git_repo),
                             'archive',
-                            channel.git_revision],
+                            pin.git_revision],
                            stdout=subprocess.PIPE)
     tar = subprocess.Popen(
         ['tar', 'x', '-C', dest, '-f', '-'], stdin=git.stdout)
@@ -499,7 +512,7 @@ def git_get_tarball(
         v: Verification,
         channel: TarrableSearchPath,
         pin: GitPin) -> str:
-    cache_file = tarball_cache_file(channel)
+    cache_file = tarball_cache_file(channel, pin)
     if os.path.exists(cache_file):
         cached_tarball = open(cache_file).read(9999)
         if os.path.exists(cached_tarball):
@@ -537,46 +550,50 @@ def git_get_tarball(
 
 def check_channel_metadata(
         v: Verification,
-        channel: TarrableSearchPath,
+        pin: GitPin,
         channel_contents: str) -> None:
     v.status('Verifying git commit in channel tarball')
     v.result(
         open(
             os.path.join(
                 channel_contents,
-                channel.release_name,
-                '.git-revision')).read(999) == channel.git_revision)
+                pin.release_name,
+                '.git-revision')).read(999) == pin.git_revision)
 
     v.status(
         'Verifying version-suffix is a suffix of release name %s:' %
-        channel.release_name)
+        pin.release_name)
     version_suffix = open(
         os.path.join(
             channel_contents,
-            channel.release_name,
+            pin.release_name,
             '.version-suffix')).read(999)
     v.status(version_suffix)
-    v.result(channel.release_name.endswith(version_suffix))
+    v.result(pin.release_name.endswith(version_suffix))
 
 
 def check_channel_contents(
         v: Verification,
-        channel: TarrableSearchPath) -> None:
+        channel: TarrableSearchPath,
+        pin: GitPin) -> None:
     with tempfile.TemporaryDirectory() as channel_contents, \
             tempfile.TemporaryDirectory() as git_contents:
 
         extract_tarball(v, channel, channel_contents)
-        check_channel_metadata(v, channel, channel_contents)
+        check_channel_metadata(v, pin, channel_contents)
 
-        git_checkout(v, channel, git_contents)
+        git_checkout(v, channel, pin, git_contents)
 
-        compare_tarball_and_git(v, channel, channel_contents, git_contents)
+        compare_tarball_and_git(v, pin, channel_contents, git_contents)
 
         v.status('Removing temporary directories')
     v.ok()
 
 
-def git_revision_name(v: Verification, channel: TarrableSearchPath) -> str:
+def git_revision_name(
+        v: Verification,
+        channel: TarrableSearchPath,
+        git_revision: str) -> str:
     v.status('Getting commit date')
     process = subprocess.run(['git',
                               '-C',
@@ -586,7 +603,7 @@ def git_revision_name(v: Verification, channel: TarrableSearchPath) -> str:
                               '--format=%ct-%h',
                               '--abbrev=11',
                               '--no-show-signature',
-                              channel.git_revision],
+                              git_revision],
                              stdout=subprocess.PIPE)
     v.result(process.returncode == 0 and process.stdout != b'')
     return '%s-%s' % (os.path.basename(channel.git_repo),