Reglas del repositorio

Informar un problema Ver fuente

En esta página, se explica cómo definir reglas del 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 mediante la ejecución de su regla de repositorio correspondiente. Los repositorios se pueden definir de varias maneras, pero, en última instancia, cada repositorio se define mediante la invocación de una regla de repositorio, al igual que los objetivos de compilación se definen con la invocación de reglas de compilación. Se pueden usar para depender de bibliotecas de terceros (como las bibliotecas empaquetadas de Maven), pero también para generar archivos BUILD específicos del host en el que se ejecuta Bazel.

Definición de reglas de repositorio

En un archivo .bzl, usa la función repository_rule para definir una regla de repositorio nueva 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 una extensión de módulo.

Los dos componentes principales de una definición de reglas de repositorio son el 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 repositorio, y la función de implementación se ejecuta cuando se debe recuperar el repositorio.

Atributos

Los atributos son argumentos que se pasan a la invocación de reglas de repositorio. El esquema de atributos que acepta una regla de repositorio se especifica con el argumento attrs cuando esta se define con una llamada a repository_rule. Este es un ejemplo en el que se definen los atributos url y sha256 como strings:

http_archive = repository_rule(
    implementation=_impl,
    local=True,
    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

Todas las repository_rule tienen el atributo definido implícitamente name. Este es un atributo de string que se comporta de forma mágica: cuando se especifica como una entrada a una invocación de regla de repositorio, toma un nombre de repositorio aparente; pero cuando se lee desde la función de implementación de la regla de repositorio con repository_ctx.attr.name, muestra el nombre de repositorio canónico.

Función de implementación

Cada regla de repositorio 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 un dict con un conjunto de parámetros para esa regla que convertiría esa regla en una reproducible que genera el mismo repositorio. Por ejemplo, para una regla que realiza un seguimiento de un repositorio de Git que significa 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 valores de atributos y funciones no herméticas (por ejemplo, para buscar o ejecutar un objeto binario, o bien para crear un archivo en el repositorio o descargar un archivo de Internet). Consulta los documentos 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 repositorio se ejecuta cuando Bazel necesita un destino de ese repositorio, por ejemplo, cuando otro destino (en otro repositorio) depende de él o si se menciona en la línea de comandos. Se espera que la función de implementación cree el repositorio en el sistema de archivos. Esto se llama "recuperar" el repositorio.

A diferencia de los objetivos normales, los repositorios no necesariamente se vuelven a recuperar cuando algo cambia que haría que el repositorio fuera diferente. Esto se debe a que Bazel no puede detectar cambios en algunos elementos o provocaría 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 alguna de las siguientes condiciones:

  • Los atributos que se pasaron a la invocación de la regla de repositorio.
  • El código de Starlark que comprende la implementación de la regla de repo.
  • Es el valor de cualquier variable de entorno que se pasa al método getenv() de repository_ctx o se declara con el atributo environ de repository_rule. Los valores de estas variables de entorno se pueden conectar de forma directa en la línea de comandos con la marca --repo_env.
  • El contenido de cualquier archivo que se pase a read(), execute() y métodos similares de repository_ctx al que hace referencia una etiqueta (por ejemplo, //mypkg:label.txt, pero no mypkg/label.txt)
  • 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 configura la marca configure, el repositorio solo se vuelve a recuperar en bazel fetch cuando se le pasa el parámetro --configure (si no se establece el atributo, este comando no causará una nueva recuperación).
  • Si se configura la marca local, además de los casos anteriores, el repositorio también se vuelve a recuperar cuando se reinicia el servidor de Bazel.

Reinicia la función de implementación

La función de implementación se puede reiniciar mientras se recupera un repositorio si falta una dependencia que solicita. En ese caso, se detendrá la ejecución de la función de implementación, se resolverá la dependencia faltante y la función se volverá a ejecutar después de que se haya resuelto la dependencia. Para evitar reinicios innecesarios (que son costosos, ya que el acceso a la red podría tener que repetirse), los argumentos de las etiquetas se cargan previamente, siempre que todos los argumentos de las etiquetas se puedan resolver en un archivo existente. Ten en cuenta que resolver una ruta de acceso a partir de una string o una etiqueta que se construyó solo durante la ejecución de la función puede causar un reinicio.

Fuerza la recuperació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 podría seguir una rama específica 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 de repositorio inspeccionan la máquina local y podrían quedar desactualizadas si esta se actualizó. Aquí puedes pedirle a Bazel que solo vuelva a recuperar esos repositorios externos en los que la definición repository_rule tenga configurado el atributo configure. Usa bazel fetch --all --configure.

Ejemplos

  • Cadena de herramientas configurada automáticamente de C++: Usa una regla de repositorio a fin de crear automáticamente los archivos de configuración de C++ para Bazel mediante la búsqueda del 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 a fin de usar las reglas de Go.

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