Sistemas de compilación basados en artefactos

En esta página, se describen los sistemas de compilación basados en artefactos y la filosofía detrás de su creación. Bazel es un sistema de compilación basado en artefactos. Si bien los sistemas de compilación basados en tareas son un buen paso por encima de las secuencias de comandos de compilación, les otorgan demasiado poder a los ingenieros individuales, ya que les permiten definir sus propias tareas.

Los sistemas de compilación basados en artefactos tienen una pequeña cantidad de tareas definidas por el sistema que los ingenieros pueden configurar de forma limitada. Los ingenieros aún le dicen al sistema qué compilar, pero el sistema de compilación determina cómo compilarlo. Al igual que con los sistemas de compilación basados en tareas, los sistemas de compilación basados en artefactos, como Bazel, aún tienen archivos de compilación, pero el contenido de esos archivos es muy diferente. En lugar de ser un conjunto imperativo de comandos en un lenguaje de secuencias de comandos Turing-completo que describe cómo producir un resultado, los archivos de compilación en Bazel son un manifiesto declarativo que describe un conjunto de artefactos para compilar, sus dependencias y un conjunto limitado de opciones que afectan la forma en que se compilan. Cuando los ingenieros ejecutan bazel en la línea de comandos, especifican un conjunto de destinos para compilar (el qué) y Bazel es responsable de configurar, ejecutar y programar los pasos de compilación (el cómo). Debido a que el sistema de compilación ahora tiene control total sobre qué herramientas ejecutar y cuándo, puede ofrecer garantías mucho más sólidas que le permiten ser mucho más eficiente y, a la vez, garantizar la precisión.

Una perspectiva funcional

Es fácil hacer una analogía entre los sistemas de compilación basados en artefactos y la programación funcional. Los lenguajes de programación imperativos tradicionales (como Java, C y Python) especifican listas de instrucciones que se ejecutarán una tras otra, de la misma manera que los sistemas de compilación basados en tareas permiten que los programadores definan una serie de pasos para ejecutar. En cambio, los lenguajes de programación funcionales (como Haskell y ML) están estructurados más como una serie de ecuaciones matemáticas. En los lenguajes funcionales, el programador describe un cálculo que se debe realizar, pero deja los detalles de cuándo y cómo se ejecuta exactamente ese cálculo al compilador.

Esto se relaciona con la idea de declarar un manifiesto en un sistema de compilación basado en artefactos y permitir que el sistema determine cómo ejecutar la compilación. Muchos problemas no se pueden expresar fácilmente con la programación funcional, pero los que se benefician mucho de ella: el lenguaje suele poder paralelizar de forma trivial esos programas y ofrecer garantías sólidas sobre su corrección que serían imposibles en un lenguaje imperativo. Los problemas más fáciles de expresar con la programación funcional son los que simplemente implican transformar un dato en otro con una serie de reglas o funciones. Y eso es exactamente lo que es un sistema de compilación: todo el sistema es, en realidad, una función matemática que toma archivos de origen (y herramientas como el compilador) como entradas y produce objetos binarios como resultados. Por lo tanto, no es de extrañar que funcione bien basar un sistema de compilación en los principios de la programación funcional.

Información sobre los sistemas de compilación basados en artefactos

El sistema de compilación de Google, Blaze, fue el primer sistema de compilación basado en artefactos. Bazel es la versión de código abierto de Blaze.

Así se ve un archivo de compilación (que normalmente se llama BUILD) en Bazel:

java_binary(
    name = "MyBinary",
    srcs = ["MyBinary.java"],
    deps = [
        ":mylib",
    ],
)
java_library(
    name = "mylib",
    srcs = ["MyLibrary.java", "MyHelper.java"],
    visibility = ["//java/com/example/myproduct:__subpackages__"],
    deps = [
        "//java/com/example/common",
        "//java/com/example/myproduct/otherlib",
    ],
)

En Bazel, los archivos BUILD definen destinos, los dos tipos de destinos aquí son java_binary y java_library. Cada destino corresponde a un artefacto que puede crear el sistema: los destinos binarios producen objetos binarios que se pueden ejecutar directamente, y los destinos de bibliotecas producen bibliotecas que pueden usar objetos binarios o bibliotecas. Cada objetivo tiene lo siguiente:

• name: Indica cómo se hace referencia al destino en la línea de comandos y en otros destinos.
• srcs: Son los archivos de origen que se compilarán para crear el artefacto del destino.
• deps: Otros destinos que se deben compilar antes de este y vincular a él.

Las dependencias pueden estar dentro del mismo paquete (como la dependencia de MyBinary en :mylib) o en un paquete diferente en la misma jerarquía de origen (como la dependencia de mylib en //java/com/example/common).

Al igual que con los sistemas de compilación basados en tareas, realizas compilaciones con la herramienta de línea de comandos de Bazel. Para compilar el destino MyBinary, ejecuta bazel build :MyBinary. Después de ingresar ese comando por primera vez en un repositorio limpio, Bazel hace lo siguiente:

1. Analiza cada archivo BUILD en el lugar de trabajo para crear un gráfico de dependencias entre los artefactos.
2. Usa el gráfico para determinar las dependencias transitivas de MyBinary, es decir, cada objetivo del que depende MyBinary y de los que dependen esos destinos, de manera recursiva.
3. Compila cada una de esas dependencias, en orden. Bazel comienza por compilar cada objetivo que no tenga otras dependencias y realiza un seguimiento de las dependencias que aún se deben compilar para cada objetivo. En cuanto se compilan todas las dependencias de un objetivo, Bazel comienza a compilarlo. Este proceso continúa hasta que se compila cada una de las dependencias transitivas de MyBinary.
4. Compila MyBinary para producir un ejecutable binario final que vincula todas las dependencias que se compilaron en el paso 3.

En esencia, puede parecer que lo que sucede aquí no es muy diferente de lo que sucedía cuando se usaba un sistema de compilación basado en tareas. De hecho, el resultado final es el mismo objeto binario, y el proceso para producirlo implica analizar varios pasos a fin de encontrar dependencias entre ellos y, luego, ejecutar esos pasos en orden. Pero existen diferencias críticas. El primero aparece en el paso 3: como Bazel sabe que cada destino solo produce una biblioteca de Java, sabe que todo lo que tiene que hacer es ejecutar el compilador de Java en lugar de una secuencia de comandos arbitraria definida por el usuario, por lo que sabe que es seguro ejecutar estos pasos en paralelo. Esto puede producir una mejora de rendimiento de orden de magnitud en comparación con la compilación de objetivos uno a la vez en una máquina multinúcleo, y solo es posible porque el enfoque basado en artefactos deja al sistema de compilación a cargo de su propia estrategia de ejecución para que pueda ofrecer garantías más sólidas sobre el paralelismo.

Sin embargo, los beneficios se extienden más allá del paralelismo. Lo siguiente que nos brinda este enfoque se hace evidente cuando el desarrollador escribe bazel build :MyBinary por segunda vez sin hacer ningún cambio: Bazel sale en menos de un segundo con un mensaje que dice que el destino está actualizado. Esto es posible debido al paradigma de programación funcional del que hablamos antes: Bazel sabe que cada destino es el resultado solo de la ejecución de un compilador de Java y que el resultado del compilador de Java depende solo de sus entradas, de modo que, mientras estas no hayan cambiado, el resultado se puede volver a usar. Este análisis funciona en todos los niveles. Si MyBinary.java cambia, Bazel sabe volver a compilar MyBinary, pero reutilizar mylib. Si cambia un archivo de origen para //java/com/example/common, Bazel sabe que debe volver a compilar esa biblioteca, mylib y MyBinary, pero volver a usar //java/com/example/myproduct/otherlib. Debido a que Bazel conoce las propiedades de las herramientas que ejecuta en cada paso, puede volver a compilar solo el conjunto mínimo de artefactos cada vez y, al mismo tiempo, garantizar que no se produzcan compilaciones inactivas.

Reformular el proceso de compilación en términos de artefactos en lugar de tareas es sutil, pero potente. Al reducir la flexibilidad expuesta al programador, el sistema de compilación puede obtener más información sobre lo que se hace en cada paso de la compilación. Puede usar este conocimiento para hacer que la compilación sea mucho más eficiente, ya que paraleliza los procesos de compilación y reutiliza sus resultados. Sin embargo, este es solo el primer paso, y estos componentes básicos de paralelismo y reutilización son la base de un sistema de compilación distribuido y altamente escalable.

Otros trucos útiles de Bazel

Los sistemas de compilación basados en artefactos resuelven, en esencia, los problemas de paralelismo y reutilización que son inherentes a los sistemas de compilación basados en tareas. Sin embargo, todavía hay algunos problemas que surgieron antes y que no abordamos. Bazel tiene formas inteligentes de resolver cada una de ellas, y deberíamos hablarlas antes de continuar.

Herramientas como dependencias

Un problema que encontramos antes era que las compilaciones dependían de las herramientas instaladas en nuestra máquina, y reproducir compilaciones en diferentes sistemas podría ser difícil debido a las diferentes versiones o ubicaciones de las herramientas. El problema se vuelve aún más difícil cuando tu proyecto usa lenguajes que requieren herramientas diferentes según la plataforma en la que se compilan (como Windows o Linux), y cada una de esas plataformas requiere un conjunto de herramientas ligeramente diferente para realizar la misma tarea.

Para resolver la primera parte de este problema, Bazel trata las herramientas como dependencias de cada destino. Cada java_library en el espacio de trabajo depende implícitamente de un compilador de Java, que de forma predeterminada es un compilador conocido. Cada vez que Bazel compila un java_library, verifica que el compilador especificado esté disponible en una ubicación conocida. Al igual que cualquier otra dependencia, si cambia el compilador de Java, se vuelve a compilar cada artefacto que depende de él.

Bazel resuelve la segunda parte del problema, la independencia de la plataforma, configurando parámetros de configuración de compilación. En lugar de depender directamente de sus herramientas, los objetivos dependen de los tipos de configuración:

• Configuración del host: herramientas de compilación que se ejecutan durante la compilación
• Configuración de destino: compila el objeto binario que solicitaste

Cómo extender el sistema de compilación

Bazel incluye objetivos para varios lenguajes de programación populares desde el primer momento, pero los ingenieros siempre querrán hacer más. Parte del beneficio de los sistemas basados en tareas es su flexibilidad para admitir cualquier tipo de proceso de compilación, y sería mejor no renunciar a eso en un sistema de compilación basado en artefactos. Por suerte, Bazel permite que se extiendan sus tipos de destino compatibles con la adición de reglas personalizadas.

Para definir una regla en Bazel, el autor de la regla declara las entradas que requiere (en forma de atributos pasados en el archivo BUILD) y el conjunto fijo de resultados que produce la regla. El autor también define las acciones que se generarán con esa regla. Cada acción declara sus entradas y salidas, ejecuta un ejecutable en particular o escribe una cadena en un archivo, y se puede conectar a otras acciones a través de sus entradas y salidas. Esto significa que las acciones son la unidad componible de nivel más bajo en el sistema de compilación: una acción puede hacer lo que quiera, siempre y cuando use solo sus entradas y salidas declaradas, y Bazel se encarga de programar acciones y almacenar en caché sus resultados según corresponda.

El sistema no es infalible, ya que no hay forma de impedir que un desarrollador de acciones realice acciones como introducir un proceso no determinista como parte de su acción. Sin embargo, esto no sucede muy a menudo en la práctica, y llevar las posibilidades de abuso hasta el nivel de acción disminuye en gran medida las oportunidades de errores. Las reglas que admiten muchos lenguajes y herramientas comunes están ampliamente disponibles en línea, y la mayoría de los proyectos nunca necesitarán definir sus propias reglas. Incluso para aquellos que sí lo hacen, las definiciones de reglas solo deben definirse en un lugar central del repositorio, lo que significa que la mayoría de los ingenieros podrán usar esas reglas sin tener que preocuparse por su implementación.

Cómo aislar el entorno

Parece que las acciones podrían tener los mismos problemas que las tareas de otros sistemas. ¿Acaso no es posible escribir acciones que ambas escriban en el mismo archivo y terminen en conflicto entre sí? En realidad, Bazel hace que estos conflictos sean imposibles con la zona de pruebas. En los sistemas compatibles, cada acción se aísla de las demás a través de la zona de pruebas del sistema de archivos. Efectivamente, cada acción solo puede ver una vista restringida del sistema de archivos que incluye las entradas que declaró y los resultados que produjo. Esto se aplica mediante sistemas como LXC en Linux, la misma tecnología que se usa en Docker. Esto significa que es imposible que las acciones entren en conflicto entre sí porque no pueden leer ningún archivo que no declaren y los archivos que escriban, pero no declaren, se descartarán cuando la acción finalice. Bazel también usa zonas de pruebas para evitar que las acciones se comuniquen a través de la red.

Haz que las dependencias externas sean deterministas

Aún queda un problema: los sistemas de compilación suelen necesitar descargar dependencias (ya sean herramientas o bibliotecas) desde fuentes externas en lugar de compilarlas directamente. Esto se puede ver en el ejemplo a través de la dependencia @com_google_common_guava_guava//jar, que descarga un archivo JAR de Maven.

El uso de archivos fuera del espacio de trabajo actual es riesgoso. Esos archivos pueden cambiar en cualquier momento, lo que podría requerir que el sistema de compilación verifique constantemente si están actualizados. Si un archivo remoto cambia sin el cambio correspondiente en el código fuente del lugar de trabajo, también puede generar compilaciones no reproducibles: una compilación puede funcionar un día y fallar al siguiente sin motivo aparente debido a un cambio de dependencia no notado. Por último, una dependencia externa puede generar un gran riesgo de seguridad cuando es propiedad de un tercero: si un atacante puede infiltrarse en ese servidor de terceros, puede reemplazar el archivo de dependencia con algo de su propio diseño, lo que le da control total sobre tu entorno de compilación y su resultado.

El problema fundamental es que queremos que el sistema de compilación esté al tanto de estos archivos sin tener que verificarlos en el control de código fuente. La actualización de una dependencia debería ser una decisión consciente, pero debe hacerse una vez en un lugar central, en lugar de que los ingenieros individuales o el sistema la administren automáticamente. Esto se debe a que, incluso con un modelo "Live at Head", queremos que las compilaciones sean deterministas, lo que implica que, si revisas una confirmación de la semana pasada, deberías ver tus dependencias como estaban en ese momento, en lugar de como están ahora.

Bazel y algunos otros sistemas de compilación solucionan este problema, ya que requieren un archivo de manifiesto para todo el espacio de trabajo que enumere un hash criptográfico para cada dependencia externa del lugar de trabajo. El hash es una forma concisa de representar el archivo de forma única sin verificar todo el archivo en el control de código fuente. Cada vez que se hace referencia a una dependencia externa nueva desde un lugar de trabajo, el hash de esa dependencia se agrega al manifiesto, ya sea de forma manual o automática. Cuando Bazel ejecuta una compilación, verifica el hash real de su dependencia almacenada en caché con el hash esperado definido en el manifiesto y vuelve a descargar el archivo solo si el hash difiere.

Si el artefacto que descargamos tiene un hash diferente del declarado en el manifiesto, la compilación fallará, a menos que se actualice el hash en el manifiesto. Esto se puede hacer automáticamente, pero ese cambio se debe aprobar y registrar en el control de código fuente para que la compilación acepte la dependencia nueva. Esto significa que siempre hay un registro de cuándo se actualizó una dependencia, y una dependencia externa no puede cambiar sin un cambio correspondiente en la fuente del espacio de trabajo. También significa que, cuando se obtiene una versión anterior del código fuente, se garantiza que la compilación use las mismas dependencias que usaba en el momento en que se revisó esa versión (de lo contrario, fallará si esas dependencias ya no están disponibles).

Por supuesto, puede seguir siendo un problema si un servidor remoto deja de estar disponible o comienza a entregar datos dañados. Esto puede provocar que todas tus compilaciones comiencen a fallar si no tienes otra copia de esa dependencia disponible. Para evitar este problema, te recomendamos que, en cualquier proyecto no trivial, dupliques todas sus dependencias en servidores o servicios que sean de confianza y controles. De lo contrario, siempre estarás a merced de un tercero para la disponibilidad de tu sistema de compilación, incluso si los hashes verificados garantizan su seguridad.