BUILD 파일

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
문제 신고 소스 보기

이전 섹션에서는 패키지, 대상 및 라벨, 빌드 종속 항목 그래프를 추상적으로 설명했습니다. 이 섹션에서는 패키지를 정의하는 데 사용되는 구체적인 구문을 설명합니다.

정의에 따라 모든 패키지에는 짧은 프로그램인 BUILD 파일이 포함됩니다. BUILD 파일은 명령적 언어인 Starlark를 사용하여 평가됩니다.

순차적인 문 목록으로 해석됩니다.

일반적으로 순서는 중요합니다. 예를 들어 변수가 사용되기 전에 정의해야 합니다. 그러나 대부분의 BUILD 파일은 빌드 규칙의 선언으로만 구성되며 이러한 문의의 상대적 순서는 중요하지 않습니다. 중요한 것은 패키지 평가가 완료되는 시점에 선언된 어떤 규칙과 어떤 값이 결정되었는지입니다.

빌드 규칙 함수(예: cc_library)를 실행하면 그래프에서 새 대상이 생성됩니다. 이 대상은 나중에 라벨을 사용하여 참조할 수 있습니다.

간단한 BUILD 파일에서 규칙 선언은 동작을 변경하지 않고 자유롭게 다시 정렬할 수 있습니다.

코드와 데이터를 명확하게 구분하기 위해 BUILD 파일에는 함수 정의, for 문 또는 if 문이 포함될 수 없습니다 (단, 목록 이해와 if 표현식은 허용됨). 대신 .bzl 파일에서 함수를 선언할 수 있습니다. 또한 *args**kwargs 인수는 BUILD 파일에서 허용되지 않습니다. 대신 모든 인수를 명시적으로 나열합니다.

중요한 점은 Starlark의 프로그램이 임의 I/O를 수행할 수 없다는 것입니다. 이러한 불변성은 BUILD 파일의 해석을 기본 제공으로 간주하며, 알려진 입력 세트에만 의존합니다. 이는 빌드의 재현 가능성을 높이는 데 반드시 필요합니다. 자세한 내용은 혈류를 참고하세요.

BUILD 파일은 ASCII 문자만 사용하여 작성해야 하지만, 기술적으로 라틴-1 문자 집합을 사용하여 해석됩니다.

BUILD 파일은 기본 코드의 종속 항목이 변경될 때마다 업데이트해야 하므로 일반적으로 팀의 여러 사용자가 유지관리합니다. BUILD 파일 작성자는 각 빌드 대상의 역할을 공개 사용 여부와 관계없이 자유롭게 문서화하고 패키지 자체의 역할을 문서화해야 합니다.

확장 프로그램 로드

Bazel 확장 프로그램은 .bzl으로 끝나는 파일입니다. load 문을 사용하여 확장 프로그램에서 기호를 가져옵니다.

load("//foo/bar:file.bzl", "some_library")

이 코드는 foo/bar/file.bzl 파일을 로드하고 환경에 some_library 기호를 추가합니다. 새 규칙, 함수 또는 상수(예: 문자열 또는 목록)를 로드하는 데 사용할 수 있습니다. load 호출에 추가 인수를 사용하여 여러 기호를 가져올 수 있습니다. 인수는 문자열 리터럴(변수 없음)이어야 하며 load 문은 최상위 수준에 표시되어야 하며 함수 본문에 있을 수 없습니다.

load의 첫 번째 인수는 .bzl 파일을 식별하는 라벨입니다. 상대 라벨인 경우 현재 bzl 파일이 포함된 패키지 (디렉터리 아님)와 관련하여 확인됩니다. load 문의 상대 라벨은 선행 :를 사용해야 합니다.

load는 별칭도 지원하므로 가져온 기호에 다른 이름을 할당할 수 있습니다.

load("//foo/bar:file.bzl", library_alias = "some_library")

load 문 하나에 여러 별칭을 정의할 수 있습니다. 또한 인수 목록에는 별칭과 일반 기호 이름이 모두 포함될 수 있습니다. 다음 예는 완전히 합법적입니다 (따옴표를 사용할 때 유의).

load(":my_rules.bzl", "some_rule", nice_alias = "some_other_rule")

.bzl 파일에서 _로 시작하는 기호는 내보내지지 않으며 다른 파일에서 로드할 수 없습니다.

로드 가시성을 사용하여 .bzl 파일을 로드할 수 있는 사용자를 제한할 수 있습니다.

빌드 규칙의 유형

대부분의 빌드 규칙은 언어별로 그룹화되어 있습니다. 예를 들어 cc_binary, cc_library, cc_test는 각각 C++ 바이너리, 라이브러리, 테스트의 빌드 규칙입니다. 다른 언어는 같은 이름 지정 스키마를 사용하지만 접두사가 다른 경우(예: 자바의 경우 java_*) 이러한 함수 중 일부는 빌드 백과사전에 설명되어 있지만 누구나 새 규칙을 만들 수 있습니다.

  • *_binary 규칙은 특정 언어로 실행 가능한 프로그램을 빌드합니다. 빌드 후 실행 파일은 규칙 라벨의 해당 이름에 해당하는 빌드 도구의 바이너리 출력 트리에 상주하므로 //my:program$(BINDIR)/my/program에 나타납니다.

    일부 언어의 경우 이러한 규칙은 규칙에 속한 data 속성 또는 종속 항목의 전이적 폐쇄에 포함된 모든 규칙을 포함하는 runfile 디렉터리를 생성합니다. 이 파일 세트는 프로덕션으로 쉽게 배포할 수 있도록 한곳에 수집됩니다.

  • *_test 규칙은 자동 테스트용으로 사용되는 *_binary 규칙의 전문 분야입니다. 테스트는 성공 시 0을 반환하는 프로그램입니다.

    바이너리와 마찬가지로 테스트에는 runfile 트리도 있으며 이 파일은 실행 시 합법적으로 열 수 있는 유일한 파일입니다. 예를 들어 프로그램 cc_test(name='x', data=['//foo:bar'])는 실행 중에 $TEST_SRCDIR/workspace/foo/bar을 열고 읽을 수 있습니다. (각 프로그래밍 언어에는 $TEST_SRCDIR 값에 액세스하기 위한 자체 유틸리티 함수가 있지만 모두 환경 변수를 직접 사용하는 것과 같습니다.) 규칙을 준수하지 않으면 원격 테스트 호스트에서 실행될 때 테스트가 실패합니다.

  • *_library 규칙은 지정된 프로그래밍 언어로 별도로 컴파일된 모듈을 지정합니다. 라이브러리는 다른 라이브러리에 종속될 수 있으며 바이너리 및 테스트는 예상되는 별도의 컴파일 동작과 함께 라이브러리에 종속될 수 있습니다.

라벨 종속 항목