如何使用 bazel 构建工具在 Go 存储库中修复 envoyproxy 的验证规则 proto 依赖项答案

【问题标题】：How to fix envoyproxy's validate rules proto dependency in Go repository with bazel build tool如何使用 bazel 构建工具在 Go 存储库中修复 envoyproxy 的验证规则 proto 依赖项
【发布时间】：2021-11-23 17:55:54
【问题描述】：

我正在尝试使用 bazel 和gazelle 工具来构建一个带有预先生成的原型文件的大型 Golang 存储库。在原型定义中使用来自 envoyproxy 的验证规则存在问题，并且 bazel 工具无法使用此依赖项构建存储库。为了重现该问题，我创建了一个带有示例 gRPC 服务的github repository。如果没有 envoyproxy 的 validate proto 依赖，bazel 工具可以成功构建 go 包。但是引入这种依赖会引发错误。

用于构建存储库的命令：

在构建存储库之前生成 proto 文件。

protoc -I=. -I ~/go/pkg/mod/github.com/envoyproxy/protoc-gen-validate@v0.6.1 --go_out=./../../../ --validate_out="lang=go:./../../../" --go-grpc_out=./../../../ ./protos/pinger/service.proto

使用gazelle生成依赖

bazel run //:gazelle -- update-repos -from_file=go.mod -to_macro=deps.bzl%go_dependencies -build_file_proto_mode=disable_global -prune

使用gazelle生成BUILD.bazel文件

bazel run //:gazelle

构建 pinger 去二进制

bazel build //cmd/pinger

最后一个构建命令抛出错误

去/src/github.com/ihtkas/bazel-gazelle-ex/api/pinger/BUILD.bazel:3:11: 加载包时出错 '@com_github_envoyproxy_protoc_gen_validate//validate'：找不到 @com_google_protobuf//:protobuf.bzl 的包：存储库 '@com_google_protobuf' 无法解析。并被引用 '//api/pinger:pinger' 错误：分析目标'//cmd/pinger:pinger' 失败的;构建中止：分析失败

同样有一个github issue。有很多建议，但似乎没有一个对我有用。解释所有的尝试将使这个问题变得毫无用处。我需要帮助来找到一种解决方案，该解决方案将解决问题并使用带有预生成原型文件的 bazel 工具成功构建存储库。根据建议，我将在此处或同一存储库中进行实验并分享结果。

【问题讨论】：

标签： go protocol-buffers bazel envoyproxy

【解决方案1】：

这个问题可以通过以下三个步骤来解决。

-> 使用来自 envoyproxy/protoc-gen-validate 的特定提交和 bazel naming convention fix

go get github.com/envoyproxy/protoc-gen-validate@4f41f10dde19ec4dd9dd8cf6f7537139f52fb58b

-> 在 bazel WORKSPACE 中包含对“com_google_protobuf”的依赖

http_archive(
        name = "com_google_protobuf",
        sha256 = "d0f5f605d0d656007ce6c8b5a82df3037e1d8fe8b121ed42e536f569dec16113",
        strip_prefix = "protobuf-3.14.0",
        urls = [
            "https://mirror.bazel.build/github.com/protocolbuffers/protobuf/archive/v3.14.0.tar.gz",
            "https://github.com/protocolbuffers/protobuf/archive/v3.14.0.tar.gz",
        ],
    )
    
    load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")

protobuf_deps()

-> 更新 io_bazel_rules_go 到 v0.28.0

所有修复都包含在存储库中的PR and merged to a branch "working" 中以供参考。

【讨论】：