-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: move all manifest parsing and validation to manifest.bzl
Cleanup resolve.bzl and package_index.bzl by moving all of the manifest functionality to a separate manifest.bzl file where we now do all of the work to generate the lock: manifest parsing, validation and the package index and resolution. IMHO this is how it should be because the lock is the "frozen state" of the manifest. * _parse() parses the YAML * _from_dict validates the manifest dict and does the rest of the changes that we need to produce a manifest struct * add extra validation for e.g. duplicated architectures * _lock is the only method that's exposed to the outside and it encapsulates all of the other parts, calling _from_dict and all of the package index and resolution, to produce the lock file. * move get_dupes to util.bzl * refactor the "source" struct into the new manifest where we can now centralize a lot of the structure and logic spread across multiple parts of the code. * remove yq_toolchain_prefix since it's always "yq" and, looking at GH code search, this seems to be a copy-paste leftover from rules_js (or the other way around)... the code is always the same and it never receives a string different from "yq".
- Loading branch information
Showing
11 changed files
with
277 additions
and
129 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| "manifest" | ||
|
|
||
| load("@aspect_bazel_lib//lib:repo_utils.bzl", "repo_utils") | ||
| load(":lockfile.bzl", "lockfile") | ||
| load(":package_index.bzl", "package_index") | ||
| load(":util.bzl", "util") | ||
|
|
||
| def _parse(rctx, manifest_label): | ||
| host_yq = Label("@yq_{}//:yq{}".format( | ||
| repo_utils.platform(rctx), | ||
| ".exe" if repo_utils.is_windows(rctx) else "", | ||
| )) | ||
|
|
||
| yq_args = [ | ||
| str(rctx.path(host_yq)), | ||
| str(rctx.path(manifest_label)), | ||
| "-o=json", | ||
| ] | ||
|
|
||
| result = rctx.execute(yq_args) | ||
| if result.return_code: | ||
| err = "failed to parse manifest - '{}' exited with {}: " | ||
| err += "\nSTDOUT:\n{}\nSTDERR:\n{}" | ||
| fail(err.format( | ||
| " ".join(yq_args), | ||
| result.return_code, | ||
| result.stdout, | ||
| result.stderr, | ||
| )) | ||
|
|
||
| return json.decode(result.stdout if result.stdout != "null" else "{}") | ||
|
|
||
| def _source(src): | ||
| _ext = lambda name, ext: "%s%s" % (name, (".%s" % ext) if ext else "") | ||
|
|
||
| src["url"] = src["url"].rstrip("/") | ||
|
|
||
| index = "Packages" | ||
|
|
||
| index_path = "dists/{dist}/{comp}/binary-{arch}".format(**src) | ||
| output = "{dist}/{comp}/{arch}/{index}".format(index = index, **src) | ||
|
|
||
| return struct( | ||
| arch = src["arch"], | ||
| base_url = src["url"], | ||
| index = index, | ||
| index_full = lambda ext: _ext(index, ext), | ||
| output = output, | ||
| output_full = lambda ext: _ext(output, ext), | ||
| index_path = index_path, | ||
| index_url = lambda ext: "/".join((src["url"], index_path, _ext(index, ext))), | ||
| ) | ||
|
|
||
| def _from_dict(manifest, manifest_label): | ||
| manifest["label"] = manifest_label | ||
|
|
||
| if manifest["version"] != 1: | ||
| err = "Unsupported manifest version: {}. Please use `version: 1`" | ||
| fail(err.format(manifest["version"])) | ||
|
|
||
| for key in ("sources", "archs", "packages"): | ||
| if type(manifest[key]) != "list": | ||
| fail("`{}` should be an array".format(key)) | ||
|
|
||
| for key in ("archs", "packages"): | ||
| dupes = util.get_dupes(manifest[key]) | ||
| if dupes: | ||
| err = "Duplicate {}: {}. Please remove them from manifest {}" | ||
| fail(err.format(key, dupes, manifest["label"])) | ||
|
|
||
| sources = [] | ||
|
|
||
| for arch in manifest["archs"]: | ||
| for src in manifest["sources"]: | ||
| dist, components = src["channel"].split(" ", 1) | ||
|
|
||
| for comp in components.split(" "): | ||
| src["dist"] = dist | ||
| src["comp"] = comp | ||
| src["arch"] = arch | ||
|
|
||
| sources.append(_source(src)) | ||
|
|
||
| manifest["sources"] = sources | ||
|
|
||
| return struct(**manifest) | ||
|
|
||
| def _lock(rctx, manifest, include_transitive): | ||
| pkgindex = package_index.new(rctx, manifest) | ||
|
|
||
| lockf = lockfile.empty(rctx) | ||
|
|
||
| for arch in manifest.archs: | ||
| for package_name in manifest.packages: | ||
| resolved = package_index.parse_depends(package_name).pop() | ||
|
|
||
| rctx.report_progress("Resolving %s" % package_name) | ||
| package, dependencies = pkgindex.resolve_all( | ||
| arch = arch, | ||
| name = resolved["name"], | ||
| version = resolved["version"], | ||
| include_transitive = include_transitive, | ||
| ) | ||
|
|
||
| if not package: | ||
| fail("Unable to locate package `%s`" % package_name) | ||
|
|
||
| lockf.add_package(package, arch) | ||
|
|
||
| for dep in dependencies: | ||
| lockf.add_package(dep, arch) | ||
| lockf.add_package_dependency(package, dep, arch) | ||
|
|
||
| return lockf | ||
|
|
||
| manifest = struct( | ||
| lock = lambda rctx, manifest_label, include_transitive: _lock( | ||
| rctx, | ||
| _from_dict(_parse(rctx, manifest_label), manifest_label), | ||
| include_transitive, | ||
| ), | ||
| # NOTE: these are exposed here for testing purposes, DO NOT USE OTHERWISE | ||
| _source = _source, | ||
| _from_dict = _from_dict, | ||
| _lock = _lock, | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.