X-Git-Url: http://git.scottworley.com/pinch/blobdiff_plain/988531533047eac7a381e103cb59301ec165de0e..a67cfec99a43c3a437aeab3257552c035ebab5bf:/pinch.py?ds=inline diff --git a/pinch.py b/pinch.py index 8bda816..a90ec3b 100644 --- a/pinch.py +++ b/pinch.py @@ -1,3 +1,4 @@ +from abc import ABC, abstractmethod import argparse import configparser import filecmp @@ -7,8 +8,10 @@ import hashlib import operator import os import os.path +import shlex import shutil import subprocess +import sys import tempfile import types import urllib.parse @@ -23,28 +26,17 @@ from typing import ( Tuple, ) -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): - absolute_url: str - digest: Digest16 - file: str - size: int - url: str +class XDG(types.SimpleNamespace): + XDG_CACHE_HOME: str -class Channel(types.SimpleNamespace): - channel_html: bytes - channel_url: str - forwarded_url: str - git_ref: str - git_repo: str - git_revision: str - old_git_revision: str - release_name: str - table: Dict[str, ChannelTableEntry] +xdg = XDG( + XDG_CACHE_HOME=os.getenv( + 'XDG_CACHE_HOME', + os.path.expanduser('~/.cache'))) class VerificationError(Exception): @@ -57,7 +49,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 @@ -67,9 +59,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() @@ -82,6 +74,85 @@ 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 SearchPath(types.SimpleNamespace, ABC): + release_name: str + + @abstractmethod + def pin(self, v: Verification, conf: configparser.SectionProxy) -> None: + pass + + +class AliasSearchPath(SearchPath): + alias_of: str + + def pin(self, v: Verification, conf: configparser.SectionProxy) -> None: + assert not hasattr(self, 'git_repo') + + +# (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 + git_revision: str + old_git_revision: str + table: Dict[str, ChannelTableEntry] + + 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) + + if 'channel_url' in conf: + return fetch_with_nix_prefetch_url( + v, conf['tarball_url'], Digest16( + conf['tarball_sha256'])) + + ensure_git_rev_available(v, self) + return git_get_tarball(v, self) + + +class GitSearchPath(TarrableSearchPath): + def pin(self, v: Verification, conf: configparser.SectionProxy) -> None: + if hasattr(self, 'git_revision'): + self.old_git_revision = self.git_revision + del self.git_revision + + git_fetch(v, self) + conf['release_name'] = git_revision_name(v, self) + conf['git_revision'] = self.git_revision + + +class ChannelSearchPath(TarrableSearchPath): + def pin(self, v: Verification, conf: configparser.SectionProxy) -> None: + if hasattr(self, 'git_revision'): + self.old_git_revision = self.git_revision + del self.git_revision + + pin_channel(v, self) + conf['release_name'] = self.release_name + conf['tarball_url'] = self.table['nixexprs.tar.xz'].absolute_url + conf['tarball_sha256'] = self.table['nixexprs.tar.xz'].digest + conf['git_revision'] = self.git_revision + + def compare(a: str, b: str) -> Tuple[List[str], List[str], List[str]]: def throw(error: OSError) -> None: @@ -110,16 +181,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.channel_url, timeout=10) channel.channel_html = request.read() channel.forwarded_url = request.geturl() - v.result(request.status == 200) + 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) -> None: v.status('Parsing channel description as XML') d = xml.dom.minidom.parseString(channel.channel_html) v.ok() @@ -168,7 +239,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()) @@ -176,7 +247,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()) @@ -187,7 +258,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 == '' @@ -196,10 +267,10 @@ 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: TarrableSearchPath) -> None: for resource in ['git-revision', 'nixexprs.tar.xz']: fields = channel.table[resource] fields.absolute_url = urllib.parse.urljoin( @@ -213,14 +284,23 @@ def fetch_resources(v: Verification, channel: Channel) -> None: def git_cachedir(git_repo: str) -> str: - # TODO: Consider using pyxdg to find this path. - return os.path.expanduser( - '~/.cache/pinch/git/%s' % - digest_string( - git_repo.encode())) + return os.path.join( + xdg.XDG_CACHE_HOME, + 'pinch/git', + digest_string(git_repo.encode())) -def verify_git_ancestry(v: Verification, channel: Channel) -> None: +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', @@ -246,7 +326,7 @@ def verify_git_ancestry(v: Verification, channel: Channel) -> None: 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 @@ -288,7 +368,9 @@ def git_fetch(v: Verification, channel: Channel) -> None: verify_git_ancestry(v, channel) -def ensure_git_rev_available(v: Verification, channel: Channel) -> None: +def ensure_git_rev_available( + v: Verification, + channel: TarrableSearchPath) -> None: cachedir = git_cachedir(channel.git_repo) if os.path.exists(cachedir): v.status('Checking if we already have this rev:') @@ -307,7 +389,7 @@ def ensure_git_rev_available(v: Verification, channel: Channel) -> None: 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') @@ -338,7 +420,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( @@ -347,7 +432,10 @@ 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', @@ -357,13 +445,20 @@ def git_checkout(v: Verification, channel: Channel, dest: str) -> None: 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: Channel) -> str: +def git_get_tarball(v: Verification, channel: TarrableSearchPath) -> 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, channel.release_name + '.tar.xz') @@ -385,14 +480,18 @@ def git_get_tarball(v: Verification, channel: Channel) -> str: v.status('Putting tarball in Nix store') process = subprocess.run( - ['nix-store', '--add', output_filename], capture_output=True) + ['nix-store', '--add', output_filename], stdout=subprocess.PIPE) v.result(process.returncode == 0) - return process.stdout.decode().strip() + 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( @@ -414,7 +513,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: @@ -429,7 +530,7 @@ def check_channel_contents(v: Verification, channel: Channel) -> None: v.ok() -def pin_channel(v: Verification, channel: Channel) -> None: +def pin_channel(v: Verification, channel: TarrableSearchPath) -> None: fetch(v, channel) parse_channel(v, channel) fetch_resources(v, channel) @@ -437,44 +538,59 @@ def pin_channel(v: Verification, channel: Channel) -> None: check_channel_contents(v, channel) -def git_revision_name(v: Verification, channel: Channel) -> str: +def git_revision_name(v: Verification, channel: TarrableSearchPath) -> str: v.status('Getting commit date') process = subprocess.run(['git', '-C', git_cachedir(channel.git_repo), - 'lo', + 'log', '-n1', '--format=%ct-%h', '--abbrev=11', + '--no-show-signature', channel.git_revision], - capture_output=True) - v.result(process.returncode == 0 and process.stdout != '') + 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: + 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())) + + +def read_config(filename: str) -> configparser.ConfigParser: + config = configparser.ConfigParser() + 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 pin(args: argparse.Namespace) -> None: v = Verification() - config = configparser.ConfigParser() - config.read_file(open(args.channels_file), args.channels_file) + config = read_config(args.channels_file) for section in config.sections(): if args.channels and section not in args.channels: continue - channel = Channel(**dict(config[section].items())) - if hasattr(channel, 'git_revision'): - channel.old_git_revision = channel.git_revision - del channel.git_revision - - if 'channel_url' in config[section]: - pin_channel(v, channel) - config[section]['release_name'] = channel.release_name - 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]['release_name'] = git_revision_name(v, channel) - config[section]['git_revision'] = channel.git_revision + sp = read_search_path(config[section]) + + sp.pin(v, config[section]) with open(args.channels_file, 'w') as configfile: config.write(configfile) @@ -482,35 +598,38 @@ def pin(args: argparse.Namespace) -> None: def update(args: argparse.Namespace) -> None: v = Verification() - config = configparser.ConfigParser() - config.read_file(open(args.channels_file), args.channels_file) - exprs = [] - for section in config.sections(): - if 'channel_url' in config[section]: - tarball = fetch_with_nix_prefetch_url( - v, config[section]['tarball_url'], Digest16( - config[section]['tarball_sha256'])) - else: - channel = Channel(**dict(config[section].items())) - ensure_git_rev_available(v, channel) - tarball = git_get_tarball(v, channel) - exprs.append( - 'f: f { name = "%s"; channelName = "%s"; src = builtins.storePath "%s"; }' % - (config[section]['release_name'], section, tarball)) - v.status('Installing channels with nix-env') - process = subprocess.run( - [ - 'nix-env', - '--profile', - '/nix/var/nix/profiles/per-user/%s/channels' % - getpass.getuser(), - '--show-trace', - '--file', - '', - '--install', - '--from-expression'] + - exprs) - v.result(process.returncode == 0) + 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', + '', + '--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: @@ -521,10 +640,12 @@ def main() -> None: parser_pin.add_argument('channels', type=str, nargs='*') parser_pin.set_defaults(func=pin) parser_update = subparsers.add_parser('update') - parser_update.add_argument('channels_file', type=str) + parser_update.add_argument('--dry-run', action='store_true') + parser_update.add_argument('channels_file', type=str, nargs='+') parser_update.set_defaults(func=update) args = parser.parse_args() args.func(args) -main() +if __name__ == '__main__': + main()