작업 기반 빌드 시스템

이 페이지에서는 태스크 기반 빌드 시스템, 작동 방식, 태스크 기반 시스템에서 발생할 수 있는 몇 가지 문제에 대해 설명합니다. 셸 스크립트 다음으로 작업 기반 빌드 시스템이 빌드의 다음 논리적 진화입니다.

태스크 기반 빌드 시스템 이해

태스크 기반 빌드 시스템에서 기본 작업 단위는 태스크입니다. 각 작업은 모든 종류의 로직을 실행할 수 있는 스크립트이며 다른 작업을 먼저 실행해야 하는 종속 항목으로 지정합니다. 현재 사용 중인 대부분의 주요 빌드 시스템(예: Ant, Maven, Gradle, Grunt, Rake)은 태스크 기반입니다. 대부분의 최신 빌드 시스템에서는 셸 스크립트 대신 엔지니어가 빌드 수행 방법을 설명하는 빌드 파일을 작성해야 합니다.

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>

빌드 파일은 XML로 작성되며 작업 목록(XML의 <target> 태그)과 함께 빌드에 관한 몇 가지 간단한 메타데이터를 정의합니다. (Ant는 타겟이라는 단어를 사용하여 작업을 나타내고 작업이라는 단어를 사용하여 명령어를 나타냅니다.) 각 태스크는 Ant에서 정의한 가능한 명령어 목록을 실행합니다. 여기에는 디렉터리 생성 및 삭제, javac 실행, JAR 파일 생성이 포함됩니다. 이 명령어 집합은 사용자가 제공한 플러그인으로 확장하여 모든 종류의 로직을 처리할 수 있습니다. 각 태스크는 depends 속성을 통해 종속되는 태스크를 정의할 수도 있습니다. 이러한 종속 항목은 그림 1과 같이 비순환 그래프를 형성합니다.

그림 1. 종속 항목을 보여주는 비순환 그래프

사용자는 Ant의 명령줄 도구에 태스크를 제공하여 빌드를 실행합니다. 예를 들어 사용자가 ant dist를 입력하면 Ant는 다음 단계를 따릅니다.

현재 디렉터리에 build.xml라는 파일을 로드하고 이를 파싱하여 그림 1과 같은 그래프 구조를 만듭니다.
명령줄에 제공된 dist라는 작업을 찾아 compile라는 작업에 종속 항목이 있음을 발견합니다.
compile라는 작업을 찾아 init라는 작업에 종속 항목이 있음을 발견합니다.
init라는 작업을 찾아 종속 항목이 없음을 발견합니다.
init 작업에 정의된 명령어를 실행합니다.
해당 작업의 모든 종속 항목이 실행된 경우 compile 작업에 정의된 명령어를 실행합니다.
해당 작업의 모든 종속 항목이 실행된 경우 dist 작업에 정의된 명령어를 실행합니다.

결과적으로 dist 작업 실행 시 Ant가 실행하는 코드는 다음 셸 스크립트와 같습니다.

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

문법을 제거하면 빌드 파일과 빌드 스크립트는 실제로 크게 다르지 않습니다. 하지만 이렇게 하여 이미 많은 이점을 얻었습니다. 다른 디렉터리에 새 빌드 파일을 생성하고 서로 연결할 수 있습니다. 기존 태스크에 종속된 새 태스크를 임의적이고 복잡한 방식으로 쉽게 추가할 수 있습니다. 단일 작업의 이름을 ant 명령줄 도구에 전달하기만 하면 실행해야 하는 모든 작업이 결정됩니다.

Ant는 2000년에 처음 출시된 오래된 소프트웨어입니다. 그동안 Maven 및 Gradle과 같은 다른 도구가 Ant을 개선했으며 외부 종속 항목의 자동 관리, XML이 없는 더 깔끔한 문법과 같은 기능을 추가하여 Ant을 대체했습니다. 그러나 이러한 최신 시스템의 특성은 동일하게 유지됩니다. 즉, 엔지니어가 원칙에 입각한 모듈식 방식으로 빌드 스크립트를 작업으로 작성할 수 있으며, 이러한 작업을 실행하고 이들 간의 종속 항목을 관리하기 위한 도구를 제공할 수 있습니다.

태스크 기반 빌드 시스템의 어두운 측면

이러한 도구를 사용하면 엔지니어가 스크립트를 작업으로 정의할 수 있으므로 매우 강력하여 상상할 수 있는 거의 모든 작업을 할 수 있습니다. 하지만 이러한 강력한 기능에는 단점도 있으며, 빌드 스크립트가 더 복잡해질수록 작업 기반 빌드 시스템을 사용하기 어려워질 수 있습니다. 이러한 시스템의 문제는 실제로 엔지니어에게 너무 많은 권한을 주고 시스템에는 충분하지 않은 결과로 이어집니다. 시스템은 스크립트가 무엇을 하는지 알 수 없으므로 빌드 단계를 예약하고 실행하는 방식이 매우 보수적이어야 하므로 성능이 저하됩니다. 또한 시스템에서 각 스크립트가 제대로 작동하고 있는지 확인할 방법이 없으므로 스크립트가 복잡해지고 결국 디버깅이 필요한 또 다른 요소가 되는 경향이 있습니다.

빌드 단계 병렬화 어려움

최신 개발 워크스테이션은 여러 빌드 단계를 병렬로 실행할 수 있는 여러 코어를 사용하여 매우 강력합니다. 하지만 작업 기반 시스템은 작업 실행을 병렬화할 수 있을 것 같아도 실제로는 병렬화하지 못하는 경우가 많습니다. 작업 A가 작업 B 및 C에 종속된다고 가정해 보겠습니다. 작업 B와 C는 서로 종속되지 않으므로 시스템이 작업 A에 더 빠르게 도달할 수 있도록 동시에 실행하는 것이 안전한가요? 동일한 리소스를 건드리지 않는 경우는 가능합니다. 하지만 그렇지 않을 수도 있습니다. 두 루틴 모두 동일한 파일을 사용하여 상태를 추적하고 동시에 실행하면 충돌이 발생할 수 있습니다. 일반적으로 시스템이 이를 알 수 있는 방법이 없으므로 이러한 충돌이 발생할 위험을 감수해야 합니다(드물지만 디버그하기 매우 어려운 빌드 문제로 이어짐). 또는 전체 빌드가 단일 프로세스의 단일 스레드에서 실행되도록 제한해야 합니다. 이는 강력한 개발자 머신을 낭비할 수 있으며 여러 머신에 빌드를 배포할 가능성을 완전히 배제합니다.

증분 빌드 실행의 어려움

우수한 빌드 시스템을 사용하면 엔지니어가 소규모 변경사항으로 전체 코드베이스를 처음부터 다시 빌드할 필요가 없도록 안정적인 증분 빌드를 실행할 수 있습니다. 이는 빌드 시스템이 느리고 앞서 언급한 이유로 빌드 단계를 병렬화할 수 없는 경우에 특히 중요합니다. 하지만 안타깝게도 태스크 기반 빌드 시스템도 여기서 어려움을 겪습니다. 작업은 무엇이든 할 수 있으므로 일반적으로 작업이 이미 완료되었는지 확인할 방법이 없습니다. 많은 작업은 단순히 소스 파일 세트를 가져와 컴파일러를 실행하여 바이너리 세트를 만듭니다. 따라서 기본 소스 파일이 변경되지 않은 경우 다시 실행할 필요가 없습니다. 하지만 추가 정보가 없으면 시스템은 이를 확실히 알 수 없습니다. 작업이 변경되었을 수 있는 파일을 다운로드하거나 실행할 때마다 다를 수 있는 타임스탬프를 쓸 수 있기 때문입니다. 정확성을 보장하기 위해 시스템은 일반적으로 각 빌드 중에 모든 태스크를 다시 실행해야 합니다. 일부 빌드 시스템은 엔지니어가 작업을 재실행해야 하는 조건을 지정하도록 하여 증분 빌드를 사용 설정하려고 합니다. 이 방법이 가능한 경우도 있지만, 생각보다 훨씬 까다로운 문제인 경우가 많습니다. 예를 들어 다른 파일에서 파일을 직접 포함할 수 있는 C++와 같은 언어에서는 입력 소스를 파싱하지 않고 변경사항을 감시해야 하는 전체 파일 세트를 결정할 수 없습니다. 엔지니어는 지름길을 택하는 경우가 많으며 이러한 지름길은 부적절하더라도 작업 결과가 재사용되는 드물고 불편한 문제로 이어질 수 있습니다. 이 문제가 자주 발생하면 엔지니어는 새 상태를 가져오기 위해 모든 빌드를 실행하기 전에 정리를 실행하는 습관을 들이게 되어 처음부터 증분 빌드를 하려는 의도를 완전히 무너뜨립니다. 작업을 다시 실행해야 하는 시점을 파악하는 것은 생각보다 미묘한 작업이며 인간보다 기계가 더 잘 처리할 수 있습니다.

스크립트 유지관리 및 디버깅의 어려움

마지막으로 작업 기반 빌드 시스템에서 적용하는 빌드 스크립트는 종종 작업하기가 어려운 경우가 많습니다. 빌드 스크립트는 빌드 중인 시스템과 똑같은 코드이며 버그를 쉽게 숨길 수 있습니다. 다음은 작업 기반 빌드 시스템에서 작업할 때 매우 일반적인 버그의 몇 가지 예입니다.

작업 A는 특정 파일을 출력으로 생성하기 위해 작업 B에 종속됩니다. 작업 B의 소유자가 다른 작업에서 이 작업을 사용하고 있다는 사실을 모르고 다른 위치에서 출력을 생성하도록 변경합니다. 이는 누군가 작업 A를 실행하려고 할 때 실패를 확인할 때까지 감지할 수 없습니다.
작업 A는 작업 A에 필요한 출력으로 특정 파일을 생성하는 작업 C에 종속되는 작업 B에 종속됩니다. 태스크 B의 소유자가 더 이상 태스크 C에 종속될 필요가 없다고 결정하면 태스크 B가 태스크 C를 전혀 신경 쓰지 않더라도 태스크 A가 실패하게 됩니다.
새 작업의 개발자가 도구의 위치나 특정 환경 변수의 값과 같이 작업을 실행하는 머신에 관해 실수로 가정합니다. 태스크가 개발자의 머신에서는 작동하지만 다른 개발자가 시도할 때마다 실패합니다.
작업에는 인터넷에서 파일을 다운로드하거나 빌드에 타임스탬프를 추가하는 등의 비확정적인 구성요소가 포함됩니다. 이제 빌드를 실행할 때마다 다른 결과가 나올 수 있으므로 엔지니어가 서로의 오류나 자동화된 빌드 시스템에서 발생하는 오류를 재현하고 수정할 수 없는 경우가 있습니다.
여러 종속 항목이 있는 작업은 경합 상태를 일으킬 수 있습니다. 작업 A가 작업 B와 작업 C에 모두 의존하고 작업 B와 C 모두 동일한 파일을 수정하는 경우 작업 A는 작업 B와 작업 C 중 어느 것이 먼저 완료되었는지에 따라 다른 결과를 얻습니다.

여기에 설명된 태스크 기반 프레임워크 내에서 이러한 성능, 정확성 또는 유지보수 문제를 해결하는 범용적인 방법은 없습니다. 엔지니어가 빌드 중에 실행되는 임의의 코드를 작성할 수 있는 한 시스템은 항상 빌드를 빠르고 정확하게 실행하기에 충분한 정보를 보유할 수 없습니다. 이 문제를 해결하려면 엔지니어의 일부 권한을 시스템에 다시 부여하고 시스템의 역할을 작업 실행이 아닌 아티팩트 생성으로 재개념화해야 합니다.

이 접근 방식으로 인해 Blaze 및 Bazel과 같은 아티팩트 기반 빌드 시스템이 만들어졌습니다.