]> git.scottworley.com Git - pinch/blobdiff - pinch.py
Start pulling release_name and git_revision out of SearchPath
[pinch] / pinch.py
index ec6e8b587dc8014e89562f6431f8b57b8dad3fba..5e6aab9f6dcaab63bcbd936069b51654a7cd6182 100644 (file)
--- a/pinch.py
+++ b/pinch.py
@@ -1,10 +1,14 @@
+from abc import ABC, abstractmethod
+import argparse
 import configparser
 import filecmp
 import functools
+import getpass
 import hashlib
 import operator
 import os
 import os.path
+import shlex
 import shutil
 import subprocess
 import sys
@@ -18,31 +22,25 @@ from typing import (
     Dict,
     Iterable,
     List,
+    Mapping,
+    NamedTuple,
     NewType,
     Tuple,
+    Type,
+    Union,
 )
 
-Digest16 = NewType('Digest16', str)
-Digest32 = NewType('Digest32', str)
+# Use xdg module when it's less painful to have as a dependency
 
 
-class ChannelTableEntry(types.SimpleNamespace):
-    digest: Digest16
-    file: str
-    size: int
-    url: str
+class XDG(types.SimpleNamespace):
+    XDG_CACHE_HOME: str
 
 
-class Channel(types.SimpleNamespace):
-    channel_html: bytes
-    forwarded_url: str
-    git_cachedir: str
-    git_ref: str
-    git_repo: str
-    git_revision: str
-    release_name: str
-    table: Dict[str, ChannelTableEntry]
-    url: str
+xdg = XDG(
+    XDG_CACHE_HOME=os.getenv(
+        'XDG_CACHE_HOME',
+        os.path.expanduser('~/.cache')))
 
 
 class VerificationError(Exception):
@@ -55,7 +53,7 @@ class Verification:
         self.line_length = 0
 
     def status(self, s: str) -> None:
-        print(s, end=' ', flush=True)
+        print(s, end=' ', file=sys.stderr, flush=True)
         self.line_length += 1 + len(s)  # Unicode??
 
     @staticmethod
@@ -65,9 +63,9 @@ class Verification:
     def result(self, r: bool) -> None:
         message, color = {True: ('OK ', 92), False: ('FAIL', 91)}[r]
         length = len(message)
-        cols = shutil.get_terminal_size().columns
+        cols = shutil.get_terminal_size().columns or 80
         pad = (cols - (self.line_length + length)) % cols
-        print(' ' * pad + self._color(message, color))
+        print(' ' * pad + self._color(message, color), file=sys.stderr)
         self.line_length = 0
         if not r:
             raise VerificationError()
@@ -80,6 +78,119 @@ class Verification:
         self.result(True)
 
 
+Digest16 = NewType('Digest16', str)
+Digest32 = NewType('Digest32', str)
+
+
+class ChannelTableEntry(types.SimpleNamespace):
+    absolute_url: str
+    digest: Digest16
+    file: str
+    size: int
+    url: str
+
+
+class AliasPin(NamedTuple):
+    pass
+
+
+class GitPin(NamedTuple):
+    git_revision: str
+    release_name: str
+
+
+class ChannelPin(NamedTuple):
+    git_revision: str
+    release_name: str
+    tarball_url: str
+    tarball_sha256: str
+
+
+Pin = Union[AliasPin, GitPin, ChannelPin]
+
+
+class SearchPath(types.SimpleNamespace, ABC):
+
+    @abstractmethod
+    def pin(self, v: Verification) -> Pin:
+        pass
+
+
+class AliasSearchPath(SearchPath):
+    alias_of: str
+
+    def pin(self, v: Verification) -> AliasPin:
+        assert not hasattr(self, 'git_repo')
+        return AliasPin()
+
+
+# (This lint-disable is for pylint bug https://github.com/PyCQA/pylint/issues/179
+# which is fixed in pylint 2.5.)
+class TarrableSearchPath(SearchPath, ABC):  # pylint: disable=abstract-method
+    channel_html: bytes
+    channel_url: str
+    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:
+        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)
+
+    def fetch(self, v: Verification, section: str,
+              conf: configparser.SectionProxy) -> str:
+        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, the_pin)
+        return git_get_tarball(v, self, the_pin)
+
+
+class ChannelSearchPath(TarrableSearchPath):
+    def pin(self, v: Verification) -> ChannelPin:
+        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)
+        return ChannelPin(
+            release_name=self.release_name,
+            tarball_url=self.table['nixexprs.tar.xz'].absolute_url,
+            tarball_sha256=self.table['nixexprs.tar.xz'].digest,
+            git_revision=self.git_revision)
+
+    # Lint TODO: Put tarball_url and tarball_sha256 in ChannelSearchPath
+    # pylint: disable=no-self-use
+    def fetch(self, v: Verification, section: str,
+              conf: configparser.SectionProxy) -> str:
+        if 'git_repo' not in conf or 'release_name' not in conf:
+            raise Exception(
+                'Cannot update unpinned channel "%s" (Run "pin" before "update")' %
+                section)
+
+        return fetch_with_nix_prefetch_url(
+            v, conf['tarball_url'], Digest16(
+                conf['tarball_sha256']))
+
+
 def compare(a: str, b: str) -> Tuple[List[str], List[str], List[str]]:
 
     def throw(error: OSError) -> None:
@@ -108,16 +219,16 @@ def compare(a: str, b: str) -> Tuple[List[str], List[str], List[str]]:
     return filecmp.cmpfiles(a, b, files, shallow=False)
 
 
-def fetch(v: Verification, channel: Channel) -> None:
+def fetch(v: Verification, channel: TarrableSearchPath) -> 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)
-    v.check('Got forwarded', channel.url != channel.forwarded_url)
+    v.result(request.status == 200)  # type: ignore  # (for old mypy)
+    v.check('Got forwarded', channel.channel_url != channel.forwarded_url)
 
 
-def parse_channel(v: Verification, channel: Channel) -> 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()
@@ -148,6 +259,7 @@ def parse_channel(v: Verification, channel: Channel) -> 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:
@@ -166,7 +278,7 @@ def digest_file(filename: str) -> Digest16:
 def to_Digest16(v: Verification, digest32: Digest32) -> Digest16:
     v.status('Converting digest to base16')
     process = subprocess.run(
-        ['nix', 'to-base16', '--type', 'sha256', digest32], capture_output=True)
+        ['nix', 'to-base16', '--type', 'sha256', digest32], stdout=subprocess.PIPE)
     v.result(process.returncode == 0)
     return Digest16(process.stdout.decode().strip())
 
@@ -174,7 +286,7 @@ def to_Digest16(v: Verification, digest32: Digest32) -> Digest16:
 def to_Digest32(v: Verification, digest16: Digest16) -> Digest32:
     v.status('Converting digest to base32')
     process = subprocess.run(
-        ['nix', 'to-base32', '--type', 'sha256', digest16], capture_output=True)
+        ['nix', 'to-base32', '--type', 'sha256', digest16], stdout=subprocess.PIPE)
     v.result(process.returncode == 0)
     return Digest32(process.stdout.decode().strip())
 
@@ -185,7 +297,7 @@ def fetch_with_nix_prefetch_url(
         digest: Digest16) -> str:
     v.status('Fetching %s' % url)
     process = subprocess.run(
-        ['nix-prefetch-url', '--print-path', url, digest], capture_output=True)
+        ['nix-prefetch-url', '--print-path', url, digest], stdout=subprocess.PIPE)
     v.result(process.returncode == 0)
     prefetch_digest, path, empty = process.stdout.decode().split('\n')
     assert empty == ''
@@ -194,77 +306,133 @@ def fetch_with_nix_prefetch_url(
     v.status("Verifying file digest")
     file_digest = digest_file(path)
     v.result(file_digest == digest)
-    return path
+    return path  # type: ignore  # (for old mypy)
 
 
-def fetch_resources(v: Verification, channel: Channel) -> None:
+def fetch_resources(
+        v: Verification,
+        channel: ChannelSearchPath,
+        pin: GitPin) -> 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(
-            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:
+    return os.path.join(
+        xdg.XDG_CACHE_HOME,
+        'pinch/git',
+        digest_string(git_repo.encode()))
+
+
+def tarball_cache_file(channel: TarrableSearchPath) -> 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))
+
+
+def verify_git_ancestry(v: Verification, channel: TarrableSearchPath) -> None:
+    cachedir = git_cachedir(channel.git_repo)
+    v.status('Verifying rev is an ancestor of ref')
+    process = subprocess.run(['git',
+                              '-C',
+                              cachedir,
+                              'merge-base',
+                              '--is-ancestor',
+                              channel.git_revision,
+                              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',
+                                  cachedir,
+                                  'merge-base',
+                                  '--is-ancestor',
+                                  channel.old_git_revision,
+                                  channel.git_revision])
+        v.result(process.returncode == 0)
 
 
-def git_fetch(v: Verification, channel: Channel) -> None:
+def git_fetch(v: Verification, channel: TarrableSearchPath) -> None:
     # 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
     # details for my comfort.  So we re-implement here half of nix.fetchGit.
     # :(
 
-    # TODO: Consider using pyxdg to find this path.
-    channel.git_cachedir = os.path.expanduser(
-        '~/.cache/nix-pin-channel/git/%s' %
-        digest_string(
-            channel.url.encode()))
-    if not os.path.exists(channel.git_cachedir):
+    cachedir = git_cachedir(channel.git_repo)
+    if not os.path.exists(cachedir):
         v.status("Initializing git repo")
         process = subprocess.run(
-            ['git', 'init', '--bare', channel.git_cachedir])
+            ['git', 'init', '--bare', 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_revision])
-    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)
-        # We don't use --force here because we want to abort and freak out if forced
-        # updates are happening.
-        process = subprocess.run(['git',
-                                  '-C',
-                                  channel.git_cachedir,
-                                  'fetch',
-                                  channel.git_repo,
-                                  '%s:%s' % (channel.git_ref,
-                                             channel.git_ref)])
-        v.result(process.returncode == 0)
+    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',
+                              '-C',
+                              cachedir,
+                              'fetch',
+                              channel.git_repo,
+                              '%s:%s' % (channel.git_ref,
+                                         channel.git_ref)])
+    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])
+            ['git', '-C', cachedir, 'cat-file', '-e', channel.git_revision])
         v.result(process.returncode == 0)
+    else:
+        channel.git_revision = open(
+            os.path.join(
+                cachedir,
+                'refs',
+                'heads',
+                channel.git_ref)).read(999).strip()
 
-    v.status('Verifying rev is an ancestor of ref')
-    process = subprocess.run(['git',
-                              '-C',
-                              channel.git_cachedir,
-                              'merge-base',
-                              '--is-ancestor',
-                              channel.git_revision,
-                              channel.git_ref])
-    v.result(process.returncode == 0)
+    verify_git_ancestry(v, channel)
+
+
+def ensure_git_rev_available(
+        v: Verification,
+        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', pin.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)
+        if process.returncode == 0:
+            verify_git_ancestry(v, channel)
+            return
+    git_fetch(v, channel)
 
 
 def compare_tarball_and_git(
         v: Verification,
-        channel: Channel,
+        channel: TarrableSearchPath,
         channel_contents: str,
         git_contents: str) -> None:
     v.status('Comparing channel tarball with git checkout')
@@ -295,7 +463,10 @@ def compare_tarball_and_git(
         len(benign_errors) == len(expected_errors))
 
 
-def extract_tarball(v: Verification, channel: Channel, dest: str) -> None:
+def extract_tarball(
+        v: Verification,
+        channel: TarrableSearchPath,
+        dest: str) -> None:
     v.status('Extracting tarball %s' %
              channel.table['nixexprs.tar.xz'].file)
     shutil.unpack_archive(
@@ -304,25 +475,69 @@ def extract_tarball(v: Verification, channel: Channel, dest: str) -> None:
     v.ok()
 
 
-def git_checkout(v: Verification, channel: Channel, dest: str) -> None:
+def git_checkout(
+        v: Verification,
+        channel: TarrableSearchPath,
+        dest: str) -> None:
     v.status('Checking out corresponding git revision')
     git = subprocess.Popen(['git',
                             '-C',
-                            channel.git_cachedir,
+                            git_cachedir(channel.git_repo),
                             'archive',
                             channel.git_revision],
                            stdout=subprocess.PIPE)
     tar = subprocess.Popen(
         ['tar', 'x', '-C', dest, '-f', '-'], stdin=git.stdout)
-    git.stdout.close()
+    if git.stdout:
+        git.stdout.close()
     tar.wait()
     git.wait()
     v.result(git.returncode == 0 and tar.returncode == 0)
 
 
+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)
+        if os.path.exists(cached_tarball):
+            return cached_tarball
+
+    with tempfile.TemporaryDirectory() as output_dir:
+        output_filename = os.path.join(
+            output_dir, pin.release_name + '.tar.xz')
+        with open(output_filename, 'w') as output_file:
+            v.status(
+                'Generating tarball for git revision %s' %
+                pin.git_revision)
+            git = subprocess.Popen(['git',
+                                    '-C',
+                                    git_cachedir(channel.git_repo),
+                                    'archive',
+                                    '--prefix=%s/' % pin.release_name,
+                                    pin.git_revision],
+                                   stdout=subprocess.PIPE)
+            xz = subprocess.Popen(['xz'], stdin=git.stdout, stdout=output_file)
+            xz.wait()
+            git.wait()
+            v.result(git.returncode == 0 and xz.returncode == 0)
+
+        v.status('Putting tarball in Nix store')
+        process = subprocess.run(
+            ['nix-store', '--add', output_filename], stdout=subprocess.PIPE)
+        v.result(process.returncode == 0)
+        store_tarball = process.stdout.decode().strip()
+
+        os.makedirs(os.path.dirname(cache_file), exist_ok=True)
+        open(cache_file, 'w').write(store_tarball)
+        return store_tarball  # type: ignore  # (for old mypy)
+
+
 def check_channel_metadata(
         v: Verification,
-        channel: Channel,
+        channel: TarrableSearchPath,
         channel_contents: str) -> None:
     v.status('Verifying git commit in channel tarball')
     v.result(
@@ -344,7 +559,9 @@ def check_channel_metadata(
     v.result(channel.release_name.endswith(version_suffix))
 
 
-def check_channel_contents(v: Verification, channel: Channel) -> None:
+def check_channel_contents(
+        v: Verification,
+        channel: TarrableSearchPath) -> None:
     with tempfile.TemporaryDirectory() as channel_contents, \
             tempfile.TemporaryDirectory() as git_contents:
 
@@ -359,17 +576,115 @@ def check_channel_contents(v: Verification, channel: Channel) -> None:
     v.ok()
 
 
-def main(argv: List[str]) -> None:
-    v = Verification()
+def git_revision_name(v: Verification, channel: TarrableSearchPath) -> str:
+    v.status('Getting commit date')
+    process = subprocess.run(['git',
+                              '-C',
+                              git_cachedir(channel.git_repo),
+                              'log',
+                              '-n1',
+                              '--format=%ct-%h',
+                              '--abbrev=11',
+                              '--no-show-signature',
+                              channel.git_revision],
+                             stdout=subprocess.PIPE)
+    v.result(process.returncode == 0 and process.stdout != b'')
+    return '%s-%s' % (os.path.basename(channel.git_repo),
+                      process.stdout.decode().strip())
+
+
+def read_search_path(conf: configparser.SectionProxy) -> SearchPath:
+    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:
     config = configparser.ConfigParser()
-    config.read_file(open(argv[1]), argv[1])
-    channel = Channel(**dict(config['nixos'].items()))
-    fetch(v, channel)
-    parse_channel(v, channel)
-    fetch_resources(v, channel)
-    git_fetch(v, channel)
-    check_channel_contents(v, channel)
-    print(channel)
+    config.read_file(open(filename), filename)
+    return config
+
+
+def read_config_files(
+        filenames: Iterable[str]) -> Dict[str, configparser.SectionProxy]:
+    merged_config: Dict[str, configparser.SectionProxy] = {}
+    for file in filenames:
+        config = read_config(file)
+        for section in config.sections():
+            if section in merged_config:
+                raise Exception('Duplicate channel "%s"' % section)
+            merged_config[section] = config[section]
+    return merged_config
+
+
+def pinCommand(args: argparse.Namespace) -> None:
+    v = Verification()
+    config = read_config(args.channels_file)
+    for section in config.sections():
+        if args.channels and section not in args.channels:
+            continue
+
+        sp = read_search_path(config[section])
+
+        config[section].update(sp.pin(v)._asdict())
+
+    with open(args.channels_file, 'w') as configfile:
+        config.write(configfile)
+
+
+def updateCommand(args: argparse.Namespace) -> None:
+    v = Verification()
+    exprs: Dict[str, str] = {}
+    config = read_config_files(args.channels_file)
+    for section in config:
+        sp = read_search_path(config[section])
+        if isinstance(sp, AliasSearchPath):
+            assert 'git_repo' not in config[section]
+            continue
+        tarball = sp.fetch(v, section, config[section])
+        exprs[section] = (
+            'f: f { name = "%s"; channelName = "%%s"; src = builtins.storePath "%s"; }' %
+            (config[section]['release_name'], tarball))
+
+    for section in config:
+        if 'alias_of' in config[section]:
+            exprs[section] = exprs[str(config[section]['alias_of'])]
+
+    command = [
+        'nix-env',
+        '--profile',
+        '/nix/var/nix/profiles/per-user/%s/channels' %
+        getpass.getuser(),
+        '--show-trace',
+        '--file',
+        '<nix/unpack-channel.nix>',
+        '--install',
+        '--from-expression'] + [exprs[name] % name for name in sorted(exprs.keys())]
+    if args.dry_run:
+        print(' '.join(map(shlex.quote, command)))
+    else:
+        v.status('Installing channels with nix-env')
+        process = subprocess.run(command)
+        v.result(process.returncode == 0)
+
+
+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.add_argument('channels', type=str, nargs='*')
+    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=updateCommand)
+    args = parser.parse_args()
+    args.func(args)
 
 
-main(sys.argv)
+if __name__ == '__main__':
+    main()