Las siguientes funciones se pueden cargar desde @bazel_tools//tools/build_defs/repo:http.bzl
.
Reglas para descargar archivos a través de HTTP.
Configuración
Para usar estas reglas, cárgalas en tu archivo WORKSPACE
de la siguiente manera:
load(
"@bazel_tools//tools/build_defs/repo:http.bzl",
"http_archive",
"http_file",
"http_jar",
)
Estas son versiones mejoradas de las reglas HTTP nativas y, con el tiempo, reemplazarán las reglas nativas.
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_file_integrity, remote_file_urls, remote_patch_strip, remote_patches, repo_mapping, sha256, strip_prefix, type, url, urls, workspace_file, workspace_file_content)
Descarga un repositorio de Bazel como un archivo comprimido, lo descomprime y hace que sus destinos estén disponibles para la vinculación.
Admite las siguientes extensiones de archivo: "zip"
, "jar"
, "war"
, "aar"
, "tar"
, "tar.gz"
, "tgz"
, "tar.xz"
, "txz"
, "tar.zst"
, "tzst"
, tar.bz2
, "ar"
o "deb"
.
Ejemplos: Supongamos que el repositorio actual contiene el código fuente para un programa de chat, con permisos de administrador en el directorio ~/chat-app
. Depende de una biblioteca SSL que está disponible en http://example.com/openssl.zip. Este archivo .zip
contiene la siguiente estructura de directorio:
WORKSPACE
src/
openssl.cc
openssl.h
En el repositorio local, el usuario crea un archivo openssl.BUILD
que contiene la siguiente definición de destino:
cc_library(
name = "openssl-lib",
srcs = ["src/openssl.cc"],
hdrs = ["src/openssl.h"],
)
Los objetivos del repositorio ~/chat-app
pueden depender de este destino si se agregan las siguientes líneas a ~/chat-app/WORKSPACE
:
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",
)
Luego, los destinos especificarían @my_ssl//:openssl-lib
como dependencia.
Atributos
name |
Name; obligatorio
Un nombre único para este repositorio. |
add_prefix |
Cadena (opcional)
Directorio de destino relacionado con el directorio del repositorio. El archivo se descomprimirá en este directorio después de aplicar `strip_prefix` (si corresponde) a las rutas de acceso del archivo. Por ejemplo, el archivo `foo-1.2.3/src/foo.h` se descomprime en `bar/src/foo.h` si `add_prefix = "bar"` y `strip_prefix = "foo-1.2.3"`. |
auth_patterns |
Diccionario: String -> String; opcional
Un dict opcional que asigna nombres de host a patrones de autorización personalizados.
Si el nombre de host de una URL está presente en este diccionario, el valor se usará como patrón cuando se genere el encabezado de autorización para la solicitud HTTP. Esto habilita el uso de esquemas de autorización personalizados utilizados en muchos proveedores comunes de almacenamiento en la nube.
Actualmente, el patrón admite 2 tokens: auth_patterns = { "storage.cloudprovider.com": "Bearer <password>" }netrc: machine storage.cloudprovider.com password RANDOM-TOKENLa solicitud HTTP final tendría el siguiente encabezado: Authorization: Bearer RANDOM-TOKEN |
build_file |
Etiqueta (opcional)
El archivo que se usará como archivo de COMPILACIÓN para este repositorio.Este atributo es una etiqueta absoluta (usa “@//” para el repositorio principal). No es necesario que el archivo tenga el nombre BUILD, pero puede tener el nombre (algo como BUILD.new-repo-name puede funcionar bien para distinguirlo de los archivos BUILD reales del repositorio. Se puede especificar build_file o build_file_content, pero no ambos. |
build_file_content |
Cadena (opcional)
El contenido del archivo Build de este repositorio. Se puede especificar build_file o build_file_content, pero no ambos. |
canonical_id |
Cadena (opcional)
Es un ID canónico del archivo descargado. Si se especifica y no está vacío, Bazel no quitará el archivo de la caché, a menos que se lo haya agregado a la caché mediante una solicitud con el mismo ID canónico. Si no se especifica o está vacío, Bazel usa las URLs del archivo como el ID canónico de forma predeterminada. Esto ayuda a detectar el error común de actualizar las URLs sin actualizar también el hash, lo que da como resultado compilaciones que se ejecutan de forma correcta a nivel local, pero que fallan en máquinas sin el archivo en caché. Este comportamiento se puede inhabilitar con --repo_env=BAZEL_HTTP_RULES_URLS_AS_DEFAULT_CANONICAL_ID=0. |
integrity |
Cadena (opcional)
La suma de comprobación esperada en el formato de integridad de los subrecursos del archivo descargado. Debe coincidir con la suma de comprobación del archivo descargado. _Omitir la suma de comprobación es un riesgo de seguridad, ya que los archivos remotos pueden cambiar. En el mejor de los casos, omitir este campo hará que tu compilación no sea hermética. Facilitar el desarrollo es opcional, pero se debe configurar este atributo o `sha256` antes del envío. |
netrc |
Cadena (opcional)
Ubicación del archivo .netrc para usar en la autenticación |
patch_args |
Lista de cadenas (opcional)
Los argumentos proporcionados a la herramienta de parches. El valor predeterminado es -p0; sin embargo, -p1 suele ser necesario para los parches que genera git. Si se especifican varios argumentos -p, el último tendrá efecto.Si se especifican otros argumentos distintos de -p, Bazel recurrirá a la herramienta de línea de comandos de parches en lugar de la implementación de parches nativa de Bazel. Cuando recurras a la herramienta de línea de comandos del parche y no se especifica el atributo parche_herramienta, se utilizará “parche”. Esto solo afecta a los archivos de parche en el atributo “patches”. |
patch_cmds |
Lista de cadenas (opcional)
Secuencia de comandos de Bash que se aplicará en Linux/Macos después de aplicar los parches. |
patch_cmds_win |
Lista de cadenas (opcional)
Secuencia de comandos de PowerShell que se aplicarán en Windows después de aplicar los parches. Si no se establece este atributo, se ejecutará patch_cmds en Windows, lo que requiere que exista el objeto binario Bash. |
patch_tool |
Cadena (opcional)
La utilidad parche(1) que se usará. Si lo haces, Bazel usará la herramienta de parches especificada en lugar de la implementación de parches nativa de Bazel. |
patches |
Lista de etiquetas (opcional)
Una lista de los archivos que se aplicarán como parches después de extraerlo. De forma predeterminada, usa la implementación de parches nativa de Bazel que no admite la coincidencia de fuzz ni el parche binario, pero Bazel recurrirá a la herramienta de línea de comandos de parche si se especifica el atributo `patch_tool` o si hay argumentos distintos de `-p` en el atributo `patch_args`. |
remote_file_integrity |
Diccionario: String -> String; opcional
Es una asignación de las rutas de acceso relativas de los archivos (clave) a su valor de integridad (valor). Estas rutas de acceso relativas se deben asignar a los archivos (clave) en el atributo `remote_file_urls`. |
remote_file_urls |
Diccionario: String -> Lista de cadenas; opcional
Es un mapa de rutas de acceso relativas (clave) a una lista de URLs (valor) que se descargarán y estarán disponibles como archivos superpuestos en el repositorio. Esto es útil cuando quieres agregar archivos WORKSPACE o BUILD.bazel encima de un repositorio existente. Los archivos se descargan antes de aplicar los parches en el atributo "patches" y la lista de URL debe ser posible una duplicación del mismo archivo. Las URL se prueban en orden hasta que una tiene éxito. |
remote_patch_strip |
Número entero (opcional)
La cantidad de barras iniciales que se quitarán del nombre de archivo en los parches remotos. |
remote_patches |
Diccionario: String -> String; opcional
Es una asignación de la URL del archivo de parche a su valor de integridad. Se aplican después de extraer el archivo y antes de aplicar los archivos de parche del atributo “patches”. Usa la implementación de parches nativos de Bazel. Puedes especificar el número de la tira de parches con “remote_patch_strip” |
repo_mapping |
Diccionario: String -> String; obligatorio
Un diccionario que va del nombre del repositorio local al nombre del repositorio global. Esto permite controlar la resolución de dependencias de lugares de trabajo para las dependencias de este repositorio. Por ejemplo, una entrada"@foo": "@bar"` declara que, en cualquier momento, este repositorio depende de `@foo` (por ejemplo, una dependencia de `@foo//some:target`, en realidad debería resolver esa dependencia dentro de `@bar`, declarada de manera global, `@bar//some:target`). |
sha256 |
Cadena (opcional)
El SHA-256 esperado del archivo descargado. Debe coincidir con el SHA-256 del archivo descargado. _Omitir el hash SHA-256, ya que los archivos remotos pueden cambiar. En el mejor de los casos, omitir este campo hará que tu compilación no sea hermética. Facilitar el desarrollo es opcional, pero se debe configurar este atributo o "integridad" antes del envío. |
strip_prefix |
Cadena (opcional)
Un prefijo de directorio para quitar los archivos extraídos. Muchos archivos contienen un directorio de nivel superior que contiene todos los archivos útiles en el archivo. En lugar de necesitar especificar este prefijo una y otra vez en el “build_file”, se puede usar este campo para quitarlo de todos los archivos extraídos. Por ejemplo, supongamos que usas “foo-lib-latest.zip”, que contiene el directorio “foo-lib-1.2.3/” en el que se encuentra un archivo “WORKSPACE” y que son directorios “src/”, “lib/” y “test/” que contienen el código real que deseas compilar. Especifica `strip_prefix = "foo-lib-1.2.3"` para usar el directorio `foo-lib-1.2.3` como tu directorio de nivel superior. Ten en cuenta que, si hay archivos fuera de este directorio, se descartarán y no se podrá acceder a ellos (p.ej., un archivo de licencia de nivel superior). Esto incluye archivos o directorios que comienzan con el prefijo, pero que no están en el directorio (p.ej., “foo-lib-1.2.3.release-notes”. Si el prefijo especificado no coincide con un directorio del archivo, Bazel mostrará un error. |
type |
Cadena (opcional)
Es el tipo de archivo del archivo descargado. De forma predeterminada, el tipo de archivo se determina a partir de la extensión de archivo de la URL. Si el archivo no tiene extensión, puedes especificar explícitamente una de las siguientes opciones: “zip”`, ”jar”`, ”war"`, ”aar"`, ”tar"`, ”tar.gz"`, `"tgz"`, ”tar.xz"`, ”txz"`, `"tar.zst"`, ”"tar.zst."`, ”"tar.zst."`, ”"tar.zst." |
url |
Cadena (opcional)
Una URL a un archivo que estará disponible para Bazel. Debe ser un archivo, una URL HTTP o HTTPS. Se siguen los redireccionamientos. No se admite la autenticación. Se puede lograr más flexibilidad con el parámetro de URLs, que permite especificar URLs alternativas desde las que se pueden recuperar. |
urls |
Lista de cadenas (opcional)
Una lista de URLs a un archivo que estará disponible para Bazel. Cada entrada debe ser un archivo, una URL HTTP o HTTPS. Se siguen los redireccionamientos. No se admite la autenticación. Las URLs se prueban en orden hasta que una se ejecuta correctamente, por lo que primero debes enumerar las duplicaciones locales. Si todas las descargas fallan, también lo hará la regla. |
workspace_file |
Etiqueta (opcional)
El archivo que se usará como archivo `WORKSPACE` para este repositorio. Se puede especificar “workspace_file” o “workspace_file_content”, o ninguno, pero no ambos. |
workspace_file_content |
Cadena (opcional)
El contenido del archivo WORKSPACE de este repositorio. Se puede especificar “workspace_file” o “workspace_file_content”, o ninguno, pero no ambos. |
http_file
http_file(name, auth_patterns, canonical_id, downloaded_file_path, executable, integrity, netrc, repo_mapping, sha256, url, urls)
Descarga un archivo de una URL y lo pone a disposición para usarlo como un grupo de archivos.
Ejemplos: Supongamos que necesitas tener un paquete debian para tus reglas personalizadas. Este paquete está disponible en http://example.com/package.deb. Luego, puedes agregar a tu archivo 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",
)
Los destinos especificarían @my_deb//file
como una dependencia para depender de este archivo.
Atributos
name |
Name; obligatorio
Un nombre único para este repositorio. |
auth_patterns |
Diccionario: String -> String; opcional
Un dict opcional que asigna nombres de host a patrones de autorización personalizados.
Si el nombre de host de una URL está presente en este diccionario, el valor se usará como patrón cuando se genere el encabezado de autorización para la solicitud HTTP. Esto habilita el uso de esquemas de autorización personalizados utilizados en muchos proveedores comunes de almacenamiento en la nube.
Actualmente, el patrón admite 2 tokens: auth_patterns = { "storage.cloudprovider.com": "Bearer <password>" }netrc: machine storage.cloudprovider.com password RANDOM-TOKENLa solicitud HTTP final tendría el siguiente encabezado: Authorization: Bearer RANDOM-TOKEN |
canonical_id |
Cadena (opcional)
Es un ID canónico del archivo descargado. Si se especifica y no está vacío, Bazel no quitará el archivo de la caché, a menos que se lo haya agregado a la caché mediante una solicitud con el mismo ID canónico. Si no se especifica o está vacío, Bazel usa las URLs del archivo como el ID canónico de forma predeterminada. Esto ayuda a detectar el error común de actualizar las URLs sin actualizar también el hash, lo que da como resultado compilaciones que se ejecutan de forma correcta a nivel local, pero que fallan en máquinas sin el archivo en caché. Este comportamiento se puede inhabilitar con --repo_env=BAZEL_HTTP_RULES_URLS_AS_DEFAULT_CANONICAL_ID=0. |
downloaded_file_path |
Cadena (opcional)
Ruta de acceso asignada al archivo descargado |
executable |
Booleano; opcional
Si el archivo descargado debe ser ejecutable. |
integrity |
Cadena (opcional)
La suma de comprobación esperada en el formato de integridad de los subrecursos del archivo descargado. Debe coincidir con la suma de comprobación del archivo descargado. _Omitir la suma de comprobación es un riesgo de seguridad, ya que los archivos remotos pueden cambiar. En el mejor de los casos, omitir este campo hará que tu compilación no sea hermética. Facilitar el desarrollo es opcional, pero se debe configurar este atributo o `sha256` antes del envío. |
netrc |
Cadena (opcional)
Ubicación del archivo .netrc para usar en la autenticación |
repo_mapping |
Diccionario: String -> String; obligatorio
Un diccionario que va del nombre del repositorio local al nombre del repositorio global. Esto permite controlar la resolución de dependencias de lugares de trabajo para las dependencias de este repositorio. Por ejemplo, una entrada"@foo": "@bar"` declara que, en cualquier momento, este repositorio depende de `@foo` (por ejemplo, una dependencia de `@foo//some:target`, en realidad debería resolver esa dependencia dentro de `@bar`, declarada de manera global, `@bar//some:target`). |
sha256 |
Cadena (opcional)
El SHA-256 esperado del archivo descargado. Debe coincidir con el SHA-256 del archivo descargado. _Omitir el hash SHA-256, ya que los archivos remotos pueden cambiar. En el mejor de los casos, omitir este campo hará que tu compilación no sea hermética. Facilitar el desarrollo es opcional, pero debes configurarlo antes del envío. |
url |
Cadena (opcional)
Una URL a un archivo que estará disponible para Bazel. Debe ser un archivo, una URL HTTP o HTTPS. Se siguen los redireccionamientos. No se admite la autenticación. Se puede lograr más flexibilidad con el parámetro de URLs, que permite especificar URLs alternativas desde las que se pueden recuperar. |
urls |
Lista de cadenas (opcional)
Una lista de URLs a un archivo que estará disponible para Bazel. Cada entrada debe ser un archivo, una URL HTTP o HTTPS. Se siguen los redireccionamientos. No se admite la autenticación. Las URLs se prueban en orden hasta que una se ejecuta correctamente, por lo que primero debes enumerar las duplicaciones locales. Si todas las descargas fallan, también lo hará la regla. |
http_jar
http_jar(name, auth_patterns, canonical_id, downloaded_file_name, integrity, netrc, repo_mapping, sha256, url, urls)
Descarga un jar desde una URL y lo pone a disposición como java_import
Los archivos descargados deben tener la extensión .jar.
Ejemplos: Supongamos que el repositorio actual contiene el código fuente para un programa de chat, con permisos de administrador en el directorio ~/chat-app
. Depende de una biblioteca SSL que esté disponible en http://example.com/openssl-0.2.jar
.
Los objetivos del repositorio ~/chat-app
pueden depender de este destino si se agregan las siguientes líneas
a ~/chat-app/WORKSPACE
:
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",
)
Los destinos especificarían @my_ssl//jar
como una dependencia para depender de este jar.
También puedes hacer referencia a archivos en el sistema actual (localhost) con “file:///path/to/file”
si usas sistemas basados en Unix. Si usas Windows, usa “file:///c:/path/to/file”. En ambos ejemplos, ten en cuenta las tres barras diagonales (/
): las primeras dos barras pertenecen a file://
y la tercera pertenece a la ruta de acceso absoluta al archivo.
Atributos
name |
Name; obligatorio
Un nombre único para este repositorio. |
auth_patterns |
Diccionario: String -> String; opcional
Un dict opcional que asigna nombres de host a patrones de autorización personalizados.
Si el nombre de host de una URL está presente en este diccionario, el valor se usará como patrón cuando se genere el encabezado de autorización para la solicitud HTTP. Esto habilita el uso de esquemas de autorización personalizados utilizados en muchos proveedores comunes de almacenamiento en la nube.
Actualmente, el patrón admite 2 tokens: auth_patterns = { "storage.cloudprovider.com": "Bearer <password>" }netrc: machine storage.cloudprovider.com password RANDOM-TOKENLa solicitud HTTP final tendría el siguiente encabezado: Authorization: Bearer RANDOM-TOKEN |
canonical_id |
Cadena (opcional)
Es un ID canónico del archivo descargado. Si se especifica y no está vacío, Bazel no quitará el archivo de la caché, a menos que se lo haya agregado a la caché mediante una solicitud con el mismo ID canónico. Si no se especifica o está vacío, Bazel usa las URLs del archivo como el ID canónico de forma predeterminada. Esto ayuda a detectar el error común de actualizar las URLs sin actualizar también el hash, lo que da como resultado compilaciones que se ejecutan de forma correcta a nivel local, pero que fallan en máquinas sin el archivo en caché. Este comportamiento se puede inhabilitar con --repo_env=BAZEL_HTTP_RULES_URLS_AS_DEFAULT_CANONICAL_ID=0. |
downloaded_file_name |
Cadena (opcional)
Nombre de archivo asignado al archivo jar descargado |
integrity |
Cadena (opcional)
La suma de comprobación esperada en el formato de integridad de los subrecursos del archivo descargado. Debe coincidir con la suma de comprobación del archivo descargado. _Omitir la suma de comprobación es un riesgo de seguridad, ya que los archivos remotos pueden cambiar. En el mejor de los casos, omitir este campo hará que tu compilación no sea hermética. Facilitar el desarrollo es opcional, pero se debe configurar este atributo o `sha256` antes del envío. |
netrc |
Cadena (opcional)
Ubicación del archivo .netrc para usar en la autenticación |
repo_mapping |
Diccionario: String -> String; obligatorio
Un diccionario que va del nombre del repositorio local al nombre del repositorio global. Esto permite controlar la resolución de dependencias de lugares de trabajo para las dependencias de este repositorio. Por ejemplo, una entrada"@foo": "@bar"` declara que, en cualquier momento, este repositorio depende de `@foo` (por ejemplo, una dependencia de `@foo//some:target`, en realidad debería resolver esa dependencia dentro de `@bar`, declarada de manera global, `@bar//some:target`). |
sha256 |
Cadena (opcional)
El SHA-256 esperado del archivo descargado. Debe coincidir con el SHA-256 del archivo descargado. _Omitir el hash SHA-256, ya que los archivos remotos pueden cambiar. En el mejor de los casos, omitir este campo hará que tu compilación no sea hermética. Facilitar el desarrollo es opcional, pero se debe configurar este atributo o "integridad" antes del envío. |
url |
Cadena (opcional)
Una URL a un archivo que estará disponible para Bazel. Debe ser un archivo, una URL HTTP o HTTPS. Se siguen los redireccionamientos. No se admite la autenticación. Se puede lograr más flexibilidad con el parámetro de URLs, que permite especificar URLs alternativas desde las que se pueden recuperar. La URL debe terminar en ".jar". |
urls |
Lista de cadenas (opcional)
Una lista de URLs a un archivo que estará disponible para Bazel. Cada entrada debe ser un archivo, una URL HTTP o HTTPS. Se siguen los redireccionamientos. No se admite la autenticación. Las URLs se prueban en orden hasta que una se ejecuta correctamente, por lo que primero debes enumerar las duplicaciones locales. Si todas las descargas fallan, también lo hará la regla. Todas las URLs deben terminar en ".jar". |