Ya comenzó el registro para BazelCon 2024

Se usó la API de Cloud Translation para traducir esta página.

Trabaja con dependencias externas

Informar un problema Ver fuente Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

El archivo WORKSPACE (o WORKSPACE.bazel) en el directorio de espacio 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 dentro del proyecto principal pueden depender de estos destinos externos usando su 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 un repositorio llamado project2 se puede encontrar en /home/user/project2. Luego, 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 de paquetes externos

Dependencia de 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 los destinos que definió desde 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 hacer referencia a él como @coworkers_project//foo:bar. Los nombres de proyectos externos deben ser nombres de lugares de trabajo válidos.

Depende de 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 quieres 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 superponerlo en el proyecto existente, por ejemplo:

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

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

Dependencia de paquetes externos

Artefactos y repositorios de Maven

Usa el conjunto de reglas rules_jvm_external para descargar artefactos de los repositorios de Maven y ponerlos a disposición 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 se realiza 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 obligatorio para las dependencias que compilas y que terminan en tu ejecutable final. Sin embargo, en los casos en que esto no sea cierto, es posible ocultar las 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 versiones diferentes 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 llamaban con nombres diferentes, esas dependencias se pueden unir en myproject/WORKSPACE.

Cómo anular 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 en el que puedes realizar cambios con mayor facilidad.
Vendoring 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 recuperará las direcciones de proxy de las variables de entorno HTTPS_PROXY y HTTP_PROXY y las usará para descargar archivos HTTP o HTTPS (si se especifican).

Compatibilidad con IPv6

En máquinas solo 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 alcanzar direcciones externas, esto puede generar excepciones de 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 destinos de compilación de Java que también deben conectarse a Internet (las pruebas de integración a veces lo necesitan), también usa la marca de herramienta --jvmopt=-Djava.net.preferIPv6Addresses=true, por ejemplo, con 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 versiones de dependencias, también agrega -Djava.net.preferIPv6Addresses=true a la variable de entorno COURSIER_OPTS para proporcionar opciones de JVM para Coursier

Dependencias transitivas

Bazel solo lee las dependencias que se enumeran en tu archivo WORKSPACE. Si tu proyecto (A) depende de otro proyecto (B) que enumera 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 parches o archivos BUILD).

Para forzar una nueva descarga, usa bazel sync.

Diseño

Todas las dependencias externas se descargan en un directorio debajo del subdirectorio external en la base de salida. En el caso de un repositorio local, se crea un symlink en lugar de 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, obtener con anticipación 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. Cada vez que una regla de repositorio le pide 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 básico de la primera URL proporcionada y usará esa copia local si el hash coincide.

Bazel usa esta técnica para iniciar sin conexión desde el 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 se comunican con la red. Por lo tanto, Bazel no tiene la opción de forzar 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 otra parte del sistema
Descargar recursos desde URLs
Generar archivos BUILD o crear symlinks en el directorio del repositorio externo

Evita usar repository_ctx.execute siempre que sea posible. Por ejemplo, cuando usas una biblioteca C++ que no es de Bazel que tiene una compilación con Make, es preferible usar repository_ctx.download() y, luego, escribir un archivo BUILD 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 git(1) del sistema, mientras que el descargador de HTTP se compila en Bazel y no tiene dependencias del sistema.
http_archive admite una lista de urls como espejos, y git_repository solo admite un solo 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 bind" para obtener un análisis detallado de sus problemas y alternativas.