Configura la CI de Bazel a fin de probar reglas para la ejecución remota

Esta página está dirigida a los propietarios y mantenedores de repositorios de reglas de Bazel. En ella, se describe cómo configurar el sistema de integración continua (CI) de Bazel para que tu repositorio pruebe la compatibilidad de tus reglas con una situación de ejecución remota. Las instrucciones de esta página se aplican a los proyectos almacenados en repositorios de GitHub.

Requisitos previos

Antes de completar los pasos de esta página, asegúrate de cumplir con los siguientes requisitos:

• Tu repositorio de GitHub forma parte de la organización de GitHub de Bazel.
• Configuraste Buildkite para tu repositorio como se describe en Integración continua de Bazel.

Cómo configurar la CI de Bazel para realizar pruebas

1. En tu archivo .bazelci/presubmit.yml, haz lo siguiente:

   a. Agrega una configuración llamada rbe_ubuntu1604.

   b. En la configuración de rbe_ubuntu1604, agrega los destinos de compilación y prueba con los que deseas probar la ejecución remota.

2. Agrega el repositorio de GitHubbazel-toolchains a tu archivo WORKSPACE, fijado a la versión más reciente. También agrega un objetivo rbe_autoconfig con el nombre buildkite_config. En este ejemplo, se crea la configuración de la cadena de herramientas para la ejecución remota con BuildKite CI para rbe_ubuntu1604.

load("@bazel_toolchains//rules:rbe_repo.bzl", "rbe_autoconfig")
rbe_autoconfig(name = "buildkite_config")

1. Envía una solicitud de extracción con los cambios que realizaste en el archivo presubmit.yml. (Consulta un ejemplo de solicitud de extracción).

2. Para ver los resultados de la compilación, haz clic en Details en la verificación de la solicitud de extracción de RBE (Ubuntu 16.04) en GitHub, como se muestra en la siguiente figura. Este vínculo estará disponible después de que se combine la solicitud de extracción y se ejecuten las pruebas de CI. (Consulta los resultados de ejemplo).

   

3. (Opcional) Establece la verificación bazel test (RBE (Ubuntu 16.04)) como una prueba que debe aprobarse antes de combinar la regla de protección de la rama. El parámetro de configuración se encuentra en GitHub en Settings > Branches > Branch protection rules, como se muestra en la siguiente figura.

   

Soluciona problemas relacionados con compilaciones y pruebas con errores

Si fallan tus compilaciones o pruebas, es probable que se deba a lo siguiente:

• Las herramientas de compilación o prueba necesarias no están instaladas en el contenedor predeterminado. Las compilaciones que usan la configuración de rbe_ubuntu1604 se ejecutan de forma predeterminada dentro de un contenedor de rbe-ubuntu16-04, que incluye herramientas comunes a muchas compilaciones de Bazel. Sin embargo, si tus reglas requieren herramientas que no están presentes en el contenedor predeterminado, debes crear un contenedor personalizado basado en el contenedor rbe-ubuntu16-04 e incluir esas herramientas como se describe más adelante.

• Los destinos de compilación o prueba usan reglas que son incompatibles con la ejecución remota. Consulta Cómo adaptar reglas de Bazel para la ejecución remota para obtener detalles sobre la compatibilidad con la ejecución remota.

Usa un contenedor personalizado en la configuración de CI de rbe_ubuntu1604

El contenedor rbe-ubuntu16-04 está disponible públicamente en la siguiente URL:

http://gcr.io/cloud-marketplace/google/rbe-ubuntu16-04

Puedes extraerlo directamente de Container Registry o compilarlo desde la fuente. En las siguientes secciones, se describen ambas opciones.

Antes de comenzar, asegúrate de haber instalado gcloud, docker y git. Si compilas el contenedor desde la fuente, también debes instalar la versión más reciente de Bazel.

Cómo extraer rbe-ubuntu16-04 de Container Registry

Para extraer el contenedor rbe-ubuntu16-04 de Container Registry, ejecuta el siguiente comando:

gcloud docker -- pull gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum

Reemplaza sha256-checksum por el valor de la suma de comprobación SHA256 del contenedor más reciente.

Cómo compilar el contenedor rbe-ubuntu16-04 desde la fuente

Para compilar el contenedor rbe-ubuntu16-04 a partir del código fuente, haz lo siguiente:

1. Clona el repositorio bazel-toolchains:

   git clone https://github.com/bazelbuild/bazel-toolchains

2. Configura los objetivos de los contenedores de la cadena de herramientas y compila el contenedor como se explica en Contenedores de la cadena de herramientas.

3. Extrae el contenedor recién compilado:

   gcloud docker -- pull gcr.io/project-id/custom-container-namesha256-checksum

Ejecuta el contenedor personalizado

Para ejecutar el contenedor personalizado, realiza una de las siguientes acciones:

• Si extrajiste el contenedor de Container Registry, ejecuta el siguiente comando:

  docker run -it gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum/bin/bash

  Reemplaza sha256-checksum por el valor de suma de comprobación SHA256 del contenedor más reciente.

• Si compilaste el contenedor desde la fuente, ejecuta el siguiente comando:

  docker run -it gcr.io/project-id/custom-container-name@sha256:sha256sum /bin/bash

Agrega recursos al contenedor personalizado

Usa Dockerfile o rules_docker para agregar recursos o versiones alternativas de los recursos originales al contenedor rbe-ubuntu16-04. Si no conoces Docker, lee lo siguiente:

• Docker para principiantes
• Muestras de Docker

Por ejemplo, el siguiente fragmento de Dockerfile instala my_tool_package:

FROM gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum
RUN apt-get update && yes | apt-get install -y my_tool_package

Envía el contenedor personalizado a Container Registry

Una vez que hayas personalizado el contenedor, compila la imagen del contenedor y envíala a Container Registry de la siguiente manera:

1. Compila la imagen del contenedor:

   docker build -t custom-container-name.
   docker tag custom-container-name gcr.io/project-id/custom-container-name

2. Envía la imagen de contenedor a Container Registry:

   gcloud docker -- push gcr.io/project-id/custom-container-name

3. Navega a la siguiente URL para verificar que se haya enviado el contenedor:

   https://console.cloud.google.com/gcr/images/project-id/GLOBAL/custom-container-name

4. Anota la suma de verificación SHA256 de tu contenedor personalizado. Deberás proporcionarlo más adelante en la definición de la plataforma de compilación.

5. Configura el contenedor para el acceso público como se describe en Cómo publicar imágenes de forma pública.

   Para obtener más información, consulta Envía y extrae imágenes.

Cómo especificar la definición de la plataforma de compilación

Debes incluir una configuración de plataforma de Bazel en tu configuración de cadena de herramientas personalizada, lo que permite que Bazel seleccione una cadena de herramientas adecuada para la plataforma de hardware o software deseada. Para generar automáticamente una plataforma válida, puedes agregar a tu WORKSPACE un destino rbe_autoconfig con el nombre buildkite_config que incluya atributos adicionales para seleccionar tu contenedor personalizado. Para obtener detalles sobre esta configuración, lee la documentación actualizada de rbe_autoconfig.