Go 애플리케이션 빌드 및 테스트

이 페이지에서는 Cloud Build를 사용하여 Go 애플리케이션을 빌드 및 테스트하고, 아티팩트를 Artifact Registry에 업로드하고, 출처 정보를 생성하고, Cloud Storage에 테스트 로그를 저장하는 방법을 설명합니다.

시작하기 전에

이 페이지의 안내에서는 Go에 익숙하다고 가정합니다. 또한 다음 사항도 적용됩니다.

서비스 계정 구성

이 문서의 예에서는 사용자 지정 서비스 계정을 사용합니다. Cloud Build에서 사용하는 서비스 계정을 만들려면 Google Cloud CLI에서 다음 명령어를 실행합니다.

gcloud iam service-accounts create cloud-build-go \
--description="Build and test Go applications" \
--display-name="Cloud Build Go" \
--project="PROJECT_ID"

Cloud Run에서 사용하는 기본 Compute 서비스 계정은 새 서비스 계정 역할을 할 권한이 필요합니다. 먼저 프로젝트에서 컴퓨팅 서비스 계정의 이름을 확인합니다.

gcloud iam service-accounts list --filter="email:-compute@developer.gserviceaccount.com"

그런 다음 서비스 계정 사용자 (roles/iam.serviceAccountUser) 역할을 부여합니다.

gcloud iam service-accounts add-iam-policy-binding \
COMPUTE_SERVICE_ACCOUNT_EMAIL  \
--member="serviceAccount:cloud-build-go@PROJECT_ID.iam.gserviceaccount.com" \
--role="roles/iam.serviceAccountUser"

COMPUTE_SERVICE_ACCOUNT_EMAIL을 이전 명령어로 출력된 기본 컴퓨팅 서비스 계정 이메일 주소로 바꿉니다.

IAM 권한 구성

필요한 권한이 있는지 확인합니다.

Cloud Build에서 빌드를 실행하는 데 필요한 권한을 얻으려면 관리자에게 빌드 서비스 계정에 대한 Cloud Build 서비스 계정 (roles/cloudbuild.builds.builder) IAM 역할을 부여해 달라고 요청하세요. 역할 부여에 대한 자세한 내용은 프로젝트, 폴더, 조직에 대한 액세스 관리를 참조하세요.

커스텀 역할이나 다른 사전 정의된 역할을 통해 필요한 권한을 얻을 수도 있습니다.

Artifact Registry에 빌드된 아티팩트를 저장하는 데 필요한 권한을 얻으려면 관리자에게 빌드 서비스 계정에 대한 Artifact Registry 작성자 (roles/artifactregistry.writer) IAM 역할을 부여해 달라고 요청하세요.

Logging에 테스트 로그를 저장하는 데 필요한 권한을 얻으려면 관리자에게 빌드 서비스 계정에 대한 스토리지 객체 생성자 (roles/storage.objectCreator) IAM 역할을 부여해 달라고 요청하세요.

Cloud Run에 애플리케이션을 배포하는 데 필요한 권한을 얻으려면 관리자에게 빌드 서비스 계정에 대한 Cloud Run 개발자 (roles/run.developer) IAM 역할을 부여해 달라고 요청하세요.

Go 빌드 구성

Docker Hub의 공개 golang 이미지는 Go 모듈을 사용한 빌드를 지원합니다. Cloud Build 구성 파일에서 이 이미지를 빌드 단계로 사용하면 이미지 내에서 go 명령어를 호출할 수 있습니다. 이 빌드 단계로 전달된 인수는 바로 golang 도구로 전달되어 이 이미지에 있는 모든 go 명령어를 실행할 수 있도록 합니다.

이 섹션에서는 cloud-build-samples Git 저장소에서 Go 앱의 예시 빌드 구성 파일을 만드는 방법을 보여줍니다. 빌드 구성 파일에는 앱을 빌드하고, 단위 테스트를 추가하고, 테스트가 통과한 후 앱을 배포하는 단계가 포함되어 있습니다.

예시 Go 애플리케이션을 빌드하려면 다음 단계를 따르세요.

  1. 단위 테스트 구성: 애플리케이션에 단위 테스트를 정의한 경우 빌드 단계에서 다음 필드를 추가하여 테스트를 실행하도록 Cloud Build를 구성할 수 있습니다.

    • name: 이 필드의 값을 golang로 설정하여 태스크에 Docker Hub의 Golang 이미지를 사용합니다.
    • entrypoint: 이 필드의 값을 /bin/bash로 설정합니다. 이렇게 하면 빌드 단계에서 직접 여러 줄로 구성된 bash 명령어를 실행할 수 있습니다.

    • args: 빌드 단계의 args 필드는 인수 목록을 가져와서 name 필드로 참조되는 이미지에 전달합니다. 다음 예시에서 args 필드는 다음에 대한 인수를 가져옵니다.

      • 테스트 로그 형식 지정 도구를 실행하여 테스트 로그 출력을 다운로드합니다.
      • 로그 출력을 인쇄합니다.
      • sponge.log에 테스트 결과를 저장합니다.

      • sponge.log의 결과를 JUNIT XML 파일로 출력합니다. JUNIT XML 파일의 이름은 해당 빌드와 연관된 커밋 ID의 짧은 버전을 사용하여 생성됩니다. 이후의 빌드 단계는 이 파일의 로그를 Cloud Storage에 저장합니다.

        steps:
  # Run tests and save to file
  - name: golang:1.23
    entrypoint: /bin/bash
    args:
      - -c
      - |
        go install github.com/jstemmer/go-junit-report/v2@latest
        2>&1 go test -timeout 1m -v ./... | /go/bin/go-junit-report -set-exit-code -iocopy -out ${SHORT_SHA}_test_log.xml

  2. Artifact Registry에 업로드: 구성 파일에서 goModules 필드를 사용하여 애플리케이션 경로 및 Go 저장소를 Artifact Registry에 지정합니다.

    # Upload Go module to artifact registry
artifacts:
  goModules:
    repositoryName: 'repositoryName'
    repositoryLocation: 'location'
    repositoryProjectId: 'projectId'
    sourcePath: 'sourcePath'
    modulePath: 'appPath'
    moduleVersion: 'version'

    다음 값을 바꿉니다.

    • repositoryName: Artifact Registry의 Go 저장소 이름입니다.
    • location: Artifact Registry에서 저장소의 위치입니다.
    • projectId: Artifact Registry 저장소가 포함된 프로젝트의 ID입니다. Google Cloud
    • sourcePath: 빌드의 워크스페이스에 있는 go.mod 파일의 경로입니다.
    • appPath: 패키징된 애플리케이션의 경로입니다.
    • version: v1.0.1과 같이 숫자와 점으로 된 형식의 애플리케이션 버전 번호입니다.

  3. 선택사항: 출처 생성 사용 설정

    Cloud Build는 지속적 통합 파이프라인을 보호하는 데 도움이 되도록 검증 가능한 소프트웨어 아티팩트에 대한 공급망 등급(SLSA) 빌드 출처 메타데이터를 생성할 수 있습니다.

    출처 생성을 사용 설정하려면 구성 파일의 options 섹션에 requestedVerifyOption: VERIFIED를 추가합니다.

    빌드가 완료되면 Artifact Registry에서 저장소 세부정보를 확인할 수 있습니다.

    또한 빌드 출처 메타데이터를 확인하고 출처를 검증할 수 있습니다.

  4. Cloud Storage에 테스트 로그 저장: 기존 버킷 위치 및 테스트 로그 경로를 지정하여 Cloud Storage에 테스트 로그를 저장하도록 Cloud Build를 구성할 수 있습니다.

    다음 빌드 단계는 JUNIT XML 파일에 저장한 테스트 로그를 Cloud Storage 버킷에 저장합니다.

    # Save test logs to Google Cloud Storage
artifacts:
  objects:
    location: gs://$_BUCKET_NAME/
    paths:
      - ${SHORT_SHA}_test_log.xml

    다음 스니펫은 위 단계의 전체 빌드 구성 파일을 보여줍니다.

      steps:
    # Run tests and save to file
    - name: golang:1.23
      entrypoint: /bin/bash
      args:
        - -c
        - |
          go install github.com/jstemmer/go-junit-report/v2@latest
          2>&1 go test -timeout 1m -v ./... | /go/bin/go-junit-report -set-exit-code -iocopy -out ${SHORT_SHA}_test_log.xml

  # Store golang modules in Google Artifact Registry
  artifacts:
    goModules:
      repositoryName: 'repositoryName'
      repositoryLocation: 'location'
      repositoryProject_id: 'projectId'
      sourcePath: 'sourcePath'
      modulePath: 'appPath'
      moduleVersion: 'version'

  5. gcloud CLI를 사용하여 빌드를 시작하거나 빌드 트리거를 만듭니다.

Google Cloud CLI 

 gcloud builds submit --region=us-west2 --config=cloudbuild.yaml \
     --substitutions=_AR_REPO_NAME="AR_REPO_NAME"

트리거 제작

빌드 트리거 만들기의 단계를 따르세요. 대체 변수 필드에서 아티팩트 레지스트리 저장소의 이름과 테스트 로그의 Cloud Storage 버킷 이름도 제공해야 합니다.

다음 단계