BUILD 파일

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

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

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

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

cc_library과 같은 빌드 규칙 함수가 실행되면 그래프에 새 타겟이 생성됩니다. 이 타겟은 나중에 라벨을 사용하여 참조할 수 있습니다.

간단한 BUILD 파일에서는 동작을 변경하지 않고도 규칙 선언의 순서를 자유롭게 변경할 수 있습니다.

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

중요한 점은 Starlark의 프로그램은 임의의 I/O를 실행할 수 없다는 것입니다. 이 불변항은 BUILD 파일의 해석을 봉인된 상태로 만듭니다. 즉, 빌드가 재현 가능하도록 하는 데 필수적인 알려진 입력 집합에만 종속됩니다. 자세한 내용은 Hermeticity를 참고하세요.

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

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의 경우 java_*). 이러한 함수 중 일부는 빌드 백과사전에 설명되어 있지만 누구나 새 규칙을 만들 수 있습니다.

• *_binary 규칙은 지정된 언어로 실행 파일을 빌드합니다. 빌드 후 실행 파일은 빌드 도구의 바이너리 출력 트리에 규칙 라벨의 상응하는 이름으로 있으므로 //my:program은 (예:) $(BINDIR)/my/program에 표시됩니다.

  일부 언어에서는 이러한 규칙이 규칙에 속한 data 속성에 언급된 모든 파일 또는 종속 항목의 전이 종료에 있는 모든 규칙을 포함하는 runfiles 디렉터리도 만듭니다. 이 파일 세트는 프로덕션에 쉽게 배포할 수 있도록 한곳으로 모아집니다.

• *_test 규칙은 자동 테스트에 사용되는 *_binary 규칙의 특수화입니다. 테스트는 성공 시 0을 반환하는 단순한 프로그램입니다.

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

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