작업 기반 빌드 시스템

문제 신고 소스 보기

이 페이지에서는 작업 기반 빌드 시스템과 작동 방식, 작업 기반 시스템에서 발생할 수 있는 몇 가지 정보 표시를 다룹니다. 셸 스크립트 뒤의 작업 기반 빌드 시스템은 논리적인 차세대 빌드 발전입니다.

작업 기반 빌드 시스템 이해

작업 기반 빌드 시스템에서는 작업의 기본 단위가 태스크입니다. 각 태스크는 모든 종류의 로직을 실행할 수 있는 스크립트이며, 태스크는 다른 태스크를 앞서 실행해야 하는 종속 항목으로 지정합니다. 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는 target이라는 단어를 사용하여 task를 나타내고 task라는 단어를 사용하여 명령어를 나타냅니다. 각 작업은 Ant에서 정의한 가능한 명령어 목록을 실행합니다. 여기에는 디렉터리 생성 및 삭제, javac 실행, JAR 파일 생성이 포함됩니다. 이 명령어 집합은 사용자가 제공한 플러그인으로 확장하여 모든 종류의 로직을 처리할 수 있습니다. 각 태스크는 종속 항목 속성을 통해 종속 태스크를 정의할 수도 있습니다. 이러한 종속 항목은 그림 1과 같이 비순환 그래프를 형성합니다.

종속 항목을 보여주는 아크릴 그래프

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

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

  1. 현재 디렉터리에 build.xml라는 파일을 로드하고 파싱하여 그림 1과 같은 그래프 구조를 만듭니다.
  2. 명령줄에서 제공된 dist라는 태스크를 찾고 compile라는 태스크에 대한 종속 항목이 있음을 확인합니다.
  3. 이름이 compile인 작업을 찾아 init 작업에 종속 항목이 있음을 확인합니다.
  4. 이름이 init인 작업을 찾아 종속 항목이 없음을 확인합니다.
  5. init 작업에 정의된 명령어를 실행합니다.
  6. 작업의 모든 종속 항목이 실행되었다면 compile 작업에 정의된 명령어를 실행합니다.
  7. 작업의 모든 종속 항목이 실행되었다면 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 없이 더 깔끔한 구문과 같은 기능을 추가하여 대체되었습니다. 하지만 이러한 최신 시스템의 특성은 그대로 유지됩니다. 즉, 엔지니어가 태스크로서 원칙에 따라 모듈식으로 빌드 스크립트를 작성하고 이러한 작업을 실행하고 종속 항목을 관리하는 도구를 제공할 수 있습니다.

작업 기반 빌드 시스템의 어두운 면

엔지니어는 이러한 도구를 사용해 태스크로 스크립트를 정의할 수 있기 때문에 개발자가 상상할 수 있는 거의 모든 작업을 할 수 있습니다. 그러나 이 기능에는 단점이 있으며 빌드 스크립트가 더 복잡해지면 작업 기반 빌드 시스템이 사용하기 어려울 수 있습니다. 이러한 시스템의 문제는 실제로 엔지니어에게 너무 많은 전력을 공급하고 시스템에 필요한 전력이 부족하다는 점입니다. 시스템은 스크립트가 하는 작업을 알지 못하므로 빌드 단계를 예약하고 실행하는 방식이 매우 보수적이기 때문에 성능이 저하됩니다. 시스템이 각 스크립트가 필요한 작업을 수행하고 있는지 확인할 수 있는 방법은 없기 때문에 스크립트는 점점 더 복잡해지고 디버깅이 필요한 또 다른 작업이 되는 경향이 있습니다.

빌드 단계를 동시에 로드하기 어려움

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

증분 빌드를 수행하기 어려움

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

스크립트 유지관리 및 디버깅 문제

마지막으로, 작업 기반 빌드 시스템에서 적용하는 빌드 스크립트는 작업하기 어려운 경우가 많습니다. 이러한 테스트는 철저한 검토를 받는 경우가 많지만 빌드 스크립트는 빌드하는 시스템과 마찬가지로 코드이므로 버그를 숨기기가 쉽습니다. 다음은 작업 기반 빌드 시스템으로 작업할 때 매우 일반적인 버그의 예입니다.

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

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

이러한 접근 방식을 통해 Blaze 및 Bazel과 같은 아티팩트 기반 빌드 시스템을 만들 수 있었습니다.