19 import xml
.dom
.minidom
39 # Use xdg module when it's less painful to have as a dependency
42 class XDG(NamedTuple
):
47 XDG_CACHE_HOME
=os
.getenv(
49 os
.path
.expanduser('~/.cache')))
52 class VerificationError(Exception):
58 def __init__(self
) -> None:
61 def status(self
, s
: str) -> None:
62 print(s
, end
=' ', file=sys
.stderr
, flush
=True)
63 self
.line_length
+= 1 + len(s
) # Unicode??
66 def _color(s
: str, c
: int) -> str:
67 return '\033[%2dm%s\033[00m' % (c
, s
)
69 def result(self
, r
: bool) -> None:
70 message
, color
= {True: ('OK ', 92), False: ('FAIL', 91)}
[r
]
72 cols
= shutil
.get_terminal_size().columns
or 80
73 pad
= (cols
- (self
.line_length
+ length
)) % cols
74 print(' ' * pad
+ self
._color
(message
, color
), file=sys
.stderr
)
77 raise VerificationError()
79 def check(self
, s
: str, r
: bool) -> None:
87 Digest16
= NewType('Digest16', str)
88 Digest32
= NewType('Digest32', str)
91 class ChannelTableEntry(types
.SimpleNamespace
):
99 class AliasPin(NamedTuple
):
103 class SymlinkPin(NamedTuple
):
105 def release_name(self
) -> str:
109 class GitPin(NamedTuple
):
114 class ChannelPin(NamedTuple
):
121 Pin
= Union
[AliasPin
, SymlinkPin
, GitPin
, ChannelPin
]
124 def copy_to_nix_store(v
: Verification
, filename
: str) -> str:
125 v
.status('Putting tarball in Nix store')
126 process
= subprocess
.run(
127 ['nix-store', '--add', filename
], stdout
=subprocess
.PIPE
)
128 v
.result(process
.returncode
== 0)
129 return process
.stdout
.decode().strip() # type: ignore # (for old mypy)
132 def symlink_archive(v
: Verification
, path
: str) -> str:
133 with tempfile
.TemporaryDirectory() as td
:
134 archive_filename
= os
.path
.join(td
, 'link.tar.gz')
135 os
.symlink(path
, os
.path
.join(td
, 'link'))
136 with tarfile
.open(archive_filename
, mode
='x:gz') as t
:
137 t
.add(os
.path
.join(td
, 'link'), arcname
='link')
138 return copy_to_nix_store(v
, archive_filename
)
141 class AliasSearchPath(NamedTuple
):
144 # pylint: disable=no-self-use
145 def pin(self
, _
: Verification
, __
: Optional
[Pin
]) -> AliasPin
:
149 class SymlinkSearchPath(NamedTuple
):
152 # pylint: disable=no-self-use
153 def pin(self
, _
: Verification
, __
: Optional
[Pin
]) -> SymlinkPin
:
156 def fetch(self
, v
: Verification
, _
: Pin
) -> str:
157 return symlink_archive(v
, self
.path
)
160 class GitSearchPath(NamedTuple
):
164 def pin(self
, v
: Verification
, old_pin
: Optional
[Pin
]) -> GitPin
:
165 _
, new_revision
= git_cache
.fetch(self
.git_repo
, self
.git_ref
)
166 if old_pin
is not None:
167 assert isinstance(old_pin
, GitPin
)
168 verify_git_ancestry(v
, self
, old_pin
.git_revision
, new_revision
)
169 return GitPin(release_name
=git_revision_name(v
, self
, new_revision
),
170 git_revision
=new_revision
)
172 def fetch(self
, v
: Verification
, pin
: Pin
) -> str:
173 assert isinstance(pin
, GitPin
)
174 git_cache
.ensure_rev_available(
175 self
.git_repo
, self
.git_ref
, pin
.git_revision
)
176 return git_get_tarball(v
, self
, pin
)
179 class ChannelSearchPath(NamedTuple
):
184 def pin(self
, v
: Verification
, old_pin
: Optional
[Pin
]) -> ChannelPin
:
185 if old_pin
is not None:
186 assert isinstance(old_pin
, ChannelPin
)
188 channel_html
, forwarded_url
= fetch_channel(v
, self
)
189 table
, new_gitpin
= parse_channel(v
, channel_html
)
190 if old_pin
is not None and old_pin
.git_revision
== new_gitpin
.git_revision
:
192 fetch_resources(v
, new_gitpin
, forwarded_url
, table
)
193 git_cache
.ensure_rev_available(
194 self
.git_repo
, self
.git_ref
, new_gitpin
.git_revision
)
195 if old_pin
is not None:
197 v
, self
, old_pin
.git_revision
, new_gitpin
.git_revision
)
198 check_channel_contents(v
, self
, table
, new_gitpin
)
200 release_name
=new_gitpin
.release_name
,
201 tarball_url
=table
['nixexprs.tar.xz'].absolute_url
,
202 tarball_sha256
=table
['nixexprs.tar.xz'].digest
,
203 git_revision
=new_gitpin
.git_revision
)
205 # pylint: disable=no-self-use
206 def fetch(self
, v
: Verification
, pin
: Pin
) -> str:
207 assert isinstance(pin
, ChannelPin
)
209 return fetch_with_nix_prefetch_url(
210 v
, pin
.tarball_url
, Digest16(pin
.tarball_sha256
))
213 SearchPath
= Union
[AliasSearchPath
,
217 TarrableSearchPath
= Union
[GitSearchPath
, ChannelSearchPath
]
220 def compare(a
: str, b
: str) -> Tuple
[List
[str], List
[str], List
[str]]:
222 def throw(error
: OSError) -> None:
225 def join(x
: str, y
: str) -> str:
226 return y
if x
== '.' else os
.path
.join(x
, y
)
228 def recursive_files(d
: str) -> Iterable
[str]:
229 all_files
: List
[str] = []
230 for path
, dirs
, files
in os
.walk(d
, onerror
=throw
):
231 rel
= os
.path
.relpath(path
, start
=d
)
232 all_files
.extend(join(rel
, f
) for f
in files
)
233 for dir_or_link
in dirs
:
234 if os
.path
.islink(join(path
, dir_or_link
)):
235 all_files
.append(join(rel
, dir_or_link
))
238 def exclude_dot_git(files
: Iterable
[str]) -> Iterable
[str]:
239 return (f
for f
in files
if not f
.startswith('.git/'))
241 files
= functools
.reduce(
244 recursive_files(x
))) for x
in [a
, b
]))
245 return filecmp
.cmpfiles(a
, b
, files
, shallow
=False)
249 v
: Verification
, channel
: ChannelSearchPath
) -> Tuple
[str, str]:
250 v
.status('Fetching channel from %s' % channel
.channel_url
)
251 request
= urllib
.request
.urlopen(channel
.channel_url
, timeout
=10)
252 channel_html
= request
.read().decode()
253 forwarded_url
= request
.geturl()
254 v
.result(request
.status
== 200) # type: ignore # (for old mypy)
255 v
.check('Got forwarded', channel
.channel_url
!= forwarded_url
)
256 return channel_html
, forwarded_url
259 def parse_channel(v
: Verification
, channel_html
: str) \
260 -> Tuple
[Dict
[str, ChannelTableEntry
], GitPin
]:
261 v
.status('Parsing channel description as XML')
262 d
= xml
.dom
.minidom
.parseString(channel_html
)
265 v
.status('Extracting release name:')
266 title_name
= d
.getElementsByTagName(
267 'title')[0].firstChild
.nodeValue
.split()[2]
268 h1_name
= d
.getElementsByTagName('h1')[0].firstChild
.nodeValue
.split()[2]
270 v
.result(title_name
== h1_name
)
272 v
.status('Extracting git commit:')
273 git_commit_node
= d
.getElementsByTagName('tt')[0]
274 git_revision
= git_commit_node
.firstChild
.nodeValue
275 v
.status(git_revision
)
277 v
.status('Verifying git commit label')
278 v
.result(git_commit_node
.previousSibling
.nodeValue
== 'Git commit ')
280 v
.status('Parsing table')
281 table
: Dict
[str, ChannelTableEntry
] = {}
282 for row
in d
.getElementsByTagName('tr')[1:]:
283 name
= row
.childNodes
[0].firstChild
.firstChild
.nodeValue
284 url
= row
.childNodes
[0].firstChild
.getAttribute('href')
285 size
= int(row
.childNodes
[1].firstChild
.nodeValue
)
286 digest
= Digest16(row
.childNodes
[2].firstChild
.firstChild
.nodeValue
)
287 table
[name
] = ChannelTableEntry(url
=url
, digest
=digest
, size
=size
)
289 return table
, GitPin(release_name
=title_name
, git_revision
=git_revision
)
292 def digest_string(s
: bytes) -> Digest16
:
293 return Digest16(hashlib
.sha256(s
).hexdigest())
296 def digest_file(filename
: str) -> Digest16
:
297 hasher
= hashlib
.sha256()
298 with open(filename
, 'rb') as f
:
299 # pylint: disable=cell-var-from-loop
300 for block
in iter(lambda: f
.read(4096), b
''):
302 return Digest16(hasher
.hexdigest())
306 def _experimental_flag_needed(v
: Verification
) -> bool:
307 v
.status('Checking Nix version')
308 process
= subprocess
.run(['nix', '--help'], stdout
=subprocess
.PIPE
)
309 v
.result(process
.returncode
== 0)
310 return b
'--experimental-features' in process
.stdout
313 def _nix_command(v
: Verification
) -> List
[str]:
314 return ['nix', '--experimental-features',
315 'nix-command'] if _experimental_flag_needed(v
) else ['nix']
318 def to_Digest16(v
: Verification
, digest32
: Digest32
) -> Digest16
:
319 v
.status('Converting digest to base16')
320 process
= subprocess
.run(_nix_command(v
) + [
325 stdout
=subprocess
.PIPE
)
326 v
.result(process
.returncode
== 0)
327 return Digest16(process
.stdout
.decode().strip())
330 def to_Digest32(v
: Verification
, digest16
: Digest16
) -> Digest32
:
331 v
.status('Converting digest to base32')
332 process
= subprocess
.run(_nix_command(v
) + [
337 stdout
=subprocess
.PIPE
)
338 v
.result(process
.returncode
== 0)
339 return Digest32(process
.stdout
.decode().strip())
342 def fetch_with_nix_prefetch_url(
345 digest
: Digest16
) -> str:
346 v
.status('Fetching %s' % url
)
347 process
= subprocess
.run(
348 ['nix-prefetch-url', '--print-path', url
, digest
], stdout
=subprocess
.PIPE
)
349 v
.result(process
.returncode
== 0)
350 prefetch_digest
, path
, empty
= process
.stdout
.decode().split('\n')
352 v
.check("Verifying nix-prefetch-url's digest",
353 to_Digest16(v
, Digest32(prefetch_digest
)) == digest
)
354 v
.status("Verifying digest of %s" % path
)
355 file_digest
= digest_file(path
)
356 v
.result(file_digest
== digest
)
357 return path
# type: ignore # (for old mypy)
364 table
: Dict
[str, ChannelTableEntry
]) -> None:
365 for resource
in ['git-revision', 'nixexprs.tar.xz']:
366 fields
= table
[resource
]
367 fields
.absolute_url
= urllib
.parse
.urljoin(forwarded_url
, fields
.url
)
368 fields
.file = fetch_with_nix_prefetch_url(
369 v
, fields
.absolute_url
, fields
.digest
)
370 v
.status('Verifying git commit on main page matches git commit in table')
371 v
.result(open(table
['git-revision'].file).read(999) == pin
.git_revision
)
374 def tarball_cache_file(channel
: TarrableSearchPath
, pin
: GitPin
) -> str:
379 (digest_string(channel
.git_repo
.encode()),
384 def verify_git_ancestry(
386 channel
: TarrableSearchPath
,
388 new_revision
: str) -> None:
389 cachedir
= git_cache
.git_cachedir(channel
.git_repo
)
390 v
.status('Verifying rev is an ancestor of previous rev %s' % old_revision
)
391 process
= subprocess
.run(['git',
398 v
.result(process
.returncode
== 0)
401 def compare_tarball_and_git(
404 channel_contents
: str,
405 git_contents
: str) -> None:
406 v
.status('Comparing channel tarball with git checkout')
407 match
, mismatch
, errors
= compare(os
.path
.join(
408 channel_contents
, pin
.release_name
), git_contents
)
410 v
.check('%d files match' % len(match
), len(match
) > 0)
411 v
.check('%d files differ' % len(mismatch
), len(mismatch
) == 0)
419 for ee
in expected_errors
:
422 benign_errors
.append(ee
)
424 '%d unexpected incomparable files' %
428 '(%d of %d expected incomparable files)' %
430 len(expected_errors
)),
431 len(benign_errors
) == len(expected_errors
))
436 table
: Dict
[str, ChannelTableEntry
],
438 v
.status('Extracting tarball %s' % table
['nixexprs.tar.xz'].file)
439 shutil
.unpack_archive(table
['nixexprs.tar.xz'].file, dest
)
445 channel
: TarrableSearchPath
,
448 v
.status('Checking out corresponding git revision')
449 git
= subprocess
.Popen(['git',
451 git_cache
.git_cachedir(channel
.git_repo
),
454 stdout
=subprocess
.PIPE
)
455 tar
= subprocess
.Popen(
456 ['tar', 'x', '-C', dest
, '-f', '-'], stdin
=git
.stdout
)
461 v
.result(git
.returncode
== 0 and tar
.returncode
== 0)
466 channel
: TarrableSearchPath
,
468 cache_file
= tarball_cache_file(channel
, pin
)
469 if os
.path
.exists(cache_file
):
470 cached_tarball
= open(cache_file
).read(9999)
471 if os
.path
.exists(cached_tarball
):
472 return cached_tarball
474 with tempfile
.TemporaryDirectory() as output_dir
:
475 output_filename
= os
.path
.join(
476 output_dir
, pin
.release_name
+ '.tar.xz')
477 with open(output_filename
, 'w') as output_file
:
479 'Generating tarball for git revision %s' %
481 git
= subprocess
.Popen(['git',
483 git_cache
.git_cachedir(channel
.git_repo
),
485 '--prefix=%s/' % pin
.release_name
,
487 stdout
=subprocess
.PIPE
)
488 xz
= subprocess
.Popen(['xz'], stdin
=git
.stdout
, stdout
=output_file
)
491 v
.result(git
.returncode
== 0 and xz
.returncode
== 0)
493 store_tarball
= copy_to_nix_store(v
, output_filename
)
495 os
.makedirs(os
.path
.dirname(cache_file
), exist_ok
=True)
496 open(cache_file
, 'w').write(store_tarball
)
497 return store_tarball
# type: ignore # (for old mypy)
500 def check_channel_metadata(
503 channel_contents
: str) -> None:
504 v
.status('Verifying git commit in channel tarball')
510 '.git-revision')).read(999) == pin
.git_revision
)
513 'Verifying version-suffix is a suffix of release name %s:' %
515 version_suffix
= open(
519 '.version-suffix')).read(999)
520 v
.status(version_suffix
)
521 v
.result(pin
.release_name
.endswith(version_suffix
))
524 def check_channel_contents(
526 channel
: TarrableSearchPath
,
527 table
: Dict
[str, ChannelTableEntry
],
528 pin
: GitPin
) -> None:
529 with tempfile
.TemporaryDirectory() as channel_contents
, \
530 tempfile
.TemporaryDirectory() as git_contents
:
532 extract_tarball(v
, table
, channel_contents
)
533 check_channel_metadata(v
, pin
, channel_contents
)
535 git_checkout(v
, channel
, pin
, git_contents
)
537 compare_tarball_and_git(v
, pin
, channel_contents
, git_contents
)
539 v
.status('Removing temporary directories')
543 def git_revision_name(
545 channel
: TarrableSearchPath
,
546 git_revision
: str) -> str:
547 v
.status('Getting commit date')
548 process
= subprocess
.run(['git',
550 git_cache
.git_cachedir(channel
.git_repo
),
555 '--no-show-signature',
557 stdout
=subprocess
.PIPE
)
558 v
.result(process
.returncode
== 0 and process
.stdout
!= b
'')
559 return '%s-%s' % (os
.path
.basename(channel
.git_repo
),
560 process
.stdout
.decode().strip())
567 def partition_dict(pred
: Callable
[[K
, V
], bool],
568 d
: Dict
[K
, V
]) -> Tuple
[Dict
[K
, V
], Dict
[K
, V
]]:
569 selected
: Dict
[K
, V
] = {}
570 remaining
: Dict
[K
, V
] = {}
571 for k
, v
in d
.items():
576 return selected
, remaining
579 def filter_dict(d
: Dict
[K
, V
], fields
: Set
[K
]
580 ) -> Tuple
[Dict
[K
, V
], Dict
[K
, V
]]:
581 return partition_dict(lambda k
, v
: k
in fields
, d
)
584 def read_config_section(
585 conf
: configparser
.SectionProxy
) -> Tuple
[SearchPath
, Optional
[Pin
]]:
586 mapping
: Mapping
[str, Tuple
[Type
[SearchPath
], Type
[Pin
]]] = {
587 'alias': (AliasSearchPath
, AliasPin
),
588 'channel': (ChannelSearchPath
, ChannelPin
),
589 'git': (GitSearchPath
, GitPin
),
590 'symlink': (SymlinkSearchPath
, SymlinkPin
),
592 SP
, P
= mapping
[conf
['type']]
593 _
, all_fields
= filter_dict(dict(conf
.items()), set(['type']))
594 pin_fields
, remaining_fields
= filter_dict(all_fields
, set(P
._fields
))
595 # Error suppression works around https://github.com/python/mypy/issues/9007
596 pin_present
= pin_fields
!= {} or P
._fields
== ()
597 pin
= P(**pin_fields
) if pin_present
else None # type: ignore
598 return SP(**remaining_fields
), pin
601 def read_pinned_config_section(
602 section
: str, conf
: configparser
.SectionProxy
) -> Tuple
[SearchPath
, Pin
]:
603 sp
, pin
= read_config_section(conf
)
606 'Cannot update unpinned channel "%s" (Run "pin" before "update")' %
611 def read_config(filename
: str) -> configparser
.ConfigParser
:
612 config
= configparser
.ConfigParser()
613 config
.read_file(open(filename
), filename
)
617 def read_config_files(
618 filenames
: Iterable
[str]) -> Dict
[str, configparser
.SectionProxy
]:
619 merged_config
: Dict
[str, configparser
.SectionProxy
] = {}
620 for file in filenames
:
621 config
= read_config(file)
622 for section
in config
.sections():
623 if section
in merged_config
:
624 raise Exception('Duplicate channel "%s"' % section
)
625 merged_config
[section
] = config
[section
]
629 def pinCommand(args
: argparse
.Namespace
) -> None:
631 config
= read_config(args
.channels_file
)
632 for section
in config
.sections():
633 if args
.channels
and section
not in args
.channels
:
636 sp
, old_pin
= read_config_section(config
[section
])
638 config
[section
].update(sp
.pin(v
, old_pin
)._asdict
())
640 with open(args
.channels_file
, 'w') as configfile
:
641 config
.write(configfile
)
644 def updateCommand(args
: argparse
.Namespace
) -> None:
646 exprs
: Dict
[str, str] = {}
647 profile_manifest
= os
.path
.join(args
.profile
, "manifest.nix")
648 search_paths
: List
[str] = [
649 "-I", "pinch_profile=" + args
.profile
,
650 "-I", "pinch_profile_manifest=" + os
.readlink(profile_manifest
)
651 ] if os
.path
.exists(profile_manifest
) else []
653 section
: read_pinned_config_section(section
, conf
) for section
,
654 conf
in read_config_files(
655 args
.channels_file
).items()}
656 alias
, nonalias
= partition_dict(
657 lambda k
, v
: isinstance(v
[0], AliasSearchPath
), config
)
659 for section
, (sp
, pin
) in sorted(nonalias
.items()):
660 assert not isinstance(sp
, AliasSearchPath
) # mypy can't see through
661 assert not isinstance(pin
, AliasPin
) # partition_dict()
662 tarball
= sp
.fetch(v
, pin
)
663 search_paths
.extend(["-I", "pinch_tarball_for_%s=%s" %
664 (pin
.release_name
, tarball
)])
666 'f: f { name = "%s"; channelName = "%%s"; src = builtins.storePath "%s"; }' %
667 (pin
.release_name
, tarball
))
669 for section
, (sp
, pin
) in alias
.items():
670 assert isinstance(sp
, AliasSearchPath
) # For mypy
671 exprs
[section
] = exprs
[sp
.alias_of
]
679 '<nix/unpack-channel.nix>',
682 ] + search_paths
+ ['--from-expression'] + [
683 exprs
[name
] % name
for name
in sorted(exprs
.keys())]
685 print(' '.join(map(shlex
.quote
, command
)))
687 v
.status('Installing channels with nix-env')
688 process
= subprocess
.run(command
)
689 v
.result(process
.returncode
== 0)
693 parser
= argparse
.ArgumentParser(prog
='pinch')
694 subparsers
= parser
.add_subparsers(dest
='mode', required
=True)
695 parser_pin
= subparsers
.add_parser('pin')
696 parser_pin
.add_argument('channels_file', type=str)
697 parser_pin
.add_argument('channels', type=str, nargs
='*')
698 parser_pin
.set_defaults(func
=pinCommand
)
699 parser_update
= subparsers
.add_parser('update')
700 parser_update
.add_argument('--dry-run', action
='store_true')
701 parser_update
.add_argument('--profile', default
=(
702 '/nix/var/nix/profiles/per-user/%s/channels' % getpass
.getuser()))
703 parser_update
.add_argument('channels_file', type=str, nargs
='+')
704 parser_update
.set_defaults(func
=updateCommand
)
705 args
= parser
.parse_args()
709 if __name__
== '__main__':