단일 저장소 작업의 가장 강력한 측면 중 하나는 패키지/팀/계층 구조 간에 코드를 공유하는 기능입니다. 이 게시물에서는 매우 간단한 실제 시나리오를 설명하려고 합니다.

예시 시나리오

모노레포의 다른 부분에 유용할 수 있는 파일 크기를 메가바이트 단위로 표시하는 라이브러리를 개발한다고 가정해 보세요. 라이브러리는 크기를 정수(예: 2048바이트)로 허용하고 인간화된 문자열(예: 2MB)을 반환할 수 있습니다. 품질 보증을 추가하기 위해 동일한 테스트도 작성할 예정입니다.

Bazel은 어떻게 코드 공유를 활성화합니까?

위 시나리오에서 우리는 이 기능을 공유 라이브러리로 개발한 다음 사용하기 위해 다른 패키지에서 가져와야 한다는 것을 알고 있습니다. Bazel은 라이브러리에서 함수를 정의하고 이를 필요로 하는 다른 서비스로 내보낼 수 있도록 함으로써 이를 매우 간단하게 만듭니다. 이 게시물 하단에 링크된 이전 게시물에서 설명했듯이, 사용을 위해 가져올 수 있는 다른 라이브러리도 제어할 수 있습니다.

코딩을 해보자

코드 구성을 위해 작업공간 루트에 라이브러리 디렉토리를 두고 라이브러리 코드를 작성할 humanize_filesize라는 하위 디렉토리를 갖습니다.

humanize_filesize.go에 매우 기본적인 Go 코드를 작성해 보겠습니다.

package humanize_filesize

import "fmt"

// GetHumanizedFilesize takes size_in_bytes as an int32 pointer and returns the size in megabytes.
func GetHumanizedFilesize(size_in_bytes *int32) string {
    if size_in_bytes != nil {
        size_in_megabytes := float64(*size_in_bytes) / (1024 * 1024)
        return fmt.Sprintf("%.4f MB", size_in_megabytes)
    }
    return "0 MB"
}

이 코드는 단순히 int32를 입력으로 사용하고 계산된 읽을 수 있는 메가바이트 문자열을 소수점 4자리 정밀도로 반환합니다.

이 기능은 확실히 포괄적이지 않으며 확실히 개선될 수 있지만 이것이 이 연습의 요점은 아닙니다.

또한 논리가 의도한 대로 작동하는지 확인하고 humanize_filesize_test.go라는 파일에 go 코드와 함께 매우 기본적인 테스트를 추가합니다.

package humanize_filesize

import (
    "testing"
)

func TestHumanizeFilesize(t *testing.T) {
    tests := []struct {
        name          string
        size_in_bytes *int32
        expected      string
    }{
        {
            name:          "nil bytes",
            size_in_bytes: nil,
            expected:      "0 MB",
        },
        {
            name:          "2048 bytes",
            size_in_bytes: int32Ptr(2048),
            expected:      "0.0020 MB",
        },
        {
            name:          "0 bytes",
            size_in_bytes: int32Ptr(0),
            expected:      "0.0000 MB",
        },
    }

    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            result := GetHumanizedFilesize(tt.size_in_bytes)
            if result != tt.expected {
                t.Errorf("expected %s, got %s", tt.expected, result)
            }
        })
    }
}

func int32Ptr(n int32) *int32 {
    return &n
}

nil, int32 및 0을 입력으로 사용하는 기본 테스트를 사용한 매우 간단한 테스트

이제 이 함수를 다른 패키지나 서비스 내에서 가져올 수 있도록 내보내는 방법에 대한 흥미로운 부분이 나옵니다. 여기서 BUILD.bazel 파일을 정의해야 합니다.

load("@rules_go//go:def.bzl", "go_library", "go_test")

go_library(
    name = "humanize_filesize",
    srcs = ["humanize_filesize.go"],
    importpath = "basil/libraries/humanize_filesize",
    visibility = ["//visibility:public"],
)

go_test(
    name = "humanize_filesize_test",
    srcs = ["humanize_filesize_test.go"],
    embed = [":humanize_filesize"],
)

여기에서는 두 가지 주요 규칙을 정의합니다. 하나는 실제 라이브러리용이고 다른 하나는 우리가 작성한 테스트 파일용입니다.

go_library는 대상 humanize_filesize가 importpath에 지정된 경로로 가져올 수 있는 소스 중 하나로 humanize_filesize.go를 사용하고 다른 패키지를 가져올 수 있도록 작업공간 내에서 공개적으로 표시됨을 정의합니다. 향후 게시물에서 공개 여부를 제어하는 ​​방법을 알아보겠습니다.

go_test는 go_library 출력의 코드를 포함하는 테스트 대상을 정의합니다.

이 시점에서 다음과 같이 테스트 스위트를 실행하여 라이브러리를 테스트할 수 있습니다.

bazel 빌드 //... && bazel 실행 //libraries/humanize_filesize:humanize_filesize_test

모든 테스트가 통과되었음을 나타내는 다음과 같은 테스트 출력을 볼 수 있습니다.

INFO: Analyzed target //libraries/humanize_filesize:humanize_filesize_test (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
Target //libraries/humanize_filesize:humanize_filesize_test up-to-date:
  bazel-bin/libraries/humanize_filesize/humanize_filesize_test_/humanize_filesize_test
INFO: Elapsed time: 0.392s, Critical Path: 0.24s
INFO: 5 processes: 1 internal, 4 darwin-sandbox.
INFO: Build completed successfully, 5 total actions
INFO: Running command line: external/bazel_tools/tools/test/test-setup.sh libraries/humanize_filesize/humanize_filesize_test_/humanize_filesize_test
exec ${PAGER:-/usr/bin/less} "$0" || exit 1
Executing tests from //libraries/humanize_filesize:humanize_filesize_test
-----------------------------------------------------------------------------
PASS

? 와후!!! ? 이제 우리는 라이브러리가 의도한 대로 작동하고 있음을 알고 있습니다.

이제 다음 go 코드와 BUILD.bazel 파일을 사용하여 작업공간 루트에 생성할 서비스 디렉터리 내의 service1 서비스에서 이 라이브러리를 사용해 보겠습니다.

service1.go

package main

import (
    "basil/libraries/humanize_filesize"
    "fmt"
    "math/rand"
)

func main() {
    v := rand.Int31n(1000000)
    fmt.Printf(`%d bytes = %s\n`, v, humanize_filesize.GetHumanizedFilesize(&v))
}

BUILD.bazel

load("@rules_go//go:def.bzl", "go_binary", "go_library")

go_library(
    name = "service1_lib",
    srcs = ["service1.go"],
    importpath = "basil/services/service1",
    visibility = ["//visibility:private"],
    deps = ["//libraries/humanize_filesize"],
)

go_binary(
    name = "service1",
    embed = [":service1_lib"],
    visibility = ["//visibility:public"],
)

go 코드는 이전에 선언한 라이브러리를 가져오고 라이브러리에서 GetHumanizedFilesize 함수를 사용하고 임의의 정수 값을 전달하고 출력을 인쇄하는 매우 간단합니다.

이제 bazel build //services/service1 을 실행하면 bazel은 우리가 개발한 라이브러리를 포함하여 대상에 대한 모든 종속성을 해결하고 빌드합니다.

service1은 이제 바이너리 타겟이 하나만 정의되어 있으므로 bazel run //services/service1을 사용하여 실행할 수 있습니다. 바이너리 대상이 두 개 이상인 경우(예: serviceX) bazel run //services/service1:serviceX를 사용하여 실행할 수 있습니다. 기본적으로 대상을 지정하지 않으면 bazel은 항상 디렉터리와 동일한 이름을 가진 바이너리 대상을 찾아서 실행하려고 시도합니다.

자... 여기까지입니다. 우리는 모노레포의 다른 부분에서 사용할 수 있는 첫 번째 공유 라이브러리를 만들었습니다.

이 예제의 모든 코드는 https://github.com/nixclix/basil/pull/3/commits/61c673b8757860bd5e60eb2ab6c35f3f4da78c87에서 찾을 수 있습니다.

이 게시물의 내용이 마음에 드신다면 자유롭게 공유해 주세요. 또한 이 게시물에 대한 여러분의 생각과 제가 개선했으면 하는 점이 있으면 구독하고 댓글을 남겨주세요.