Sistemas de compilación basados en artefactos

En esta página, se abordan 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 arriba 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 este determina cómo hacerlo. 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 programación de Turing completo que describe cómo producir un resultado, los archivos de compilación en Bazel son un manifiesto declarativo en el que se 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 permitan ser mucho más eficiente y, a la vez, garantizar la precisión.

Una perspectiva funcional

Se puede 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 declaraciones que se ejecutarán una tras otra, de la misma manera que los sistemas de compilación basados en tareas permiten a los programadores definir una serie de pasos para ejecutar. En cambio, los lenguajes de programación funcionales (como Haskell y AA), se estructuran más como una serie de ecuaciones matemáticas. En los lenguajes funcionales, el programador describe un cálculo que se realizará, pero le deja al compilador los detalles de cuándo y exactamente cómo se ejecuta ese cálculo.

Esto se asigna a la idea de declarar un manifiesto en un sistema de compilación basado en artefactos y permitir que el sistema descubra cómo ejecutar la compilación. Muchos problemas no se pueden expresar con facilidad mediante la programación funcional, pero los que se benefician mucho de ella: el lenguaje a menudo puede paralelizar trivialmente esos programas y ofrecer garantías sólidas sobre su precisión que sería imposible en un lenguaje imperativo. Los problemas más fáciles de expresar mediante la programación funcional son los que simplemente implican transformar un dato en otro mediante una serie de reglas o funciones. Eso es exactamente lo que es un sistema de compilación: todo el sistema es efectivamente una función matemática que toma archivos de origen (y herramientas como el compilador) como entradas y produce objetos binarios como salidas. Por lo tanto, no es de extrañar que funcione bien para 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.

A continuación, se muestra 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. Estos dos tipos de destinos 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 de forma directa y los destinos de las bibliotecas producen bibliotecas que los objetos binarios y otras bibliotecas pueden usar. Todos los objetivos tienen lo siguiente:

• name: Indica cómo se hace referencia al destino en la línea de comandos y por 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 que este destino y vincular a él

Las dependencias pueden estar dentro del mismo paquete (como la dependencia de MyBinary de :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, las compilaciones se realizan 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 realiza las siguientes acciones:

1. Analiza cada archivo BUILD en el lugar de trabajo para crear un gráfico de dependencias entre artefactos.
2. Usa el gráfico para determinar las dependencias transitivas de MyBinary, es decir, cada objetivo del que depende MyBinary y cada objetivo del que dependen esos objetivos de forma recurrente.
3. Compila cada una de esas dependencias, en orden. Bazel comienza por compilar cada destino que no tiene otras dependencias y hace un seguimiento de las dependencias que aún se deben compilar para cada destino. En cuanto se compilan todas las dependencias de un destino, 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 objeto binario ejecutable final que se vincula con todas las dependencias que se compilaron en el paso 3.

En esencia, puede que no parezca que lo que sucede aquí sea muy diferente de lo que sucedió cuando se usó un sistema de compilación basado en tareas. De hecho, el resultado final es el mismo objeto binario, y el proceso para producirlo implicó el análisis de un conjunto de pasos para encontrar dependencias entre ellas 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 Java, sabe que lo único que tiene que hacer es ejecutar el compilador de Java en lugar de una secuencia de comandos arbitraria definida por el usuario, de modo que sepa que es seguro ejecutar estos pasos en paralelo. Esto puede producir una mejora en el rendimiento de un orden de magnitud en la compilación de objetivos de a uno a la vez en una máquina de varios núcleos 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 muestra este enfoque se hace evidente cuando el desarrollador escribe bazel build :MyBinary por segunda vez sin hacer ningún cambio: Bazel se cierra 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 que mencionamos antes: Bazel sabe que cada objetivo es solo el resultado de ejecutar un compilador de Java y que el resultado del compilador de Java depende solo de sus entradas, por lo que, si las entradas no cambiaron, el resultado se podrá volver a usar. Y este análisis funciona en todos los niveles. Si cambia MyBinary.java, Bazel sabe que debe 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 reutilizar //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, garantiza que no producirá 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 que se expone 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 mediante la paralelización de procesos de compilación y la reutilización de sus resultados. Sin embargo, este es solo el primer paso, y estos componentes básicos de paralelismo y reutilización forman la base de un sistema de compilación distribuido y altamente escalable.

Otros trucos ingeniosos de Bazel

Los sistemas de compilación basados en artefactos resuelven, en esencia, los problemas con el paralelismo y la reutilización que son inherentes en los sistemas de compilación basados en tareas. Sin embargo, todavía hay algunos problemas que surgieron antes y que no hemos abordado. Bazel tiene formas inteligentes de resolver cada uno de ellos, y debemos analizarlos antes de continuar.

Herramientas como dependencias

Un problema con el que nos encontramos antes fue que las compilaciones dependían de las herramientas instaladas en nuestra máquina, y reproducir compilaciones en todos los 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 diferentes herramientas según la plataforma en la que se compilan o en la que se compilan (como Windows o Linux), y cada una de esas plataformas requiere un conjunto de herramientas un poco diferente para hacer el mismo trabajo.

Bazel resuelve la primera parte de este problema cuando trata las herramientas como dependencias de cada objetivo. Cada java_library en el lugar 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. Como cualquier otra dependencia, si el compilador de Java cambia, cada artefacto que depende de él se vuelve a compilar.

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

• Configuración del host: Compilación de herramientas que se ejecutan durante la compilación
• Configuración de destino: Compila el objeto binario que solicitaste en última instancia.

Cómo extender el sistema de compilación

Bazel incluye objetivos para varios lenguajes de programación populares listos para usar, pero los ingenieros siempre querrán hacer más. Una de las ventajas de los sistemas basados en tareas es su flexibilidad para admitir cualquier tipo de proceso de compilación, y sería mejor no abandonarlo en un sistema de compilación basado en artefactos. Por suerte, Bazel permite extender sus tipos de destino compatibles agregando reglas personalizadas.

Para definir una regla en Bazel, el autor de la regla declara las entradas que requiere la regla (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 generará esa regla. Cada acción declara sus entradas y salidas, ejecuta un ejecutable específico o escribe una string específica 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 de componibilidad de nivel más bajo en el sistema de compilación: una acción puede hacer lo que desee, siempre que use solo sus entradas y salidas declaradas, y Bazel se encarga de programar las acciones y almacenar en caché sus resultados según corresponda.

El sistema no es infalible, ya que no hay forma de evitar que un desarrollador de acciones realice algo 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 reducir las posibilidades de abuso al nivel de la 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 las tienen, las definiciones de reglas solo deben definirse en un lugar central en el repositorio, lo que significa que la mayoría de los ingenieros podrán usar esas reglas sin tener que preocuparse por su implementación.

Aísla 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 escriben en el mismo archivo y terminan en conflicto entre sí? En realidad, Bazel hace que estos conflictos sean imposibles mediante la zona de pruebas. En los sistemas compatibles, cada acción se aísla de todas las demás mediante una zona de pruebas del sistema de archivos. Efectivamente, cada acción puede ver solo una vista restringida del sistema de archivos que incluya las entradas que declaró y cualquier salida que haya producido. Esto se aplica mediante sistemas como LXC en Linux, la misma tecnología detrás de Docker. Esto significa que es imposible que las acciones entren en conflicto entre sí, ya que no pueden leer ningún archivo que no declare y los archivos que escriban, pero que no declare, se descartarán cuando finalice la acción. Bazel también usa zonas de pruebas para impedir que las acciones se comuniquen a través de la red.

Hacer que las dependencias externas sean deterministas

Todavía queda un problema: los sistemas de compilación a menudo necesitan descargar dependencias (ya sean herramientas o bibliotecas) de 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.

Es riesgoso depender de los archivos fuera del espacio de trabajo actual. Esos archivos podrían cambiar en cualquier momento, lo que podría requerir que el sistema de compilación verifique de forma constante si son recientes. Si un archivo remoto cambia sin un cambio correspondiente en el código fuente del lugar de trabajo, también puede generar compilaciones que no se pueden reproducir; una compilación podría funcionar un día y fallar el siguiente sin una razón evidente debido a un cambio de dependencia inadvertido. Por último, una dependencia externa puede generar un gran riesgo de seguridad cuando es propiedad de un tercero: si un atacante logra infiltrarse en ese servidor de terceros, puede reemplazar el archivo de dependencia por algo de su propio diseño, lo que podría darle control total sobre el entorno de compilación y sus resultados.

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

Bazel y algunos otros sistemas de compilación abordan este problema, ya que requieren un archivo de manifiesto en todo el lugar de trabajo que enumere un hash criptográfico para cada dependencia externa del lugar de trabajo. El hash es una forma concisa de representar de forma única el archivo sin verificar el archivo completo 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 de forma manual o automática. Cuando Bazel ejecuta una compilación, compara 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 al 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 se debe aprobar y registrar ese cambio en el control de código fuente antes de 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 lugar de trabajo. También significa que, cuando se consulta una versión anterior del código fuente, se garantiza que la compilación usará las mismas dependencias que usaba cuando se registró esa versión (de lo contrario, fallará si esas dependencias ya no están disponibles).

Por supuesto, puede ser un problema si un servidor remoto deja de estar disponible o comienza a entregar datos dañados, lo que 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 en los que confíes 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 registrados garantizan su seguridad.