일반 규칙

문제 신고 소스 보기 Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

규칙

alias

규칙 소스 보기
alias(name, actual, compatible_with, deprecation, features, restricted_to, tags, target_compatible_with, testonly, visibility)

alias 규칙은 규칙을 참조할 수 있는 다른 이름을 만듭니다.

별칭은 '일반' 타겟에만 적용됩니다. 특히 package_grouptest_suite은 별칭이 지정될 수 없습니다.

별칭은 타겟의 이름을 변경하려면 많은 파일을 변경해야 하는 대규모 저장소에서 유용할 수 있습니다. 여러 타겟에 대해 해당 로직을 재사용하려면 별칭 규칙을 사용하여 select 함수 호출을 저장할 수도 있습니다.

별칭 규칙에는 자체 공개 상태 선언이 있습니다. 다른 모든 면에서 참조하는 규칙과 유사하게 동작합니다 (예: 별칭의 testonly는 무시됨, 참조된 규칙의 testonly가 대신 사용됨). 몇 가지 사소한 예외는 다음과 같습니다.

  • 명령줄에 별칭이 언급되면 테스트가 실행되지 않습니다. 참조된 테스트를 실행하는 별칭을 정의하려면 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" },
  )
  

다음은 라벨이 //example:glibc_2_25constraint_value가 있다고 가정할 때 x86_64 아키텍처와 glibc 버전 2.25가 있는 플랫폼을 타겟팅하는 빌드와 일치합니다. 이 두 가지 외에 추가 제약 조건 값을 정의하는 플랫폼은 여전히 일치합니다.

  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 플래그) "a"이 실제 목록에 어디든 있으면 values = { "flag": "a" }가 일치합니다.

    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,bios_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 집합입니다. (여기서는 실행 플랫폼이 고려되지 않습니다.) 플랫폼에 있는 추가 제약 조건 값은 무시됩니다. 자세한 내용은 구성 가능한 빌드 속성을 참고하세요.

config_setting가 모두 동일한 select에서 일치하는 경우 이 속성은 config_setting 중 하나가 다른 config_setting의 전문화인지 여부를 결정하는 데 고려되지 않습니다. 즉, 한 config_setting가 다른 config_setting보다 특정 플랫폼에 더 적합할 수 없습니다.

define_values

사전: 문자열 -> 문자열; 구성할 수 없음; 기본값은 {}입니다.

values와 동일하지만 --define 플래그에만 적용됩니다.

--define는 구문 (--define KEY=VAL)이 Bazel 플래그 관점에서 KEY=VAL임을 의미하므로 특별합니다.

이는 다음을 의미합니다.

            config_setting(
                name = "a_and_b",
                values = {
                    "define": "a=1",
                    "define": "b=2",
                })
          

동일한 키 (define)가 사전에 두 번 표시되므로 작동하지 않습니다. 이 속성은 이 문제를 해결합니다.

            config_setting(
                name = "a_and_b",
                define_values = {
                    "a": "1",
                    "b": "2",
                })
          

bazel build //foo --define a=1 --define b=2과 올바르게 일치합니다.

--define는 일반 플래그 구문과 함께 values에 계속 표시될 수 있으며, 사전 키가 고유하게 유지되는 한 이 속성과 자유롭게 혼합될 수 있습니다.

flag_values

사전: label -> 문자열; 구성할 수 없음; 기본값은 {}

values와 동일하지만 사용자 정의 빌드 플래그에 적용됩니다.

사용자 정의 플래그는 라벨로 참조되는 반면 내장 플래그는 임의의 문자열로 참조되므로 이는 별개의 속성입니다.

values

사전: 문자열 -> 문자열; 구성할 수 없음; 기본값은 {}입니다.

이 규칙과 일치하는 구성 값의 집합 (빌드 플래그로 표현됨)

이 규칙은 select 문에서 이를 참조하는 구성된 타겟의 구성을 상속합니다. 사전의 모든 항목에 대해 구성이 항목의 예상 값과 일치하면 Bazel 호출이 '일치'하는 것으로 간주됩니다. 예를 들어 values = {"compilation_mode": "opt"}은 타겟 구성 규칙에서 bazel build --compilation_mode=opt ...bazel build -c opt ... 호출과 일치합니다.

편의를 위해 구성 값은 빌드 플래그 (앞에 "--"가 없음)로 지정됩니다. 하지만 두 가지가 동일하지는 않습니다. 이는 타겟이 동일한 빌드 내에서 여러 구성으로 빌드될 수 있기 때문입니다. 예를 들어 실행 구성의 'cpu'는 --cpu이 아닌 --host_cpu 값과 일치합니다. 따라서 동일한 config_setting의 여러 인스턴스는 이를 사용하는 규칙의 구성에 따라 동일한 호출과 다르게 일치할 수 있습니다.

명령줄에서 플래그를 명시적으로 설정하지 않으면 기본값이 사용됩니다. 키가 사전에 여러 번 표시되면 마지막 인스턴스만 사용됩니다. 키가 명령줄에서 여러 번 설정할 수 있는 플래그 (예: bazel build --copt=foo --copt=bar --copt=baz ...)를 참조하는 경우 이러한 설정 중 하나라도 일치하면 일치하는 것으로 간주됩니다.

filegroup

규칙 소스 보기
filegroup(name, srcs, data, compatible_with, deprecation, distribs, features, licenses, output_group, restricted_to, tags, target_compatible_with, testonly, visibility)

filegroup를 사용하여 타겟 모음에 편리한 이름을 지정합니다. 그런 다음 다른 규칙에서 이를 참조할 수 있습니다.

디렉터리를 직접 참조하는 대신 filegroup를 사용하는 것이 좋습니다. 후자는 빌드 시스템이 디렉터리 아래의 모든 파일을 완전히 알지 못하므로 이러한 파일이 변경될 때 다시 빌드되지 않을 수 있어 적절하지 않습니다. glob과 결합하면 filegroup를 통해 모든 파일을 빌드 시스템에서 명시적으로 알 수 있습니다.

두 소스 파일로 구성된 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

라벨 목록입니다. 기본값은 []입니다.

파일 그룹의 구성원인 타겟 목록입니다.

srcs 속성 값에 glob 표현식의 결과를 사용하는 것이 일반적입니다.

data

라벨 목록입니다. 기본값은 []입니다.

런타임에 이 규칙에 필요한 파일 목록입니다.

data 속성에 이름이 지정된 타겟이 이 filegroup 규칙의 runfiles에 추가됩니다. filegroup이 다른 규칙의 data 속성에서 참조되면 runfiles이 종속 규칙의 runfiles에 추가됩니다. 데이터 파일에 종속되고 이를 사용하는 방법에 관한 자세한 내용은 데이터 종속 항목 섹션과 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

불리언, 기본값은 False

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

불리언, 기본값은 True

true인 경우 쿼리가 범위의 전이적 폐쇄를 벗어나는 타겟은 빌드에 실패합니다. false인 경우 Bazel은 경고를 출력하고 범위를 벗어난 쿼리 경로를 건너뛰면서 나머지 쿼리를 완료합니다.

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 명령어를 사용하여 하나 이상의 파일을 생성합니다.

Genrule은 작업에 관한 특정 규칙이 없는 경우 사용할 수 있는 일반 빌드 규칙입니다. 예를 들어 Bash 원라이너를 실행할 수 있습니다. 하지만 C++ 파일을 컴파일해야 하는 경우에는 기존 cc_* 규칙을 고수하세요. 모든 작업이 이미 완료되었기 때문입니다.

genrule은 명령 인수를 해석하기 위해 셸이 필요합니다. PATH에서 사용할 수 있는 임의의 프로그램을 참조하는 것도 쉽지만 이렇게 하면 명령어가 비밀폐형이 되어 재현할 수 없을 수 있습니다. 단일 도구만 실행해야 하는 경우 run_binary를 대신 사용하는 것이 좋습니다.

테스트 실행에 genrule을 사용하지 마세요. 캐싱 정책 및 환경 변수를 비롯한 테스트 및 테스트 결과에 관한 특별 면제가 있습니다. 일반적으로 테스트는 빌드가 완료된 후 타겟 아키텍처에서 실행해야 하지만 genrule은 빌드 중에 실행 아키텍처에서 실행됩니다 (두 아키텍처가 다를 수 있음). 범용 테스트 규칙이 필요한 경우 sh_test를 사용하세요.

크로스 컴파일 고려사항

교차 컴파일에 관한 자세한 내용은 사용자 설명서를 참고하세요.

genrule은 빌드 중에 실행되지만 출력은 빌드 후 배포 또는 테스트에 사용되는 경우가 많습니다. 마이크로컨트롤러용 C 코드를 컴파일하는 예를 생각해 보세요. 컴파일러는 C 소스 파일을 허용하고 마이크로컨트롤러에서 실행되는 코드를 생성합니다. 생성된 코드는 빌드에 사용된 CPU에서 실행할 수 없지만 C 컴파일러 (소스에서 컴파일된 경우) 자체는 실행할 수 있어야 합니다.

빌드 시스템은 실행 구성을 사용하여 빌드가 실행되는 머신을 설명하고 타겟 구성을 사용하여 빌드 출력이 실행되어야 하는 머신을 설명합니다. 각각을 구성하는 옵션을 제공하고 충돌을 방지하기 위해 해당 파일을 별도의 디렉터리로 분리합니다.

genrule의 경우 빌드 시스템은 종속 항목이 적절하게 빌드되도록 합니다. srcstarget 구성을 위해 빌드되고 (필요한 경우) toolsexec 구성을 위해 빌드되며 출력은 target 구성용으로 간주됩니다. 또한 genrule 명령어가 해당 도구에 전달할 수 있는 'Make' 변수도 제공합니다.

genrule이 deps 속성을 정의하지 않는 것은 의도적인 것입니다. 다른 내장 규칙은 규칙 간에 전달되는 언어 종속 메타 정보를 사용하여 종속 규칙을 처리하는 방법을 자동으로 결정하지만 genrule에서는 이러한 수준의 자동화가 불가능합니다. Genrule은 파일 및 runfile 수준에서만 작동합니다.

특수한 케이스

실행-실행 컴파일: 경우에 따라 빌드 시스템은 빌드 중에 출력도 실행할 수 있도록 genrules를 실행해야 합니다. 예를 들어 genrule이 일부 맞춤 컴파일러를 빌드하고 이 컴파일러가 이후 다른 genrule에 의해 사용되는 경우 첫 번째 genrule은 실행 구성에 대한 출력을 생성해야 합니다. 다른 genrule에서 컴파일러가 실행되기 때문입니다. 이 경우 빌드 시스템은 올바른 작업을 자동으로 실행합니다. 타겟 구성 대신 실행 구성을 위한 첫 번째 genrule의 srcsouts를 빌드합니다. 자세한 내용은 사용자 매뉴얼을 참고하세요.

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로 실행되는 도구가 결정적이고 hermetic한지 확인하세요. 타임스탬프를 출력에 작성해서는 안 되며, 집합과 맵에 안정적인 순서를 사용하고 상대 파일 경로만 출력에 작성해야 합니다(절대 경로 아님). 이 규칙을 따르지 않으면 예기치 않은 빌드 동작 (Bazel이 빌드할 것으로 생각한 genrule을 빌드하지 않음)이 발생하고 캐시 성능이 저하됩니다.
  • 출력, 도구, 소스에 $(location)를 광범위하게 사용하세요. 다른 구성을 위한 출력 파일이 분리되어 있으므로 genrule은 하드 코딩된 경로 또는 절대 경로를 사용할 수 없습니다.
  • 동일하거나 매우 유사한 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 as ls $(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

라벨 목록입니다. 기본값은 []입니다.

처리할 소스 파일과 같은 이 규칙의 입력 목록입니다.

이 속성은 cmd에 의해 실행되는 도구를 나열하는 데 적합하지 않습니다. 대신 tools 속성을 사용하세요.

빌드 시스템은 genrule 명령어를 실행하기 전에 이러한 필수 구성요소가 빌드되도록 합니다. 필수 구성요소는 원래 빌드 요청과 동일한 구성을 사용하여 빌드됩니다. 이러한 필수 구성요소의 파일 이름은 $(SRCS)에서 공백으로 구분된 목록으로 명령어에 제공됩니다. 또는 $(location //x:y)을 사용하여 개별 srcs 타겟 //x:y의 경로를 가져오거나 srcs의 유일한 항목인 경우 $<을 사용하여 가져올 수 있습니다.

outs

파일 이름 목록; 구성할 수 없음; 필수

이 규칙에 의해 생성된 파일 목록입니다.

출력 파일이 패키지 경계를 넘어서는 안 됩니다. 출력 파일 이름은 패키지를 기준으로 해석됩니다.

executable 플래그가 설정된 경우 outs에는 라벨이 정확히 하나 포함되어야 합니다.

genrule 명령어는 미리 정해진 위치에 각 출력 파일을 생성해야 합니다. 위치는 genrule 전용 'Make' 변수 ($@, $(OUTS), $(@D) 또는 $(RULEDIR))를 사용하거나 $(location) 대체를 사용하여 cmd에서 사용할 수 있습니다.

cmd

문자열, 기본값은 ""입니다.

실행할 명령어입니다. $(location) 'Make' 변수 대체가 적용됩니다.
  1. 먼저 $(location) 대체가 적용되어 $(location label)$(locations label)의 모든 항목 (및 관련 변수 execpath, execpaths, rootpath, rootpaths을 사용하는 유사한 구조)이 대체됩니다.
  2. 다음으로 'Make' 변수가 확장됩니다. 미리 정의된 변수 $(JAVA), $(JAVAC), $(JAVABASE)exec 구성에서 확장되므로 빌드 단계의 일부로 실행되는 Java 호출이 공유 라이브러리 및 기타 종속 항목을 올바르게 로드할 수 있습니다.
  3. 마지막으로 결과 명령어가 Bash 셸을 사용하여 실행됩니다. 종료 코드가 0이 아니면 명령어가 실패한 것으로 간주됩니다.
cmd_bash, cmd_ps, cmd_bat 중 해당하는 항목이 없는 경우의 대체 값입니다.

명령줄 길이가 플랫폼 한도 (Linux/macOS에서는 64K, Windows에서는 8K)를 초과하면 genrule이 명령어를 스크립트에 쓰고 해당 스크립트를 실행하여 해결합니다. 이는 모든 cmd 속성 (cmd, cmd_bash, cmd_ps, cmd_bat)에 적용됩니다.

cmd_bash

문자열, 기본값은 ""입니다.

실행할 Bash 명령어입니다.

이 속성은 cmd보다 우선순위가 높습니다. 명령어가 확장되고 cmd 속성과 정확히 동일한 방식으로 실행됩니다.

cmd_bat

문자열, 기본값은 ""입니다.

Windows에서 실행할 배치 명령어입니다.

이 속성은 cmdcmd_bash보다 우선순위가 높습니다. 이 명령어는 cmd 속성과 유사한 방식으로 실행되지만 다음과 같은 차이점이 있습니다.

  • 이 속성은 Windows에만 적용됩니다.
  • 이 명령어는 다음 기본 인수를 사용하여 cmd.exe /c으로 실행됩니다.
    • /S - 첫 번째와 마지막 따옴표를 삭제하고 나머지는 그대로 실행합니다.
    • /E:ON - 확장 명령어 집합을 사용 설정합니다.
    • /V:ON - 지연된 변수 확장 사용 설정
    • /D - 자동 실행 레지스트리 항목을 무시합니다.
  • $(location)'Make' 변수 대체 후 경로는 백슬래시가 있는 Windows 스타일 경로로 확장됩니다.
cmd_ps

문자열, 기본값은 ""입니다.

Windows에서 실행할 Powershell 명령어입니다.

이 속성은 cmd, cmd_bash, cmd_bat보다 우선순위가 높습니다. 이 명령어는 cmd 속성과 유사한 방식으로 실행되지만 다음과 같은 차이점이 있습니다.

  • 이 속성은 Windows에만 적용됩니다.
  • 이 명령어는 powershell.exe /c로 실행됩니다.

Powershell을 더 쉽게 사용하고 오류가 발생할 가능성을 줄이기 위해 genrule에서 Powershell 명령어를 실행하기 전에 다음 명령어를 실행하여 환경을 설정합니다.

  • Set-ExecutionPolicy -Scope CurrentUser RemoteSigned - 서명되지 않은 스크립트 실행을 허용합니다.
  • $errorActionPreference='Stop' - ;로 구분된 명령어가 여러 개 있는 경우 Powershell CmdLet이 실패하면 작업이 즉시 종료되지만 외부 명령어에는 적용되지 않습니다.
  • $PSDefaultParameterValues['*:Encoding'] = 'utf8' - 기본 인코딩을 utf-16에서 utf-8로 변경
executable

불리언, 구성 불가능, 기본값은 False

출력이 실행 가능하도록 선언합니다.

이 플래그를 True로 설정하면 출력이 실행 파일이 되며 run 명령어를 사용하여 실행할 수 있습니다. 이 경우 genrule은 정확히 하나의 출력을 생성해야 합니다. 이 속성이 설정되면 run은 콘텐츠와 관계없이 파일을 실행하려고 시도합니다.

생성된 실행 파일의 데이터 종속 항목 선언은 지원되지 않습니다.

local

불리언, 기본값은 False

True로 설정하면 이 옵션은 이 genrule가 '로컬' 전략을 사용하여 실행되도록 강제합니다. 즉, 원격 실행, 샌드박스, 영구 작업자가 없습니다.

이는 'local'을 태그 (tags=["local"])로 제공하는 것과 같습니다.

message

문자열, 기본값은 ""입니다.

진행률 메시지입니다.

이 빌드 단계가 실행될 때 출력되는 진행 상황 메시지입니다. 기본적으로 메시지는 '출력 생성 중' (또는 이와 비슷한 내용)이지만 더 구체적인 메시지를 제공할 수 있습니다. 빌드 도구에서 이러한 진행 상황 메시지의 인쇄 여부를 제어할 수 있으므로 cmd 명령어에서 echo 또는 기타 인쇄 문 대신 이 속성을 사용하세요.

output_licenses

라이선스 유형입니다. 기본값은 ["none"]입니다.

common attributes 참조
output_to_bindir

불리언, 구성 불가능, 기본값은 False

True로 설정하면 이 옵션으로 인해 출력 파일이 genfiles 디렉터리 대신 bin 디렉터리에 작성됩니다.

tools

라벨 목록입니다. 기본값은 []입니다.

이 규칙의 도구 종속 항목 목록입니다. 자세한 내용은 종속 항목 정의를 참고하세요.

빌드 시스템은 genrule 명령어를 실행하기 전에 이러한 필수 구성요소가 빌드되도록 합니다. 이러한 도구는 빌드의 일부로 실행되므로 exec 구성을 사용하여 빌드됩니다. 개별 tools 타겟 //x:y의 경로는 $(location //x:y)를 사용하여 가져올 수 있습니다.

cmd에 의해 실행되는 *_binary 또는 도구는 올바른 구성으로 빌드되도록 srcs가 아닌 이 목록에 표시되어야 합니다.

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은 load() 생성 파일을 래핑할 수 없습니다.

src

라벨: 필수

문서를 추출할 Starlark 파일입니다.

이는 소스 트리의 파일이어야 합니다. Bazel은 load() 생성된 파일을 사용할 수 없습니다.

render_main_repo_name

불리언, 기본값은 False

true인 경우 저장소 구성요소와 함께 내보낸 문서에서 기본 저장소의 라벨을 렌더링합니다(즉, //foo:bar.bzl@main_repo_name//foo:bar.bzl로 내보내짐).

기본 저장소에 사용할 이름은 기본 저장소의 MODULE.bazel 파일 (Bzlmod가 사용 설정된 경우)에 있는 module(name = ...) 또는 기본 저장소의 WORKSPACE 파일에 있는 workspace(name = ...)에서 가져옵니다.

이 속성은 동일한 저장소 내에서만 사용하도록 설계된 Starlark 파일의 문서를 생성할 때는 False로, 다른 저장소에서 사용하도록 설계된 Starlark 파일의 문서를 생성할 때는 True로 설정해야 합니다.

symbol_names

문자열 목록입니다. 기본값은 []입니다.

문서를 추출할 내보낸 함수, 규칙, 제공자 또는 측면(또는 중첩된 구조체)의 정규화된 이름 목록입니다(선택사항). 여기서 정규화된 이름은 네임스페이스를 위해 항목이 중첩된 구조체를 포함하여 모듈의 사용자에게 항목이 제공되는 이름을 의미합니다.

starlark_doc_extract는 다음 조건이 충족되는 경우에만 항목의 문서를 내보냅니다.

  1. 엔티티의 정규화된 이름의 각 구성요소가 공개되어야 합니다 (즉, 정규화된 이름의 각 구성요소의 첫 번째 문자가 "_"이 아닌 알파벳임). 그리고
    1. symbol_names 목록이 비어 있거나 (기본 사례)
    2. 항목의 정규화된 이름 또는 항목이 중첩된 구조체의 정규화된 이름이 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 확장'이라고 함) 이러한 타겟을 빌드하고 테스트합니다.

현재 패키지의 모든 소규모 테스트를 실행하는 테스트 모음입니다.

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', 'database', '-flaky'와 같은 텍스트 태그 목록입니다. 태그는 유효한 문자열일 수 있습니다.

'-' 문자로 시작하는 태그는 부정적인 태그로 간주됩니다. 앞에 오는 '-' 문자는 태그의 일부로 간주되지 않으므로 '-small' 스위트 태그는 테스트의 'small' 크기와 일치합니다. 다른 모든 태그는 양성 태그로 간주됩니다.

선택적으로 긍정적인 태그를 더 명시적으로 만들기 위해 태그가 '+' 문자로 시작할 수도 있습니다. 이 문자는 태그의 텍스트로 평가되지 않습니다. 긍정적 및 부정적 구분을 더 쉽게 읽을 수 있도록 해 줍니다.

양성 태그가 모두 일치하고 음성 태그가 하나도 일치하지 않는 테스트 규칙만 테스트 모음에 포함됩니다. 이는 필터링된 테스트의 종속 항목에 대한 오류 검사가 건너뛰어진다는 의미는 아닙니다. 건너뛴 테스트의 종속 항목은 여전히 적법해야 합니다 (예: 공개 상태 제약 조건에 의해 차단되지 않음).

manual 태그 키워드는 와일드 카드 타겟 패턴이 포함된 호출에서 blaze test 명령어로 실행되는 '테스트 모음 확장'에 의해 위와 다르게 처리됩니다. 여기에서 'manual'로 태그된 test_suite 타겟은 필터링되어 확장되지 않습니다. 이 동작은 blaze buildblaze test가 일반적으로 와일드 카드 타겟 패턴을 처리하는 방식과 일치합니다. 이는 blaze query 'tests(E)'의 동작과 명시적으로 다릅니다. 스위트는 manual 태그와 관계없이 항상 tests 쿼리 함수에 의해 확장되기 때문입니다.

테스트의 size는 필터링 목적으로 태그로 간주됩니다.

상호 배타적인 태그가 있는 테스트(예: 모든 소형 및 중형 테스트)가 포함된 test_suite가 필요한 경우 test_suite 규칙을 3개 만들어야 합니다. 하나는 모든 소형 테스트용이고, 하나는 모든 중형 테스트용이며, 하나는 이전 두 개를 포함합니다.

tests

라벨 목록입니다. 구성할 수 없습니다. 기본값은 []입니다.

모든 언어의 테스트 모음 및 테스트 타겟 목록입니다.

여기에서는 언어와 관계없이 모든 *_test가 허용됩니다. 테스트를 실행하는 경우에도 *_binary 타겟은 허용되지 않습니다. 지정된 tags에 의한 필터링은 이 속성에 직접 나열된 테스트에만 적용됩니다. 이 속성에 test_suite가 포함된 경우 해당 속성 내의 테스트는 이 test_suite에 의해 필터링되지 않습니다 (이미 필터링된 것으로 간주됨).

tests 속성이 지정되지 않았거나 비어 있으면 규칙은 기본적으로 manual로 태그되지 않은 현재 BUILD 파일의 모든 테스트 규칙을 포함합니다. 이러한 규칙은 여전히 tag 필터링의 적용을 받습니다.