외부 종속 항목 다루기

Nightly · 9.1 · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

Bazel은 다른 프로젝트의 대상을 종속 항목으로 사용할 수 있습니다. 이러한 다른 프로젝트의 종속 항목을 외부 종속 항목 이라고 합니다.

WORKSPACE 파일 (또는 WORKSPACE.bazel 파일)은 작업공간 디렉터리 에서 Bazel에 다른 프로젝트의 소스를 가져오는 방법을 알려줍니다. 이러한 다른 프로젝트에는 자체 대상이 있는 BUILD 파일이 하나 이상 포함될 수 있습니다. 기본 프로젝트 내의 BUILD 파일은 WORKSPACE 파일의 이름을 사용하여 이러한 외부 대상을 종속 항목으로 사용할 수 있습니다.

예를 들어 시스템에 두 개의 프로젝트가 있다고 가정해 보겠습니다.

/
  home/
    user/
      project1/
        WORKSPACE
        BUILD
        srcs/
          ...
      project2/
        WORKSPACE
        BUILD
        my-libs/

project1이 /home/user/project2/BUILD에 정의된 대상 :foo을 종속 항목으로 사용하려면 project2라는 저장소가 /home/user/project2에 있음을 지정할 수 있습니다. 그러면 /home/user/project1/BUILD의 대상이 @project2//:foo를 종속 항목으로 사용할 수 있습니다.

WORKSPACE 파일을 사용하면 사용자가 파일 시스템의 다른 부분에 있는 대상 또는 인터넷에서 다운로드한 대상을 종속 항목으로 사용할 수 있습니다. BUILD 파일과 동일한 문법을 사용하지만 저장소 규칙 (작업공간 규칙 이라고도 함)이라는 다른 규칙 집합을 허용합니다. Bazel에는 몇 가지 기본 제공 저장소 규칙과 임베디드 Starlark 저장소 규칙 집합이 포함되어 있습니다. 사용자는 맞춤 저장소규칙 을 작성하여 더 복잡한 동작을 가져올 수도 있습니다.

지원되는 외부 종속 항목 유형

몇 가지 기본 유형의 외부 종속 항목을 사용할 수 있습니다.

다른 Bazel 프로젝트에 종속

두 번째 Bazel 프로젝트의 대상을 사용하려면 local_repository, git_repository 또는 http_archive 를 사용하여 로컬 파일 시스템에서 심볼릭 링크를 만들거나 Git 저장소를 참조하거나 다운로드 할 수 있습니다 (각각).

예를 들어 my-project/ 프로젝트에서 작업 중이고 동료의 프로젝트 coworkers-project/의 대상을 종속 항목으로 사용하려는 경우를 가정해 보겠습니다. 두 프로젝트 모두 Bazel을 사용하므로 동료의 프로젝트를 외부 종속 항목으로 추가한 후 동료가 정의한 대상을 자체 BUILD 파일에서 사용할 수 있습니다. my_project/WORKSPACE에 다음을 추가합니다.

local_repository(
    name = "coworkers_project",
    path = "/path/to/coworkers-project",
)

동료에게 대상 //foo:bar가 있는 경우 프로젝트에서 @coworkers_project//foo:bar로 참조할 수 있습니다. 외부 프로젝트 이름은 유효한 작업공간 이름이어야 합니다.

Bazel 이외의 프로젝트에 종속

new_와 같이 new_local_repository로 시작하는 규칙을 사용하면 Bazel을 사용하지 않는 프로젝트에서 대상을 만들 수 있습니다.

예를 들어 my-project/ 프로젝트에서 작업 중이고 동료의 프로젝트 coworkers-project/를 종속 항목으로 사용하려는 경우를 가정해 보겠습니다. 동료의 프로젝트는 make를 사용하여 빌드하지만 생성하는 .so 파일 중 하나를 종속 항목으로 사용하려고 합니다. 이렇게 하려면 my_project/WORKSPACE에 다음을 추가합니다.

new_local_repository(
    name = "coworkers_project",
    path = "/path/to/coworkers-project",
    build_file = "coworker.BUILD",
)

build_file 은 기존 프로젝트에 오버레이할 BUILD 파일을 지정합니다. 예를 들면 다음과 같습니다.

cc_library(
    name = "some-lib",
    srcs = glob(["**"]),
    visibility = ["//visibility:public"],
)

그런 다음 프로젝트의 BUILD 파일에서 @coworkers_project//:some-lib를 종속 항목으로 사용할 수 있습니다.

외부 패키지에 종속

Maven 아티팩트 및 저장소

규칙 집합 rules_jvm_external 을 사용하여 Maven 저장소에서 아티팩트를 다운로드하고 Java 종속 항목으로 사용할 수 있도록 합니다.

종속 항목 가져오기

기본적으로 외부 종속 항목은 bazel build 중에 필요에 따라 가져옵니다. 특정 대상 집합에 필요한 종속 항목을 미리 가져오려면 bazel fetch를 사용합니다. 모든 외부 종속 항목을 무조건 가져오려면 bazel sync를 사용합니다. 가져온 저장소는 출력 기본에 저장되므로 가져오기는 작업공간별로 발생합니다.

종속 항목 섀도잉

가능하면 프로젝트에 단일 버전 정책을 사용하는 것이 좋습니다. 이는 컴파일하고 최종 바이너리에 포함되는 종속 항목에 필요합니다. 하지만 그렇지 않은 경우 종속 항목을 섀도잉할 수 있습니다. 다음 상황을 살펴보세요.

myproject/WORKSPACE

workspace(name = "myproject")

local_repository(
    name = "A",
    path = "../A",
)
local_repository(
    name = "B",
    path = "../B",
)

A/WORKSPACE

workspace(name = "A")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner",
    urls = ["https://github.com/testrunner/v1.zip"],
    sha256 = "...",
)

B/WORKSPACE

workspace(name = "B")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner",
    urls = ["https://github.com/testrunner/v2.zip"],
    sha256 = "..."
)

종속 항목 A와 B는 모두 testrunner에 종속되지만 서로 다른 버전의 testrunner에 종속됩니다. 이러한 테스트 실행기가 myproject 내에서 평화롭게 공존하지 못할 이유는 없지만 이름이 같으므로 서로 충돌합니다. 두 종속 항목을 모두 선언하려면 myproject/WORKSPACE를 업데이트합니다.

workspace(name = "myproject")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner-v1",
    urls = ["https://github.com/testrunner/v1.zip"],
    sha256 = "..."
)
http_archive(
    name = "testrunner-v2",
    urls = ["https://github.com/testrunner/v2.zip"],
    sha256 = "..."
)
local_repository(
    name = "A",
    path = "../A",
    repo_mapping = {"@testrunner" : "@testrunner-v1"}
)
local_repository(
    name = "B",
    path = "../B",
    repo_mapping = {"@testrunner" : "@testrunner-v2"}
)

이 메커니즘은 다이아몬드를 조인하는 데에도 사용할 수 있습니다. 예를 들어 A와 B에 동일한 종속 항목이 있지만 서로 다른 이름으로 호출하는 경우 이러한 종속 항목을 myproject/WORKSPACE에서 조인할 수 있습니다.

명령줄에서 저장소 재정의

선언된 저장소를 명령줄의 로컬 저장소로 재정의하려면 다음 --override_repository 플래그를 사용합니다. 이 플래그를 사용하면 소스 코드를 변경하지 않고 외부 저장소의 콘텐츠를 변경할 수 있습니다.

예를 들어 @foo를 로컬 디렉터리 /path/to/local/foo로 재정의하려면 --override_repository=foo=/path/to/local/foo 플래그를 전달합니다.

다음은 몇 가지 사용 사례입니다.

  • 디버깅 문제. 예를 들어 http_archive 저장소를 변경하기 더 쉬운 로컬 디렉터리로 재정의할 수 있습니다.
  • 벤더링. 네트워크 호출을 할 수 없는 환경에 있는 경우 네트워크 기반 저장소 규칙을 재정의하여 대신 로컬 디렉터리를 가리킵니다.

프록시 사용

Bazel은 HTTPS_PROXY 및 HTTP_PROXY 환경 변수에서 프록시 주소를 가져와서 이를 사용하여 HTTP/HTTPS 파일을 다운로드합니다 (지정된 경우).

IPv6 지원

IPv6 전용 머신에서 Bazel은 변경사항 없이 종속 항목을 다운로드할 수 있습니다. 하지만 이중 스택 IPv4/IPv6 머신에서 Bazel은 Java와 동일한 규칙을 따릅니다. IPv4가 사용 설정된 경우 IPv4가 우선 적용됩니다. 예를 들어 IPv4 네트워크가 외부 주소를 확인하거나 연결할 수 없는 경우 Network unreachable 예외 및 빌드 실패가 발생할 수 있습니다. 이러한 경우 IPv6를 우선 적용하도록 Bazel의 동작을 재정의할 수 있습니다. java.net.preferIPv6Addresses=true 시스템 속성을 사용하여 구체적인 내용은 다음과 같습니다.

전이 종속 항목

Bazel은 WORKSPACE 파일에 나열된 종속 항목만 읽습니다. 프로젝트 (A)가 WORKSPACE 파일에 세 번째 프로젝트 (C)에 대한 종속 항목을 나열하는 다른 프로젝트 (B)에 종속되는 경우 프로젝트의 WORKSPACE 파일에 B 와 C를 모두 추가해야 합니다. 이 요구사항으로 인해 WORKSPACE 파일 크기가 커질 수 있지만 한 라이브러리에 버전 1.0의 C가 포함되고 다른 라이브러리에 버전 2.0의 C가 포함될 가능성이 제한됩니다.

외부 종속 항목 캐싱

기본적으로 Bazel은 정의가 변경된 경우에만 외부 종속 항목을 다시 다운로드합니다. 정의에서 참조되는 파일 (예: 패치 또는 BUILD 파일)의 변경사항도 Bazel에서 고려합니다.

강제로 다시 다운로드하려면 bazel sync를 사용합니다.

레이아웃

모든 외부 종속 항목은 출력 기본의 하위 디렉터리 external 아래에 있는 디렉터리로 다운로드됩니다. 로컬 저장소의 경우 새 디렉터리를 만드는 대신 심볼릭 링크가 생성됩니다. 다음을 실행하여 external 디렉터리를 확인할 수 있습니다.

ls $(bazel info output_base)/external

bazel clean을 실행해도 외부 디렉터리가 실제로 삭제되지는 않습니다. 모든 외부 아티팩트를 삭제하려면 bazel clean --expunge를 사용합니다.

오프라인 빌드

오프라인 방식으로 빌드를 실행하는 것이 바람직하거나 필요한 경우가 있습니다. 비행기 여행과 같은 간단한 사용 사례의 경우 prefetching 저장소를 bazel fetch 또는 bazel sync를 사용하여 미리 가져오는 것으로 충분할 수 있습니다. 또한 --nofetch 옵션을 사용하면 빌일드 중에 추가 저장소 가져오기를 사용 중지할 수 있습니다.

필요한 파일 제공을 Bazel과 다른 항목에서 수행하는 실제 오프라인 빌드의 경우 Bazel은 --distdir 옵션을 지원합니다. 저장소 규칙에서 Bazel에 ctx.download 또는 ctx.download_and_extract 를 통해 파일을 가져오도록 요청하고 필요한 파일의 해시 합계를 제공할 때마다 Bazel은 먼저 제공된 첫 번째 URL의 기본 이름과 일치하는 파일을 해당 옵션으로 지정된 디렉터리에서 찾고 해시가 일치하면 해당 로컬 사본을 사용합니다.

Bazel 자체는 이 기법을 사용하여 배포 아티팩트에서 오프라인으로 부트스트랩합니다. 이렇게 하려면 필요한 모든 외부 종속 항목 을 내부 distdir_tar에 수집합니다.

하지만 Bazel은 네트워크를 호출하는지 여부를 알지 못해도 저장소 규칙에서 임의의 명령어를 실행할 수 있습니다. 따라서 Bazel에는 빌드를 완전히 오프라인으로 강제하는 옵션이 없습니다. 따라서 빌드가 오프라인에서 올바르게 작동하는지 테스트하려면 Bazel이 부트스트랩 테스트에서와 같이 네트워크를 외부에서 차단해야 합니다.

권장사항

저장소 규칙

저장소 규칙은 일반적으로 다음을 담당해야 합니다.

  • 시스템 설정을 감지하고 파일에 작성합니다.
  • 시스템의 다른 곳에서 리소스를 찾습니다.
  • URL에서 리소스를 다운로드합니다.
  • BUILD 파일을 생성하거나 심볼릭 링크를 외부 저장소 디렉터리에 만듭니다.

가능하면 repository_ctx.execute를 사용하지 마세요. 예를 들어 Make를 사용하여 빌드하는 Bazel 이외의 C++ 라이브러리를 사용하는 경우 repository_ctx.download()를 사용한 후 빌드하는 BUILD 파일을 작성하는 것이 ctx.execute(["make"])를 실행하는 것보다 좋습니다.

git_repository 및 new_git_repository보다 http_archive를 선호합니다. 이유는 다음과 같습니다.

  • Git 저장소 규칙은 시스템 git(1)에 종속되는 반면 HTTP 다운로더는 Bazel에 내장되어 있으며 시스템 종속 항목이 없습니다.
  • http_archive 는 urls 목록을 미러로 지원하고 git_repository는 단일 remote만 지원합니다.
  • http_archive는 저장소 캐시와 함께 작동하지만 git_repository는 작동하지 않습니다. 자세한 내용은 #5116을 참고하세요.

bind()를 사용하지 마세요. 문제 및 대안에 관한 자세한 내용은 "bind 삭제 고려"를 참고하세요.