매크로를 사용하여 커스텀 동사 만들기

Bazel과의 일상적인 상호작용은 주로 build, test, run과 같은 명령어를 통해 이루어집니다. 하지만 이러한 배포는 상황에 따라 제한적으로 적용될 수 있습니다. 즉, 저장소를 저장소로 푸시하거나, 최종 사용자를 위한 문서를 게시하거나, Kubernetes를 사용해서 애플리케이션을 배포하는 것이 좋습니다. 하지만 Bazel에는 publish 또는 deploy 명령어가 없습니다. 이러한 작업은 어디에 적용되나요?

bazel 실행 명령어

Bazel이 밀폐성, 재현성, 점진적 효과에 중점을 두기 때문에 build 및 test 명령어는 위의 작업에 유용하지 않습니다. 이러한 작업은 제한된 네트워크 액세스 권한으로 샌드박스에서 실행될 수 있으며 매번 bazel build로 실행되는 것은 아닙니다.

대신, bazel run를 사용하여 부수적 효과를 원하는 작업을 처리합니다. Bazel 사용자는 실행 파일을 만드는 규칙에 익숙하며, 규칙 작성자는 일반적인 패턴 집합을 따라 이를 '커스텀 동사'로 확장할 수 있습니다.

실제 규칙: rules_k8s

예를 들어 Bazel에 대한 Kubernetes 규칙인 rules_k8s가 있다고 가정하겠습니다. 다음과 같은 타겟이 있다고 가정해 보겠습니다.

# BUILD file in //application/k8s
k8s_object(
    name = "staging",
    kind = "deployment",
    cluster = "testing",
    template = "deployment.yaml",
)

k8s_object 규칙은 staging가 bazel build에 사용될 때 표준 Kubernetes YAML 파일을 빌드합니다. 하지만 추가 타겟은 staging.apply 및 :staging.delete와 같은 이름의 k8s_object 매크로에서도 생성됩니다. 이러한 빌드 스크립트는 이러한 작업을 수행하고, bazel run staging.apply로 실행 시 자체 bazel k8s-apply 또는 bazel k8s-delete 명령어처럼 동작합니다.

다른 예: ts_api_guardian_test

이 패턴은 Angular 프로젝트에서도 볼 수 있습니다. ts_api_guardian_test 매크로는 두 개의 타겟을 생성합니다. 첫 번째는 일부 생성된 출력을 '골든' 파일 (즉, 예상되는 출력이 포함된 파일)과 비교하는 표준 nodejs_test 대상입니다. 이는 일반 bazel test 호출로 빌드하고 실행할 수 있습니다. angular-cli에서 bazel test //etc/api:angular_devkit_core_api을 사용하여 이러한 타겟 하나를 실행할 수 있습니다.

시간이 지남에 따라 타당한 이유로 이 골든 파일을 업데이트해야 할 수도 있습니다. 이를 직접 업데이트하면 지루하고 오류가 발생하기 쉬우므로 이 매크로는 골든 파일을 비교하는 대신 골든 파일을 업데이트하는 nodejs_binary 타겟도 제공합니다. 사실상 동일한 테스트 스크립트를 작성하여 호출 방법에 따라 '확인' 또는 '수락' 모드로 실행할 수 있습니다. 이미 학습한 동일한 패턴을 따릅니다. 네이티브 bazel test-accept 명령어는 없지만 bazel run //etc/api:angular_devkit_core_api.accept을 사용하여 동일한 효과를 얻을 수 있습니다.

이 패턴은 상당히 강력할 수 있으며 알아보기 위해서는 흔하게 발견됩니다.

자체 규칙 조정

매크로는 이 패턴의 핵심입니다. 매크로는 규칙처럼 사용되지만 여러 개의 타겟을 생성할 수 있습니다. 일반적으로 기본 빌드 작업을 수행하는 지정된 이름으로 대상을 만듭니다. 일반 바이너리, Docker 이미지 또는 소스 코드 보관 파일을 빌드할 수 있습니다. 이 패턴에서는 결과 바이너리 게시 또는 예상 테스트 출력 업데이트와 같이 기본 대상의 출력을 기반으로 부작용을 수행하는 스크립트를 생성하기 위해 추가 대상이 생성됩니다.

이를 설명하기 위해 Sphinx가 포함된 웹사이트를 생성하는 가상의 규칙을 매크로로 포함하여 사용자가 필요할 때 게시할 수 있는 추가 대상을 생성합니다. Sphinx로 웹사이트를 생성하는 다음과 같은 기존 규칙을 고려해 보세요.

_sphinx_site = rule(
     implementation = _sphinx_impl,
     attrs = {"srcs": attr.label_list(allow_files = [".rst"])},
)

그런 다음 실행 시 생성된 페이지를 게시하는 스크립트를 빌드하는 다음과 같은 규칙을 살펴보겠습니다.

_sphinx_publisher = rule(
    implementation = _publish_impl,
    attrs = {
        "site": attr.label(),
        "_publisher": attr.label(
            default = "//internal/sphinx:publisher",
            executable = True,
        ),
    },
    executable = True,
)

마지막으로 다음 매크로를 정의하여 위의 두 규칙에 대한 타겟을 만듭니다.

def sphinx_site(name, srcs = [], **kwargs):
    # This creates the primary target, producing the Sphinx-generated HTML.
    _sphinx_site(name = name, srcs = srcs, **kwargs)
    # This creates the secondary target, which produces a script for publishing
    # the site generated above.
    _sphinx_publisher(name = "%s.publish" % name, site = name, **kwargs)

BUILD 파일에서 매크로는 기본 타겟을 생성하는 것처럼 사용합니다.

sphinx_site(
    name = "docs",
    srcs = ["index.md", "providers.md"],
)

이 예시에서는 매크로가 표준 단일 Bazel 규칙인 것처럼 'docs' 대상이 생성됩니다. 규칙이 빌드되면 일부 구성을 생성하고 Sphinx를 실행하여 HTML 사이트를 생성하며, 이때 수동 검사가 가능합니다. 하지만 사이트를 게시하기 위한 스크립트를 빌드하는 추가 'docs.publish' 대상도 생성됩니다. 기본 대상의 출력을 확인하면 가상의 bazel publish 명령어와 마찬가지로 bazel run :docs.publish를 사용하여 공개적으로 사용할 수 있습니다.

_sphinx_publisher 규칙 구현은 어떤 형태인지 즉시 알 수 없습니다. 이와 같은 작업은 런처 셸 스크립트를 작성하는 경우가 많습니다. 이 메서드에는 일반적으로 ctx.actions.expand_template를 사용하여 매우 간단한 셸 스크립트가 포함됩니다. 이 경우 기본 대상의 출력 경로가 있는 게시자 바이너리를 호출합니다. 에서 확인할 수 있습니다. 이렇게 하면 게시자 구현이 일반적인 상태로 유지되고, _sphinx_site 규칙에서 HTML을 생성할 수 있으며, 이 작은 스크립트만으로는 두 가지를 결합하여 사용할 수 있습니다.

포함rules_k8s , 이는 실제로.apply 다음과 같이 처리합니다.expand_template 다음을 기반으로 매우 간단한 Bash 스크립트를 작성합니다. apply.sh.tpl 이는kubectl 를 기본 대상의 출력으로 바꿉니다. 그러면 이 스크립트를 bazel run :staging.apply로 빌드하고 실행할 수 있으므로 k8s_object 대상에 k8s-apply 명령어를 효과적으로 제공할 수 있습니다.