本頁資訊適用於 Bazel 規則存放區的擁有者和維護人員。說明如何為存放區設定 Bazel 持續整合 (CI) 系統,以便測試規則與遠端執行情境的相容性。本頁的操作說明適用於儲存在 GitHub 存放區的專案。
先備知識
完成本頁的步驟之前,請確認下列事項:
- 您的 GitHub 存放區屬於 Bazel GitHub 機構的一部分。
- 您已按照 Bazel 持續整合中的說明為存放區設定 Buildkite。
設定 Bazel CI 進行測試
在您的
.bazelci/presubmit.yml
檔案中執行下列操作:a. 新增名為
rbe_ubuntu1604
的設定。b. 在
rbe_ubuntu1604
設定中,新增您要對遠端執行作業進行測試的建構和測試目標。將
bazel-toolchains
GitHub 存放區新增至WORKSPACE
檔案,並固定至最新版本。同時新增名為buildkite_config
的rbe_autoconfig
目標。這個範例會使用 BuildKite CI 為rbe_ubuntu1604
建立用於遠端執行作業的工具鍊設定。
load("@bazel_toolchains//rules:rbe_repo.bzl", "rbe_autoconfig")
rbe_autoconfig(name = "buildkite_config")
將包含變更內容的提取要求傳送至
presubmit.yml
檔案。(請參閱提取要求範例)。如要查看建構結果,請在 GitHub 中按一下 RBE (Ubuntu 16.04) 提取要求檢查的「詳細資料」,如下圖所示。在已合併提取要求且執行持續整合測試後,這個連結就會提供使用。(請參閱結果範例)。
(選用) 將 bazel test (RBE (RBE (RBE) 16.04)) 檢查設為您必須先通過測試,才能合併分支保護規則。這項設定位於 GitHub 的「Settings」>「Branches」>「Branch Protection rules」中,如下圖所示。
排解建構和測試失敗的問題
如果建構或測試失敗,原因可能如下:
預設容器中未安裝必要的建構或測試工具。 根據預設,使用
rbe_ubuntu1604
設定建構的建構作業會在rbe-ubuntu16-04
容器內執行,其中包含許多 Bazel 建構作業常用的工具。不過,如果您的規則需要預設容器中沒有的工具,則必須根據rbe-ubuntu16-04
容器建立自訂容器,並納入這些工具,後續說明。建構或測試目標使用的規則與遠端執行不相容。如要進一步瞭解與遠端執行的相容性,請參閱為 Remote Execution 調整 Bazel 規則。
在 rbe_ubuntu1604 CI 設定中使用自訂容器
rbe-ubuntu16-04
容器可於以下網址公開存取:
http://gcr.io/cloud-marketplace/google/rbe-ubuntu16-04
您可以直接從 Container Registry 提取,或是從原始碼建構。以下各節將說明這兩個選項。
開始之前,請確認您已安裝 gcloud
、docker
和 git
。如果您要從原始碼建構容器,也必須安裝最新版的 Bazel。
從 Container Registry 提取 rbe-ubuntu16-04
如要從 Container Registry 提取 rbe-ubuntu16-04
容器,請執行下列指令:
gcloud docker -- pull gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum
將 sha256-checksum 替換為最新容器的 SHA256 總和檢查碼值。
從來源建構 rbe-ubuntu16-04 容器
如要從來源建構 rbe-ubuntu16-04
容器,請按照下列步驟操作:
複製
bazel-toolchains
存放區:git clone https://github.com/bazelbuild/bazel-toolchains
如工具鍊容器所述,設定工具鍊容器目標並建構容器。
提取新建立的容器:
gcloud docker -- pull gcr.io/project-id/custom-container-namesha256-checksum
執行自訂容器
如要執行自訂容器,請執行下列其中一項操作:
如果您是從 Container Registry 提取容器,請執行下列指令:
docker run -it gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum/bin/bash
將
sha256-checksum
替換為最新容器的 SHA256 總和檢查碼值。如果從原始碼建構容器,請執行下列指令:
docker run -it gcr.io/project-id/custom-container-name@sha256:sha256sum /bin/bash
將資源新增至自訂容器
使用 Dockerfile
或 rules_docker
,將資源或原始資源的替代版本新增至 rbe-ubuntu16-04
容器。如果您是第一次使用 Docker,請閱讀以下內容:
舉例來說,下列 Dockerfile
程式碼片段會安裝 my_tool_package
:
FROM gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum
RUN apt-get update && yes | apt-get install -y my_tool_package
將自訂容器推送至 Container Registry
自訂容器後,請建構容器映像檔,並推送至 Container Registry,如下所示:
建構容器映像檔:
docker build -t custom-container-name.
docker tag custom-container-name gcr.io/project-id/custom-container-name
將容器映像檔推送到 Container Registry:
gcloud docker -- push gcr.io/project-id/custom-container-name
請前往下列網址,確認容器已推送完成:
https://console.cloud.google.com/gcr/images/project-id/GLOBAL/custom-container-name
請記下自訂容器的 SHA256 總和檢查碼。您稍後會在建構平台定義中提供這個 ID。
按照公開提供映像檔一節所述,將容器設定為可公開存取。
詳情請參閱推送及提取映像檔。
指定建構平台定義
您必須在自訂工具鍊設定中加入 Bazel 平台設定,才能讓 Bazel 選擇適合所需硬體/軟體平台的工具鍊。如要自動產生有效的平台,您可以將名為 buildkite_config
的 rbe_autoconfig
目標新增至 WORKSPACE
,其中包含可選取自訂容器的額外攻擊者。如要進一步瞭解這項設定,請參閱 rbe_autoconfig
的最新說明文件。