Trabaja con dependencias externas

Informar un problema Ver fuente Noche}

Bazel puede depender de destinos de otros proyectos. Las dependencias de estos otros proyectos se denominan dependencias externas.

Nota: Bazel 5.0 y las versiones posteriores tienen un nuevo sistema de dependencia externa, con el nombre interno "Bzlmod", que hace que gran parte del contenido de esta página sea obsoleto. Consulta la guía del usuario de Bzlmod para obtener más información.

El archivo WORKSPACE (o archivo WORKSPACE.bazel) en el directorio del lugar de trabajo le indica a Bazel cómo obtener las fuentes de otros proyectos. Estos otros proyectos pueden contener uno o más archivos BUILD con sus propios destinos. Los archivos BUILD del proyecto principal pueden depender de estos destinos externos mediante el nombre del archivo WORKSPACE.

Por ejemplo, supongamos que hay dos proyectos en un sistema:

/
  home/
    user/
      project1/
        WORKSPACE
        BUILD
        srcs/
          ...
      project2/
        WORKSPACE
        BUILD
        my-libs/

Si project1 quisiera depender de un destino, :foo, definido en /home/user/project2/BUILD, podría especificar que se pudiera encontrar un repositorio llamado project2 en /home/user/project2. Entonces, los objetivos en /home/user/project1/BUILD podrían depender de @project2//:foo.

El archivo WORKSPACE permite a los usuarios depender de destinos de otras partes del sistema de archivos o de los que se descargan de Internet. Usa la misma sintaxis que los archivos BUILD, pero permite un conjunto diferente de reglas llamadas reglas del repositorio (a veces, también conocidas como reglas del lugar de trabajo). Bazel incluye algunas reglas de repositorio integradas y un conjunto de reglas de repositorio de Starlark incorporadas. Los usuarios también pueden escribir reglas de repositorio personalizadas para obtener un comportamiento más complejo.

Tipos de dependencias externas compatibles

Se pueden usar algunos tipos básicos de dependencias externas:

• Dependencias en otros proyectos de Bazel
• Dependencias en proyectos que no son de Bazel
• Dependencias en paquetes externos

Según otros proyectos de Bazel

Si quieres usar destinos de un segundo proyecto de Bazel, puedes usar local_repository, git_repository o http_archive para establecer un symlink desde el sistema de archivos local, hacer referencia a un repositorio de Git o descargarlo (respectivamente).

Por ejemplo, supongamos que estás trabajando en un proyecto, my-project/, y deseas depender de los objetivos del proyecto de tu compañero de trabajo, coworkers-project/. Ambos proyectos usan Bazel, por lo que puedes agregar el proyecto de tu compañero de trabajo como una dependencia externa y, luego, usar cualquier destino que haya definido tu compañero de trabajo a partir de tus propios archivos de COMPILACIÓN. Agregarías lo siguiente a my_project/WORKSPACE:

local_repository(
    name = "coworkers_project",
    path = "/path/to/coworkers-project",
)

Si tu compañero de trabajo tiene un //foo:bar de destino, tu proyecto puede referirse a él como @coworkers_project//foo:bar. Los nombres de proyectos externos deben ser nombres de lugares de trabajo válidos.

Según proyectos que no sean de Bazel

Las reglas con el prefijo new_, como new_local_repository, te permiten crear destinos desde proyectos que no usan Bazel.

Por ejemplo, supongamos que estás trabajando en un proyecto, my-project/, y deseas depender del proyecto de tu compañero de trabajo, coworkers-project/. El proyecto de tu compañero de trabajo usa make para compilar, pero te gustaría depender de uno de los archivos .so que genera. Para ello, agrega lo siguiente a my_project/WORKSPACE:

new_local_repository(
    name = "coworkers_project",
    path = "/path/to/coworkers-project",
    build_file = "coworker.BUILD",
)

build_file especifica un archivo BUILD para superponer en el proyecto existente, por ejemplo:

cc_library(
    name = "some-lib",
    srcs = glob(["**"]),
    visibility = ["//visibility:public"],
)

Luego, puedes depender de @coworkers_project//:some-lib de los archivos BUILD de tu proyecto.

Según los paquetes externos

Artefactos y repositorios de Maven

Usa el conjunto de reglas rules_jvm_external para descargar artefactos de repositorios de Maven y hacer que estén disponibles como dependencias de Java.

Recupera dependencias

De forma predeterminada, las dependencias externas se recuperan según sea necesario durante bazel build. Si deseas cargar previamente las dependencias necesarias para un conjunto específico de destinos, usa bazel fetch. Para recuperar de forma incondicional todas las dependencias externas, usa bazel sync. Como los repositorios recuperados se almacenan en la base de salida, la recuperación ocurre por lugar de trabajo.

Dependencias de la duplicación

Siempre que sea posible, se recomienda tener una sola política de versión en tu proyecto. Esto es necesario para las dependencias con las que compilas y terminas en tu objeto binario final. Sin embargo, en los casos en los que esto no sea cierto, es posible crear sombras de dependencias. Considera la siguiente situación:

miproyecto/WORKSPACE

workspace(name = "myproject")

local_repository(
    name = "A",
    path = "../A",
)
local_repository(
    name = "B",
    path = "../B",
)

A/WORKSPACE

workspace(name = "A")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner",
    urls = ["https://github.com/testrunner/v1.zip"],
    sha256 = "...",
)

B/WORKSPACE

workspace(name = "B")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner",
    urls = ["https://github.com/testrunner/v2.zip"],
    sha256 = "..."
)

Ambas dependencias, A y B, dependen de testrunner, pero dependen de diferentes versiones de testrunner. No hay motivo para que estos ejecutores de pruebas no coexistan de forma pacífica dentro de myproject. Sin embargo, chocarán entre sí, ya que tienen el mismo nombre. Para declarar ambas dependencias, actualiza myproject/WORKSPACE:

workspace(name = "myproject")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner-v1",
    urls = ["https://github.com/testrunner/v1.zip"],
    sha256 = "..."
)
http_archive(
    name = "testrunner-v2",
    urls = ["https://github.com/testrunner/v2.zip"],
    sha256 = "..."
)
local_repository(
    name = "A",
    path = "../A",
    repo_mapping = {"@testrunner" : "@testrunner-v1"}
)
local_repository(
    name = "B",
    path = "../B",
    repo_mapping = {"@testrunner" : "@testrunner-v2"}
)

Este mecanismo también se puede utilizar para unir diamantes. Por ejemplo, si A y B tenían la misma dependencia, pero la llaman con nombres diferentes, esas dependencias se pueden unir en myproject/WORKSPACE.

Anula repositorios desde la línea de comandos

Para anular un repositorio declarado con un repositorio local desde la línea de comandos, usa la marca --override_repository. El uso de esta marca cambia el contenido de los repositorios externos sin cambiar el código fuente.

Por ejemplo, para anular @foo en el directorio local /path/to/local/foo, pasa la marca --override_repository=foo=/path/to/local/foo.

A continuación, se presentan algunos de los casos prácticos:

• Problemas de depuración. Por ejemplo, puedes anular un repositorio http_archive en un directorio local donde puedas realizar cambios con mayor facilidad.
• Proveedores Si estás en un entorno en el que no puedes realizar llamadas de red, anula las reglas del repositorio basadas en la red para que apunten a directorios locales en su lugar.

Usa proxies

Bazel recopilará las direcciones de proxy de las variables de entorno HTTPS_PROXY y HTTP_PROXY, y las usará para descargar archivos HTTP/HTTPS (si se especifica).

Compatibilidad con IPv6

En las máquinas que solo usan IPv6, Bazel podrá descargar dependencias sin cambios. Sin embargo, en las máquinas IPv4/IPv6 de pila doble, Bazel sigue la misma convención que Java: si se habilita IPv4, se prefiere IPv4. En algunas situaciones, por ejemplo, cuando la red IPv4 no puede resolver o llegar a direcciones externas, esto puede causar excepciones Network unreachable y fallas de compilación. En estos casos, puedes anular el comportamiento de Bazel y priorizar IPv6 mediante la propiedad del sistema java.net.preferIPv6Addresses=true. En particular, haz lo siguiente:

• Usa la opción de inicio --host_jvm_args=-Djava.net.preferIPv6Addresses=true, por ejemplo, si agregas la siguiente línea a tu archivo .bazelrc:

  startup --host_jvm_args=-Djava.net.preferIPv6Addresses=true

• Si ejecutas objetivos de compilación de Java que también necesitan conectarse a Internet (a veces, las pruebas de integración lo necesitan), usa también la marca de herramienta --jvmopt=-Djava.net.preferIPv6Addresses=true. Por ejemplo, incluye la siguiente línea en tu archivo .bazelrc:

  build --jvmopt=-Djava.net.preferIPv6Addresses

• Si usas rules_jvm_external, por ejemplo, para la resolución de la versión de dependencia, también agrega -Djava.net.preferIPv6Addresses=true a la variable de entorno COURSIER_OPTS a fin de proporcionar opciones de JVM para Coursier.

Dependencias transitivas

Bazel solo lee las dependencias que se indican en tu archivo WORKSPACE. Si tu proyecto (A) depende de otro proyecto (B) que indica una dependencia en un tercer proyecto (C) en su archivo WORKSPACE, deberás agregar B y C al archivo WORKSPACE de tu proyecto. Este requisito puede aumentar el tamaño del archivo WORKSPACE, pero limita las posibilidades de que una biblioteca incluya C en la versión 1.0 y otra incluya C en la versión 2.0.

Almacenamiento en caché de dependencias externas

De forma predeterminada, Bazel solo volverá a descargar dependencias externas si cambia su definición. Bazel también tiene en cuenta los cambios en los archivos a los que se hace referencia en la definición (como los parches o los archivos BUILD).

Para forzar una nueva descarga, usa bazel sync.

Diseño

Todas las dependencias externas se descargan en un directorio dentro del subdirectorio external en la base de salida. En el caso de un repositorio local, allí se crea un symlink en lugar de crear un directorio nuevo. Para ver el directorio external, ejecuta lo siguiente:

ls $(bazel info output_base)/external

Ten en cuenta que ejecutar bazel clean no borrará el directorio externo. Para quitar todos los artefactos externos, usa bazel clean --expunge.

Compilaciones sin conexión

A veces, es conveniente o necesario ejecutar una compilación sin conexión. Para casos de uso simples, como viajar en un avión, cargar previamente los repositorios necesarios con bazel fetch o bazel sync puede ser suficiente. Además, con la opción --nofetch, se puede inhabilitar la recuperación de más repositorios durante la compilación.

En el caso de las verdaderas compilaciones sin conexión, en las que una entidad diferente de Bazel realiza los archivos necesarios y proporciona los archivos necesarios, Bazel admite la opción --distdir. Cuando una regla de repositorio le solicita a Bazel que recupere un archivo a través de ctx.download o ctx.download_and_extract y proporciona una suma de hash del archivo necesario, Bazel primero buscará en los directorios especificados por esa opción un archivo que coincida con el nombre base de la primera URL proporcionada y usará esa copia local si el hash coincide.

Bazel usa esta técnica para realizar un arranque sin conexión a partir del artefacto de distribución. Para ello, recopila todas las dependencias externas necesarias en un distdir_tar interno.

Sin embargo, Bazel permite la ejecución de comandos arbitrarios en las reglas del repositorio, sin saber si llaman a la red. Por lo tanto, Bazel no tiene la opción de aplicar de manera forzosa que las compilaciones sean completamente sin conexión. Por lo tanto, probar si una compilación funciona correctamente sin conexión requiere el bloqueo externo de la red, como lo hace Bazel en su prueba de arranque.

Prácticas recomendadas

Reglas del repositorio

Por lo general, una regla de repositorio debe ser responsable de lo siguiente:

• Detectar la configuración del sistema y escribirla en archivos.
• Buscar recursos en otras partes del sistema.
• Se están descargando recursos a partir de URLs.
• Generar o vincular symlink archivos BUILD en el directorio del repositorio externo

Evita usar repository_ctx.execute cuando sea posible. Por ejemplo, cuando usas una biblioteca C++ que no es de Bazel y tiene una compilación con Make, es preferible usar repository_ctx.download() y, luego, escribir un archivo de COMPILACIÓN que la compile, en lugar de ejecutar ctx.execute(["make"]).

Elige http_archive en lugar de git_repository y new_git_repository. Estos son los motivos:

• Las reglas del repositorio de Git dependen del sistema git(1), mientras que el cargador HTTP está compilado en Bazel y no tiene dependencias del sistema.
• http_archive admite una lista de urls como duplicaciones, y git_repository admite solo una remote.
• http_archive funciona con la caché del repositorio, pero no con git_repository. Consulta #5116 para obtener más información.

No uses bind(). Consulta "Considera quitar la vinculación" para obtener un análisis extenso de sus problemas y alternativas.