X-Git-Url: http://git.scottworley.com/pinch/blobdiff_plain/4603b1a7c9e6463deba8c974e4181bd5ce2be9ef..a67cfec99a43c3a437aeab3257552c035ebab5bf:/pinch.py?ds=inline diff --git a/pinch.py b/pinch.py index 2698226..a90ec3b 100644 --- a/pinch.py +++ b/pinch.py @@ -1,3 +1,4 @@ +from abc import ABC, abstractmethod import argparse import configparser import filecmp @@ -85,12 +86,24 @@ class ChannelTableEntry(types.SimpleNamespace): url: str -class SearchPath(types.SimpleNamespace): +class SearchPath(types.SimpleNamespace, ABC): release_name: str + @abstractmethod + def pin(self, v: Verification, conf: configparser.SectionProxy) -> None: + pass + -class Channel(SearchPath): +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 @@ -100,25 +113,6 @@ class Channel(SearchPath): old_git_revision: str table: Dict[str, ChannelTableEntry] - def pin(self, v: Verification, conf: configparser.SectionProxy) -> None: - if hasattr(self, 'alias_of'): - assert not hasattr(self, 'git_repo') - return - - if hasattr(self, 'git_revision'): - self.old_git_revision = self.git_revision - del self.git_revision - - if 'channel_url' in conf: - 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 - else: - git_fetch(v, self) - conf['release_name'] = git_revision_name(v, self) - conf['git_revision'] = self.git_revision - def fetch(self, v: Verification, section: str, conf: configparser.SectionProxy) -> str: if 'git_repo' not in conf or 'release_name' not in conf: @@ -135,6 +129,30 @@ class Channel(SearchPath): 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: @@ -163,7 +181,7 @@ 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() @@ -172,7 +190,7 @@ def fetch(v: Verification, channel: Channel) -> None: 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() @@ -252,7 +270,7 @@ def fetch_with_nix_prefetch_url( 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( @@ -272,7 +290,7 @@ def git_cachedir(git_repo: str) -> str: digest_string(git_repo.encode())) -def tarball_cache_file(channel: Channel) -> str: +def tarball_cache_file(channel: TarrableSearchPath) -> str: return os.path.join( xdg.XDG_CACHE_HOME, 'pinch/git-tarball', @@ -282,7 +300,7 @@ def tarball_cache_file(channel: Channel) -> str: channel.release_name)) -def verify_git_ancestry(v: Verification, channel: Channel) -> None: +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', @@ -308,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 @@ -350,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:') @@ -369,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') @@ -400,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( @@ -409,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', @@ -426,7 +452,7 @@ def git_checkout(v: Verification, channel: Channel, dest: str) -> None: 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) @@ -465,7 +491,7 @@ def git_get_tarball(v: Verification, channel: Channel) -> str: def check_channel_metadata( v: Verification, - channel: Channel, + channel: TarrableSearchPath, channel_contents: str) -> None: v.status('Verifying git commit in channel tarball') v.result( @@ -487,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: @@ -502,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) @@ -510,7 +538,7 @@ 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', @@ -528,7 +556,11 @@ def git_revision_name(v: Verification, channel: Channel) -> str: def read_search_path(conf: configparser.SectionProxy) -> SearchPath: - return Channel(**dict(conf.items())) + 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: @@ -569,10 +601,10 @@ def update(args: argparse.Namespace) -> None: exprs: Dict[str, str] = {} config = read_config_files(args.channels_file) for section in config: - if 'alias_of' in config[section]: + sp = read_search_path(config[section]) + if isinstance(sp, AliasSearchPath): assert 'git_repo' not in config[section] continue - sp = read_search_path(config[section]) tarball = sp.fetch(v, section, config[section]) exprs[section] = ( 'f: f { name = "%s"; channelName = "%%s"; src = builtins.storePath "%s"; }' %