Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Issue #1855: "All Bazel commands fail when changing a Go dependency when using Bzlmod extension" #1861

Merged
merged 4 commits into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions internal/bzlmod/go_deps.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -632,11 +632,16 @@ def _go_deps_impl(module_ctx):
"local_path": module.local_path,
})
else:
go_repository_args.update({
"sum": _get_sum_from_module(path, module, sums),
repo_args = {
"replace": getattr(module, "replace", None),
"version": "v" + module.raw_version,
})
}

sum = _get_sum_from_module(path, module, sums)
if sum:
repo_args["sum"] = sum

go_repository_args.update(repo_args)

go_repository(**go_repository_args)

Expand Down Expand Up @@ -689,7 +694,10 @@ def _get_sum_from_module(path, module, sums):
# replacement have no sums, so we can skip this
return None
elif module.local_path == None:
fail("No sum for {}@{} from {} found. You may need to run: bazel run @rules_go//go -- mod tidy".format(path, module.raw_version, "parent-label-todo")) #module.parent_label))
# When updating a dependency, its sum may not be in go.sum and we can't hard fail here
# since we need Bazel to tidy the module
print("No sum for {}@{} found, run bazel run @rules_go//go -- mod tidy to generate it".format(path, module.raw_version))
return None

return sums[entry]

Expand Down
13 changes: 7 additions & 6 deletions internal/go_repository.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ def _go_repository_impl(ctx):
fetch_repo_args = None
gazelle_path = None

is_module_extension_repo = bool(ctx.attr.internal_only_do_not_use_apparent_name)

# Declare Label dependencies at the top of function to avoid unnecessary fetching:
# https://docs.bazel.build/versions/main/skylark/repository_rules.html#when-is-the-implementation-function-executed
go_env_cache = str(ctx.path(Label("@bazel_gazelle_go_repository_cache//:go.env")))
Expand Down Expand Up @@ -188,8 +190,11 @@ def _go_repository_impl(ctx):
for key in ("urls", "strip_prefix", "type", "sha256", "commit", "tag", "vcs", "remote"):
if getattr(ctx.attr, key):
fail("cannot specify both version and %s" % key)
if ctx.attr.version and not ctx.attr.sum:
fail("if version is specified, sum must also be")
if not ctx.attr.sum:
if is_module_extension_repo:
fail("No sum for {}@{} found, run bazel run @rules_go//go -- mod tidy to generate it".format(ctx.attr.importpath, ctx.attr.version))
else:
fail("if version is specified, sum must also be")
fmeum marked this conversation as resolved.
Show resolved Hide resolved

fetch_path = ctx.attr.replace if ctx.attr.replace else ctx.attr.importpath
fetch_repo_args = [
Expand Down Expand Up @@ -305,10 +310,6 @@ def _go_repository_impl(ctx):
if gazelle_path == None:
gazelle_path = ctx.path(Label(_gazelle))

# ctx.attr.name is the canonical name of this repository, which contains a '~' if and only
# if this repository is generated by a module extension rather than an invocation in
# WORKSPACE.
is_module_extension_repo = ctx.attr.internal_only_do_not_use_apparent_name
if is_module_extension_repo:
# This repository is generated by the 'go_deps' extension. Since as of Bazel 7.2.0 there
# is no API that constructs a label referencing a sibling repo from within a repo rule,
Expand Down