이 섹션에서는 여러 함수 또는 빌드 규칙에 공통된 다양한 용어와 개념을 정의합니다.
목차
- Bourne 셸 토큰화
- 라벨 확장
- 대부분의 빌드 규칙에 의해 정의되는 일반적인 속성
- 모든 빌드 규칙의 공통 속성
- 모든 테스트 규칙에 공통된 속성 (*_test)
- 모든 바이너리 규칙에 공통된 속성 (*_binary)
- 구성 가능한 속성
- 암시적 출력 타겟
Bourne 셸 토큰화
일부 규칙의 특정 문자열 속성은 Bourne 셸의 토큰화 규칙에 따라 여러 단어로 분할됩니다. 따옴표가 없는 공백은 개별 단어를 구분하고 작은따옴표 및 큰따옴표 문자와 백슬래시를 사용하여 토큰화를 방지합니다.
이 토큰화의 대상이 되는 속성은 이 문서의 정의에 명시적으로 표시되어 있습니다.
'Make' 변수 확장 및 Bourne 셸 토큰화가 적용되는 속성은 일반적으로 컴파일러 및 기타 도구에 임의의 옵션을 전달하는 데 사용됩니다. 이러한 속성의 예로는 cc_library.copts 및 java_library.javacopts가 있습니다.
이러한 대체 항목을 함께 사용하면 단일 문자열 변수를 구성별 옵션 단어 목록으로 확장할 수 있습니다.
라벨 확장
극소수 규칙의 일부 문자열 속성은 라벨이 확장될 수 있습니다. 이러한 문자열이 //mypkg:target와 같이 유효한 하위 문자열로 유효한 라벨을 포함하고 있고 이 라벨이 현재 규칙의 선행 조건으로 선언된 경우 대상
//mypkg:target이 나타내는 파일의 경로 이름으로 확장됩니다.
속성의 예로는 genrule.cmd와 cc_binary.linkopts가 있습니다. 각 경우, 상대 라벨이 확장되었는지 여부, 여러 파일로 확장되는 라벨이 처리되는 방법 등과 같은 문제에 따라 세부정보가 크게 다를 수 있습니다. 자세한 내용은 규칙 속성 문서를 참조하세요.
대부분의 빌드 규칙에서 정의하는 일반적인 속성
이 섹션에서는 전부는 아닌 여러 빌드 규칙에서 정의하는 속성을 설명합니다.
| 속성 | 설명 |
|---|---|
data |
라벨 목록. 기본값은 런타임 시 이 규칙에 필요한 파일입니다. 파일 또는 규칙 대상을 나열할 수 있습니다. 일반적으로 모든 대상을 허용합니다.
새 규칙은 런타임 시 다른 입력을 사용할 수 있는 입력을 처리하는 경우 |
deps |
라벨 목록. 기본값은
이 대상의 종속 항목입니다. 일반적으로 규칙 대상만 나열해야 합니다. 일부 규칙에서는 파일을 언어별 규칙은 일반적으로 나열된 대상을 특정 제공자가 있는 대상으로 제한합니다.
대부분의 경우 |
licenses |
문자열 목록, 비구성 가능, 기본값은 이 특정 타겟에 사용할 라이선스 유형 문자열의 목록입니다. 이는 Bazel에서 더 이상 사용하지 않는 지원 중단된 License API의 일부입니다. 사용하지 마세요. |
srcs |
라벨 목록. 기본값은
이 규칙으로 처리되거나 포함된 파일입니다. 일반적으로 파일을 직접 나열하지만, 기본 출력을 포함하도록 규칙 대상 (예: 언어별 규칙에서는 종종 나열된 파일에 특정 파일 확장자가 있어야 합니다. |
모든 빌드 규칙의 공통 속성
이 섹션에서는 모든 빌드 규칙에 암시적으로 추가되는 속성을 설명합니다.
| 속성 | 설명 |
|---|---|
compatible_with |
기본 지원 환경 외에 이 대상을 빌드할 수 있는 환경 목록입니다. 이는 Bazel 제약 조건 시스템의 일부이며, 이 시스템을 통해 사용자는 서로 종속될 수 있는 대상과 불가능한 대상을 선언할 수 있습니다. 예를 들어 외부에 배포 가능한 바이너리는 회사 보안 비밀 코드가 있는 라이브러리에 종속되면 안 됩니다. 자세한 내용은 ConstraintSemantics를 참조하세요. |
deprecation |
문자열, 구성 불가, 기본값은 이 타겟과 관련된 설명 경고 메시지입니다. 일반적으로 타겟이 더 이상 사용되지 않거나, 다른 규칙에 의해 대체되었거나, 패키지에만 해당하거나, 어떤 이유로든 유해한 것으로 간주된다는 점을 사용자에게 알리는 데 사용됩니다. 메시지를 표시하지 않기 위해 필요한 변경사항을 쉽게 찾을 수 있도록 웹페이지, 버그 번호, 이전 CL 예시와 같은 일부 참조를 포함하는 것이 좋습니다. 대체로 사용할 수 있는 새 대상이 있는 경우 이전 대상의 모든 사용자만 이전하는 것이 좋습니다.
이 속성은 빌드되는 방식에는 영향을 미치지 않지만 빌드 도구의 진단 출력에는 영향을 줄 수 있습니다. 패키지 내 종속 항목은 이 경고에서 제외되므로, 예를 들어 지원 중단된 규칙의 테스트를 빌드하면 경고가 발생하지 않습니다. 지원 중단된 타겟이 지원 중단된 다른 타겟에 종속되는 경우 경고 메시지가 발행되지 않습니다. 사용자가 사용을 중단하면 타겟을 삭제할 수 있습니다. |
distribs |
문자열 목록, 비구성 가능, 기본값은 이 특정 타겟에 사용할 배포 메서드 문자열의 목록입니다. 이는 Bazel에서 더 이상 사용하지 않는 지원 중단된 License API의 일부입니다. 사용하지 마세요. |
exec_compatible_with |
이 타겟의 실행 플랫폼에 있어야 하는 |
exec_properties |
문자열 사전, 기본값은 이 타겟에 대해 선택된 플랫폼의 키가 플랫폼 속성과 타겟 수준 속성에 모두 있는 경우 타겟에서 값을 가져옵니다. |
features |
feature 문자열의 목록. 기본값은 기능은 타겟에서 사용 설정 또는 사용 중지할 수 있는 문자열 태그입니다. 특성의 의미는 규칙 자체에 따라 다릅니다. 이 |
restricted_to |
기본 지원 환경 대신 이 대상을 빌드할 수 있는 환경 목록입니다.
이는 Bazel 제약조건 시스템의 일부입니다. 자세한 내용은 |
tags |
문자열 목록, 비구성 가능, 기본값은
태그는 모든 규칙에 사용할 수 있습니다. 테스트의 태그와
Bazel은 테스트 또는
테스트의 태그는 일반적으로 디버그 및 출시 프로세스에서 테스트의 역할에 주석을 추가하는 데 사용됩니다. 일반적으로 태그는 런타임 주석 기능이 없는 C++ 및 Python 테스트에 가장 유용합니다. 태그와 크기 요소를 사용하면 코드베이스 체크인 정책에 따라 테스트 모음을 유연하게 조합할 수 있습니다.
Bazel은 테스트 규칙의
|
target_compatible_with |
라벨 목록. 기본값은
이 타겟이 호환되는 것으로 간주되려면 타겟 플랫폼에 있어야 하는 호환되지 않는 타겟에 전이적으로 의존하는 타겟 자체는 호환되지 않는 것으로 간주됩니다. 빌드 및 테스트에서도 건너뜁니다. 빈 목록 (기본값)은 타겟이 모든 플랫폼과 호환됨을 나타냅니다.
작업공간 규칙을 제외한 모든 규칙에서 이 속성을 지원합니다.
일부 규칙의 경우 이 속성이 아무런 영향을 미치지 않습니다. 예를 들어
호환되지 않는 타겟 건너뛰기에 관한 자세한 내용은 플랫폼 페이지를 참고하세요. |
testonly |
부울. 구성 불가능. 기본값은
마찬가지로
테스트 ( 이 속성은 타겟이 프로덕션으로 출시된 바이너리에 포함되어서는 안 된다는 것을 의미합니다. 테스트 전용은 런타임이 아닌 빌드 시간에 적용되고 종속 항목 트리를 통해 바이러스로 전파되므로 신중하게 적용해야 합니다. 예를 들어 단위 테스트에 유용한 스텁 및 모조 앱은 프로덕션에 출시될 동일한 바이너리를 포함하는 통합 테스트에도 유용할 수 있으므로 테스트 전용으로 표시해서는 안 됩니다. 반대로, 무조건 정상 동작을 재정의하기 때문에 연결하기도 위험한 규칙은 테스트 전용으로 표시해야 합니다. |
toolchains |
이 타겟이 액세스할 수 있는 변수를 만드는 타겟 집합입니다. 이러한 대상은
이는 플랫폼 종속 구성의 규칙 구현에서 사용하는 도구 모음 확인 개념과는 다릅니다. 이 속성을 사용하여 타겟에서 사용할 특정 |
visibility |
라벨 목록. 구성 불가능. 기본값은 package의
타겟의 |
모든 테스트 규칙에 공통된 속성 (*_test)
이 섹션에서는 모든 테스트 규칙에 공통된 속성을 설명합니다.
| 속성 | 설명 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
args |
문자열 목록. $(location) 및 "Makevariable" 대체 및 Bourne 셸 토큰화가 적용됩니다. 기본값은 Bazel이
이 인수는 |
||||||||||||||||||||
env |
문자열 사전. 값에는 $(location) 및 "Make 변수" 대체가 적용됩니다. 기본값은
이 속성은 |
||||||||||||||||||||
env_inherit |
문자열 목록. 기본값은
이 속성은 |
||||||||||||||||||||
size |
문자열 테스트 대상의 '무게', 즉 실행에 필요한 시간/리소스를 지정합니다. 단위 테스트는 '소형', 통합 테스트는 '중형'으로, 엔드 투 엔드 테스트는 '대규모' 또는 '대규모'로 간주됩니다. Bazel은 크기를 사용하여 기본 제한 시간을 결정하며 테스트 크기는 다음 기본 제한 시간에 해당하며 최대 로컬 리소스 사용량을 가정합니다.
환경 변수 |
||||||||||||||||||||
timeout |
문자열 반환 전에 테스트가 실행될 것으로 예상되는 시간입니다.
테스트의 크기 속성은 리소스 추정을 제어하지만 테스트 제한 시간은 독립적으로 설정할 수 있습니다. 명시적으로 지정되지 않은 경우 제한 시간은 테스트 크기를 기반으로 합니다. 테스트 제한 시간은
위에 해당하지 않는 시간에는
|
||||||||||||||||||||
flaky |
불리언, 구성 불가능. 기본값은 테스트가 불안정하다고 표시합니다. 이 옵션을 설정하면 테스트를 최대 세 번 실행하고 매번 실패하는 경우에만 실패로 표시합니다. 기본적으로 이 속성은 False로 설정되며 테스트는 한 번만 실행됩니다. 일반적으로 이 속성은 사용하지 않는 것이 좋습니다. 어설션이 유지되면 테스트를 안정적으로 통과해야 합니다. |
||||||||||||||||||||
shard_count |
50 이하의 음수가 아닌 정수입니다. 기본값은 테스트를 실행하는 데 사용할 병렬 샤드의 수를 지정합니다. 이 값을 설정하면 테스트를 실행할 병렬 샤드 수를 결정하는 데 사용되는 모든 휴리스틱이 재정의됩니다. 일부 테스트 규칙의 경우 처음부터 샤딩을 사용 설정하려면 이 매개변수가 필요할 수 있습니다. 테스트 샤딩이 사용 설정된 경우 테스트를 생성할 때 환경 변수 샤딩을 하려면 테스트 실행기에서 테스트 샤딩 프로토콜을 지원해야 합니다. 그렇지 않으면 모든 샤드에서 모든 테스트를 실행할 가능성이 높으며 이는 원치 않는 실행입니다. 샤딩에 관한 자세한 내용은 테스트 백과사전의 테스트 샤딩을 참고하세요. |
||||||||||||||||||||
local |
불리언, 구성 불가능. 기본값은 테스트를 샌드박스 없이 로컬에서 강제 실행합니다. 이 값을 True로 설정하는 것은 'local'을 태그( |
모든 바이너리 규칙에 공통된 속성 (*_binary)
이 섹션에서는 모든 바이너리 규칙에 공통된 속성에 대해 설명합니다.
| 속성 | 설명 |
|---|---|
args |
문자열 목록. $(location) 및 "Makevariable" 대체 및 Bourne 셸 토큰화가 적용됩니다. un구성 가능. 기본값은
참고: Bazel 외부에서 타겟을 실행할 때는 (예: |
env |
문자열 사전. 값에는 $(location) 및 "Make 변수" 대체가 적용됩니다. 기본값은
이 속성은
참고: Bazel 외부에서 대상을 실행할 때는 (예: |
output_licenses |
문자열 목록. 기본값은 이 바이너리가 생성하는 출력 파일의 라이선스입니다. 이는 Bazel에서 더 이상 사용하지 않는 지원 중단된 License API의 일부입니다. 사용하지 마세요. |
구성 가능한 속성
대부분의 속성은 '구성 가능'합니다. 즉, 타겟이 다른 방식으로 빌드될 때 값이 변경될 수 있습니다. 특히 구성 가능한 속성은 Bazel 명령줄에 전달된 플래그 또는 대상을 요청하는 다운스트림 종속 항목에 따라 다를 수 있습니다. 예를 들어 여러 플랫폼 또는 컴파일 모드에 맞게 타겟을 맞춤설정하는 데 사용할 수 있습니다.
다음 예에서는 다양한 타겟 아키텍처에 대해 서로 다른 소스를 선언합니다. bazel build :multiplatform_lib --cpu x86를 실행하면 x86_impl.cc를 사용하여 타겟이 빌드되고 --cpu arm를 바꾸면 arm_impl.cc가 대신 사용됩니다.
cc_library(
name = "multiplatform_lib",
srcs = select({
":x86_mode": ["x86_impl.cc"],
":arm_mode": ["arm_impl.cc"]
})
)
config_setting(
name = "x86_mode",
values = { "cpu": "x86" }
)
config_setting(
name = "arm_mode",
values = { "cpu": "arm" }
)
select() 함수는 타겟의 구성이 충족하는 config_setting 또는 constraint_value 기준에 따라 구성 가능한 속성의 다양한 대체 값 중에서 선택합니다.
Bazel은 매크로를 처리한 후 그리고 규칙을 처리하기 전에 (엄밀히 말해
로드 단계와 분석 단계 사이) 구성 가능한 속성을 평가합니다.
select() 평가 전의 처리는 select()가 어떤 브랜치를 선택하는지 알지 못합니다. 예를 들어 매크로는 선택된 브랜치를 기반으로 동작을 변경할 수 없으며 bazel query는 타겟의 구성 가능한 종속 항목에 관해 보수적인 추측만 할 수 있습니다. 규칙 및 매크로와 함께 select()를 사용하는 방법에 관한 자세한 내용은
이 FAQ를 참고하세요.
문서에 nonconfigurable로 표시된 속성은 이 기능을 사용할 수 없습니다. 일반적으로 속성은 구성할 수 없습니다. Bazel이 select() 확인 방법을 결정하려면 먼저 이 값을 내부적으로 알아야 하기 때문입니다.
자세한 개요는 구성 가능한 빌드 속성을 참고하세요.
암시적 출력 타겟
C++의 암시적 출력은 지원 중단되었습니다. 가능하면 다른 언어로는 사용하지 마시기 바랍니다. 아직 지원 중단 경로는 없지만 결국에는 지원 중단될 예정입니다.
BUILD 파일에서 빌드 규칙을 정의하면 패키지에 이름이 지정된 새로운 규칙 대상을 명시적으로 선언하게 됩니다. 또한 많은 빌드 규칙 함수는 내용 및 의미가 규칙에 따라 달라지는 하나 이상의 출력 파일 대상을 암시적으로 수반합니다.
예를 들어 java_binary(name='foo', ...) 규칙을 명시적으로 선언하면 출력 파일 타겟 foo_deploy.jar도 동일한 패키지의 구성원으로 암시적으로 선언됩니다.
(이 특정 대상은 배포에 적합한 독립 실행형 자바 아카이브입니다.)
암시적 출력 타겟은 전역 타겟 그래프의 최고 멤버입니다. 다른 타겟과 마찬가지로, 최상위 수준 빌드 명령어에 지정되거나 다른 빌드 타겟의 필수 기본 요건인 경우 주문형으로 빌드됩니다. 이러한 요소는 BUILD 파일에서 종속 항목으로 참조될 수 있으며 bazel query와 같은 분석 도구의 출력에서 관찰될 수 있습니다.
빌드 규칙의 각 종류에 관한 규칙 문서에는 이러한 종류의 규칙 선언에 수반되는 암시적 출력의 이름과 내용을 자세히 설명하는 특수 섹션이 포함되어 있습니다.
빌드 시스템에서 사용하는 두 네임스페이스 간의 중요하지만 다소 미묘한 차이입니다. 라벨은 타겟(규칙 또는 파일일 수 있음)을 식별하고 파일 타겟은 소스(또는 입력) 파일 타겟과 파생(또는 출력) 파일 타겟으로 나눌 수 있습니다. 이러한 항목은 BUILD 파일에서 언급하거나 명령줄에서 빌드하거나 bazel query를 사용하여 검사할 수 있습니다. 이것이 대상 네임스페이스입니다. 각 파일 대상은 디스크에 있는 실제 파일 1개('파일 시스템 네임스페이스')에 해당합니다. 각 규칙 대상은 디스크에 있는 0개, 1개 이상의 실제 파일에 해당할 수 있습니다.
디스크에 상응하는 타겟이 없는 파일이 있을 수 있습니다. 예를 들어 C++ 컴파일 중에 생성된 .o 객체 파일은 BUILD 파일 내나 명령줄에서 참조될 수 없습니다.
이러한 방식으로 빌드 도구는 작업 실행 방법에 관한 특정 구현 세부정보를 숨길 수 있습니다. 이에 대해서는 빌드 개념 참조에서 자세히 설명합니다.