Sistemas de compilación basados en artefactos

Informa un problemaopen_in_new Ver código fuenteopen_in_new

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 por encima de las secuencias de comandos de compilación, les dan 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 todavía le indican al sistema qué compilar, pero el sistema determina cómo compilarlo. Al igual que con los sistemas de compilación basados en tareas, los sistemas basados en artefactos, como Bazel, aún tienen archivos de compilación, pero el contenido de estos es muy diferente. En lugar de ser un conjunto imperativo de comandos en un lenguaje de secuencia de comandos de 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 cómo 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 la compilación (el cómo). Debido a que el sistema de compilación ahora tiene control total sobre qué herramientas ejecutar, puede hacer garantías mucho más sólidas que le permiten ser mucho más eficiente sin dejar de 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 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. Los lenguajes de programación funcionales (como Haskell y AA), en cambio, están estructurados como una serie de ecuaciones matemáticas. En los lenguajes funcionales, el programador describe un cálculo para realizar, pero deja los detalles sobre cuándo y cómo se ejecuta ese cálculo en el compilador.

Esto se corresponde con 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 sí se benefician mucho son aquellos en los que el lenguaje a menudo puede paralelizar trivialmente esos programas y hacer 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. Y 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 torno a los principios de la programación funcional.

Comprende los sistemas de compilación basados en artefactos

Blaze, el sistema de compilación de Google, 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 (normalmente llamado 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 objetivos. Los 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 directamente, y los objetivos de las bibliotecas producen bibliotecas que los objetos binarios y otras bibliotecas pueden usar. Cada destino tiene lo siguiente:

• name: Cómo se hace referencia al destino en la línea de comandos y mediante otros destinos
• srcs: Los archivos de origen que se compilarán para crear el artefacto para el destino
• deps: Son otros destinos que se deben compilar antes del destino 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, puedes realizar compilaciones mediante 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:

1. Analiza cada archivo BUILD del lugar de trabajo para crear un grafo de dependencias entre artefactos.
2. Usa el grafo para determinar las dependencias transitivas de MyBinary; es decir, cada objetivo del que depende MyBinary y cada destino del que dependen, de forma recursiva.
3. Compila cada una de esas dependencias, en orden. Para comenzar, Bazel compila cada destino que no tiene otras dependencias y realiza 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 compilar ese destino. Este proceso continúa hasta que se haya compilado una de las dependencias transitivas de MyBinary.
4. Compila MyBinary para producir un objeto binario final ejecutable que vincule todas las dependencias que se compilaron en el paso 3.

Básicamente, puede parecer que lo que sucede aquí no es lo mismo que lo que sucede cuando se usa 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 muchos pasos a fin de encontrar dependencias entre ellos y, luego, ejecutar esos pasos en orden. Pero hay diferencias importantes. El primero aparece en el paso 3: dado que Bazel sabe que cada destino solo produce una biblioteca de Java, sabe que todo lo que debe hacer es ejecutar el compilador de Java en lugar de una secuencia de secuencia de comandos arbitraria definida por el usuario, por lo que sabe que es seguro ejecutar estos pasos en paralelo. Esto puede producir un orden de magnitud de mejora de rendimiento en comparación con la compilación de objetivos uno a la vez en una máquina de varios núcleos, y solo es posible porque el enfoque basado en artefactos deja el sistema de compilación a cargo de su propia estrategia de ejecución, de modo que pueda hacer 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 es 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 que mencionamos antes. Bazel sabe que cada destino es el resultado solo de ejecutar un compilador de Java, y sabe que el resultado del compilador de Java solo depende de sus entradas, por lo que, siempre y cuando las entradas no hayan cambiado, el resultado se puede volver a usar. Este análisis funciona en todos los niveles. Si cambia MyBinary.java, Bazel sabe que volver a compilar MyBinary, pero reutilizar mylib. Si cambia un archivo fuente de //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 reconstruir solo el conjunto mínimo de artefactos cada vez y garantizar 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 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 mediante la paralelización de los procesos de compilación y la reutilización de sus resultados. Sin embargo, este es solo el primer paso, y estos componentes básicos del paralelismo y la reutilización constituyen 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 los problemas con el paralelismo y la reutilización que son inherentes a los sistemas de compilación basados en tareas. Pero todavía hay algunos problemas que surgieron antes y que no tratamos. Bazel tiene formas inteligentes de resolver cada una de estas cuestiones, por lo que debemos analizarlas antes de avanzar.

Herramientas como dependencias

Un problema que encontramos antes fue que las compilaciones dependían de las herramientas instaladas en nuestra máquina, y reproducir las compilaciones en los sistemas podía ser difícil debido a las diferentes versiones de herramientas o ubicaciones. El problema se vuelve aún más difícil cuando el proyecto usa lenguajes que requieren herramientas diferentes en función de la plataforma en la que se compilan o compilan (como Windows frente a Linux), y cada una de esas plataformas requiere un conjunto de herramientas un poco diferente para realizar el mismo trabajo.

Para resolver la primera parte de este problema, Bazel trata las herramientas como dependencias de cada destino. Cada java_library del lugar de trabajo depende implícitamente de un compilador de Java, cuyo valor predeterminado es un compilador conocido. Cada vez que Bazel compila un java_library, comprueba que el compilador especificado esté disponible en una ubicación conocida. Como cualquier otra dependencia, si cambia el compilador de Java, se reconstruyen todos los artefactos que dependen de él.

Bazel resuelve la segunda parte del problema, la independencia de la plataforma, mediante la configuración de configuraciones de compilación. En lugar de objetivos en función de sus herramientas, dependen de los siguientes tipos de configuraciones:

• 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 parte de los beneficios de los sistemas basados en tareas es su flexibilidad para admitir cualquier tipo de proceso de compilación, y sería mejor no dejar de hacerlo en un sistema de compilación basado en artefactos. Afortunadamente, Bazel permite que sus tipos de destinos compatibles se extiendan 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 que Bazel se encargue de programar 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 una acción, como ingresar un proceso no determinista como parte de su acción. Sin embargo, esto no sucede con mucha frecuencia en la práctica, y empujar las posibilidades de abuso hasta el nivel de acción disminuye enormemente las oportunidades de errores. Las reglas compatibles con muchos lenguajes y herramientas comunes están disponibles en línea, y la mayoría de los proyectos nunca necesitarán definir sus propias reglas. Incluso para aquellos que lo hacen, las definiciones de las 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

Las acciones suenan como si se encontraran con los mismos problemas que las tareas de otros sistemas. ¿No es posible, de todos modos, 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 está aislada de las demás a través de una zona de pruebas del sistema de archivos. Efectivamente, cada acción puede ver solo una vista restringida del sistema de archivos que incluye las entradas que ha declarado y cualquier resultado que haya producido. Esto se aplica mediante sistemas, como LXC en Linux, con la misma tecnología detrás de Docker. Esto significa que es imposible que las acciones entren en conflicto entre sí porque no pueden leer ningún archivo que no declaran, y cualquier archivo que escriban, pero que no declaren, se descartará cuando finalice la acción. Bazel también usa zonas de pruebas para evitar que las acciones se comuniquen a través de la red.

Cómo hacer que las dependencias externas sean deterministas

Queda un problema restante: 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 desde Maven.

Según los archivos fuera del lugar de trabajo actual, es riesgoso. Esos archivos podrían cambiar en cualquier momento, lo que requeriría que el sistema de compilación verifique si están actualizados. Si un archivo remoto cambia sin un cambio correspondiente en el código fuente del lugar de trabajo, también puede generar compilaciones irreproducibles: una compilación puede funcionar un día y fallar la siguiente sin motivo evidente debido a un cambio de dependencia no detectado. Por último, una dependencia externa puede generar un gran riesgo de seguridad cuando es propiedad de un tercero: si un atacante puede filtrar ese servidor de terceros, puede reemplazar el archivo de dependencia por algo de su propio diseño, lo que le dará el control total sobre tu entorno de compilación y su resultado.

El problema fundamental es que queremos que el sistema de compilación tenga en cuenta estos archivos sin tener que registrarlos en el control de código fuente. La actualización de una dependencia debe ser una elección consciente, pero esa elección debe hacerse una vez en un lugar central, en lugar de que los ingenieros individuales o el sistema las 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 consultas una confirmación de la semana pasada, deberías ver tus dependencias como eran en ese momento en lugar de hacerlo como lo son ahora.

Bazel y 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 verificarlo por completo en el control de código fuente. Cuando se hace referencia a una nueva dependencia externa 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 respecto al 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 de forma automática, pero ese cambio debe aprobarse y registrarse en el control de origen antes de que la compilación acepte la nueva dependencia. 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, ya que esto puede causar que todas tus compilaciones comiencen a fallar si no tienes otra copia de esa dependencia disponible. A fin de evitar este problema, te recomendamos que, para cualquier proyecto no trivial, dupliques todas sus dependencias en servidores o servicios en los que confíes y controles. De lo contrario, estarás a discreción de un tercero para conocer la disponibilidad de tu sistema de compilación, incluso si los hashes verificados garantizan su seguridad.