Reglas del repositorio

En esta página, se explica cómo definir reglas de repositorio y se proporcionan ejemplos para obtener más detalles.

Un repositorio externo es un árbol de directorios que contiene archivos de origen que se pueden usar en una compilación de Bazel, que se genera a pedido ejecutando su regla de repositorio correspondiente. Los repositorios se pueden definir de muchas maneras, pero, en última instancia, cada repositorio se define invocando una regla de repositorio, al igual que los destinos de compilación se definen invocando reglas de compilación. Se pueden usar para depender de bibliotecas de terceros (como bibliotecas empaquetadas de Maven), pero también para generar archivos BUILD específicos del host en el que se ejecuta Bazel.

Definición de la regla del repositorio

En un archivo .bzl, usa la función repository_rule para definir una nueva regla de repo y almacenarla en una variable global. Después de definir una regla de repositorio, se puede invocar como una función para definir repositorios. Por lo general, esta invocación se realiza desde una función de implementación de extensión de módulo.

Los dos componentes principales de la definición de una regla de repo son su esquema de atributos y la función de implementación. El esquema de atributos determina los nombres y tipos de atributos que se pasan a una invocación de regla de repo, y la función de implementación se ejecuta cuando se debe recuperar el repo.

Atributos

Los atributos son argumentos que se pasan a la invocación de la regla del repositorio. El esquema de atributos que acepta una regla de repo se especifica con el argumento attrs cuando la regla de repo se define con una llamada a repository_rule. Un ejemplo que define los atributos url y sha256 como cadenas:

http_archive = repository_rule(
    implementation=_impl,
    attrs={
        "url": attr.string(mandatory=True),
        "sha256": attr.string(mandatory=True),
    }
)

Para acceder a un atributo dentro de la función de implementación, usa repository_ctx.attr.<attribute_name>:

def _impl(repository_ctx):
    url = repository_ctx.attr.url
    checksum = repository_ctx.attr.sha256

Todos los repository_rule tienen el atributo name definido de forma implícita. Este es un atributo de cadena que se comporta de manera un tanto mágica: cuando se especifica como entrada para una invocación de regla de repo, toma un nombre de repo aparente, pero cuando se lee desde la función de implementación de la regla de repo con repository_ctx.attr.name, muestra el nombre canónico del repo.

Función de implementación

Cada regla de repo requiere una función implementation. Contiene la lógica real de la regla y se ejecuta estrictamente en la fase de carga.

La función tiene exactamente un parámetro de entrada, repository_ctx. La función muestra None para indicar que la regla es reproducible según los parámetros especificados, o bien un diccionario con un conjunto de parámetros para esa regla que la convertiría en una reproducible que genera el mismo repo. Por ejemplo, para una regla que realiza un seguimiento de un repositorio de git, eso significaría mostrar un identificador de confirmación específico en lugar de una rama flotante que se especificó originalmente.

El parámetro de entrada repository_ctx se puede usar para acceder a los valores de los atributos y a las funciones no herméticas (encontrar un archivo binario, ejecutarlo, crear un archivo en el repositorio o descargar un archivo de Internet). Consulta la documentación de la API para obtener más contexto. Ejemplo:

def _impl(repository_ctx):
  repository_ctx.symlink(repository_ctx.attr.path, "")

local_repository = repository_rule(
    implementation=_impl,
    ...)

¿Cuándo se ejecuta la función de implementación?

La función de implementación de una regla de repo se ejecuta cuando Bazel necesita un destino de ese repositorio, por ejemplo, cuando otro destino (en otro repo) depende de él o si se menciona en la línea de comandos. Luego, se espera que la función de implementación cree el repositorio en el sistema de archivos. Esto se denomina “recuperación” del repositorio.

A diferencia de los destinos normales, los repositorios no se vuelven a recuperar necesariamente cuando cambia algo que haría que el repositorio fuera diferente. Esto se debe a que hay elementos en los que Bazel no puede detectar cambios o que causarían demasiada sobrecarga en cada compilación (por ejemplo, elementos que se recuperan de la red). Por lo tanto, los repositorios se vuelven a recuperar solo si cambia una de las siguientes opciones:

• Los atributos pasados a la invocación de la regla del repositorio
• Es el código Starlark que comprende la implementación de la regla del repositorio.
• El valor de cualquier variable de entorno que se pasa al método getenv() de repository_ctx o que se declara con el atributo environ de repository_rule Los valores de estas variables de entorno se pueden configurar de forma fija en la línea de comandos con la marca --repo_env.
• La existencia, el contenido y el tipo de las rutas que se watchan en la función de implementación de la regla del repo
  • Ciertos otros métodos de repository_ctx con un parámetro watch, como read(), execute() y extract(), también pueden hacer que se supervisen las rutas.
  • De manera similar, repository_ctx.watch_tree y path.readdir pueden hacer que las rutas se supervisen de otras maneras.
• Cuando se ejecuta bazel fetch --force.

Hay dos parámetros de repository_rule que controlan cuándo se vuelven a recuperar los repositorios:

• Si se establece la marca configure, el repositorio se vuelve a recuperar en bazel fetch --force --configure (no se vuelven a recuperar los repositorios que no son configure).
• Si se establece la marca local, además de los casos anteriores, el repositorio también se vuelve a recuperar cuando se reinicia el servidor de Bazel.

Cómo forzar la actualización de repositorios externos

A veces, un repositorio externo puede quedar desactualizado sin ningún cambio en su definición o dependencias. Por ejemplo, un repositorio que recupera fuentes puede seguir una rama particular de un repositorio de terceros, y las confirmaciones nuevas están disponibles en esa rama. En este caso, puedes pedirle a bazel que vuelva a recuperar todos los repositorios externos de forma incondicional llamando a bazel fetch --force --all.

Además, algunas reglas del repositorio inspeccionan la máquina local y pueden quedar desactualizadas si esta se actualizó. Aquí, puedes pedirle a Bazel que vuelva a recuperar solo aquellos repositorios externos en los que la definición de repository_rule tiene el atributo configure establecido. Usa bazel fetch --force --configure.

Ejemplos

• Cadena de herramientas configurada automáticamente para C++: Usa una regla de repo para crear automáticamente los archivos de configuración de C++ para Bazel buscando el compilador de C++ local, el entorno y las marcas que admite el compilador de C++.

• Los repositorios de Go usan varios repository_rule para definir la lista de dependencias necesarias para usar las reglas de Go.

• rules_jvm_external crea, de forma predeterminada, un repositorio externo llamado @maven que genera destinos de compilación para cada artefacto de Maven en el árbol de dependencias transitivas.