HTTP リポジトリ ルール

Nightly · 9.1 · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

次の関数は @bazel_tools//tools/build_defs/repo:http.bzl から読み込むことができます。

HTTP 経由でファイルとアーカイブをダウンロードするためのルール。

設定

これらのルールを使用するには、次のように WORKSPACE ファイルに読み込みます。

load(
    "@bazel_tools//tools/build_defs/repo:http.bzl",
    "http_archive",
    "http_file",
    "http_jar",
)

これらのルールはネイティブの http ルールの改良版であり、最終的にはネイティブのルールに置き換わります。

http_archive

http_archive(name, add_prefix, auth_patterns, build_file, build_file_content, canonical_id,
             integrity, netrc, patch_args, patch_cmds, patch_cmds_win, patch_tool, patches,
             remote_patch_strip, remote_patches, repo_mapping, sha256, strip_prefix, type, url, urls,
             workspace_file, workspace_file_content)

Bazel リポジトリを圧縮アーカイブ ファイルとしてダウンロードし、解凍して、そのターゲットをバインディングに使用できるようにします。

次のファイル拡張子がサポートされています。"zip"、"jar"、"war"、"aar"、"tar"、 "tar.gz"、"tgz"、"tar.xz"、"txz"、"tar.zst"、"tzst"、tar.bz2、"ar"、 または"deb"。

例: 現在のリポジトリに、チャット プログラムのソースコードが含まれているとします。 ルート ディレクトリは ~/chat-app です。このプログラムは、http://example.com/openssl.zip から入手できる SSL ライブラリ に依存する必要があります。この .zip ファイル には、次のディレクトリ構造が含まれています。

  WORKSPACE
  src/
    openssl.cc
    openssl.h

ローカル リポジトリで、ユーザーは openssl.BUILD ファイルを作成します。これには次のターゲット定義が含まれます。

  cc_library(
      name = "openssl-lib",
      srcs = ["src/openssl.cc"],
      hdrs = ["src/openssl.h"],
  )

次の行が ~/chat-app/WORKSPACE に追加されている場合、~/chat-app リポジトリのターゲットはこのターゲットに依存できます。

  load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

  http_archive(
      name = "my_ssl",
      url = "http://example.com/openssl.zip",
      sha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      build_file = "@//:openssl.BUILD",
  )

ターゲットは、依存関係として @my_ssl//:openssl-lib を指定します。

属性

name 名前。必須。

このリポジトリの一意の名前。

add_prefix 文字列。省略可。

リポジトリ ディレクトリからの相対パスで指定する宛先ディレクトリ。 アーカイブ内のファイルパスに `strip_prefix` （存在する場合）が適用された後、アーカイブはこのディレクトリに解凍されます。たとえば、ファイル `foo-1.2.3/src/foo.h` は `add_prefix = "bar"` と `strip_prefix = "foo-1.2.3"` の場合、`bar/src/foo.h` に解凍されます。
auth_patterns ディクショナリ: 文字列 -> 文字列。省略可。

ホスト名をカスタム認証パターンにマッピングする省略可能なディクショナリ。 URL のホスト名がこのディクショナリに存在する場合、HTTP リクエストの認証ヘッダーを生成するときに、この値がパターンとして使用されます。これにより、一般的なクラウド ストレージ プロバイダで多く使用されているカスタム認証スキームを使用できます。 現在、パターンは 2 つのトークン <login> と <password> をサポートしています。これらのトークンは、同じホスト名の netrc ファイル内の同等の値 に置き換えられます。フォーマット後、結果は HTTP リクエストの Authorization フィールドの値として設定されます。 ベアラートークンを使用して oauth2 対応 API に http ダウンロードを行う場合の属性と netrc の例: 

auth_patterns = {
    "storage.cloudprovider.com": "Bearer <password>"
}
netrc: 
machine storage.cloudprovider.com
        password RANDOM-TOKEN
最終的な HTTP リクエストには次のヘッダーが含まれます。 
Authorization: Bearer RANDOM-TOKEN

build_file ラベル。省略可。

このリポジトリの BUILD ファイルとして使用するファイル。この属性は絶対ラベルです（メイン リポジトリには '@//' を使用します）。ファイル名は BUILD である必要はありませんが、BUILD にすることができます（BUILD.new-repo-name のようにすると、リポジトリの実際の BUILD ファイルと区別しやすくなります）。build_file と build_file_content のいずれか 1 つを指定できますが、両方は指定できません。

build_file_content 文字列。省略可。

このリポジトリの BUILD ファイルの内容。build_file と build_file_content のいずれか 1 つを指定できますが、両方は指定できません。

canonical_id 文字列。省略可。

ダウンロードしたファイルの正規 ID。 指定されていて空でない場合、Bazel は、同じ正規 ID のリクエストによってキャッシュに追加された場合を除き、キャッシュからファイルを取得しません。 指定されていない場合、または空の場合、Bazel はデフォルトでファイルの URL を正規 ID として使用します。これにより、ハッシュを更新せずに URL を更新するというよくある間違いを回避できます。この間違いがあると、ローカルではビルドが成功しても、キャッシュにファイルがないマシンではビルドが失敗します。この動作は、 --repo_env=BAZEL_HTTP_RULES_URLS_AS_DEFAULT_CANONICAL_ID=0 で無効にできます。

integrity 文字列。省略可。

ダウンロードしたファイルの Subresource Integrity 形式の予想チェックサム。 これは、ダウンロードしたファイルのチェックサムと一致する必要があります。チェックサムを省略すると、リモート ファイルが変更される可能性があるため、セキュリティ リスクになります。 __このフィールドを省略すると、ビルドが非ハーメチックになります。開発を容易にするために省略できますが、リリースする前にこの属性または `sha256` を設定する必要があります。

netrc 文字列。省略可。

認証に使用する .netrc ファイルの場所

patch_args 文字列のリスト。省略可。

patch ツールに渡される引数。デフォルトは -p0 ですが、通常は git で生成されたパッチに -p1 が必要になります。複数の -p 引数が指定されている場合は、最後の引数が有効になります。-p 以外の引数が指定されている場合、Bazel は Bazel ネイティブのパッチ実装ではなく、patch コマンドライン ツールを使用します。patch コマンドライン ツールにフォールバックし、patch_tool 属性が指定されていない場合は、`patch` が使用されます。これは、`patches` 属性のパッチファイルにのみ影響します。

patch_cmds 文字列のリスト。省略可。

パッチの適用後に Linux/Macos で適用される Bash コマンドのシーケンス。

patch_cmds_win 文字列のリスト。省略可。

パッチの適用後に Windows で適用される Powershell コマンドのシーケンス。この属性が設定されていない場合、Windows で patch_cmds が実行されます。これには Bash バイナリが存在する必要があります。

patch_tool 文字列。省略可。

使用する patch(1) ユーティリティ。これが指定されている場合、Bazel は Bazel ネイティブのパッチ実装ではなく、指定されたパッチツールを使用します。

patches ラベルのリスト。省略可。

アーカイブの抽出後にパッチとして適用されるファイルのリスト。デフォルトでは、ファジーマッチとバイナリ パッチをサポートしていない Bazel ネイティブのパッチ実装が使用されますが、`patch_tool` 属性が指定されている場合、または `patch_args` 属性に `-p` 以外の引数がある場合は、Bazel は patch コマンドライン ツールを使用します。

remote_patch_strip 整数。省略可。

リモート パッチのファイル名から削除する先頭のスラッシュの数。

remote_patches ディクショナリ: 文字列 -> 文字列。省略可。

パッチファイルの URL とその整合性値のマッピング。これらは、アーカイブの抽出後、`patches` 属性のパッチファイルの適用前に適用されます。Bazel ネイティブのパッチ実装を使用します。パッチの削除数を `remote_patch_strip` で指定できます。
repo_mapping ディクショナリ: 文字列 -> 文字列。必須

ローカル リポジトリ名からグローバル リポジトリ名へのディクショナリ。これにより、このリポジトリの依存関係のワークスペース依存関係解決を制御できます。

たとえば、エントリ"@foo": "@bar" は、このリポジトリが `@foo` に依存するたびに（`@foo//some:target` への依存関係など）、グローバルに宣言された `@bar`（`@bar//some:target`）内でその依存関係を解決する必要があることを宣言します。

sha256 文字列。省略可。

ダウンロードしたファイルの予想される SHA-256。 これは、ダウンロードしたファイルの SHA-256 と一致する必要があります。SHA-256 を省略すると、リモート ファイルが変更される可能性があるため、セキュリティ リスクになります。 __このフィールドを省略すると、ビルドが非ハーメチックになります。開発を容易にするために省略できますが、リリースする前にこの属性または `integrity` を設定する必要があります。
strip_prefix 文字列。省略可。

抽出したファイルから削除するディレクトリ接頭辞。 多くのアーカイブには、アーカイブ内のすべての有用なファイルを含む最上位ディレクトリが含まれています。`build_file` でこの接頭辞を何度も指定する代わりに、このフィールドを使用して、抽出したすべてのファイルから削除できます。たとえば、`foo-lib-latest.zip` を使用しているとします。このファイルには、 ディレクトリ `foo-lib-1.2.3/` が含まれています。このディレクトリには、`WORKSPACE` ファイルと、ビルドする実際のコードを含む `src/`、`lib/`、`test/` ディレクトリがあります。 `strip_prefix = "foo-lib-1.2.3"` を指定して、 `foo-lib-1.2.3` ディレクトリを最上位ディレクトリとして使用します。 このディレクトリの外にファイルがある場合、それらのファイルは破棄され、アクセスできなくなることに注意してください（最上位のライセンス ファイルなど）。これには、接頭辞で始まるがディレクトリにないファイル/ディレクトリ（`foo-lib-1.2.3.release-notes` など）が含まれます。指定した接頭辞がアーカイブ内のディレクトリと一致しない場合、Bazel はエラーを返します。
type 文字列。省略可。

ダウンロードしたファイルのアーカイブ タイプ。 デフォルトでは、アーカイブ タイプは URL のファイル拡張子から判断されます。ファイルに拡張子がない場合は、 `"zip"`、`"jar"`、`"war"`、`"aar"`、`"tar"`、`"tar.gz"`、`"tgz"`、 `"tar.xz"`、`"txz"`、`"tar.zst"`、`"tzst"`、`"tar.bz2"`、`"ar"`、`"deb"` のいずれかを明示的に指定できます。

url 文字列。省略可。

Bazel で使用できるファイルの URL。 これは、ファイル、http、または https の URL である必要があります。リダイレクトが追跡されます。 認証はサポートされていません。urls パラメータを使用すると、取得元の代替 URL を指定できるため、柔軟性が向上します。

urls 文字列のリスト。省略可。

Bazel で使用できるファイルの URL のリスト。 各エントリは、ファイル、http、または https の URL である必要があります。リダイレクトが追跡されます。 認証はサポートされていません。URL は成功するまで順番に試行されるため、ローカル ミラーを最初にリストする必要があります。 すべてのダウンロードが失敗した場合、ルールは失敗します。

workspace_file ラベル。省略可。

このリポジトリの `WORKSPACE` ファイルとして使用するファイル。`workspace_file` または `workspace_file_content` のいずれか 1 つを指定できます。両方は指定できません。どちらも指定しないこともできます。

workspace_file_content 文字列。省略可。

このリポジトリの WORKSPACE ファイルの内容。`workspace_file` または `workspace_file_content` のいずれか 1 つを指定できます。両方は指定できません。どちらも指定しないこともできます。

http_file

http_file(name, auth_patterns, canonical_id, downloaded_file_path, executable, integrity, netrc,
          repo_mapping, sha256, url, urls)

URL からファイルをダウンロードし、ファイルグループとして使用できるようにします。

例: カスタムルールに debian パッケージが必要だとします。このパッケージ は http://example.com/package.deb から入手できます。次に、 WORKSPACE ファイルに追加します。

  load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_file")

  http_file(
      name = "my_deb",
      url = "http://example.com/package.deb",
      sha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  )

ターゲットは、このファイルに依存する依存関係として @my_deb//file を指定します。

属性

name 名前。必須。

このリポジトリの一意の名前。

auth_patterns ディクショナリ: 文字列 -> 文字列。省略可。

ホスト名をカスタム認証パターンにマッピングする省略可能なディクショナリ。 URL のホスト名がこのディクショナリに存在する場合、HTTP リクエストの認証ヘッダーを生成するときに、この値がパターンとして使用されます。これにより、一般的なクラウド ストレージ プロバイダで多く使用されているカスタム認証スキームを使用できます。 現在、パターンは 2 つのトークン <login> と <password> をサポートしています。これらのトークンは、同じホスト名の netrc ファイル内の同等の値 に置き換えられます。フォーマット後、結果は HTTP リクエストの Authorization フィールドの値として設定されます。 ベアラートークンを使用して oauth2 対応 API に http ダウンロードを行う場合の属性と netrc の例: 

auth_patterns = {
    "storage.cloudprovider.com": "Bearer <password>"
}
netrc: 
machine storage.cloudprovider.com
        password RANDOM-TOKEN
最終的な HTTP リクエストには次のヘッダーが含まれます。 
Authorization: Bearer RANDOM-TOKEN

canonical_id 文字列。省略可。

ダウンロードしたファイルの正規 ID。 指定されていて空でない場合、Bazel は、同じ正規 ID のリクエストによってキャッシュに追加された場合を除き、キャッシュからファイルを取得しません。 指定されていない場合、または空の場合、Bazel はデフォルトでファイルの URL を正規 ID として使用します。これにより、ハッシュを更新せずに URL を更新するというよくある間違いを回避できます。この間違いがあると、ローカルではビルドが成功しても、キャッシュにファイルがないマシンではビルドが失敗します。この動作は、 --repo_env=BAZEL_HTTP_RULES_URLS_AS_DEFAULT_CANONICAL_ID=0 で無効にできます。

downloaded_file_path 文字列。省略可。

ダウンロードしたファイルに割り当てられたパス

executable ブール値。省略可。

ダウンロードしたファイルを実行可能にするかどうか。

integrity 文字列。省略可。

ダウンロードしたファイルの Subresource Integrity 形式の予想チェックサム。 これは、ダウンロードしたファイルのチェックサムと一致する必要があります。チェックサムを省略すると、リモート ファイルが変更される可能性があるため、セキュリティ リスクになります。 __このフィールドを省略すると、ビルドが非ハーメチックになります。開発を容易にするために省略できますが、リリースする前にこの属性または `sha256` を設定する必要があります。

netrc 文字列。省略可。

認証に使用する .netrc ファイルの場所

repo_mapping ディクショナリ: 文字列 -> 文字列。必須

ローカル リポジトリ名からグローバル リポジトリ名へのディクショナリ。これにより、このリポジトリの依存関係のワークスペース依存関係解決を制御できます。

たとえば、エントリ"@foo": "@bar" は、このリポジトリが `@foo` に依存するたびに（`@foo//some:target` への依存関係など）、グローバルに宣言された `@bar`（`@bar//some:target`）内でその依存関係を解決する必要があることを宣言します。

sha256 文字列。省略可。

ダウンロードしたファイルの予想される SHA-256。 これは、ダウンロードしたファイルの SHA-256 と一致する必要があります。SHA-256 を省略すると、リモート ファイルが変更される可能性があるため、セキュリティ リスクになります。 __このフィールドを省略すると、ビルドが非ハーメチックになります。開発を容易にするために省略できますが、リリースする前に設定する必要があります。

url 文字列。省略可。

Bazel で使用できるファイルの URL。 これは、ファイル、http、または https の URL である必要があります。リダイレクトが追跡されます。 認証はサポートされていません。urls パラメータを使用すると、取得元の代替 URL を指定できるため、柔軟性が向上します。

urls 文字列のリスト。省略可。

Bazel で使用できるファイルの URL のリスト。 各エントリは、ファイル、http、または https の URL である必要があります。リダイレクトが追跡されます。 認証はサポートされていません。URL は成功するまで順番に試行されるため、ローカル ミラーを最初にリストする必要があります。 すべてのダウンロードが失敗した場合、ルールは失敗します。

http_jar

http_jar(name, auth_patterns, canonical_id, downloaded_file_name, integrity, netrc, repo_mapping,
         sha256, url, urls)

URL から jar をダウンロードし、java_import として使用できるようにします。

ダウンロードしたファイルの拡張子は .jar である必要があります。

例: 現在のリポジトリに、 ディレクトリ ~/chat-app をルートとするチャット プログラムのソースコードが含まれているとします。このプログラムは、 http://example.com/openssl-0.2.jar から入手できる SSL ライブラリに依存する必要があります。

次の行が ~/chat-app/WORKSPACE に追加されている場合、~/chat-app リポジトリのターゲットはこのターゲットに依存できます。

  load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_jar")

  http_jar(
      name = "my_ssl",
      url = "http://example.com/openssl-0.2.jar",
      sha256 = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  )

ターゲットは、この jar に依存する依存関係として @my_ssl//jar を指定します。

Unix ベースのシステムを使用している場合は、「file:///path/to/file」を使用して、現在のシステム（localhost）上のファイルを参照することもできます。Windows を使用している場合は、「file:///c:/path/to/file」を使用します。どちらの例でも 、3 つのスラッシュ（/）に注意してください。最初の 2 つのスラッシュは file:// に属し、3 つ目の スラッシュはファイルへの絶対パスに属します。

属性

name 名前。必須。

このリポジトリの一意の名前。

auth_patterns ディクショナリ: 文字列 -> 文字列。省略可。

ホスト名をカスタム認証パターンにマッピングする省略可能なディクショナリ。 URL のホスト名がこのディクショナリに存在する場合、HTTP リクエストの認証ヘッダーを生成するときに、この値がパターンとして使用されます。これにより、一般的なクラウド ストレージ プロバイダで多く使用されているカスタム認証スキームを使用できます。 現在、パターンは 2 つのトークン <login> と <password> をサポートしています。これらのトークンは、同じホスト名の netrc ファイル内の同等の値 に置き換えられます。フォーマット後、結果は HTTP リクエストの Authorization フィールドの値として設定されます。 ベアラートークンを使用して oauth2 対応 API に http ダウンロードを行う場合の属性と netrc の例: 

auth_patterns = {
    "storage.cloudprovider.com": "Bearer <password>"
}
netrc: 
machine storage.cloudprovider.com
        password RANDOM-TOKEN
最終的な HTTP リクエストには次のヘッダーが含まれます。 
Authorization: Bearer RANDOM-TOKEN

canonical_id 文字列。省略可。

ダウンロードしたファイルの正規 ID。 指定されていて空でない場合、Bazel は、同じ正規 ID のリクエストによってキャッシュに追加された場合を除き、キャッシュからファイルを取得しません。 指定されていない場合、または空の場合、Bazel はデフォルトでファイルの URL を正規 ID として使用します。これにより、ハッシュを更新せずに URL を更新するというよくある間違いを回避できます。この間違いがあると、ローカルではビルドが成功しても、キャッシュにファイルがないマシンではビルドが失敗します。この動作は、 --repo_env=BAZEL_HTTP_RULES_URLS_AS_DEFAULT_CANONICAL_ID=0 で無効にできます。

downloaded_file_name 文字列。省略可。

ダウンロードした jar に割り当てられたファイル名

integrity 文字列。省略可。

ダウンロードしたファイルの Subresource Integrity 形式の予想チェックサム。 これは、ダウンロードしたファイルのチェックサムと一致する必要があります。チェックサムを省略すると、リモート ファイルが変更される可能性があるため、セキュリティ リスクになります。 __このフィールドを省略すると、ビルドが非ハーメチックになります。開発を容易にするために省略できますが、リリースする前にこの属性または `sha256` を設定する必要があります。

netrc 文字列。省略可。

認証に使用する .netrc ファイルの場所

repo_mapping ディクショナリ: 文字列 -> 文字列。必須

ローカル リポジトリ名からグローバル リポジトリ名へのディクショナリ。これにより、このリポジトリの依存関係のワークスペース依存関係解決を制御できます。

たとえば、エントリ"@foo": "@bar" は、このリポジトリが `@foo` に依存するたびに（`@foo//some:target` への依存関係など）、グローバルに宣言された `@bar`（`@bar//some:target`）内でその依存関係を解決する必要があることを宣言します。

sha256 文字列。省略可。

ダウンロードしたファイルの予想される SHA-256。 これは、ダウンロードしたファイルの SHA-256 と一致する必要があります。SHA-256 を省略すると、リモート ファイルが変更される可能性があるため、セキュリティ リスクになります。 __このフィールドを省略すると、ビルドが非ハーメチックになります。開発を容易にするために省略できますが、リリースする前にこの属性または `integrity` を設定する必要があります。
url 文字列。省略可。

Bazel で使用できるファイルの URL。 これは、ファイル、http、または https の URL である必要があります。リダイレクトが追跡されます。 認証はサポートされていません。urls パラメータを使用すると、取得元の代替 URL を指定できるため、柔軟性が向上します。 URL は `.jar` で終わる必要があります。

urls 文字列のリスト。省略可。

Bazel で使用できるファイルの URL のリスト。 各エントリは、ファイル、http、または https の URL である必要があります。リダイレクトが追跡されます。 認証はサポートされていません。URL は成功するまで順番に試行されるため、ローカル ミラーを最初にリストする必要があります。 すべてのダウンロードが失敗した場合、ルールは失敗します。 すべての URL は `.jar` で終わる必要があります。