Release: 1.5.1

[pinch] / pinch.py

diff --git a/pinch.py b/pinch.py
index 8bda816bd2c2d80f86bb7ae8416cefe95d4aa998..47f4e34a261779d1a880a7693e8cc66b22f2f871 100644 (file)
--- a/pinch.py
+++ b/pinch.py
@@ -7,8 +7,10 @@ import hashlib
 import operator
 import os
 import os.path
 import operator
 import os
 import os.path

+import shlex

 import shutil
 import subprocess
 import shutil
 import subprocess

+import sys

 import tempfile
 import types
 import urllib.parse
 import tempfile
 import types
 import urllib.parse


@@ -23,6 +25,19 @@ from typing import (
     Tuple,
 )
 
     Tuple,
 )
 

+# Use xdg module when it's less painful to have as a dependency
+
+
+class XDG(types.SimpleNamespace):
+    XDG_CACHE_HOME: str
+
+
+xdg = XDG(
+    XDG_CACHE_HOME=os.getenv(
+        'XDG_CACHE_HOME',
+        os.path.expanduser('~/.cache')))
+
+

 Digest16 = NewType('Digest16', str)
 Digest32 = NewType('Digest32', str)
 
 Digest16 = NewType('Digest16', str)
 Digest32 = NewType('Digest32', str)
 


@@ -36,6 +51,7 @@ class ChannelTableEntry(types.SimpleNamespace):
 
 
 class Channel(types.SimpleNamespace):
 
 
 class Channel(types.SimpleNamespace):

+    alias_of: str

     channel_html: bytes
     channel_url: str
     forwarded_url: str
     channel_html: bytes
     channel_url: str
     forwarded_url: str


@@ -57,7 +73,7 @@ class Verification:
         self.line_length = 0
 
     def status(self, s: str) -> None:
         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
         self.line_length += 1 + len(s)  # Unicode??
 
     @staticmethod


@@ -67,9 +83,9 @@ class Verification:
     def result(self, r: bool) -> None:
         message, color = {True: ('OK ', 92), False: ('FAIL', 91)}[r]
         length = len(message)
     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
         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()
         self.line_length = 0
         if not r:
             raise VerificationError()


@@ -115,7 +131,7 @@ def fetch(v: Verification, channel: Channel) -> None:
     request = urllib.request.urlopen(channel.channel_url, timeout=10)
     channel.channel_html = request.read()
     channel.forwarded_url = request.geturl()
     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)
 
 
     v.check('Got forwarded', channel.channel_url != channel.forwarded_url)
 
 


@@ -168,7 +184,7 @@ def digest_file(filename: str) -> Digest16:
 def to_Digest16(v: Verification, digest32: Digest32) -> Digest16:
     v.status('Converting digest to base16')
     process = subprocess.run(
 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())
 
     v.result(process.returncode == 0)
     return Digest16(process.stdout.decode().strip())
 


@@ -176,7 +192,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(
 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())
 
     v.result(process.returncode == 0)
     return Digest32(process.stdout.decode().strip())
 


@@ -187,7 +203,7 @@ def fetch_with_nix_prefetch_url(
         digest: Digest16) -> str:
     v.status('Fetching %s' % url)
     process = subprocess.run(
         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 == ''
     v.result(process.returncode == 0)
     prefetch_digest, path, empty = process.stdout.decode().split('\n')
     assert empty == ''


@@ -196,7 +212,7 @@ def fetch_with_nix_prefetch_url(
     v.status("Verifying file digest")
     file_digest = digest_file(path)
     v.result(file_digest == digest)
     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: Channel) -> None:


@@ -213,11 +229,20 @@ def fetch_resources(v: Verification, channel: Channel) -> None:
 
 
 def git_cachedir(git_repo: str) -> str:
 
 
 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 tarball_cache_file(channel: Channel) -> 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: Channel) -> None:
 
 
 def verify_git_ancestry(v: Verification, channel: Channel) -> None:


@@ -357,13 +382,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)
                            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:
     tar.wait()
     git.wait()
     v.result(git.returncode == 0 and tar.returncode == 0)
 
 
 def git_get_tarball(v: Verification, channel: Channel) -> 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')
     with tempfile.TemporaryDirectory() as output_dir:
         output_filename = os.path.join(
             output_dir, channel.release_name + '.tar.xz')


@@ -385,9 +417,13 @@ def git_get_tarball(v: Verification, channel: Channel) -> str:
 
         v.status('Putting tarball in Nix store')
         process = subprocess.run(
 
         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)
         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(
 
 
 def check_channel_metadata(


@@ -442,26 +478,37 @@ def git_revision_name(v: Verification, channel: Channel) -> str:
     process = subprocess.run(['git',
                               '-C',
                               git_cachedir(channel.git_repo),
     process = subprocess.run(['git',
                               '-C',
                               git_cachedir(channel.git_repo),

-                              'lo',
+                              'log',

                               '-n1',
                               '--format=%ct-%h',
                               '--abbrev=11',
                               '-n1',
                               '--format=%ct-%h',
                               '--abbrev=11',

+                              '--no-show-signature',

                               channel.git_revision],
                               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())
 
 
     return '%s-%s' % (os.path.basename(channel.git_repo),
                       process.stdout.decode().strip())
 
 

+def read_config(filename: str) -> configparser.ConfigParser:
+    config = configparser.ConfigParser()
+    config.read_file(open(filename), filename)
+    return config
+
+

 def pin(args: argparse.Namespace) -> None:
     v = Verification()
 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()))
     for section in config.sections():
         if args.channels and section not in args.channels:
             continue
 
         channel = Channel(**dict(config[section].items()))

+
+        if hasattr(channel, 'alias_of'):
+            assert not hasattr(channel, 'git_repo')
+            continue
+

         if hasattr(channel, 'git_revision'):
             channel.old_git_revision = channel.git_revision
             del channel.git_revision
         if hasattr(channel, 'git_revision'):
             channel.old_git_revision = channel.git_revision
             del channel.git_revision


@@ -480,37 +527,65 @@ def pin(args: argparse.Namespace) -> None:
         config.write(configfile)
 
 
         config.write(configfile)
 
 

+def fetch_channel(
+        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']))
+
+    channel = Channel(**dict(conf.items()))
+    ensure_git_rev_available(v, channel)
+    return git_get_tarball(v, channel)
+
+

 def update(args: argparse.Namespace) -> None:
     v = Verification()
     config = configparser.ConfigParser()
 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',
-            '<nix/unpack-channel.nix>',
-            '--install',
-            '--from-expression'] +
-        exprs)
-    v.result(process.returncode == 0)
+    exprs: Dict[str, str] = {}
+    configs = [read_config(filename) for filename in args.channels_file]
+    for config in configs:
+        for section in config.sections():
+            if 'alias_of' in config[section]:
+                assert 'git_repo' not in config[section]
+                continue
+            tarball = fetch_channel(v, section, config[section])
+            if section in exprs:
+                raise Exception('Duplicate channel "%s"' % section)
+            exprs[section] = (
+                'f: f { name = "%s"; channelName = "%%s"; src = builtins.storePath "%s"; }' %
+                (config[section]['release_name'], tarball))
+
+    for config in configs:
+        for section in config.sections():
+            if 'alias_of' in config[section]:
+                if section in exprs:
+                    raise Exception('Duplicate channel "%s"' % 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:
 
 
 def main() -> None:


@@ -521,10 +596,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_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)
 
 
     parser_update.set_defaults(func=update)
     args = parser.parse_args()
     args.func(args)
 
 

-main()
+if __name__ == '__main__':
+    main()