X-Git-Url: http://git.scottworley.com/pinch/blobdiff_plain/7f4c3ace15d9dc80a366743e5f7a38ec7b2af201..3258ff2c4690f84d827b466d03e47042750774df:/pinch.py?ds=sidebyside diff --git a/pinch.py b/pinch.py index ea380a3..f4fd0b5 100644 --- a/pinch.py +++ b/pinch.py @@ -25,6 +25,7 @@ from typing import ( Mapping, NamedTuple, NewType, + Optional, Tuple, Type, Union, @@ -132,43 +133,51 @@ class TarrableSearchPath(SearchPath, ABC): # pylint: disable=abstract-method 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: + old_revision = ( + self.git_revision if hasattr(self, 'git_revision') else None) 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) + new_revision = git_fetch(v, self, None, old_revision) + return GitPin(release_name=git_revision_name(v, self, new_revision), + git_revision=new_revision) def fetch(self, v: Verification, section: str, conf: configparser.SectionProxy) -> str: - if 'git_repo' not in conf or 'release_name' not in conf: + 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) - return git_get_tarball(v, self) + ensure_git_rev_available(v, self, the_pin, None) + return git_get_tarball(v, self, the_pin) class ChannelSearchPath(TarrableSearchPath): def pin(self, v: Verification) -> ChannelPin: + old_revision = ( + self.git_revision if hasattr(self, 'git_revision') else None) if hasattr(self, 'git_revision'): - self.old_git_revision = self.git_revision del self.git_revision - pin_channel(v, self) + fetch(v, self) + new_gitpin = parse_channel(v, self) + fetch_resources(v, self, new_gitpin) + ensure_git_rev_available(v, self, new_gitpin, old_revision) + check_channel_contents(v, self, new_gitpin) return ChannelPin( - release_name=self.release_name, + release_name=new_gitpin.release_name, tarball_url=self.table['nixexprs.tar.xz'].absolute_url, tarball_sha256=self.table['nixexprs.tar.xz'].digest, - git_revision=self.git_revision) + git_revision=new_gitpin.git_revision) # Lint TODO: Put tarball_url and tarball_sha256 in ChannelSearchPath # pylint: disable=no-self-use @@ -221,7 +230,7 @@ def fetch(v: Verification, channel: TarrableSearchPath) -> None: v.check('Got forwarded', channel.channel_url != channel.forwarded_url) -def parse_channel(v: Verification, channel: TarrableSearchPath) -> 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() @@ -232,12 +241,11 @@ def parse_channel(v: Verification, channel: TarrableSearchPath) -> None: h1_name = d.getElementsByTagName('h1')[0].firstChild.nodeValue.split()[2] v.status(title_name) v.result(title_name == h1_name) - channel.release_name = title_name v.status('Extracting git commit:') git_commit_node = d.getElementsByTagName('tt')[0] - channel.git_revision = git_commit_node.firstChild.nodeValue - v.status(channel.git_revision) + git_revision = git_commit_node.firstChild.nodeValue + v.status(git_revision) v.ok() v.status('Verifying git commit label') v.result(git_commit_node.previousSibling.nodeValue == 'Git commit ') @@ -252,6 +260,7 @@ def parse_channel(v: Verification, channel: TarrableSearchPath) -> None: channel.table[name] = ChannelTableEntry( url=url, digest=digest, size=size) v.ok() + return GitPin(release_name=title_name, git_revision=git_revision) def digest_string(s: bytes) -> Digest16: @@ -301,7 +310,10 @@ def fetch_with_nix_prefetch_url( return path # type: ignore # (for old mypy) -def fetch_resources(v: Verification, channel: TarrableSearchPath) -> None: +def fetch_resources( + v: Verification, + channel: ChannelSearchPath, + pin: GitPin) -> None: for resource in ['git-revision', 'nixexprs.tar.xz']: fields = channel.table[resource] fields.absolute_url = urllib.parse.urljoin( @@ -311,7 +323,7 @@ def fetch_resources(v: Verification, channel: TarrableSearchPath) -> None: 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: @@ -321,17 +333,21 @@ def git_cachedir(git_repo: str) -> str: digest_string(git_repo.encode())) -def tarball_cache_file(channel: TarrableSearchPath) -> str: +def tarball_cache_file(channel: TarrableSearchPath, pin: GitPin) -> 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)) + pin.git_revision, + pin.release_name)) -def verify_git_ancestry(v: Verification, channel: TarrableSearchPath) -> None: +def verify_git_ancestry( + v: Verification, + channel: TarrableSearchPath, + new_revision: str, + old_revision: Optional[str]) -> None: cachedir = git_cachedir(channel.git_repo) v.status('Verifying rev is an ancestor of ref') process = subprocess.run(['git', @@ -339,25 +355,29 @@ def verify_git_ancestry(v: Verification, channel: TarrableSearchPath) -> None: cachedir, 'merge-base', '--is-ancestor', - channel.git_revision, + new_revision, channel.git_ref]) v.result(process.returncode == 0) - if hasattr(channel, 'old_git_revision'): + if old_revision is not None: v.status( 'Verifying rev is an ancestor of previous rev %s' % - channel.old_git_revision) + old_revision) process = subprocess.run(['git', '-C', cachedir, 'merge-base', '--is-ancestor', - channel.old_git_revision, - channel.git_revision]) + old_revision, + new_revision]) v.result(process.returncode == 0) -def git_fetch(v: Verification, channel: TarrableSearchPath) -> None: +def git_fetch( + v: Verification, + channel: TarrableSearchPath, + desired_revision: Optional[str], + old_revision: Optional[str]) -> str: # 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 @@ -383,49 +403,53 @@ def git_fetch(v: Verification, channel: TarrableSearchPath) -> None: channel.git_ref)]) v.result(process.returncode == 0) - if hasattr(channel, 'git_revision'): + if desired_revision is not None: v.status('Verifying that fetch retrieved this rev') process = subprocess.run( - ['git', '-C', cachedir, 'cat-file', '-e', channel.git_revision]) + ['git', '-C', cachedir, 'cat-file', '-e', desired_revision]) v.result(process.returncode == 0) - else: - channel.git_revision = open( - os.path.join( - cachedir, - 'refs', - 'heads', - channel.git_ref)).read(999).strip() - verify_git_ancestry(v, channel) + new_revision = open( + os.path.join( + cachedir, + 'refs', + 'heads', + channel.git_ref)).read(999).strip() + + verify_git_ancestry(v, channel, new_revision, old_revision) + + return new_revision def ensure_git_rev_available( v: Verification, - channel: TarrableSearchPath) -> None: + channel: TarrableSearchPath, + pin: GitPin, + old_revision: Optional[str]) -> 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', channel.git_revision]) + ['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) + verify_git_ancestry(v, channel, pin.git_revision, old_revision) return - git_fetch(v, channel) + git_fetch(v, channel, pin.git_revision, old_revision) def compare_tarball_and_git( v: Verification, - channel: TarrableSearchPath, + pin: GitPin, channel_contents: str, git_contents: str) -> None: v.status('Comparing channel tarball with git checkout') match, mismatch, errors = compare(os.path.join( - channel_contents, channel.release_name), git_contents) + channel_contents, pin.release_name), git_contents) v.ok() v.check('%d files match' % len(match), len(match) > 0) v.check('%d files differ' % len(mismatch), len(mismatch) == 0) @@ -466,13 +490,14 @@ def extract_tarball( def git_checkout( v: Verification, channel: TarrableSearchPath, + pin: GitPin, dest: str) -> None: v.status('Checking out corresponding git revision') git = subprocess.Popen(['git', '-C', git_cachedir(channel.git_repo), 'archive', - channel.git_revision], + pin.git_revision], stdout=subprocess.PIPE) tar = subprocess.Popen( ['tar', 'x', '-C', dest, '-f', '-'], stdin=git.stdout) @@ -483,8 +508,11 @@ def git_checkout( v.result(git.returncode == 0 and tar.returncode == 0) -def git_get_tarball(v: Verification, channel: TarrableSearchPath) -> str: - cache_file = tarball_cache_file(channel) +def git_get_tarball( + v: Verification, + channel: TarrableSearchPath, + pin: GitPin) -> str: + cache_file = tarball_cache_file(channel, pin) if os.path.exists(cache_file): cached_tarball = open(cache_file).read(9999) if os.path.exists(cached_tarball): @@ -492,17 +520,17 @@ def git_get_tarball(v: Verification, channel: TarrableSearchPath) -> str: with tempfile.TemporaryDirectory() as output_dir: output_filename = os.path.join( - output_dir, channel.release_name + '.tar.xz') + output_dir, pin.release_name + '.tar.xz') with open(output_filename, 'w') as output_file: v.status( 'Generating tarball for git revision %s' % - channel.git_revision) + pin.git_revision) git = subprocess.Popen(['git', '-C', git_cachedir(channel.git_repo), 'archive', - '--prefix=%s/' % channel.release_name, - channel.git_revision], + '--prefix=%s/' % pin.release_name, + pin.git_revision], stdout=subprocess.PIPE) xz = subprocess.Popen(['xz'], stdin=git.stdout, stdout=output_file) xz.wait() @@ -522,54 +550,50 @@ def git_get_tarball(v: Verification, channel: TarrableSearchPath) -> str: def check_channel_metadata( v: Verification, - channel: TarrableSearchPath, + pin: GitPin, 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) + pin.release_name, + '.git-revision')).read(999) == pin.git_revision) v.status( 'Verifying version-suffix is a suffix of release name %s:' % - channel.release_name) + pin.release_name) version_suffix = open( os.path.join( channel_contents, - channel.release_name, + pin.release_name, '.version-suffix')).read(999) v.status(version_suffix) - v.result(channel.release_name.endswith(version_suffix)) + v.result(pin.release_name.endswith(version_suffix)) def check_channel_contents( v: Verification, - channel: TarrableSearchPath) -> None: + channel: TarrableSearchPath, + pin: GitPin) -> 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) + check_channel_metadata(v, pin, channel_contents) - git_checkout(v, channel, git_contents) + git_checkout(v, channel, pin, git_contents) - compare_tarball_and_git(v, channel, channel_contents, git_contents) + compare_tarball_and_git(v, pin, channel_contents, git_contents) v.status('Removing temporary directories') v.ok() -def pin_channel(v: Verification, channel: TarrableSearchPath) -> None: - fetch(v, channel) - parse_channel(v, channel) - fetch_resources(v, channel) - ensure_git_rev_available(v, channel) - check_channel_contents(v, channel) - - -def git_revision_name(v: Verification, channel: TarrableSearchPath) -> str: +def git_revision_name( + v: Verification, + channel: TarrableSearchPath, + git_revision: str) -> str: v.status('Getting commit date') process = subprocess.run(['git', '-C', @@ -579,7 +603,7 @@ def git_revision_name(v: Verification, channel: TarrableSearchPath) -> str: '--format=%ct-%h', '--abbrev=11', '--no-show-signature', - channel.git_revision], + git_revision], stdout=subprocess.PIPE) v.result(process.returncode == 0 and process.stdout != b'') return '%s-%s' % (os.path.basename(channel.git_repo), @@ -613,7 +637,7 @@ def read_config_files( return merged_config -def pin(args: argparse.Namespace) -> None: +def pinCommand(args: argparse.Namespace) -> None: v = Verification() config = read_config(args.channels_file) for section in config.sections(): @@ -628,7 +652,7 @@ def pin(args: argparse.Namespace) -> None: config.write(configfile) -def update(args: argparse.Namespace) -> None: +def updateCommand(args: argparse.Namespace) -> None: v = Verification() exprs: Dict[str, str] = {} config = read_config_files(args.channels_file) @@ -670,11 +694,11 @@ def main() -> None: 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=pin) + 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=update) + parser_update.set_defaults(func=updateCommand) args = parser.parse_args() args.func(args)