저장소 규칙

이 페이지에서는 저장소 규칙을 정의하는 방법을 설명하고 자세한 내용을 보여주는 예시를 제공합니다.

외부 저장소는 Bazel 빌드에서 사용할 수 있는 소스 파일이 포함된 디렉터리 트리로, 해당 저장소 규칙을 실행하여 필요에 따라 생성됩니다. 저장소는 다양한 방법으로 정의할 수 있지만 궁극적으로 각 저장소는 빌드 타겟이 빌드 규칙을 호출하여 정의되는 것처럼 저장소 규칙을 호출하여 정의됩니다. 또한 Maven 패키지 라이브러리와 같은 서드 파티 라이브러리에 종속되는 데 사용할 수 있을 뿐만 아니라 Bazel이 실행되는 호스트와 관련된 BUILD 파일을 생성하기 위해서도 사용할 수 있습니다.

저장소 규칙 정의

.bzl 파일에서 repository_rule 함수를 사용하여 새 저장소 규칙을 정의하고 전역 변수에 저장합니다. 저장소 규칙을 정의한 후에는 이 규칙을 함수로 호출하여 저장소를 정의할 수 있습니다. 이 호출은 일반적으로 모듈 확장 구현 함수 내에서 실행됩니다.

저장소 규칙 정의의 두 가지 주요 구성요소는 속성 스키마와 구현 함수입니다. 속성 스키마는 저장소 규칙 호출에 전달되는 속성의 이름과 유형을 결정하며, 저장소를 가져와야 할 때 구현 함수가 실행됩니다.

속성

속성은 저장소 규칙 호출에 전달되는 인수입니다. 저장소 규칙에서 허용하는 속성의 스키마는 저장소 규칙이 repository_rule 호출로 정의될 때 attrs 인수를 사용하여 지정됩니다. url 및 sha256 속성을 문자열로 정의하는 예는 다음과 같습니다.

http_archive = repository_rule(
    implementation=_impl,
    attrs={
        "url": attr.string(mandatory=True),
        "sha256": attr.string(mandatory=True),
    }
)

구현 함수 내에서 속성에 액세스하려면 repository_ctx.attr.<attribute_name>를 사용합니다.

def _impl(repository_ctx):
    url = repository_ctx.attr.url
    checksum = repository_ctx.attr.sha256

모든 repository_rule에는 암시적으로 정의된 속성 name가 있습니다. 이는 다소 마술처럼 작동하는 문자열 속성입니다. 저장소 규칙 호출의 입력으로 지정되면 표시되는 저장소 이름을 사용하지만 repository_ctx.attr.name를 사용하여 저장소 규칙의 구현 함수에서 읽으면 표준 저장소 이름을 반환합니다.

구현 함수

모든 저장소 규칙에는 implementation 함수가 필요합니다. 여기에는 규칙의 실제 로직이 포함되며 로드 단계에서 엄격하게 실행됩니다.

이 함수에는 정확히 하나의 입력 매개변수인 repository_ctx가 있습니다. 이 함수는 지정된 매개변수를 고려할 때 규칙을 재현할 수 있음을 나타내는 None를 반환하거나, 해당 규칙을 동일한 저장소를 생성하는 재현 가능한 규칙으로 전환하는 규칙의 매개변수 집합이 포함된 사전을 반환합니다. 예를 들어 Git 저장소를 추적하는 규칙의 경우 원래 지정된 플로팅 브랜치 대신 특정 커밋 식별자를 반환하는 것을 의미합니다.

입력 매개변수 repository_ctx는 속성 값 및 비밀 유지 기능 (바이너리 찾기, 바이너리 실행, 저장소에 파일 만들기 또는 인터넷에서 파일 다운로드)에 액세스하는 데 사용할 수 있습니다. 자세한 내용은 API 문서를 참고하세요. 예:

def _impl(repository_ctx):
  repository_ctx.symlink(repository_ctx.attr.path, "")

local_repository = repository_rule(
    implementation=_impl,
    ...)

구현 함수는 언제 실행되나요?

저장소 규칙의 구현 함수는 Bazel에 해당 저장소의 타겟이 필요한 경우 실행됩니다 (예: 다른 저장소의 다른 타겟이 이 저장소의 타겟에 종속되어 있거나 명령줄에 언급된 경우). 그러면 구현 함수가 파일 시스템에 저장소를 만들어야 합니다. 이를 저장소 '가져오기'라고 합니다.

일반 타겟과 달리 저장소가 달라지는 원인이 되는 사항이 변경되더라도 저장소를 반드시 다시 가져오지 않아도 됩니다. Bazel에서 변경사항을 감지할 수 없거나 모든 빌드에서 오버헤드가 너무 많이 발생하는 항목 (예: 네트워크에서 가져온 항목)이 있기 때문입니다. 따라서 다음 중 하나가 변경되는 경우에만 저장소가 다시 가져옵니다.

• 저장소 규칙 호출에 전달된 속성입니다.
• 저장소 규칙의 구현을 구성하는 Starlark 코드입니다.
• repository_ctx의 getenv() 메서드에 전달되거나 repository_rule의 environ 속성으로 선언된 환경 변수의 값입니다. 이러한 환경 변수의 값은 --repo_env 플래그를 사용하여 명령줄에 하드웨어로 연결할 수 있습니다.
• 저장소 규칙의 구현 함수에서 watch 처리되는 경로의 존재 여부, 콘텐츠, 유형입니다.
  • read(), execute(), extract()와 같은 watch 매개변수가 있는 repository_ctx의 다른 특정 메서드도 경로를 감시할 수 있습니다.
  • 마찬가지로 repository_ctx.watch_tree 및 path.readdir를 사용하면 다른 방식으로 경로를 감시할 수 있습니다.
• bazel fetch --force가 실행될 때

저장소를 다시 가져오는 시점을 제어하는 repository_rule의 두 가지 매개변수는 다음과 같습니다.

• configure 플래그가 설정되면 bazel fetch --force --configure에서 저장소가 다시 가져옵니다 (configure가 아닌 저장소는 다시 가져오지 않음).
• local 플래그가 설정된 경우 위의 경우 외에도 Bazel 서버가 다시 시작될 때 저장소도 다시 가져옵니다.

외부 저장소의 다시 가져오기 강제

정의나 종속 항목을 변경하지 않아도 외부 저장소가 오래될 수 있습니다. 예를 들어 저장소 가져오기 소스는 서드 파티 저장소의 특정 브랜치를 따를 수 있으며, 해당 브랜치에서 새 커밋을 사용할 수 있습니다. 이 경우 bazel fetch --force --all를 호출하여 무조건적으로 모든 외부 저장소를 다시 가져오도록 bazel에 요청할 수 있습니다.

또한 일부 저장소 규칙은 로컬 머신을 검사하며 로컬 머신이 업그레이드되면 오래될 수 있습니다. 여기에서 repository_rule 정의에 configure 속성이 설정되어 있는 경우 bazel fetch --force --configure를 사용하여 외부 저장소만 다시 가져오도록 Bazel에 요청할 수 있습니다.

예

• C++ 자동 구성 도구 모음: 저장소 규칙을 사용하여 로컬 C++ 컴파일러, 환경, C++ 컴파일러에서 지원하는 플래그를 찾아 Bazel용 C++ 구성 파일을 자동으로 만듭니다.

• Go 저장소는 여러 repository_rule를 사용하여 Go 규칙을 사용하는 데 필요한 종속 항목 목록을 정의합니다.

• rules_jvm_external은 기본적으로 @maven라는 외부 저장소를 만듭니다. 이 저장소는 전이 종속 항목 트리에서 모든 Maven 아티팩트의 빌드 대상을 생성합니다.