아티팩트 기반 빌드 시스템

이 페이지에서는 아티팩트 기반 빌드 시스템과 이를 만드는 데 사용되는 철학을 설명합니다. Bazel은 아티팩트 기반 빌드 시스템입니다. 작업 기반 빌드 시스템은 빌드 스크립트보다 좋은 단계이지만 개별 엔지니어가 작업을 정의할 수 있도록 하여 과도한 권한을 부여합니다.

아티팩트 기반 빌드 시스템에는 엔지니어가 제한된 방식으로 구성할 수 있는 시스템에서 정의한 소수의 태스크가 있습니다. 엔지니어는 여전히 빌드할 내용을 시스템에 지시하지만 빌드 시스템은 빌드하는 방법을 결정합니다. 작업 기반 빌드 시스템과 마찬가지로 Bazel과 같은 아티팩트 기반 빌드 시스템에는 여전히 빌드 파일이 있지만 이러한 빌드 파일의 콘텐츠는 매우 다릅니다. Bazel의 빌드 파일은 출력 생성 방법을 설명하는 Turing 완전한 스크립팅 언어의 명령적인 명령어 집합이 아니라 빌드할 아티팩트 집합, 종속 항목 및 빌드 방식에 영향을 주는 제한된 옵션 집합을 설명하는 선언적 매니페스트입니다. 엔지니어가 명령줄에서 bazel를 실행하면 빌드할 타겟 집합(what)을 지정하고 Bazel은 컴파일 단계(how)를 구성, 실행, 예약합니다. 이제 빌드 시스템에서 언제 어떤 도구를 실행할지 완전히 제어할 수 있으므로 정확성을 보장하면서 훨씬 더 효율적일 수 있도록 훨씬 더 강력한 보장을 제공할 수 있습니다.

기능적인 관점

아티팩트 기반 빌드 시스템과 함수 프로그래밍을 쉽게 비유할 수 있습니다. 기존의 명령형 프로그래밍 언어 (예: Java, C, Python)는 프로그래머가 일련의 실행 단계를 정의할 수 있는 것과 같은 방식으로, 작업 기반 빌드 시스템에서 실행할 문 목록을 차례로 지정합니다. 반면 함수형 프로그래밍 언어(예: Haskell 및 ML)는 일련의 수학 방정식과 더 유사하게 구성됩니다. 기능적 언어에서는 프로그래머가 실행할 계산을 설명하지만, 계산이 실행되는 시기와 방법에 관한 세부정보는 컴파일러에 남깁니다.

이는 아티팩트 기반 빌드 시스템에서 매니페스트를 선언하고 시스템이 빌드 실행 방법을 파악하도록 하는 아이디어에 매핑됩니다. 많은 문제를 함수형 프로그래밍을 사용하여 쉽게 표현할 수는 없지만, 함수 프로그래밍으로 큰 이점을 누릴 수 있는 문제는 언어에서 이러한 프로그램을 간편하게 병렬화하고, 명령형 언어에서는 불가능할 정도로 정확성을 강력하게 보장할 수 있는 경우가 많습니다. 함수 프로그래밍을 사용하여 표현하기 가장 쉬운 문제는 일련의 규칙이나 함수를 사용하여 한 데이터를 다른 데이터로 변환하는 것만 포함하는 문제입니다. 이것이 바로 빌드 시스템의 역할입니다. 전체 시스템은 소스 파일(및 컴파일러와 같은 도구)을 입력으로 받아 바이너리를 출력하는 수학적 함수라고 할 수 있습니다. 따라서 함수 프로그래밍의 원칙을 중심으로 빌드 시스템을 구축하는 것이 효과적이라는 것은 놀라운 일이 아닙니다.

아티팩트 기반 빌드 시스템 이해

Google의 빌드 시스템인 Blaze는 최초의 아티팩트 기반 빌드 시스템이었습니다. Bazel은 Blaze의 오픈소스 버전입니다.

Bazel에서 빌드 파일 (일반적으로 BUILD)은 다음과 같이 표시됩니다.

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",
    ],
)

Bazel에서 BUILD 파일은 타겟을 정의합니다. 여기서 두 가지 유형의 타겟은 java_binary 및 java_library입니다. 모든 타겟은 시스템에서 만들 수 있는 아티팩트에 해당합니다. 바이너리 타겟은 직접 실행할 수 있는 바이너리를 생성하고 라이브러리 타겟은 바이너리 또는 다른 라이브러리에서 사용할 수 있는 라이브러리를 생성합니다. 모든 타겟에는 다음이 있습니다.

name: 명령줄 및 다른 대상에서 대상을 참조하는 방법
srcs: 타겟의 아티팩트를 만들기 위해 컴파일할 소스 파일
deps: 이 타겟 전에 빌드되고 이 타겟에 연결되어야 하는 다른 타겟

종속 항목은 동일한 패키지 내에 있을 수도 있고(예: MyBinary의 :mylib 종속 항목) 동일한 소스 계층 구조의 다른 패키지에 있을 수도 있습니다(예: mylib의 //java/com/example/common 종속 항목).

작업 기반 빌드 시스템과 마찬가지로 Bazel의 명령줄 도구를 사용하여 빌드를 수행합니다. MyBinary 타겟을 빌드하려면 bazel build :MyBinary를 실행합니다. 깨끗한 저장소에서 이 명령어를 처음 입력하면 Bazel은 다음을 실행합니다.

워크스페이스의 모든 BUILD 파일을 파싱하여 아티팩트 간의 종속 항목 그래프를 만듭니다.
그래프를 사용하여 MyBinary의 전이 종속 항목(MyBinary에 종속되는 모든 대상과 이러한 대상에 종속되는 모든 대상)을 재귀적으로 결정합니다.
이러한 각 종속 항목을 순서대로 빌드합니다. Bazel은 다른 종속 항목이 없는 각 대상을 빌드하는 것으로 시작하여 각 대상에 대해 빌드해야 하는 종속 항목을 추적합니다. 대상의 모든 종속 항목이 빌드되는 즉시 Bazel이 해당 대상을 빌드하기 시작합니다. 이 프로세스는 MyBinary의 모든 전이 종속 항목이 빌드될 때까지 계속됩니다.
MyBinary를 빌드하여 3단계에서 빌드된 모든 종속 항목에 연결되는 최종 실행 가능한 바이너리를 생성합니다.

기본적으로 여기서 일어나는 일은 태스크 기반 빌드 시스템을 사용할 때와 크게 다르지 않아 보일 수 있습니다. 실제로 최종 결과는 동일한 바이너리이며 이를 생성하는 프로세스에는 여러 단계를 분석하여 그 중에서 종속 항목을 찾은 다음 해당 단계를 순서대로 실행하는 작업이 포함됩니다. 하지만 중요한 차이점이 있습니다. 첫 번째는 3단계에 있습니다. Bazel은 각 타겟이 Java 라이브러리만 생성한다는 사실을 알고 있기 때문에 해야 할 일은 임의의 사용자 정의 스크립트가 아닌 Java 컴파일러를 실행하기만 하므로 이러한 단계를 병렬로 실행하는 것이 안전하다는 것을 알고 있습니다. 이렇게 하면 멀티코어 머신에서 타겟을 한 번에 하나씩 빌드하는 것보다 훨씬 더 나은 성능을 얻을 수 있습니다. 이는 아티팩트 기반 접근 방식에서 빌드 시스템이 자체 실행 전략을 담당하므로 병렬성을 더 강력하게 보장할 수 있기 때문에 가능합니다.

그러나 이점은 동시 로드 외에도 다양합니다. 이 접근 방식을 통해 개발자가 아무것도 변경하지 않고 bazel build :MyBinary를 두 번째로 입력하면 Bazel이 1초 이내에 종료되고 타겟이 최신 상태라는 메시지가 표시됩니다. 이는 앞에서 설명한 함수 프로그래밍 패러다임 덕분에 가능합니다. Bazel은 각 타겟이 Java 컴파일러 실행의 결과일 뿐이라는 것을 알고 있으며, Java 컴파일러의 출력은 입력에만 종속된다는 것을 알고 있으므로 입력이 변경되지 않는 한 출력을 재사용할 수 있습니다. 이 분석은 모든 수준에서 작동합니다. MyBinary.java가 변경되면 Bazel은 MyBinary를 다시 빌드하고 mylib는 재사용해야 함을 알 수 있습니다. //java/com/example/common의 소스 파일이 변경되면 Bazel은 해당 라이브러리, mylib, MyBinary를 다시 빌드해야 한다는 것을 알지만 //java/com/example/myproduct/otherlib는 재사용합니다. Bazel은 매 단계에서 실행되는 도구의 속성을 알고 있으므로 매번 최소한의 아티팩트 세트만 다시 빌드하면서 오래된 빌드가 생성되지 않도록 할 수 있습니다.

작업이 아닌 아티팩트 측면에서 빌드 프로세스를 재구성하는 것은 미묘하지만 강력합니다. 빌드 시스템은 프로그래머에 노출되는 유연성을 줄임으로써 빌드의 모든 단계에서 실행되는 작업에 관해 더 많이 알 수 있습니다. 이 지식을 활용하여 빌드 프로세스를 병렬화하고 출력을 재사용함으로써 빌드를 훨씬 더 효율적으로 만들 수 있습니다. 하지만 이는 첫 번째 단계일 뿐이며 이러한 동시 로드 및 재사용의 빌딩 블록은 분산되고 확장성이 뛰어난 빌드 시스템의 기반을 형성합니다.

Bazel의 다른 멋진 트릭

아티팩트 기반 빌드 시스템은 작업 기반 빌드 시스템에 내재된 동시 로드 및 재사용 관련 문제를 근본적으로 해결합니다. 하지만 이전에 발생했지만 아직 해결하지 못한 문제가 몇 가지 있습니다. Bazel에는 이러한 문제를 각각 해결하는 영리한 방법이 있습니다. 계속 진행하기 전에 이러한 방법을 살펴보겠습니다.

종속 항목로서의 도구

이전에 발생한 한 가지 문제는 빌드가 머신에 설치된 도구에 종속되며 도구 버전이나 위치가 다르면 시스템 전반에서 빌드를 재현하기 어려울 수 있다는 점입니다. 프로젝트에서 빌드 또는 컴파일되는 플랫폼(예: Windows와 Linux)에 따라 다른 도구가 필요한 언어를 사용하고 각 플랫폼에서 동일한 작업을 수행하는 데 약간 다른 도구 세트가 필요한 경우 문제는 더욱 복잡해집니다.

Bazel은 도구를 각 대상에 대한 종속 항목으로 취급하여 이 문제의 첫 번째 부분을 해결합니다. 작업공간의 모든 java_library는 자바 컴파일러에 암시적으로 종속됩니다. Java 컴파일러는 기본적으로 잘 알려진 컴파일러를 사용합니다. Bazel은 java_library를 빌드할 때마다 지정된 컴파일러를 알려진 위치에서 사용할 수 있는지 확인합니다. 다른 종속 항목과 마찬가지로 Java 컴파일러가 변경되면 Java 컴파일러에 종속된 모든 아티팩트가 다시 빌드됩니다.

Bazel은 빌드 구성을 설정하여 문제의 두 번째 부분인 플랫폼 독립성을 해결합니다. 타겟은 도구에 직접 종속되는 대신 구성 유형에 종속됩니다.

호스트 구성: 빌드 중에 실행되는 빌드 도구
대상 구성: 최종적으로 요청한 바이너리 빌드

빌드 시스템 확장

Bazel은 여러 인기 프로그래밍 언어의 타겟을 기본적으로 제공하지만 엔지니어는 항상 더 많은 작업을 하고 싶어 합니다. 작업 기반 시스템의 이점 중 하나는 모든 종류의 빌드 프로세스를 유연하게 지원한다는 점이며 아티팩트 기반 빌드 시스템에서는 이 기능을 포기하지 않는 것이 좋습니다. 다행히 Bazel에서는 맞춤 규칙을 추가하여 지원되는 대상 유형을 확장할 수 있습니다.

Bazel에서 규칙을 정의하기 위해 규칙 작성자는 규칙에 필요한 입력 (BUILD 파일에 전달된 속성 형태로)과 규칙이 생성하는 고정된 출력 세트를 선언합니다. 또한 작성자는 해당 규칙에서 생성될 작업을 정의합니다. 각 작업은 입력과 출력을 선언하고, 특정 실행 파일을 실행하거나 특정 문자열을 파일에 씁니다. 또한 입력과 출력을 통해 다른 작업에 연결할 수 있습니다. 즉, 작업은 빌드 시스템의 최하위 수준의 컴포저블 단위입니다. 작업은 선언된 입력과 출력만 사용하는 한 원하는 모든 작업을 할 수 있으며 Bazel이 적절하게 작업을 예약하고 결과를 캐시합니다.

작업 개발자가 작업의 일부로 비결정론적 프로세스를 도입하는 등의 작업을 중지할 방법이 없으므로 시스템은 완벽하지는 않습니다. 하지만 실제로는 이러한 일이 자주 발생하지 않으며 악용 가능성을 작업 수준까지 낮추면 오류가 발생할 가능성이 크게 줄어듭니다. 많은 일반적인 언어와 도구를 지원하는 규칙은 온라인에서 광범위하게 제공되며 대부분의 프로젝트에서는 자체 규칙을 정의할 필요가 없습니다. 구현이 필요한 규칙이더라도 저장소의 한 중앙 위치에 규칙 정의를 정의하기만 하면 됩니다. 즉, 대부분의 엔지니어는 구현에 대해 걱정하지 않고 이러한 규칙을 사용할 수 있습니다.

환경 격리

작업을 수행하면 다른 시스템의 작업과 동일한 문제가 발생할 수 있는 것처럼 보입니다. 하지만 같은 파일에 쓰고 서로 충돌하는 작업을 작성할 수는 없나요? 실제로 Bazel은 샌드박스를 사용하여 이러한 충돌을 불가능하게 합니다. 지원되는 시스템에서 모든 작업은 파일 시스템 샌드박스를 통해 다른 모든 작업과 격리됩니다. 실질적으로 각 작업은 선언한 입력과 생성한 출력을 포함하는 파일 시스템의 제한된 뷰만 볼 수 있습니다. 이는 Docker의 기반이 되는 동일한 기술인 Linux의 LXC와 같은 시스템에서 시행됩니다. 즉, 작업은 선언하지 않은 파일을 읽을 수 없기 때문에 작업이 서로 충돌할 수 없으며 작성했지만 선언하지 않은 파일은 작업이 완료되면 삭제됩니다. 또한 Bazel은 샌드박스를 사용하여 작업을 통한 네트워크 통신을 제한합니다.

외부 종속 항목을 결정론적 방식으로 만들기

여전히 한 가지 문제가 남아 있습니다. 빌드 시스템은 종속 항목을 직접 빌드하기보다는 외부 소스에서 도구 또는 라이브러리로 다운로드해야 하는 경우가 많습니다. 이 예에서는 Maven에서 JAR 파일을 다운로드하는 @com_google_common_guava_guava//jar 종속 항목을 통해 확인할 수 있습니다.

현재 작업공간 외부의 파일에 의존하는 것은 위험합니다. 이러한 파일은 언제든지 변경될 수 있으므로 빌드 시스템에서 파일이 최신 상태인지 지속적으로 확인해야 할 수 있습니다. 작업 영역 소스 코드에서 상응하는 변경사항 없이 원격 파일이 변경되면 재현할 수 없는 빌드가 발생할 수도 있습니다. 눈에 띄지 않는 종속 항목 변경으로 인해 빌드가 어느 날은 작동하고 다음 날은 명확한 이유 없이 실패할 수 있습니다. 마지막으로 외부 종속 항목이 서드 파티 소유인 경우 큰 보안 위험이 발생할 수 있습니다. 공격자가 서드 파티 서버에 침투할 수 있다면 종속 항목 파일을 자체 설계한 것으로 대체하여 빌드 환경과 출력을 완전히 제어할 수 있기 때문입니다.

기본적인 문제는 빌드 시스템이 소스 제어에 체크인하지 않고도 이러한 파일을 인식하도록 하는 것입니다. 종속 항목을 업데이트하는 것은 의식적인 선택이어야 하지만, 이러한 선택은 개별 엔지니어가 관리하거나 시스템에서 자동으로 관리하는 대신 중앙 위치에서 한 번만 이루어져야 합니다. 이는 'Live at Head' 모델에서도 여전히 확정적으로 빌드해야 하기 때문입니다. 즉, 지난주의 커밋을 확인하면 종속 항목이 지금이 아닌 그때 그대로 표시되어야 합니다.

Bazel 및 기타 빌드 시스템은 작업공간의 모든 외부 종속 항목에 대한 암호화 해시를 나열하는 작업공간 전체 매니페스트 파일을 요구하여 이 문제를 해결합니다. 해시는 전체 파일을 소스 제어에 체크하지 않고도 파일을 고유하게 나타내는 간단한 방법입니다. 새로운 외부 종속 항목이 작업공간에서 참조될 때마다 종속 항목의 해시가 수동 또는 자동으로 매니페스트에 추가됩니다. Bazel은 빌드를 실행할 때 캐시된 종속 항목의 실제 해시를 매니페스트에 정의된 예상 해시와 비교하고 해시가 다른 경우에만 파일을 다시 다운로드합니다.

다운로드한 아티팩트에 매니페스트에 선언된 해시가 다른 해시가 있는 경우 매니페스트의 해시를 업데이트하지 않으면 빌드가 실패합니다. 이 작업은 자동으로 실행될 수 있지만 빌드가 새 종속 항목을 수락하기 전에 변경사항을 승인하고 소스 제어에 체크인해야 합니다. 즉, 종속 항목이 업데이트된 시점에 관한 기록이 항상 있으며, 작업공간 소스에서 상응하는 변경사항이 없으면 외부 종속 항목을 변경할 수 없습니다. 또한 이전 버전의 소스 코드를 체크아웃할 때 빌드는 해당 버전이 체크인된 시점에서 사용한 것과 동일한 종속 항목을 사용하게 됩니다. 그러지 않으면 해당 종속 항목을 더 이상 사용할 수 없는 경우 빌드가 실패합니다.

물론 원격 서버를 사용할 수 없게 되거나 손상된 데이터를 제공하기 시작하면 문제가 될 수 있습니다. 종속 항목의 다른 사본을 사용할 수 없으면 모든 빌드가 실패하기 시작할 수 있습니다. 이 문제를 방지하려면 중요한 프로젝트의 경우 모든 종속 항목을 신뢰할 수 있고 제어하는 서버 또는 서비스에 미러링하는 것이 좋습니다. 그렇지 않으면 체크인된 해시가 보안을 보장하더라도 항상 서드 파티의 도움을 받아 빌드 시스템을 사용할 수 있게 됩니다.