Sistemas de compilación basados en tareas

Informar un problema Ver código fuente Nightly · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

En esta página, se describen los sistemas de compilación basados en tareas, su funcionamiento y algunas de las complicaciones que pueden ocurrir con estos sistemas. Después de las secuencias de comandos de shell, los sistemas de compilación basados en tareas son la siguiente evolución lógica de la compilación.

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

En un sistema de compilación basado en tareas, la unidad de trabajo fundamental es la tarea. Cada tarea es una secuencia de comandos que puede ejecutar cualquier tipo de lógica, y las tareas especifican otras las tareas como dependencias que deben ejecutarse antes que ellas. La mayoría de los sistemas de compilación principales que se usan en la actualidad, como Ant, Maven, Gradle, Grunt y Rake, se basan en tareas. En lugar de secuencias de comandos de shell, la mayoría de los sistemas de compilación modernos requieren que los ingenieros creen archivos de compilación que describen cómo realizar la compilación.

Toma este ejemplo del Manual de Ant:

<project name="MyProject" default="dist" basedir=".">
   <description>
     simple example build file
   </description>
   <!-- set global properties for this build -->
   <property name="src" location="src"/>
   <property name="build" location="build"/>
   <property name="dist" location="dist"/>

   <target name="init">
     <!-- Create the time stamp -->
     <tstamp/>
     <!-- Create the build directory structure used by compile -->
     <mkdir dir="${build}"/>
   </target>
   <target name="compile" depends="init"
       description="compile the source">
     <!-- Compile the Java code from ${src} into ${build} -->
     <javac srcdir="${src}" destdir="${build}"/>
   </target>
   <target name="dist" depends="compile"
       description="generate the distribution">
     <!-- Create the distribution directory -->
     <mkdir dir="${dist}/lib"/>
     <!-- Put everything in ${build} into the MyProject-${DSTAMP}.jar file -->
     <jar jarfile="${dist}/lib/MyProject-${DSTAMP}.jar" basedir="${build}"/>
   </target>
   <target name="clean"
       description="clean up">
     <!-- Delete the ${build} and ${dist} directory trees -->
     <delete dir="${build}"/>
     <delete dir="${dist}"/>
   </target>
</project>

El archivo de compilación está escrito en XML y define algunos metadatos simples sobre la compilación junto con una lista de tareas (las etiquetas <target> en el archivo en formato XML). (Ant usa la palabra target para representar una tarea y la palabra task para referirse a comandos). Cada tarea ejecuta una lista de posibles comandos definidos por Ant, que incluyen crear y borrar directorios, ejecutar javac y crear un archivo JAR. Este conjunto de comandos puede extenderse complementos para cubrir cualquier tipo de lógica. Cada tarea también puede definir las tareas de las que depende a través del atributo depends. Estas dependencias forman un grafo acíclico, como se ve en la Figura 1.

Figura 1: Un grafo acíclico que muestra las dependencias

Los usuarios realizan compilaciones proporcionando tareas a la herramienta de línea de comandos de Ant. Por ejemplo, cuando un usuario escribe ant dist, Ant sigue los siguientes pasos:

Carga un archivo llamado build.xml en el directorio actual y lo analiza para crear la estructura de grafo que se muestra en la Figura 1.
Busca la tarea llamada dist que se proporcionó en la línea de comandos y descubre que tiene una dependencia en la tarea llamada compile.
Busca la tarea llamada compile y descubre que tiene una dependencia en la tarea llamada init.
Busca la tarea llamada init y descubre que no tiene dependencias.
Ejecuta los comandos definidos en la tarea init.
Ejecuta los comandos definidos en la tarea compile dado que todo eso se hayan ejecutado las dependencias de la tarea.
Ejecuta los comandos definidos en la tarea dist dado que todo eso se hayan ejecutado las dependencias de la tarea.

Al final, el código que ejecuta Ant cuando ejecuta la tarea dist es equivalente a la siguiente secuencia de comandos de shell:

./createTimestamp.sh
mkdir build/
javac src/* -d build/
mkdir -p dist/lib/
jar cf dist/lib/MyProject-$(date --iso-8601).jar build/*

Cuando se quita la sintaxis, el archivo de compilación y la secuencia de comandos de compilación no son demasiado diferentes. Pero ya ganamos mucho con esto. Podemos crear archivos de compilación nuevos en otros directorios y vincularlos. Podemos agregar tareas nuevas que dependen de tareas existentes de manera arbitraria y compleja con facilidad. Solo debemos pasar el nombre de una sola tarea a la herramienta de línea de comandos ant, y esta determina todo lo que se debe ejecutar.

Ant es un software antiguo que se lanzó originalmente en 2000. Otras herramientas, como Maven y Gradle, mejoraron en Ant en los años intermedios y, en esencia, lo reemplazaron con la adición de funciones como la administración automática de dependencias externas y una sintaxis más clara sin ningún XML. Sin embargo, la naturaleza de estos sistemas más nuevos sigue siendo la misma: permiten que los ingenieros escriban secuencias de comandos de compilación de manera modular y basada en principios como tareas, y proporcionan herramientas para ejecutar esas tareas y administrar las dependencias entre ellas.

El lado oscuro de los sistemas de compilación basados en tareas

Debido a que estas herramientas permiten esencialmente que los ingenieros definan cualquier script como una tarea, son muy potentes y te permiten hacer prácticamente todo lo que te imagines con ellos. Pero esa potencia trae desventajas, y los sistemas de compilación basados en tareas se vuelve difícil trabajar con ellas a medida que sus secuencias de comandos de compilación se vuelven más complejas. El problema con estos sistemas es que, en realidad, terminan ofreciendo demasiada potencia a no hay suficiente energía para el sistema. Debido a que el sistema no tiene idea lo que hacen las secuencias de comandos, el rendimiento se ve afectado, ya que debe ser muy conservador. en cómo programa y ejecuta los pasos de la compilación. Y el sistema no tiene forma de confirmar que cada secuencia de comandos esté haciendo lo que debería, por lo que las secuencias de comandos tienden a aumentar en complejidad y terminan siendo otra cosa que necesita depuración.

Dificultad para paralelizar los pasos de compilación

Las estaciones de trabajo de desarrollo modernas son potentes y tienen varios núcleos capaz de ejecutar varios pasos de compilación en paralelo. Pero los sistemas basados en tareas a menudo no pueden paralelizar la ejecución de tareas, incluso cuando parece que deberían que no puedas hacerlo. Supongamos que la tarea A depende de las tareas B y C. Dado que las tareas B y C no dependen una de la otra, ¿es seguro ejecutarlas al mismo tiempo para que el sistema pueda llegar más rápido a la tarea A? Tal vez, si no tocan ninguno de los mismos recursos. Pero tal vez no. Quizás ambos usan el mismo archivo para hacer un seguimiento de sus estados y ejecutarlos al mismo tiempo causa un conflicto. En general, el sistema no tiene forma de saberlo, por lo que debe arriesgarse a estos conflictos (lo que genera problemas de compilación poco frecuentes, pero muy difíciles de depurar) o debe restringir toda la compilación para que se ejecute en un solo subproceso en un solo proceso. Esto puede ser un gran desperdicio de una potente máquina de desarrollador, descarta la posibilidad de distribuir la compilación entre varias máquinas.

Dificultad para realizar compilaciones incrementales

Un buen sistema de compilación permite a los ingenieros realizar compilaciones incrementales confiables, como para que un pequeño cambio no requiera que se reconstruya toda la base de código desde cero. Esto es muy importante si el sistema de compilación es lento y no puede paralelizar los pasos de compilación por los motivos antes mencionados. Pero, lamentablemente, los sistemas de compilación basados en tareas también tienen dificultades aquí. Debido a que las tareas pueden hacer cualquier cosa, en general, no hay forma de verificar si ya se completaron. Muchas tareas simplemente toman un conjunto de archivos fuente y ejecutan un compilador para crear un conjunto de objetos binarios. Por lo tanto, no es necesario volver a ejecutarlas si los archivos fuente subyacentes no cambiaron. Pero, sin información adicional, el sistema no puede decirlo seguramente. Puede que la tarea descargue un archivo que podría haber cambiado o quizás escribe una marca de tiempo que podría ser diferente en cada ejecución. Para garantizar el sistema, por lo general, debe volver a ejecutar cada tarea durante cada compilación. Algunos los sistemas de compilación intentan habilitar compilaciones incrementales permitiendo que los ingenieros especifiquen la condiciones bajo las que una tarea debe volver a ejecutarse. A veces, esto es posible, pero a menudo es un problema mucho más complicado de lo que parece. Por ejemplo, en los idiomas como C++, que permiten que otros archivos incluyan archivos, Es imposible determinar el conjunto completo de archivos que debe observarse para detectar cambios. sin analizar las fuentes de entrada. A menudo, los ingenieros terminan tomando atajos, y estos atajos pueden generar problemas poco comunes y frustrantes en los que se reutiliza un resultado de tarea incluso cuando no debería ser así. Cuando esto sucede con frecuencia, los ingenieros adquieren el hábito de ejecutar una limpieza antes de cada compilación para obtener un estado nuevo, lo que anula por completo el propósito de tener una compilación incremental en primer lugar. Averiguar cuándo se debe volver a ejecutar una tarea es sorprendentemente sutil y es un trabajo mejor manejado por las máquinas que por las personas.

Dificultades de mantener y depurar secuencias de comandos

Por último, las secuencias de comandos de compilación impuestas por los sistemas de compilación basados en tareas suelen ser difíciles de trabajar. Aunque a menudo reciben menos escrutinio, las secuencias de comandos de compilación son código, al igual que el sistema que se compila, y son lugares fáciles para que se oculten los errores. Estos son algunos ejemplos de errores muy comunes cuando se trabaja con un sistema de compilación basado en tareas:

La tarea A depende de la tarea B para producir un archivo en particular como resultado. El propietario de la tarea B no se da cuenta de que otras tareas dependen de ella, así que la cambian a producir resultados en una ubicación diferente. Esto no se puede detectar hasta que alguien intenta ejecutar la tarea A y descubre que falla.
La tarea A depende de la tarea B, que depende de la tarea C, que produce un archivo particular como resultado que necesita la tarea A. El propietario de la tarea B decide que ya no necesita depender de la tarea C, lo que hace que la tarea A falle, a pesar de que a la tarea B no le importa en absoluto la tarea C.
El desarrollador de una tarea nueva hace una suposición accidental sobre la máquina que ejecuta la tarea, como la ubicación de una herramienta o el valor de variables de entorno particulares. La tarea funciona en su máquina, pero falla cada vez que otro desarrollador la prueba.
Una tarea contiene un componente no determinista, como la descarga de un archivo de Internet o agregar una marca de tiempo a una compilación. Ahora, las personas obtienen resultados potencialmente diferentes cada vez que ejecutan la compilación, lo que significa que los ingenieros no siempre podrán reproducir y corregir los errores de los demás o los que se producen en un sistema de compilación automatizado.
Las tareas con varias dependencias pueden crear condiciones de carrera. Si la tarea A depende de las tareas B y C, y las tareas B y C modifican la misma archivo, la tarea A obtiene un resultado diferente según cuál de las tareas B y C termina primero.

No hay una forma general de resolver estos problemas de rendimiento, exactitud o manutenibilidad dentro del framework basado en tareas que se describe aquí. Mientras los ingenieros puedan escribir código arbitrario que se ejecute durante la compilación, el sistema no puede tener suficiente información para poder ejecutar compilaciones de forma rápida y correcta. Para resolver el problema, debemos quitarles poder a los ingenieros y devolverlo al sistema, y reconceptualizar el rol del sistema no como ejecutar tareas, sino como producir artefactos.

Este enfoque llevó a la creación de sistemas de compilación basados en artefactos, como Blaze y Bazel.