WORKSPACE ルールでの非密閉動作の検出

問題を報告する ソースを表示 Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

以降では、ホストマシンは Bazel が実行されるマシンを指します。

リモート実行を使用する場合、実際のビルドやテストの手順はホストマシンでは実行されず、リモート実行システムに送信されます。ただし、ワークスペース ルールの解決に関わる手順はホストマシンで行われます。ワークスペース ルールが実行時に使用するホストマシンの情報にアクセスする場合、環境間の非互換性によりビルドが失敗する可能性があります。

リモート実行用に Bazel ルールを適応させるには、このようなワークスペース ルールを見つけて修正する必要があります。このページでは、ワークスペース ログを使用して問題が発生する可能性のあるワークスペース ルールを見つける方法について説明します。

非ハーメチック ルールを見つける

ワークスペース ルールを使用すると、デベロッパーは外部ワークスペースに依存関係を追加できますが、プロセス内で任意の処理を実行できるほど柔軟性があります。関連するコマンドはすべてローカルで実行されるため、非ハーメティシティの原因となる可能性があります。通常、非密閉型の動作は、ホストマシンとのやり取りを可能にする repository_ctx を介して導入されます。

Bazel 0.18 以降では、Bazel コマンドに --experimental_workspace_rules_log_file=[PATH] フラグを追加することで、非ハーメチックな可能性のあるアクションのログを取得できます。ここで、[PATH] はログが作成されるファイル名です。

注意事項:

  • ログには、実行されたイベントがキャプチャされます。一部の手順がキャッシュに保存されている場合、ログに表示されません。完全な結果を取得するには、事前に bazel clean --expunge を実行してください。

  • 関数が再実行されることがあります。その場合、関連するイベントがログに複数回表示されます。

  • 現在、Workspace ルールは Starlark イベントのみをログに記録します。

ワークスペースの初期化中に実行された内容を確認するには:

  1. bazel clean --expunge を実行します。このコマンドを実行すると、ローカル キャッシュとキャッシュに保存されたリポジトリが消去され、すべての初期化が再実行されます。

  2. Bazel コマンドに --experimental_workspace_rules_log_file=/tmp/workspacelog を追加して、ビルドを実行します。

    これにより、WorkspaceEvent 型のメッセージを一覧表示するバイナリ proto ファイルが生成されます。

  3. 次のコマンドを使用して Bazel ソースコードをダウンロードし、Bazel フォルダに移動します。workspacelog パーサーでワークスペース ログを解析するには、ソースコードが必要です。

    git clone https://github.com/bazelbuild/bazel.git
cd bazel

  4. Bazel ソースコード リポジトリで、ワークスペース全体のログをテキストに変換します。

    bazel build src/tools/workspacelog:parser
bazel-bin/src/tools/workspacelog/parser --log_path=/tmp/workspacelog > /tmp/workspacelog.txt

  5. 出力は非常に冗長になる可能性があり、組み込みの Bazel ルールからの出力が含まれる場合があります。

    特定のルールを出力から除外するには、--exclude_rule オプションを使用します。次に例を示します。

    bazel build src/tools/workspacelog:parser
bazel-bin/src/tools/workspacelog/parser --log_path=/tmp/workspacelog \
    --exclude_rule "//external:local_config_cc" \
    --exclude_rule "//external:dep" > /tmp/workspacelog.txt

  6. /tmp/workspacelog.txt を開き、安全でないオペレーションを確認します。

ログは、repository_ctx で実行された、非ハーメチックな可能性がある特定のアクションを説明する WorkspaceEvent メッセージで構成されます。

隔離されていない可能性があるとハイライト表示されたアクションは次のとおりです。

  • execute: ホスト環境で任意のコマンドを実行します。これらがホスト環境に依存関係を導入する可能性があるかどうかを確認します。

  • download、download_and_extract: 密閉ビルドを確保するため、sha256 が指定されていることを確認します。

  • file、template: それ自体は非ハーメチックではありませんが、ホスト環境への依存関係をリポジトリに導入するメカニズムになる可能性があります。入力の出所を把握し、ホスト環境に依存しないようにしてください。

  • os: それ自体は非密閉型ではありませんが、ホスト環境の依存関係を簡単に取得する方法です。通常、密閉ビルドはこの呼び出しを行いません。使用状況が密閉型かどうかを評価する際は、ワーカーではなくホストで実行されていることに注意してください。リモートビルドでは、ホストから環境の詳細を取得することは一般的に推奨されません。

  • symlink: 通常は安全ですが、危険な兆候がないか確認してください。リポジトリ外または絶対パスへのシンボリック リンクは、リモート ワーカーで問題を引き起こします。シンボリック リンクがホストマシンのプロパティに基づいて作成されている場合も、問題が発生する可能性があります。

  • which: ワーカーの構成が異なる場合があるため、ホストにインストールされているプログラムの確認は通常問題があります。