Start pulling release_name and git_revision out of SearchPath

[pinch] / pinch.py

diff --git a/pinch.py b/pinch.py
index f5fbb481bea3cb0df30bf45f12c40d58dda55f83..5e6aab9f6dcaab63bcbd936069b51654a7cd6182 100644 (file)
--- a/pinch.py
+++ b/pinch.py
@@ -22,9 +22,11 @@ from typing import (
     Dict,
     Iterable,
     List,
+    Mapping,
     NamedTuple,
     NewType,
     Tuple,
+    Type,
     Union,
 )
 
@@ -146,13 +148,16 @@ class GitSearchPath(TarrableSearchPath):
 
     def fetch(self, v: Verification, section: str,
               conf: configparser.SectionProxy) -> str:
-        if 'git_repo' not in conf or 'release_name' not in conf:
+        if 'git_revision' not in conf or 'release_name' not in conf:
             raise Exception(
                 'Cannot update unpinned channel "%s" (Run "pin" before "update")' %
                 section)
+        the_pin = GitPin(
+            release_name=conf['release_name'],
+            git_revision=conf['git_revision'])
 
-        ensure_git_rev_available(v, self)
-        return git_get_tarball(v, self)
+        ensure_git_rev_available(v, self, the_pin)
+        return git_get_tarball(v, self, the_pin)
 
 
 class ChannelSearchPath(TarrableSearchPath):
@@ -161,7 +166,11 @@ class ChannelSearchPath(TarrableSearchPath):
             self.old_git_revision = self.git_revision
             del self.git_revision
 
-        pin_channel(v, self)
+        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)
         return ChannelPin(
             release_name=self.release_name,
             tarball_url=self.table['nixexprs.tar.xz'].absolute_url,
@@ -219,7 +228,7 @@ def fetch(v: Verification, channel: TarrableSearchPath) -> None:
     v.check('Got forwarded', channel.channel_url != channel.forwarded_url)
 
 
-def parse_channel(v: Verification, channel: TarrableSearchPath) -> None:
+def parse_channel(v: Verification, channel: TarrableSearchPath) -> GitPin:
     v.status('Parsing channel description as XML')
     d = xml.dom.minidom.parseString(channel.channel_html)
     v.ok()
@@ -250,6 +259,7 @@ def parse_channel(v: Verification, channel: TarrableSearchPath) -> None:
         channel.table[name] = ChannelTableEntry(
             url=url, digest=digest, size=size)
     v.ok()
+    return GitPin(release_name=title_name, git_revision=channel.git_revision)
 
 
 def digest_string(s: bytes) -> Digest16:
@@ -299,7 +309,10 @@ def fetch_with_nix_prefetch_url(
     return path  # type: ignore  # (for old mypy)
 
 
-def fetch_resources(v: Verification, channel: TarrableSearchPath) -> None:
+def fetch_resources(
+        v: Verification,
+        channel: ChannelSearchPath,
+        pin: GitPin) -> None:
     for resource in ['git-revision', 'nixexprs.tar.xz']:
         fields = channel.table[resource]
         fields.absolute_url = urllib.parse.urljoin(
@@ -309,7 +322,7 @@ def fetch_resources(v: Verification, channel: TarrableSearchPath) -> None:
     v.status('Verifying git commit on main page matches git commit in table')
     v.result(
         open(
-            channel.table['git-revision'].file).read(999) == channel.git_revision)
+            channel.table['git-revision'].file).read(999) == pin.git_revision)
 
 
 def git_cachedir(git_repo: str) -> str:
@@ -399,12 +412,13 @@ def git_fetch(v: Verification, channel: TarrableSearchPath) -> None:
 
 def ensure_git_rev_available(
         v: Verification,
-        channel: TarrableSearchPath) -> None:
+        channel: TarrableSearchPath,
+        pin: GitPin) -> None:
     cachedir = git_cachedir(channel.git_repo)
     if os.path.exists(cachedir):
         v.status('Checking if we already have this rev:')
         process = subprocess.run(
-            ['git', '-C', cachedir, 'cat-file', '-e', channel.git_revision])
+            ['git', '-C', cachedir, 'cat-file', '-e', pin.git_revision])
         if process.returncode == 0:
             v.status('yes')
         if process.returncode == 1:
@@ -481,7 +495,10 @@ def git_checkout(
     v.result(git.returncode == 0 and tar.returncode == 0)
 
 
-def git_get_tarball(v: Verification, channel: TarrableSearchPath) -> str:
+def git_get_tarball(
+        v: Verification,
+        channel: TarrableSearchPath,
+        pin: GitPin) -> str:
     cache_file = tarball_cache_file(channel)
     if os.path.exists(cache_file):
         cached_tarball = open(cache_file).read(9999)
@@ -490,17 +507,17 @@ def git_get_tarball(v: Verification, channel: TarrableSearchPath) -> str:
 
     with tempfile.TemporaryDirectory() as output_dir:
         output_filename = os.path.join(
-            output_dir, channel.release_name + '.tar.xz')
+            output_dir, pin.release_name + '.tar.xz')
         with open(output_filename, 'w') as output_file:
             v.status(
                 'Generating tarball for git revision %s' %
-                channel.git_revision)
+                pin.git_revision)
             git = subprocess.Popen(['git',
                                     '-C',
                                     git_cachedir(channel.git_repo),
                                     'archive',
-                                    '--prefix=%s/' % channel.release_name,
-                                    channel.git_revision],
+                                    '--prefix=%s/' % pin.release_name,
+                                    pin.git_revision],
                                    stdout=subprocess.PIPE)
             xz = subprocess.Popen(['xz'], stdin=git.stdout, stdout=output_file)
             xz.wait()
@@ -559,14 +576,6 @@ def check_channel_contents(
     v.ok()
 
 
-def pin_channel(v: Verification, channel: TarrableSearchPath) -> None:
-    fetch(v, channel)
-    parse_channel(v, channel)
-    fetch_resources(v, channel)
-    ensure_git_rev_available(v, channel)
-    check_channel_contents(v, channel)
-
-
 def git_revision_name(v: Verification, channel: TarrableSearchPath) -> str:
     v.status('Getting commit date')
     process = subprocess.run(['git',
@@ -585,11 +594,12 @@ def git_revision_name(v: Verification, channel: TarrableSearchPath) -> str:
 
 
 def read_search_path(conf: configparser.SectionProxy) -> SearchPath:
-    if 'alias_of' in conf:
-        return AliasSearchPath(**dict(conf.items()))
-    if 'channel_url' in conf:
-        return ChannelSearchPath(**dict(conf.items()))
-    return GitSearchPath(**dict(conf.items()))
+    mapping: Mapping[str, Type[SearchPath]] = {
+        'alias': AliasSearchPath,
+        'channel': ChannelSearchPath,
+        'git': GitSearchPath,
+    }
+    return mapping[conf['type']](**dict(conf.items()))
 
 
 def read_config(filename: str) -> configparser.ConfigParser:
@@ -610,7 +620,7 @@ def read_config_files(
     return merged_config
 
 
-def pin(args: argparse.Namespace) -> None:
+def pinCommand(args: argparse.Namespace) -> None:
     v = Verification()
     config = read_config(args.channels_file)
     for section in config.sections():
@@ -625,7 +635,7 @@ def pin(args: argparse.Namespace) -> None:
         config.write(configfile)
 
 
-def update(args: argparse.Namespace) -> None:
+def updateCommand(args: argparse.Namespace) -> None:
     v = Verification()
     exprs: Dict[str, str] = {}
     config = read_config_files(args.channels_file)
@@ -667,11 +677,11 @@ def main() -> None:
     parser_pin = subparsers.add_parser('pin')
     parser_pin.add_argument('channels_file', type=str)
     parser_pin.add_argument('channels', type=str, nargs='*')
-    parser_pin.set_defaults(func=pin)
+    parser_pin.set_defaults(func=pinCommand)
     parser_update = subparsers.add_parser('update')
     parser_update.add_argument('--dry-run', action='store_true')
     parser_update.add_argument('channels_file', type=str, nargs='+')
-    parser_update.set_defaults(func=update)
+    parser_update.set_defaults(func=updateCommand)
     args = parser.parse_args()
     args.func(args)