규칙
alias
규칙 소스 보기alias(name, actual, compatible_with, deprecation, features, restricted_to, tags, target_compatible_with, testonly, visibility)
alias 규칙은 규칙을 참조할 수 있는 다른 이름을 만듭니다.
별칭은 '일반' 타겟에만 적용됩니다. 특히 package_group 및 test_suite는 별칭을 지정할 수 없습니다.
별칭은 대상의 이름을 바꾸려면 많은 파일을 변경해야 하는 대규모 저장소에서 도움이 될 수 있습니다. 여러 타겟에 이 로직을 재사용하려는 경우 별칭 규칙을 사용하여 select 함수 호출을 저장할 수도 있습니다.
별칭 규칙에는 자체 공개 상태 선언이 있습니다. 다른 모든 측면에서는 참조하는 규칙과 같이 동작합니다 (예: 별칭의 테스트 전용은 무시되고 참조된 규칙의 테스트 전용이 대신 사용됨). 일부 사소한 예외가 있습니다.
-
명령줄에 별칭이 언급된 경우 테스트가 실행되지 않습니다. 참조된 테스트를 실행하는 별칭을 정의하려면
tests속성에 단일 타겟이 있는test_suite규칙을 사용하세요. -
환경 그룹을 정의할 때
environment규칙의 별칭은 지원되지 않습니다.--target_environment명령줄 옵션에서도 지원되지 않습니다.
예
filegroup(
name = "data",
srcs = ["data.txt"],
)
alias(
name = "other",
actual = ":data",
)
인수
| 속성 | |
|---|---|
name |
이름. 필수 항목입니다. 이 대상의 고유한 이름입니다. |
actual
|
라벨: 필수사항 이 별칭이 참조하는 타겟입니다. 규칙이 아니어도 되며 입력 파일일 수도 있습니다. |
config_setting
규칙 소스 보기config_setting(name, constraint_values, define_values, deprecation, distribs, features, flag_values, licenses, tags, testonly, values, visibility)
구성 가능한 속성을 트리거하기 위한 목적으로 예상 구성 상태 (빌드 플래그 또는 플랫폼 제약 조건으로 표현됨)와 일치합니다. 이 규칙을 사용하는 방법은 select를 참고하고 일반적인 기능에 관한 개요는 구성 가능한 속성을 참고하세요.
예
다음은 --compilation_mode=opt 또는 -c opt를 설정하는 모든 빌드(명령줄에서 명시적으로 또는 .bazelrc 파일에서 암시적으로)와 일치합니다.
config_setting(
name = "simple",
values = {"compilation_mode": "opt"}
)
다음은 ARM을 타겟팅하고 맞춤 정의 FOO=bar (예: bazel build --cpu=arm --define FOO=bar ...)를 적용하는 모든 빌드와 일치합니다.
config_setting(
name = "two_conditions",
values = {
"cpu": "arm",
"define": "FOO=bar"
}
)
다음은 사용자 정의 플래그
--//custom_flags:foo=1를 설정하는 모든 빌드와 일치합니다 (명령줄에서 명시적으로 또는 .bazelrc 파일에서 암시적으로 설정).
config_setting(
name = "my_custom_flag_is_set",
flag_values = { "//custom_flags:foo": "1" },
)
다음은 x86_64 아키텍처 및 glibc 버전 2.25가 있는 플랫폼을 타겟팅하는 모든 빌드와 일치합니다. 단, //example:glibc_2_25 라벨이 있는 constraint_value가 존재한다고 가정합니다. 이 두 가지 이외의 추가 제약조건 값을 정의하는 경우에도 플랫폼은 일치합니다.
config_setting(
name = "64bit_glibc_2_25",
constraint_values = [
"@platforms//cpu:x86_64",
"//example:glibc_2_25",
]
)
config_setting가 최상위 명령줄 플래그와 일치하지 않더라도 일부 빌드 타겟과 일치할 수 있습니다.
참고
- 여러
config_setting가 현재 구성 상태와 일치하는 경우 어떻게 되는지 알아보려면 select를 참고하세요. - 약어 형식을 지원하는 플래그 (예:
--compilation_mode대-c)의 경우values정의는 전체 형식을 사용해야 합니다. 두 형식 중 하나를 사용하여 호출을 자동으로 일치시킵니다. -
플래그가 여러 값을 사용하는 경우(예:
--copt=-Da --copt=-Db또는 목록 유형의 Starlark 플래그)values = { "flag": "a" }는"a"가 실제 목록의 어디서나 있는 경우 일치합니다.values = { "myflag": "a,b" }도 동일한 방식으로 작동합니다.values = { "myflag": "a,b" }는--myflag=a --myflag=b,--myflag=a --myflag=b --myflag=c,--myflag=a,b,--myflag=c,b,a와 일치합니다. 정확한 시맨틱스는 플래그마다 다릅니다. 예를 들어--copt는 동일한 인스턴스에서 여러 값을 지원하지 않습니다.--copt=a,b는["a,b"]을 생성하고--copt=a --copt=b는["a", "b"]을 생성합니다. 따라서values = { "copt": "a,b" }는 전자에 일치하지만 후자에 일치하지 않습니다. 하지만--ios_multi_cpus(Apple 규칙의 경우)는 다르게 작동합니다.-ios_multi_cpus=a,b와ios_multi_cpus=a --ios_multi_cpus=b모두["a", "b"]를 생성합니다. 플래그 정의를 확인하고 조건을 신중하게 테스트하여 정확한 기대치를 확인합니다. - 기본 제공 빌드 플래그로 모델링되지 않은 조건을 정의해야 하는 경우
Starlark 정의 플래그를 사용하세요.
--define를 사용할 수도 있지만 지원이 약하므로 권장하지 않습니다. 자세한 내용은 여기를 참고하세요. - 여러 패키지에서 동일한
config_setting정의를 반복하지 마세요. 대신 표준 패키지에 정의된 공통config_setting를 참조합니다. values,define_values,constraint_values는 동일한config_setting에서 어떤 조합으로든 사용할 수 있지만, 주어진config_setting에 하나 이상 설정해야 합니다.
인수
| 속성 | |
|---|---|
name |
이름: 필수사항 이 타겟의 고유한 이름입니다. |
constraint_values
|
이 config_setting와 일치하기 위해 타겟 플랫폼에서 지정해야 하는 최소 constraint_values 집합입니다. 여기서는 실행 플랫폼이 고려되지 않습니다. 플랫폼에 있는 추가 제약 조건 값은 무시됩니다. 자세한 내용은
구성 가능한 빌드 속성을 참고하세요.
두 |
define_values
|
사전: 문자열 -> 문자열; 구성 불가; 기본값은 values와 동일하지만 --define 플래그에만 적용됩니다.
즉,
config_setting(
name = "a_and_b",
values = {
"define": "a=1",
"define": "b=2",
})
동일한 키 (
config_setting(
name = "a_and_b",
define_values = {
"a": "1",
"b": "2",
})
|
flag_values
|
사전: label -> 문자열; 구성 불가; 기본값은 values와 동일하지만
사용자 정의 빌드 플래그에 적용됩니다.
이는 사용자 정의 플래그는 라벨로 참조되는 반면 내장 플래그는 임의의 문자열로 참조되기 때문에 고유한 속성입니다. |
values
|
사전: 문자열 -> 문자열; 구성 불가; 기본값은 이 규칙은 편의를 위해 구성 값은 빌드 플래그로 지정됩니다(앞에 명령줄에서 플래그를 명시적으로 설정하지 않으면 기본값이 사용됩니다.
사전에 키가 여러 번 표시되면 마지막 인스턴스만 사용됩니다.
키가 명령줄에서 여러 번 설정할 수 있는 플래그(예:
|
filegroup
규칙 소스 보기filegroup(name, srcs, data, compatible_with, deprecation, distribs, features, licenses, output_group, restricted_to, tags, target_compatible_with, testonly, visibility)
filegroup를 사용하여 타겟 모음에 편리한 이름을 지정합니다.
그런 다음 다른 규칙에서 참조할 수 있습니다.
디렉터리를 직접 참조하는 대신 filegroup를 사용하는 것이 좋습니다.
후자는 빌드 시스템이 디렉터리 아래의 모든 파일을 완전히 알지 못하므로 이러한 파일이 변경될 때 다시 빌드되지 않을 수 있으므로 이는 바람직하지 않습니다. filegroup를 glob와 결합하면 모든 파일이 빌드 시스템에 명시적으로 알려질 수 있습니다.
예
두 개의 소스 파일로 구성된 filegroup를 만들려면 다음을 실행합니다.
filegroup(
name = "mygroup",
srcs = [
"a_file.txt",
"some/subdirectory/another_file.txt",
],
)
또는 glob를 사용하여 testdata 디렉터리를 탐색합니다.
filegroup(
name = "exported_testdata",
srcs = glob([
"testdata/*.dat",
"testdata/logs/**/*.log",
]),
)
이러한 정의를 사용하려면 규칙의 라벨이 있는 filegroup를 참조하세요.
cc_library(
name = "my_library",
srcs = ["foo.cc"],
data = [
"//my_package:exported_testdata",
"//my_package:mygroup",
],
)
인수
| 속성 | |
|---|---|
name |
이름: 필수사항 이 타겟의 고유한 이름입니다. |
srcs
|
라벨 목록입니다. 기본값은
|
data
|
라벨 목록. 기본값은
|
output_group
|
문자열. 기본값은 '출력 그룹'은 규칙의 구현에 지정된 타겟의 출력 아티팩트 카테고리입니다. |
genquery
규칙 소스 보기genquery(name, deps, data, compatible_with, compressed_output, deprecation, distribs, exec_compatible_with, exec_properties, expression, features, licenses, opts, restricted_to, scope, strict, tags, target_compatible_with, testonly, visibility)
genquery()는 Blaze 쿼리 언어로 지정된 쿼리를 실행하고 결과를 파일에 덤프합니다.
빌드를 일관되게 유지하기 위해 쿼리는 scope 속성에 지정된 타겟의 전이적 클로저만 방문할 수 있습니다. 이 규칙을 위반하는 쿼리는 strict가 지정되지 않았거나 true인 경우 실행 중에 실패합니다. strict가 false인 경우 범위 외 타겟은 경고와 함께 건너뜁니다. 이러한 일이 발생하지 않도록 하는 가장 쉬운 방법은 쿼리 표현식에서와 동일한 라벨을 범위에 언급하는 것입니다.
여기에서 허용되는 쿼리와 명령줄에서 허용되는 쿼리의 유일한 차이점은 와일드 카드 타겟 사양(예: //pkg:* 또는 //pkg:all)이 포함된 쿼리는 여기에서 허용되지 않는다는 점입니다.
그 이유는 두 가지입니다.첫째, genquery는 쿼리의 전이 폐쇄 외부의 대상이 출력에 영향을 미치지 않도록 범위를 지정해야 하기 때문입니다. 둘째, BUILD 파일은 와일드 카드 종속 항목을 지원하지 않기 때문입니다 (예: deps=["//a/..."]는 허용되지 않음).
결정론적 출력을 적용하기 위해 genquery의 출력은 사전순으로 정렬됩니다(--output=graph|minrank|maxrank 또는 somepath가 최상위 함수로 사용되는 경우 제외).
출력 파일의 이름은 규칙의 이름입니다.
예
이 예시에서는 지정된 대상을 전이적 종료로 닫을 때 라벨 목록을 파일에 씁니다.
genquery(
name = "kiwi-deps",
expression = "deps(//kiwi:kiwi_lib)",
scope = ["//kiwi:kiwi_lib"],
)
인수
| 속성 | |
|---|---|
name |
이름: 필수사항 이 타겟의 고유한 이름입니다. |
compressed_output
|
불리언. 기본값은 True인 경우 쿼리 출력은 GZIP 파일 형식으로 작성됩니다. 이 설정은 쿼리 출력이 클 것으로 예상될 때 Bazel의 메모리 사용량이 급증하는 것을 방지하는 데 사용할 수 있습니다. Bazel은 이미 이 설정의 값과 관계없이 220바이트보다 큰 쿼리 출력을 내부적으로 압축하므로 True로 설정해도 유지된 힙이 줄어들지 않을 수 있습니다. 그러나 이렇게 하면 Bazel이 메모리 집약적인 출력 파일을 쓸 때 압축 해제를 건너뛸 수 있습니다.
|
expression
|
문자열, 필수 실행할 쿼리입니다. BUILD 파일의 명령줄 및 다른 위치와 달리 여기서 라벨은 작업공간의 루트 디렉터리를 기준으로 확인됩니다. 예를 들어a/BUILD 파일의 이 속성에서 라벨 :b는 타겟 //:b를 참조합니다.
|
opts
|
문자열 목록. 기본값은 bazel query에 전달할 수 있는 명령줄 옵션에 해당합니다. 여기서는 일부 쿼리 옵션(--keep_going, --query_file, --universe_scope, --order_results, --order_output)이 허용되지 않습니다. 여기에 지정되지 않은 옵션은 bazel query의 명령줄과 마찬가지로 기본값이 적용됩니다.
|
scope
|
라벨 목록(필수) 쿼리의 범위입니다. 쿼리에서 이러한 타겟의 전이적 클로저 외부에 있는 타겟은 터치할 수 없습니다. |
strict
|
불리언. 기본값은 |
genrule
규칙 소스 보기genrule(name, srcs, outs, cmd, cmd_bash, cmd_bat, cmd_ps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, executable, features, licenses, local, message, output_licenses, output_to_bindir, restricted_to, tags, target_compatible_with, testonly, toolchains, tools, visibility)
genrule는 사용자 정의 Bash 명령어를 사용하여 하나 이상의 파일을 생성합니다.
Genrules는 작업에 관한 특정 규칙이 없는 경우 사용할 수 있는 일반 빌드 규칙입니다.
예를 들어 Bash 원라인을 실행할 수 있습니다. 하지만 C++ 파일을 컴파일해야 하는 경우 기존 cc_* 규칙을 따르세요. 모든 번거로운 작업이 이미 완료되었기 때문입니다.
genrule을 사용하려면 셸이 명령어 인수를 해석해야 합니다. PATH에서 사용 가능한 임의의 프로그램을 쉽게 참조할 수도 있지만, 이렇게 하면 명령어가 폐쇄적이지 않게 되며 재현할 수 없을 수도 있습니다. 단일 도구만 실행해야 하는 경우 대신 run_binary를 사용하는 것이 좋습니다.
테스트 실행에는 genrule을 사용하지 마세요. 캐싱 정책 및 환경 변수를 비롯하여 테스트 및 테스트 결과에 대한 특별 예외가 있습니다. 테스트는 일반적으로 빌드가 완료된 후 타겟 아키텍처에서 실행해야 하지만 genrule은 빌드 도중과 exec 아키텍처에서 실행됩니다 (둘은 다를 수 있음). 범용 테스트 규칙이 필요한 경우 sh_test를 사용하세요.
크로스 컴파일 고려사항
교차 컴파일에 관한 자세한 내용은 사용자 설명서를 참고하세요.
genrule은 빌드 중에 실행되지만 빌드 후 배포 또는 테스트 목적으로 사용되는 경우가 많습니다. 마이크로컨트롤러용 C 코드 컴파일의 예를 생각해 보세요. 컴파일러는 C 소스 파일을 수락하고 마이크로컨트롤러에서 실행되는 코드를 생성합니다. 생성된 코드는 빌드하는 데 사용된 CPU에서 실행할 수 없지만 C 컴파일러 (소스에서 컴파일된 경우) 자체는 실행해야 합니다.
빌드 시스템은 exec 구성을 사용하여 빌드가 실행되는 머신을 설명하고 타겟 구성을 사용하여 빌드 출력이 실행되어야 하는 머신을 설명합니다. 각 항목을 구성하는 옵션을 제공하고 충돌을 방지하기 위해 해당 파일을 별도의 디렉터리로 분리합니다.
genrule의 경우 빌드 시스템이 종속 항목이 적절하게 빌드되도록 합니다. srcs는 target 구성에 대해 빌드되고 (필요한 경우), tools는 exec 구성용으로 빌드되며, 출력은 target 구성용으로 간주됩니다. 또한 genrule 명령어가 해당 도구에 전달할 수 있는
'Make' 변수를 제공합니다.
genrule이 deps 속성을 정의하지 않도록 의도된 것입니다. 다른 기본 제공 규칙은 규칙 간에 전달되는 언어 종속적인 메타 정보를 사용하여 종속 규칙을 처리하는 방법을 자동으로 결정하지만, genrule에 이러한 수준의 자동화가 불가능합니다. Genrules는 순전히 파일 및 runfiles 수준에서 작동합니다.
특수 사례
Exec-exec 컴파일: 경우에 따라 빌드 시스템은 빌드 중에 출력을 실행할 수도 있도록 genrules를 실행해야 합니다. 예를 들어 genrule이 다른 genrule에서 사용하는 커스텀 컴파일러를 빌드하는 경우 첫 번째 컴파일러가 exec 구성에 관한 출력을 생성해야 합니다. 컴파일러가 다른 genrule에서 실행되기 때문입니다. 이 경우 빌드 시스템이 올바르게 작동합니다. 즉, 대상 구성 대신 실행 구성의 첫 번째 genrule의 srcs 및 outs를 빌드합니다. 자세한 내용은 사용자 설명서를 참고하세요.
JDK 및 C++ 도구: JDK 또는 C++ 컴파일러 제품군의 도구를 사용하기 위해 빌드 시스템에서 사용할 변수 집합을 제공합니다. 자세한 내용은 'Make' 변수를 참고하세요.
Genrule 환경
genrule 명령어는 명령어 또는 파이프라인이 실패할 때 set -e -o pipefail를 사용하여 실패하도록 구성된 Bash 셸에 의해 실행됩니다.
빌드 도구는 PATH, PWD, TMPDIR와 같은 핵심 변수만 정의하는 정리된 프로세스 환경에서 Bash 명령어를 실행합니다.
빌드를 재현할 수 있도록 하기 위해 사용자의 셸 환경에 정의된 대부분의 변수는 genrule 명령어에 전달되지 않습니다. 그러나 Bazel (Blaze 제외)은 사용자의 PATH 환경 변수 값을 전달합니다.
PATH 값을 변경하면 Bazel이 다음 빌드에서 명령어를 다시 실행합니다.
genrule 명령어는 현재 시행되지는 않지만 명령어 자체의 하위 프로세스를 연결하는 경우를 제외하고 네트워크에 액세스해서는 안 됩니다.
빌드 시스템은 기존 출력 파일을 자동으로 삭제하지만 genrule을 실행하기 전에 필요한 상위 디렉터리를 만듭니다. 또한 실패할 경우 출력 파일도 삭제합니다.
일반 도움말
- genrule에서 실행하는 도구가 결정론적이고 견고한지 확인합니다. 출력에 타임스탬프를 작성해서는 안 되며, 집합과 맵에 안정적인 순서를 사용해야 하고, 절대 경로가 아닌 상대 파일 경로만 출력에 작성해야 합니다. 이 규칙을 따르지 않으면 예기치 않은 빌드 동작 (Bazel이 예상한 대로 genrule을 다시 빌드하지 않음)이 발생하고 캐시 성능이 저하됩니다.
- 출력, 도구, 소스에
$(location)를 광범위하게 사용하세요. 다양한 구성에 맞게 출력 파일이 분리되므로 genrules는 하드코딩된 경로 또는 절대 경로를 사용할 수 없습니다. - 동일하거나 매우 유사한 genrule이 여러 위치에서 사용되는 경우 공통 Starlark 매크로를 작성합니다. genrule가 복잡한 경우 스크립트에서 또는 Starlark 규칙으로 구현하는 것이 좋습니다. 이렇게 하면 테스트 가능성과 가독성이 개선됩니다.
- 종료 코드가 genrule의 성공 또는 실패를 올바르게 나타내는지 확인합니다.
- 정보 메시지를 stdout 또는 stderr에 작성하지 마세요. 디버깅에는 유용하지만 쉽게 노이즈가 될 수 있습니다. 성공적인 genrule은 조용해야 합니다. 반면에 실패하는 genrule는 유효한 오류 메시지를 내보내야 합니다.
$$evaluates to a$, a literal dollar-sign, so in order to invoke a shell command containing dollar-signs such asls $(dirname $x), one must escape it thus:ls $$(dirname $$x).- 심볼릭 링크와 디렉터리를 만들지 않는 것이 좋습니다. Bazel은 genrule로 생성된 디렉터리/심볼릭 링크 구조를 복사하지 않으며 디렉터리의 종속 항목 검사가 잘못되었습니다.
- 다른 규칙에서 genrule을 참조할 때는 genrule의 라벨 또는 개별 출력 파일의 라벨을 사용할 수 있습니다. 한 가지 접근 방식이 더 읽기 쉬울 때도 있고 다른 접근 방식이 더 읽기 쉬울 때도 있습니다. 사용하는 규칙의
srcs에서 이름으로 출력을 참조하면 의도치 않게 genrule의 다른 출력을 선택하지 않을 수 있지만 genrule이 많은 출력을 생성하는 경우 번거로울 수 있습니다.
예
이 예에서는 foo.h를 생성합니다. 명령어가 입력을 받지 않으므로 소스가 없습니다. 명령어에 의해 실행되는 '바이너리'는 genrule과 동일한 패키지에 있는 perl 스크립트입니다.
genrule(
name = "foo",
srcs = [],
outs = ["foo.h"],
cmd = "./$(location create_foo.pl) > \"$@\"",
tools = ["create_foo.pl"],
)
다음 예는 filegroup
및 다른 genrule의 출력을 사용하는 방법을 보여줍니다. 명시적 $(location) 디렉티브 대신 $(SRCS)를 사용해도 됩니다. 이 예에서는 설명을 위해 후자를 사용합니다.
genrule(
name = "concat_all_files",
srcs = [
"//some:files", # a filegroup with multiple files in it ==> $(locations)
"//other:gen", # a genrule with a single output ==> $(location)
],
outs = ["concatenated.txt"],
cmd = "cat $(locations //some:files) $(location //other:gen) > $@",
)
인수
| 속성 | |
|---|---|
name |
이름: 필수사항 이 타겟의 고유한 이름입니다. 다른 BUILD 규칙의 srcs 또는 deps 섹션에서 이 규칙을 이름으로 참조할 수 있습니다. 규칙이 소스 파일을 생성하는 경우 srcs 속성을 사용해야 합니다.
|
srcs
|
라벨 목록입니다. 기본값은
이 속성은
빌드 시스템은 genrule 명령어를 실행하기 전에 이러한 기본 요건이 빌드되도록 합니다. 기본 요건은 원래 빌드 요청과 동일한 구성을 사용하여 빌드됩니다. 이러한 기본 요건의 파일 이름은 |
outs
|
이 규칙으로 생성된 파일의 목록입니다.
출력 파일이 패키지 경계를 넘어서는 안 됩니다. 출력 파일 이름은 패키지를 기준으로 해석됩니다.
genrule 명령어는 사전에 결정된 위치에 각 출력 파일을 생성합니다.
이 위치는 genrule별 'Make' 변수( |
cmd
|
문자열, 기본값은 $(location)
및 'Make' 변수 대체가 적용됩니다.
cmd_bash, cmd_ps, cmd_bat 중 어느 것도 적용되지 않는 경우의 대체입니다.
명령줄 길이가 플랫폼 제한 (Linux/macOS에서 64K, Windows에서 8K)을 초과하면 genrule이 명령어를 스크립트에 작성하고 이 스크립트를 실행하여 문제를 해결합니다. 이는 모든 cmd 속성( |
cmd_bash
|
문자열, 기본값은 이 속성은 |
cmd_bat
|
문자열, 기본값은 이 속성의 우선순위가
|
cmd_ps
|
문자열, 기본값은 이 속성의 우선순위는
Powershell을 더 쉽게 사용하고 오류가 발생할 가능성을 줄이기 위해 genrule에서 Powershell 명령어를 실행하기 전에 다음 명령어를 실행하여 환경을 설정합니다.
|
executable
|
불리언. 구성 불가. 기본값은
이 플래그를 true로 설정하면 출력이 실행 파일이며 생성된 실행 파일의 데이터 종속 항목을 선언하는 것은 지원되지 않습니다. |
local
|
부울. 기본값은
이 옵션을 True로 설정하면 이
이는 'local'을 태그 ( |
message
|
문자열, 기본값은
이 빌드 단계가 실행될 때 출력되는 진행률 메시지입니다. 기본적으로 메시지는 '출력 생성 중' (또는 이와 비슷한 내용)이지만 더 구체적인 메시지를 제공할 수도 있습니다. |
output_licenses
|
라이선스 유형입니다. 기본값은 common attributes
참조
|
output_to_bindir
|
불리언. 구성 불가. 기본값은
이 옵션을 True로 설정하면 출력 파일이 |
tools
|
라벨 목록입니다. 기본값은
빌드 시스템은 genrule 명령어를 실행하기 전에 이러한 기본 요건이 빌드되도록 합니다. 이러한 도구는 빌드의 일부로 실행되므로 exec 구성을 사용하여 빌드됩니다. 개별
|
starlark_doc_extract
규칙 소스 보기starlark_doc_extract(name, deps, src, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, render_main_repo_name, restricted_to, symbol_names, tags, target_compatible_with, testonly, visibility)
starlark_doc_extract()는 지정된 .bzl 또는 .scl 파일에 정의되거나 다시 내보낸 규칙, 함수 (매크로 포함), 측면, 제공자에 관한 문서를 추출합니다. 이 규칙의 출력은 Bazel 소스 트리의 stardoc_output.proto에 정의된 ModuleInfo 바이너리 프로토입니다.
암시적 출력 타겟
name.binaryproto(기본 출력):ModuleInfo바이너리 프로토입니다.name.textproto(명시적으로 요청된 경우에만 빌드됨):name.binaryproto의 텍스트 프로토 버전입니다.
경고: 이 규칙의 출력 형식은 안정적이지 않을 수 있습니다. 주로 Stardoc에서 내부용으로 사용합니다.
인수
| 속성 | |
|---|---|
name |
이름. 필수 항목입니다. 이 타겟의 고유한 이름입니다. |
deps
|
라벨 목록입니다. 기본값은 src에 의해 load()이 적용되는 Starlark 파일을 래핑하는 타겟의 목록입니다. 이러한 타겟은 일반적인 사용 시 bzl_library 타겟이 어야 하지만 starlark_doc_extract 규칙은 이를 적용하지 않으며 DefaultInfo에 Starlark 파일을 제공하는 모든 타겟을 허용합니다.
래핑된 Starlark 파일은 소스 트리의 파일이어야 합니다. Bazel은 생성된 파일을 |
src
|
라벨: 필수사항 문서를 추출할 Starlark 파일입니다.이 파일은 소스 트리의 파일이어야 합니다. Bazel은 생성된 파일을 |
render_main_repo_name
|
불리언. 기본값은 //foo:bar.bzl가 @main_repo_name//foo:bar.bzl로 내보내집니다.
기본 저장소에 사용할 이름은 기본 저장소의 이 속성은 동일한 저장소 내에서만 사용할 Starlark 파일의 문서를 생성할 때는 |
symbol_names
|
문자열 목록입니다. 기본값은
|
test_suite
규칙 소스 보기test_suite(name, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, tests, visibility)
test_suite는 인간에게 '유용'하다고 간주되는 테스트 집합을 정의합니다. 이를 통해 프로젝트에서 '체크인 전에 실행해야 하는 테스트', '프로젝트의 스트레스 테스트', '모든 소규모 테스트'와 같은 테스트 세트를 정의할 수 있습니다. blaze test 명령어는 이러한 종류의 구성을 따릅니다. blaze test //some/test:suite와 같은 호출의 경우 Blaze는 먼저 //some/test:suite 타겟에 의해 전이적으로 포함된 모든 테스트 타겟을 열거합니다 (이를 'test_suite 확장'이라고 함). 그런 다음 Blaze는 이러한 타겟을 빌드하고 테스트합니다.
예
현재 패키지의 모든 소규모 테스트를 실행하는 테스트 모음입니다.
test_suite(
name = "small_tests",
tags = ["small"],
)
지정된 테스트 세트를 실행하는 테스트 모음:
test_suite(
name = "smoke_tests",
tests = [
"system_unittest",
"public_api_unittest",
],
)
현재 패키지에서 불안정하지 않은 모든 테스트를 실행하는 테스트 모음입니다.
test_suite(
name = "non_flaky_test",
tags = ["-flaky"],
)
인수
| 속성 | |
|---|---|
name |
이름: 필수사항 이 타겟의 고유한 이름입니다. |
tags
|
문자열 목록, 구성 불가능, 기본값은 '-' 문자로 시작하는 태그는 제외 태그로 간주됩니다. 앞의 '-' 문자는 태그의 일부로 간주되지 않으므로 '-small'의 모음 태그는 테스트의 'small' 크기와 일치합니다. 다른 모든 태그는 양수 태그로 간주됩니다. 원하는 경우 긍정적인 태그를 더 명시적으로 만들기 위해 태그를 '+' 문자로 시작할 수도 있습니다. 이 경우 태그 텍스트의 일부로 평가되지 않습니다. 긍정과 부정을 더 쉽게 구분할 수 있을 뿐입니다. 포지티브 태그 모두와 일치하는 테스트 규칙 및 네거티브 태그 중 아무것도 일치하지 않는 테스트 규칙만 테스트 모음에 포함됩니다. 그렇다고 필터링된 테스트의 종속 항목에 대한 오류 검사가 건너뛰어지는 것은 아닙니다. 건너뛴 테스트의 종속 항목은 여전히 유효해야 합니다(예: 공개 범위 제약 조건으로 차단되지 않음).
테스트의
상호 배타적인 태그가 있는 테스트(예: 모든 소규모 테스트 및 중규모 테스트)가 포함된 |
tests
|
라벨 목록입니다. 구성할 수 없음. 기본값은
언어와 상관없이 모든
|