Sub-command

[pinch] / pinch.py

diff --git a/pinch.py b/pinch.py
index 1a97f5377fe4c063fb448f6aba16dc7ac5b3aca4..71496a317a48366ca119cf7dba7da86ba2987931 100644 (file)
--- a/pinch.py
+++ b/pinch.py
@@ -1,3 +1,5 @@
+import argparse
+import configparser

 import filecmp
 import functools
 import hashlib
 import filecmp
 import functools
 import hashlib


@@ -25,6 +27,7 @@ Digest32 = NewType('Digest32', str)
 
 
 class ChannelTableEntry(types.SimpleNamespace):
 
 
 class ChannelTableEntry(types.SimpleNamespace):

+    absolute_url: str

     digest: Digest16
     file: str
     size: int
     digest: Digest16
     file: str
     size: int


@@ -33,14 +36,15 @@ class ChannelTableEntry(types.SimpleNamespace):
 
 class Channel(types.SimpleNamespace):
     channel_html: bytes
 
 class Channel(types.SimpleNamespace):
     channel_html: bytes

+    channel_url: str

     forwarded_url: str
     git_cachedir: str
     git_ref: str
     git_repo: str
     git_revision: str
     forwarded_url: str
     git_cachedir: str
     git_ref: str
     git_repo: str
     git_revision: str

+    old_git_revision: str

     release_name: str
     table: Dict[str, ChannelTableEntry]
     release_name: str
     table: Dict[str, ChannelTableEntry]

-    url: str

 
 
 class VerificationError(Exception):
 
 
 class VerificationError(Exception):


@@ -108,11 +112,11 @@ def compare(a: str, b: str) -> Tuple[List[str], List[str], List[str]]:
 
 def fetch(v: Verification, channel: Channel) -> None:
     v.status('Fetching channel')
 
 def fetch(v: Verification, channel: Channel) -> None:
     v.status('Fetching channel')

-    request = urllib.request.urlopen(channel.url, timeout=10)
+    request = urllib.request.urlopen(channel.channel_url, timeout=10)

     channel.channel_html = request.read()
     channel.forwarded_url = request.geturl()
     v.result(request.status == 200)
     channel.channel_html = request.read()
     channel.forwarded_url = request.geturl()
     v.result(request.status == 200)

-    v.check('Got forwarded', channel.url != channel.forwarded_url)
+    v.check('Got forwarded', channel.channel_url != channel.forwarded_url)

 
 
 def parse_channel(v: Verification, channel: Channel) -> None:
 
 
 def parse_channel(v: Verification, channel: Channel) -> None:


@@ -130,8 +134,8 @@ def parse_channel(v: Verification, channel: Channel) -> None:
 
     v.status('Extracting git commit:')
     git_commit_node = d.getElementsByTagName('tt')[0]
 
     v.status('Extracting git commit:')
     git_commit_node = d.getElementsByTagName('tt')[0]

-    channel.git_commit = git_commit_node.firstChild.nodeValue
-    v.status(channel.git_commit)
+    channel.git_revision = git_commit_node.firstChild.nodeValue
+    v.status(channel.git_revision)

     v.ok()
     v.status('Verifying git commit label')
     v.result(git_commit_node.previousSibling.nodeValue == 'Git commit ')
     v.ok()
     v.status('Verifying git commit label')
     v.result(git_commit_node.previousSibling.nodeValue == 'Git commit ')


@@ -198,12 +202,14 @@ def fetch_with_nix_prefetch_url(
 def fetch_resources(v: Verification, channel: Channel) -> None:
     for resource in ['git-revision', 'nixexprs.tar.xz']:
         fields = channel.table[resource]
 def fetch_resources(v: Verification, channel: Channel) -> None:
     for resource in ['git-revision', 'nixexprs.tar.xz']:
         fields = channel.table[resource]

-        url = urllib.parse.urljoin(channel.forwarded_url, fields.url)
-        fields.file = fetch_with_nix_prefetch_url(v, url, fields.digest)
+        fields.absolute_url = urllib.parse.urljoin(
+            channel.forwarded_url, fields.url)
+        fields.file = fetch_with_nix_prefetch_url(
+            v, fields.absolute_url, fields.digest)

     v.status('Verifying git commit on main page matches git commit in table')
     v.result(
         open(
     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_commit)
+            channel.table['git-revision'].file).read(999) == channel.git_revision)

 
 
 def git_fetch(v: Verification, channel: Channel) -> None:
 
 
 def git_fetch(v: Verification, channel: Channel) -> None:


@@ -217,23 +223,29 @@ def git_fetch(v: Verification, channel: Channel) -> None:
     channel.git_cachedir = os.path.expanduser(
         '~/.cache/nix-pin-channel/git/%s' %
         digest_string(
     channel.git_cachedir = os.path.expanduser(
         '~/.cache/nix-pin-channel/git/%s' %
         digest_string(

-            channel.url.encode()))
+            channel.git_repo.encode()))

     if not os.path.exists(channel.git_cachedir):
         v.status("Initializing git repo")
         process = subprocess.run(
             ['git', 'init', '--bare', channel.git_cachedir])
         v.result(process.returncode == 0)
 
     if not os.path.exists(channel.git_cachedir):
         v.status("Initializing git repo")
         process = subprocess.run(
             ['git', 'init', '--bare', channel.git_cachedir])
         v.result(process.returncode == 0)
 

-    v.status('Checking if we already have this rev:')
-    process = subprocess.run(
-        ['git', '-C', channel.git_cachedir, 'cat-file', '-e', channel.git_commit])
-    if process.returncode == 0:
-        v.status('yes')
-    if process.returncode == 1:
-        v.status('no')
-    v.result(process.returncode == 0 or process.returncode == 1)
-    if process.returncode == 1:
-        v.status('Fetching ref "%s"' % channel.git_ref)
+    have_rev = False
+    if hasattr(channel, 'git_revision'):
+        v.status('Checking if we already have this rev:')
+        process = subprocess.run(
+            ['git', '-C', channel.git_cachedir, 'cat-file', '-e', channel.git_revision])
+        if process.returncode == 0:
+            v.status('yes')
+        if process.returncode == 1:
+            v.status('no')
+        v.result(process.returncode == 0 or process.returncode == 1)
+        have_rev = process.returncode == 0
+
+    if not have_rev:
+        v.status(
+            'Fetching ref "%s" from %s' %
+            (channel.git_ref, channel.git_repo))

         # We don't use --force here because we want to abort and freak out if forced
         # updates are happening.
         process = subprocess.run(['git',
         # We don't use --force here because we want to abort and freak out if forced
         # updates are happening.
         process = subprocess.run(['git',


@@ -244,10 +256,19 @@ def git_fetch(v: Verification, channel: Channel) -> None:
                                   '%s:%s' % (channel.git_ref,
                                              channel.git_ref)])
         v.result(process.returncode == 0)
                                   '%s:%s' % (channel.git_ref,
                                              channel.git_ref)])
         v.result(process.returncode == 0)

-        v.status('Verifying that fetch retrieved this rev')
-        process = subprocess.run(
-            ['git', '-C', channel.git_cachedir, 'cat-file', '-e', channel.git_commit])
-        v.result(process.returncode == 0)
+        if hasattr(channel, 'git_revision'):
+            v.status('Verifying that fetch retrieved this rev')
+            process = subprocess.run(
+                ['git', '-C', channel.git_cachedir, 'cat-file', '-e', channel.git_revision])
+            v.result(process.returncode == 0)
+
+    if not hasattr(channel, 'git_revision'):
+        channel.git_revision = open(
+            os.path.join(
+                channel.git_cachedir,
+                'refs',
+                'heads',
+                channel.git_ref)).read(999).strip()

 
     v.status('Verifying rev is an ancestor of ref')
     process = subprocess.run(['git',
 
     v.status('Verifying rev is an ancestor of ref')
     process = subprocess.run(['git',


@@ -255,10 +276,23 @@ def git_fetch(v: Verification, channel: Channel) -> None:
                               channel.git_cachedir,
                               'merge-base',
                               '--is-ancestor',
                               channel.git_cachedir,
                               'merge-base',
                               '--is-ancestor',

-                              channel.git_commit,
+                              channel.git_revision,

                               channel.git_ref])
     v.result(process.returncode == 0)
 
                               channel.git_ref])
     v.result(process.returncode == 0)
 

+    if hasattr(channel, 'old_git_revision'):
+        v.status(
+            'Verifying rev is an ancestor of previous rev %s' %
+            channel.old_git_revision)
+        process = subprocess.run(['git',
+                                  '-C',
+                                  channel.git_cachedir,
+                                  'merge-base',
+                                  '--is-ancestor',
+                                  channel.old_git_revision,
+                                  channel.git_revision])
+        v.result(process.returncode == 0)
+

 
 def compare_tarball_and_git(
         v: Verification,
 
 def compare_tarball_and_git(
         v: Verification,


@@ -308,7 +342,7 @@ def git_checkout(v: Verification, channel: Channel, dest: str) -> None:
                             '-C',
                             channel.git_cachedir,
                             'archive',
                             '-C',
                             channel.git_cachedir,
                             'archive',

-                            channel.git_commit],
+                            channel.git_revision],

                            stdout=subprocess.PIPE)
     tar = subprocess.Popen(
         ['tar', 'x', '-C', dest, '-f', '-'], stdin=git.stdout)
                            stdout=subprocess.PIPE)
     tar = subprocess.Popen(
         ['tar', 'x', '-C', dest, '-f', '-'], stdin=git.stdout)


@@ -318,11 +352,37 @@ def git_checkout(v: Verification, channel: Channel, dest: str) -> None:
     v.result(git.returncode == 0 and tar.returncode == 0)
 
 
     v.result(git.returncode == 0 and tar.returncode == 0)
 
 

+def check_channel_metadata(
+        v: Verification,
+        channel: Channel,
+        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)
+
+    v.status(
+        'Verifying version-suffix is a suffix of release name %s:' %
+        channel.release_name)
+    version_suffix = open(
+        os.path.join(
+            channel_contents,
+            channel.release_name,
+            '.version-suffix')).read(999)
+    v.status(version_suffix)
+    v.result(channel.release_name.endswith(version_suffix))
+
+

 def check_channel_contents(v: Verification, channel: Channel) -> None:
     with tempfile.TemporaryDirectory() as channel_contents, \
             tempfile.TemporaryDirectory() as git_contents:
 
         extract_tarball(v, channel, channel_contents)
 def check_channel_contents(v: Verification, channel: Channel) -> 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)
+

         git_checkout(v, channel, git_contents)
 
         compare_tarball_and_git(v, channel, channel_contents, git_contents)
         git_checkout(v, channel, git_contents)
 
         compare_tarball_and_git(v, channel, channel_contents, git_contents)


@@ -331,17 +391,48 @@ def check_channel_contents(v: Verification, channel: Channel) -> None:
     v.ok()
 
 
     v.ok()
 
 

-def main() -> None:
-    v = Verification()
-    channel = Channel(url='https://channels.nixos.org/nixos-20.03',
-                      git_repo='https://github.com/NixOS/nixpkgs.git',
-                      git_ref='nixos-20.03')
+def pin_channel(v: Verification, channel: Channel) -> None:

     fetch(v, channel)
     parse_channel(v, channel)
     fetch_resources(v, channel)
     git_fetch(v, channel)
     check_channel_contents(v, channel)
     fetch(v, channel)
     parse_channel(v, channel)
     fetch_resources(v, channel)
     git_fetch(v, channel)
     check_channel_contents(v, channel)

-    print(channel)
+
+
+def make_channel(conf: configparser.SectionProxy) -> Channel:
+    channel = Channel(**dict(conf.items()))
+    if hasattr(channel, 'git_revision'):
+        channel.old_git_revision = channel.git_revision
+        del channel.git_revision
+    return channel
+
+
+def pin(args: argparse.Namespace) -> None:
+    v = Verification()
+    config = configparser.ConfigParser()
+    config.read_file(open(args.channels_file), args.channels_file)
+    for section in config.sections():
+        channel = make_channel(config[section])
+        if 'channel_url' in config[section]:
+            pin_channel(v, channel)
+            config[section]['tarball_url'] = channel.table['nixexprs.tar.xz'].absolute_url
+            config[section]['tarball_sha256'] = channel.table['nixexprs.tar.xz'].digest
+        else:
+            git_fetch(v, channel)
+        config[section]['git_revision'] = channel.git_revision
+
+    with open(args.channels_file, 'w') as configfile:
+        config.write(configfile)
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(prog='pinch')
+    subparsers = parser.add_subparsers(dest='mode', required=True)
+    parser_pin = subparsers.add_parser('pin')
+    parser_pin.add_argument('channels_file', type=str)
+    parser_pin.set_defaults(func=pin)
+    args = parser.parse_args()
+    args.func(args)

 
 
 main()
 
 
 main()