일반 규칙

규칙

• 별칭
• config_setting
• filegroup
• genquery
• genrule
• test_suite

alias

alias(name, actual, compatible_with, deprecation, features, restricted_to, tags, target_compatible_with, testonly, visibility)

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

별칭은 '일반' 타겟에만 작동합니다. 특히 package_group 및 test_suite는 별칭을 지정할 수 없습니다.

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

• 명령줄에 별칭이 언급된 경우 테스트가 실행되지 않습니다. 참조된 테스트를 실행하는 별칭을 정의하려면 tests 속성에 단일 타겟이 있는 test_suite 규칙을 사용하세요.
• 환경 그룹을 정의할 때 environment 규칙의 별칭은 지원되지 않습니다. --target_environment 명령줄 옵션에서도 지원되지 않습니다.

예

filegroup(
    name = "data",
    srcs = ["data.txt"],
)

alias(
    name = "other",
    actual = ":data",
)

인수

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_25 라벨이 있는 constraint_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가 현재 구성 상태와 일치하는 경우 어떻게 되는지 알아보려면 select를 참고하세요.
• 약어 형식을 지원하는 플래그 (예: --compilation_mode 대 -c)의 경우 values 정의는 전체 형식을 사용해야 합니다. 이는 두 형식 중 하나를 사용하여 호출을 자동으로 일치시킵니다.
• 플래그가 여러 값을 사용하는 경우 (예: --copt=-Da --copt=-Db 또는 목록 유형의 Starlark 플래그) values = { "flag": "a" }는 "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,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에 하나 이상 설정해야 합니다.

인수

            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",
                })
          

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",
    ],
)

인수

genquery

genquery(name, deps, data, compatible_with, 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의 출력은 --order_output=full를 사용하여 정렬됩니다.

출력 파일의 이름은 규칙의 이름입니다.

예

이 예에서는 지정된 타겟의 전이 폐쇄에 있는 라벨 목록을 파일에 씁니다.

genquery(
    name = "kiwi-deps",
    expression = "deps(//kiwi:kiwi_lib)",
    scope = ["//kiwi:kiwi_lib"],
)

인수

genrule

genrule(name, srcs, outs, cmd, cmd_bash, cmd_bat, cmd_ps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exec_tools, 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을 사용하지 마세요. 캐싱 정책 및 환경 변수를 비롯하여 테스트 및 테스트 결과에 대한 특별 예외가 있습니다. 테스트는 일반적으로 빌드가 완료된 후 타겟 아키텍처에서 실행해야 하지만 genrules는 빌드 중에 호스트 아키텍처에서 실행됩니다 (두 가지가 다를 수 있음). 범용 테스트 규칙이 필요한 경우 sh_test를 사용하세요.

크로스 컴파일 고려사항

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

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

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

genrules의 경우 빌드 시스템은 종속 항목이 적절하게 빌드되도록 합니다. srcs는 필요한 경우 타겟 구성용으로 빌드되고, tools는 호스트 구성용으로 빌드되며, 출력은 타겟 구성용으로 간주됩니다. 또한 genrule 명령어에서 상응하는 도구에 전달할 수 있는 'Make' 변수를 제공합니다.

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

특별 케이스

호스트-호스트 컴파일: 경우에 따라 빌드 시스템은 빌드 중에 출력을 실행할 수도 있도록 genrules를 실행해야 합니다. 예를 들어 genrule이 나중에 다른 genrule에서 사용되는 일부 맞춤 컴파일러를 빌드하는 경우, 첫 번째 genrule은 호스트 구성의 출력을 생성해야 합니다. 다른 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 as ls $(dirname $x), one must escape it thus: ls $$(dirname $$x).
• 심볼릭 링크와 디렉터리를 만들지 마세요. Bazel은 genrules로 생성된 디렉터리/심볼릭 링크 구조를 복사하지 않으며 디렉터리의 종속 항목 검사가 잘못되었습니다.
• 다른 규칙에서 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) > $@",
)

인수

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"],
)

인수