Bzlmod로 외부 종속 항목 관리

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
문제 신고 출처 보기

Bzlmod는 Bazel 5.0에 도입된 새 외부 종속 항목 시스템의 코드명입니다. 이 방법은 이전 시스템에서 점진적으로 해결할 수 없는 고충을 해결하기 위해 도입되었습니다. 자세한 내용은 원래 디자인 문서의 문제 서술 섹션을 참고하세요.

Bazel 5.0에서는 Bzlmod가 기본적으로 사용 설정되지 않습니다. --experimental_enable_bzlmod 플래그를 지정해야 다음 사항이 적용됩니다. 플래그 이름에서 알 수 있듯이 이 기능은 현재 실험용입니다. 이 기능이 공식적으로 출시될 때까지 API 및 동작이 변경될 수 있습니다.

프로젝트를 Bzlmod로 이전하려면 Bzlmod 이전 가이드를 따르세요. examples 저장소에서도 Bzlmod 사용 예시를 확인할 수 있습니다.

Bazel 모듈

기존의 WORKSPACE 기반 외부 종속 항목 시스템은 저장소 규칙(또는 저장소 규칙)을 통해 생성된 저장소(또는 저장소)를 중심으로 합니다. 저장소는 여전히 새 시스템에서 중요한 개념이지만 모듈은 종속 항목의 핵심 단위입니다.

모듈은 기본적으로 여러 버전이 있을 수 있는 Bazel 프로젝트이며 각 버전은 종속되는 다른 모듈에 대한 메타데이터를 게시합니다. 이는 다른 종속 항목 관리 시스템(Maven 아티팩트, npm 패키지, Cargo 크레이트, Go 모듈 등)의 익숙한 개념과 유사합니다.

모듈은 WORKSPACE의 특정 URL 대신 nameversion 쌍을 사용하여 종속 항목을 지정합니다. 그런 다음 종속 항목은 Bazel 레지스트리(기본적으로 Bazel Central Registry)에서 조회됩니다. 그러면 작업공간에서 각 모듈이 저장소로 변환됩니다.

모듈

모든 모듈의 모든 버전에는 종속 항목 및 기타 메타데이터를 선언하는 MODULE.bazel 파일이 있습니다. 기본적인 예는 다음과 같습니다.

module(
    name = "my-module",
    version = "1.0",
)

bazel_dep(name = "rules_cc", version = "0.0.1")
bazel_dep(name = "protobuf", version = "3.19.0")

MODULE.bazel 파일은 작업공간 디렉터리의 루트(WORKSPACE 파일 옆)에 있어야 합니다. WORKSPACE 파일과 달리 전이 종속 항목을 지정하지 않아도 됩니다. 대신 직접 종속 항목만 지정하면 됩니다. 종속 항목의 MODULE.bazel 파일은 전이 종속 항목을 자동으로 탐색하도록 처리됩니다.

MODULE.bazel 파일은 어떠한 제어 흐름도 지원하지 않으므로 BUILD 파일과 유사합니다. load 문을 추가로 금지합니다. MODULE.bazel 파일이 지원하는 지시어는 다음과 같습니다.

버전 형식

Bazel은 다양한 생태계를 보유하고 있으며 프로젝트마다 다양한 버전 체계를 사용합니다. 가장 널리 사용되는 버전은 SemVer이지만, Abseil과 같은 다양한 스킴을 사용하는 주요 프로젝트도 있습니다(버전은 날짜 기반임). 예: 20210324.2

따라서 Bzlmod는 SemVer 사양의 더 편안한 버전을 사용합니다. 차이점은 다음과 같습니다.

  • SemVer는 버전의 '해제' 부분이 3개의 세그먼트(MAJOR.MINOR.PATCH)로 구성되어야 한다고 규정합니다. Bazel에서는 이 요구사항이 느슨해져서 개수에 관계없이 세그먼트가 허용됩니다.
  • SemVer에서 '해제' 부분의 각 세그먼트는 숫자여야 합니다. Bazel에서는 문자를 허용하기도 하며 '출시 전' 부분의 '식별자'와 비교 시맨틱스가 일치합니다.
  • 또한 주 버전, 부 버전, 패치 버전 증가 시맨틱스는 적용되지 않습니다. 그러나 이전 버전과의 호환성을 표시하는 방법에 관한 자세한 내용은 호환성 수준을 참고하세요.

유효한 SemVer 버전은 유효한 Bazel 모듈 버전입니다. 또한 SemVer 버전 ab는 Bazel 모듈 버전과 비교할 때 동일한 보존 조치가 적용되는 경우 a < b를 비교합니다.

버전 해상도

다이아몬드 종속 항목 문제는 버전이 지정된 종속 항목 관리 공간에서 중요한 부분입니다. 다음과 같은 종속 항목 그래프가 있다고 가정해 보겠습니다.

       A 1.0
      /     \
   B 1.0    C 1.1
     |        |
   D 1.0    D 1.1

어떤 D 버전을 사용해야 하나요? 이 문제를 해결하기 위해 Bzlmod는 Go 모듈 시스템에 도입된 최소 버전 선택(MVS) 알고리즘을 사용합니다. MVS는 모듈의 모든 새 버전이 이전 버전과 호환된다고 가정하므로 종속 항목에서 지정한 가장 높은 버전 (이 예에서는 D 1.1)을 선택합니다. '미니멀'이라고 하는 이유는 D 1.1이 요구사항을 충족할 수 있는 최소 버전이므로 D 1.2 이상이 있더라도 Google에서 선택하지 않기 때문입니다. 이렇게 하면 버전 선택이 고충실도재현 가능하다는 추가적인 이점이 있습니다.

버전 확인은 레지스트리가 아닌 컴퓨터에서 로컬로 수행됩니다.

호환성 수준

MVS는 이전 버전과 호환되지 않는 모듈을 별도의 모듈로 취급하기 때문에 이전 버전과의 호환성에 대한 가정이 가능합니다. SemVer 측면에서는 A 1.x와 A 2.x가 별개의 모듈로 간주되며 결정된 종속 항목 그래프에서 공존할 수 있다는 의미입니다. 이는 주 버전이 Go의 패키지 경로에 인코딩되어 있기 때문에 가능합니다. 따라서 컴파일 시간이나 링크 시간 충돌이 없습니다.

Bazel에서는 이러한 보장이 없습니다. 따라서 이전 버전과 호환되지 않는 버전을 감지하려면 '주요 버전' 번호를 나타낼 방법이 필요합니다. 이 번호를 호환성 수준이라고 하며, module() 지시어의 각 모듈 버전에 의해 지정됩니다. 그러나 이 정보를 사용하여 결정된 종속 항목 그래프에 호환성 수준이 다른 동일한 모듈의 버전이 감지되면 오류가 발생할 수 있습니다.

저장소 이름

Bazel에서는 모든 외부 종속 항목에 저장소 이름이 있습니다. 서로 다른 저장소 이름을 통해 동일한 종속 항목이 사용되거나 (예: @io_bazel_skylib@bazel_skylib이 모두 Bazel skylib를 의미함) 다른 프로젝트의 여러 종속 항목에 동일한 저장소 이름이 사용되는 경우가 있습니다.

Bzlmod에서는 Bazel 모듈 및 모듈 확장 프로그램을 통해 저장소를 생성할 수 있습니다. 저장소 이름 충돌을 해결하기 위해 새 시스템에 저장소 매핑 메커니즘이 도입됩니다. 다음은 두 가지 중요한 개념입니다.

  • 표준 저장소 이름: 각 저장소의 전역적으로 고유한 저장소 이름입니다. 저장소가 있는 디렉터리 이름입니다.
    다음과 같이 구성됩니다(경고: 표준 이름 형식은 반드시 사용해야 하는 API가 아니며 언제든지 변경될 수 있습니다).

    • Bazel 모듈 저장소: module_name~version
      (. @bazel_skylib~1.0.3)
    • 모듈 확장 프로그램 저장소: module_name~version~extension_name~repo_name
      (. @rules_cc~0.0.1~cc_configure~local_config_cc)
  • 분명한 저장소 이름: 저장소 내의 BUILD.bzl 파일에서 사용할 저장소 이름입니다. 동일한 종속 항목은 다양한 저장소에 서로 다른 명확한 이름을 가질 수 있습니다.
    다음과 같이 결정됩니다.

    • Bazel 모듈 저장소의 경우: 기본적으로 module_name 또는 bazel_deprepo_name 속성으로 지정된 이름.
    • 모듈 확장 프로그램 저장소의 경우: use_repo를 통해 도입된 저장소 이름입니다.

모든 저장소에는 외래 저장소 이름에서 표준 저장소 이름으로의 매핑인 직접 종속 항목의 저장소 매핑 사전이 있습니다. 라벨을 구성할 때 저장소 매핑을 사용하여 저장소 이름을 확인합니다. 표준 저장소 이름의 충돌은 없으며, MODULE.bazel 파일의 파싱을 통해 명백한 저장소 이름의 사용을 찾을 수 있으므로 다른 종속 항목에 영향을 미치지 않고 충돌을 쉽게 포착할 수 있습니다.

엄격한 deps

새로운 종속 항목 사양 형식을 통해 더 엄격한 검사를 실행할 수 있습니다. 특히, 이제 모듈에서 직접 종속 항목에서 만든 저장소만 사용할 수 있습니다. 이렇게 하면 전이 종속 항목 그래프의 항목이 변경될 때 실수로 인해 디버그하기 어려운 손상을 방지할 수 있습니다.

엄격한 deps는 저장소 매핑을 기반으로 구현됩니다. 기본적으로 각 저장소의 저장소 매핑에는 모든 직접 종속 항목이 포함되며 다른 저장소는 표시되지 않습니다. 각 저장소에 표시되는 종속 항목은 다음과 같이 결정됩니다.

  • Bazel 모듈 저장소는 bazel_depuse_repo를 통해 MODULE.bazel 파일에 도입된 모든 저장소를 볼 수 있습니다.
  • 모듈 확장 프로그램 저장소는 확장 프로그램을 제공하는 모듈의 모든 종속 항목과 함께 동일한 모듈 확장 프로그램에서 생성된 다른 모든 저장소를 볼 수 있습니다.

레지스트리

Bzlmod는 Bazel 레지스트리에 정보를 요청하여 종속 항목을 검색합니다. Bazel 레지스트리는 단순히 Bazel 모듈의 데이터베이스입니다. 유일하게 지원되는 등록 방법은 색인 레지스트리이며, 특정 형식을 따르는 로컬 디렉터리 또는 정적 HTTP 서버입니다. 향후에는 프로젝트의 소스 및 기록이 포함된 git 저장소인 단일 모듈 레지스트리에 대한 지원을 추가할 계획입니다.

색인 레지스트리

색인 레지스트리는 홈페이지, 유지관리자, 각 버전의 MODULE.bazel 파일, 각 버전의 소스를 가져오는 방법을 포함한 모듈 목록에 대한 정보를 포함하는 로컬 디렉터리 또는 정적 HTTP 서버입니다. 특히 소스 보관 파일 자체를 제공할 필요는 없습니다.

색인 레지스트리는 아래 형식을 따라야 합니다.

  • /bazel_registry.json: 다음과 같은 레지스트리의 메타데이터를 포함하는 JSON 파일입니다.
    • mirrors: 소스 보관 파일에 사용할 미러 목록을 지정합니다.
    • module_base_path: source.json 파일에 local_repository 유형을 사용하는 모듈의 기본 경로를 지정합니다.
  • /modules: 이 레지스트리에 있는 각 모듈의 하위 디렉터리가 포함된 디렉터리입니다.
  • /modules/$MODULE: 이 모듈의 각 버전에 관한 하위 디렉터리와 다음 파일을 포함합니다.
    • metadata.json: 다음 필드가 포함된 모듈 정보가 포함된 JSON 파일입니다.
      • homepage: 프로젝트 홈페이지의 URL입니다.
      • maintainers: JSON 객체의 목록. 각각은 레지스트리에 있는 모듈의 유지관리자 정보에 해당합니다. 이것은 프로젝트의 작성자와 다를 수 있습니다.
      • versions: 이 레지스트리에서 찾을 수 있는 이 모듈의 모든 버전 목록입니다.
      • yanked_versions: 이 모듈의 양성 버전 목록입니다. 현재 노옵스(no-ops)이지만 향후 버벅거림 버전을 건너뛰거나 오류가 발생합니다.
  • /modules/$MODULE/$VERSION: 다음 파일을 포함하는 디렉터리.
    • MODULE.bazel: 이 모듈 버전의 MODULE.bazel 파일입니다.
    • source.json: 이 모듈 버전의 소스를 가져오는 방법에 대한 정보가 포함된 JSON 파일입니다.
      • 기본 유형은 'archive'이며 다음 필드가 포함되어 있습니다.
        • url: 소스 보관 파일의 URL입니다.
        • integrity: 보관 파일의 하위 리소스 무결성 체크섬입니다.
        • strip_prefix: 소스 보관 파일을 추출할 때 삭제할 디렉터리 접두어입니다.
        • patches: 추출된 보관 파일에 적용할 패치 파일의 이름을 각각 지정하는 문자열 목록입니다. 패치 파일은 /modules/$MODULE/$VERSION/patches 디렉터리 아래에 있습니다.
        • patch_strip: Unix 패치의 --strip 인수와 동일합니다.
      • 다음 필드로 로컬 경로를 사용하도록 유형을 변경할 수 있습니다.
        • type: local_path
        • path: 저장소의 로컬 경로로, 다음과 같이 계산됩니다.
          • 경로가 절대 경로인 경우 그대로 사용됩니다.
          • 경로가 상대 경로이고 module_base_path가 절대 경로이면 경로가 <module_base_path>/<path>로 확인됩니다.
          • 경로와 module_base_path이 모두 상대 경로이면 경로가 <registry_path>/<module_base_path>/<path>로 확인됩니다. 레지스트리는 로컬에서 호스팅되고 --registry=file://<registry_path>에서 사용해야 합니다. 그렇지 않으면 Bazel에서 오류가 발생합니다.
    • patches/: 패치 파일이 포함된 선택적 디렉터리로 source.json에 'archive' 유형이 있는 경우에만 사용됩니다.

Bazel 중앙 레지스트리

Bazel Central Registry (BCR)는 bcr.bazel.build에 있는 색인 레지스트리입니다. 그 콘텐츠는 GitHub 저장소 bazelbuild/bazel-central-registry에서 지원됩니다.

BCR은 Bazel 커뮤니티에서 유지하며 참여자는 pull 요청을 제출할 수 있습니다. Bazel 중앙 레지스트리 정책 및 절차를 참조하세요.

일반 색인 레지스트리의 형식 외에도 BCR은 각 모듈 버전(/modules/$MODULE/$VERSION/presubmit.yml)에 presubmit.yml 파일을 요구합니다. 이 파일은 이 모듈 버전의 유효성을 검사하는 데 사용할 수 있는 몇 가지 필수 빌드 및 테스트 대상을 지정하며 BCR의 CI 파이프라인에서 BCR의 모듈 간 상호 운용성을 확인하는 데 사용됩니다.

레지스트리 선택

반복 가능한 Bazel 플래그 --registry를 사용하여 모듈을 요청할 레지스트리 목록을 지정할 수 있으므로 타사 또는 내부 레지스트리에서 종속 항목을 가져오도록 프로젝트를 설정할 수 있습니다. 이전 레지스트리가 우선합니다. 편의를 위해 프로젝트의 .bazelrc 파일에 --registry 플래그 목록을 배치할 수 있습니다.

모듈 확장

모듈 확장 프로그램을 사용하면 종속 항목 그래프에서 모듈의 입력 데이터를 읽고 종속 항목 해결에 필요한 로직을 실행하며 마지막으로 저장소 규칙을 호출하여 저장소를 만들어 모듈 시스템을 확장할 수 있습니다. 기능적으로는 오늘의 WORKSPACE 매크로와 비슷하지만 모듈 및 전이 종속 항목에 더 적합합니다.

모듈 확장 프로그램은 저장소 규칙 또는 WORKSPACE 매크로와 마찬가지로 .bzl 파일에 정의됩니다. 직접 호출되지는 않습니다. 오히려 각 모듈은 확장 프로그램이 읽을 태그라는 데이터를 지정할 수 있습니다. 그런 다음 모듈 버전 확인이 완료되면 모듈 확장 프로그램이 실행됩니다. 각 확장 프로그램은 모듈 해상도 이후에 한 번 실행되며 (빌드가 실제로 발생하기 직전에) 발생하며 전체 종속 항목 그래프에서 확장 프로그램에 속한 모든 태그를 읽습니다.

          [ A 1.1                ]
          [   * maven.dep(X 2.1) ]
          [   * maven.pom(...)   ]
              /              \
   bazel_dep /                \ bazel_dep
            /                  \
[ B 1.2                ]     [ C 1.0                ]
[   * maven.dep(X 1.2) ]     [   * maven.dep(X 2.1) ]
[   * maven.dep(Y 1.3) ]     [   * cargo.dep(P 1.1) ]
            \                  /
   bazel_dep \                / bazel_dep
              \              /
          [ D 1.4                ]
          [   * maven.dep(Z 1.4) ]
          [   * cargo.dep(Q 1.1) ]

위의 종속 항목 그래프 예시에서 A 1.1B 1.2 등은 Bazel 모듈입니다. 각 모듈을 MODULE.bazel 파일이라고 생각하면 됩니다. 각 모듈은 모듈 확장 프로그램에 대한 몇 가지 태그를 지정할 수 있습니다. 여기서는 일부는 확장 프로그램 'maven'에 지정되고 일부는 'cargo'에 지정됩니다. 이 종속 항목 그래프가 완료되면 (예: B 1.2에 실제로 D 1.3bazel_dep이 있지만 C으로 인해 D 1.4로 업그레이드되었을 수 있음) 확장 프로그램 'maven'이 실행되고 모든 maven.* 태그를 읽고 그 안에 있는 정보를 사용하여 만들 저장소를 결정합니다. 'cargo' 확장 프로그램의 경우에도 마찬가지입니다.

확장 프로그램 사용

확장 프로그램은 Bazel 모듈 자체에서 호스팅되므로 모듈에서 확장 프로그램을 사용하려면 먼저 해당 모듈에 bazel_dep를 추가한 다음 기본 제공 use_extension 함수를 호출하여 범위를 지정해야 합니다. rules_jvm_external 모듈에 정의된 가상의 'maven' 확장 프로그램을 사용하는 MODULE.bazel 파일의 스니펫을 예로 들겠습니다.

bazel_dep(name = "rules_jvm_external", version = "1.0")
maven = use_extension("@rules_jvm_external//:extensions.bzl", "maven")

확장 프로그램을 범위에 적용한 후 dot-syntax를 사용하여 태그를 지정할 수 있습니다. 태그는 해당하는 태그 클래스에서 정의한 스키마를 따라야 합니다(아래 확장 프로그램 정의 참고). 다음은 maven.depmaven.pom 태그를 지정하는 예입니다.

maven.dep(coord="org.junit:junit:3.0")
maven.dep(coord="com.google.guava:guava:1.2")
maven.pom(pom_xml="//:pom.xml")

확장 프로그램에서 모듈에 사용할 저장소를 생성하는 경우 use_repo 지시문을 사용하여 이를 선언합니다. 이는 엄격한 deps 조건을 충족하고 로컬 저장소 이름 충돌을 방지하기 위한 것입니다.

use_repo(
    maven,
    "org_junit_junit",
    guava="com_google_guava_guava",
)

확장 프로그램에서 생성한 저장소는 API의 일부이므로 지정한 태그에서 'maven' 확장 프로그램이 'org_junit_junit'이라는 저장소와 'com_google_guava_guava'라는 저장소를 생성한다는 것을 알고 있어야 합니다. use_repo을 사용하면 필요에 따라 모듈의 범위에서 이러한 이름을 바꿀 수 있습니다(예: 'guava').

확장 프로그램 정의

모듈 확장 프로그램은 module_extension 함수를 사용하여 저장소 규칙과 비슷하게 정의됩니다. 둘 다 구현 함수가 있지만 저장소 규칙에는 여러 속성이 있지만 모듈 확장 프로그램에는 여러 tag_class가 있으며 각 속성에는 여러 속성이 있습니다. 태그 클래스는 이 확장 프로그램에서 사용하는 태그의 스키마를 정의합니다. 위의 가상의 'maven' 확장 프로그램의 예를 계속 살펴보겠습니다.

# @rules_jvm_external//:extensions.bzl
maven_dep = tag_class(attrs = {"coord": attr.string()})
maven_pom = tag_class(attrs = {"pom_xml": attr.label()})
maven = module_extension(
    implementation=_maven_impl,
    tag_classes={"dep": maven_dep, "pom": maven_pom},
)

이러한 선언은 위에 정의된 속성 스키마를 사용하여 maven.depmaven.pom 태그를 지정할 수 있도록 합니다.

구현 함수는 WORKSPACE 그래프와 비슷하지만, 종속 항목 그래프 및 모든 관련 태그에 대한 액세스 권한을 부여하는 module_ctx 객체를 가져온다는 점이 다릅니다. 그런 다음 구현 함수는 저장소 규칙을 호출하여 저장소를 생성해야 합니다.

# @rules_jvm_external//:extensions.bzl
load("//:repo_rules.bzl", "maven_single_jar")
def _maven_impl(ctx):
  coords = []
  for mod in ctx.modules:
    coords += [dep.coord for dep in mod.tags.dep]
  output = ctx.execute(["coursier", "resolve", coords])  # hypothetical call
  repo_attrs = process_coursier(output)
  [maven_single_jar(**attrs) for attrs in repo_attrs]

위의 예에서는 종속 항목 그래프(ctx.modules)의 모든 모듈을 살펴봅니다. 각 모듈은 bazel_module 객체로, tags 필드는 모듈의 모든 maven.* 태그를 노출합니다. 그런 다음 CLI 유틸리티 유틸리티를 호출하여 Maven에 문의하고 해결을 수행합니다. 마지막으로, 가상의 maven_single_jar 저장소 규칙을 사용하여 확인 결과를 사용하여 여러 저장소를 만듭니다.