다음에서 호스트 머신은 Bazel이 실행되는 머신입니다.
원격 실행을 사용하는 경우 실제 빌드 또는 테스트 단계가 호스트 머신에서 발생하는 것이 아니라 원격 실행 시스템으로 전송됩니다. 하지만 작업공간 규칙 확인 단계는 호스트 머신에서 수행됩니다. 작업공간 규칙이 실행 중에 사용할 호스트 머신에 대한 정보에 액세스하는 경우, 환경 간의 비호환성으로 인해 빌드가 손상될 수 있습니다.
원격 실행을 위해 Bazel 규칙을 조정하는 과정에서 이러한 작업공간 규칙을 찾아 수정해야 합니다. 이 페이지에서는 작업공간 로그를 사용하여 문제가 될 수 있는 작업공간 규칙을 찾는 방법을 설명합니다.
기본 설정이 아닌 규칙 찾기
작업공간 규칙을 통해 개발자는 종속 항목을 외부 작업공간에 추가할 수 있지만 프로세스에 임의 처리가 이루어질 수 있을 만큼 충분합니다. 모든 관련 명령어는 로컬에서 실행되며 밀폐성의 잠재적 소스일 수 있습니다. 일반적으로 기본 제공되지 않는 동작은 호스트 머신과 상호작용할 수 있는 repository_ctx
을 통해 도입됩니다.
Bazel 0.18부터 --experimental_workspace_rules_log_file=[PATH]
플래그를 Bazel 명령어에 추가하여 밀폐 가능성이 없는 일부 작업의 로그를 가져올 수 있습니다. 여기서 [PATH]
은 로그를 만들 파일 이름입니다.
다음 사항을 참고하세요.
로그는 로그가 실행되는 동시에 이벤트를 캡처합니다. 캐시된 단계 중 일부는 로그에 표시되지 않으므로 전체 결과를 얻으려면
bazel clean --expunge
을 미리 실행하지 마세요.함수가 다시 실행될 수 있는 경우 관련 이벤트가 로그에 여러 번 표시됩니다.
Workspace 규칙은 현재 Starlark 이벤트만 로깅합니다.
작업공간 초기화 중 실행된 작업을 찾으려면 다음 안내를 따르세요.
bazel clean --expunge
를 실행합니다. 이 명령어는 로컬 캐시 및 캐시된 저장소를 모두 초기화하여 모든 초기화를 다시 실행하도록 합니다.Bazel 명령어에
--experimental_workspace_rules_log_file=/tmp/workspacelog
를 추가하고 빌드를 실행합니다.그러면 WorkspaceEvent 유형의 메시지를 나열하는 바이너리 Proto 파일이 생성됩니다.
Bazel 소스 코드를 다운로드하고 아래 명령어를 사용하여 Bazel 폴더로 이동합니다. 작업공간 로그 파서로 작업공간 로그를 파싱하려면 소스 코드가 필요합니다.
git clone https://github.com/bazelbuild/bazel.git
cd bazel
Bazel 소스 코드 저장소에서 전체 작업공간 로그를 텍스트로 변환합니다.
bazel build src/tools/workspacelog:parser
bazel-bin/src/tools/workspacelog/parser --log_path=/tmp/workspacelog > /tmp/workspacelog.txt
출력은 매우 상세할 수 있으며 기본 제공 Bazel 규칙의 출력을 포함할 수 있습니다.
출력에서 특정 규칙을 제외하려면
--exclude_rule
옵션을 사용합니다. 예:bazel build src/tools/workspacelog:parser
bazel-bin/src/tools/workspacelog/parser --log_path=/tmp/workspacelog \ --exclude_rule "//external:local_config_cc" \ --exclude_rule "//external:dep" > /tmp/workspacelog.txt
/tmp/workspacelog.txt
을 열고 안전하지 않은 작업이 있는지 확인합니다.
로그는 repository_ctx
에서 수행된 밀폐 가능성이 있는 특정 작업을 설명하는 WorkspaceEvent 메시지로 구성됩니다.
밀폐성이 아닌 것으로 강조표시된 작업은 다음과 같습니다.
execute
: 호스트 환경에서 임의의 명령어를 실행합니다. 이로 인해 호스트 환경의 종속 항목이 발생할 수 있는지 확인하세요.download
,download_and_extract
: 밀폐 빌드를 보장하기 위해 sha256이 지정되었는지 확인합니다.file
,template
: 그 자체로 밀폐되지는 않지만 호스트 환경의 종속 항목을 저장소에 도입하는 메커니즘일 수 있습니다. 입력이 어디에서 비롯되는지, 그리고 호스트 환경에 의존하지 않는지 확인합니다.os
: 자체적으로 밀폐적이지는 않지만 호스트 환경에서 종속 항목을 쉽게 가져올 수 있습니다. 밀폐 빌드는 일반적으로 이를 부르지 않습니다. 밀폐 여부를 확인할 때는 작업자가 아닌 호스트에서 실행된다는 점을 염두에 두세요. 일반적으로 호스트에서 환경 사양을 가져오는 것은 원격 빌드에 권장되지 않습니다.symlink
: 일반적으로 안전하지만 위험 신호는 있는지 찾습니다. 심볼릭 링크가 저장소 외부 또는 절대 경로로 연결되면 원격 작업자에게 문제가 발생합니다. 심볼릭 링크가 호스트 머신 속성을 기반으로 만들어지면 문제가 발생할 수도 있습니다.which
: 일반적으로 작업자마다 구성이 다를 수 있으므로 호스트에 설치된 프로그램을 확인하는 데 문제가 있습니다.