PostgreSQL을 사용하여 GitHub Actions에서 Go 애플리케이션에 대한 원활한 통합 테스트

소개

Go 애플리케이션이 데이터베이스와 같은 외부 종속성과 완벽하게 작동하는지 확인하려면 통합 테스트가 중요합니다. 이 블로그에서는 GitHub Actions를 사용하여 Go 애플리케이션에 대한 통합 테스트를 설정하고 실행하는 방법을 살펴보겠습니다. CI 파이프라인 내에서 PostgreSQL 데이터베이스를 구성하고, 테스트 프로세스를 간소화하며, 푸시할 때마다 코드베이스가 안정적이고 프로덕션 준비가 되어 있는지 확인합니다. 뛰어들어 보세요!.

여기 이전 기사에서 단위 테스트 및 통합을 만들었습니다!. 이 기사에서는 github 저장소에 대한 모든 커밋에 대해 이러한 테스트를 실행하려고 합니다.

Github 작업

빌드, 테스트, 배포 파이프라인을 자동화할 수 있는 CI/CD(지속적 통합 및 지속적 전달) 플랫폼입니다.
Github Actions를 사용하면 저장소에서 다른 이벤트가 발생할 때 워크플로를 실행할 수 있습니다

Github 워크플로

워크플로는 하나 이상의 작업을 실행하는 구성 가능한 자동화 프로세스입니다. 워크플로는 저장소에 체크인된 YAML 파일로 정의되며 저장소의 이벤트에 의해 트리거될 때 실행됩니다. 워크플로는 .github/workfows에 정의되어 있습니다.

• 이벤트는 워크플로 실행을 트리거하는 저장소의 특정 활동입니다. 우리의 경우 이는 우리 지점으로 푸시됩니다.
• 작업은 동일한 실행기에서 실행되는 워크플로의 일련의 단계입니다.
• Runners는 워크플로가 트리거될 때 이를 실행하는 서버입니다. 각 실행자는 한 번에 하나의 작업을 실행할 수 있습니다.

워크플로 Yaml

• 첫 번째 단계는 yaml 파일이 위치할 .github/workflows 폴더를 만드는 것입니다.
• 다음은 yaml 파일을 생성하는 것입니다. 이 경우 이름을 ci-test.yml로 지정하겠습니다.

name: ci-test

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

env:
  POSTGRES_USER: postgres
  POSTGRES_PASSWORD: Password123
  POSTGRES_DB: crud_db

jobs:
  build:
    name: tests
    runs-on: ubuntu-latest
    services:
      postgres:
        image: postgres
        env:
          POSTGRES_USER: ${{ env.POSTGRES_USER }}
          POSTGRES_PASSWORD: ${{ env.POSTGRES_PASSWORD }}
          POSTGRES_DB: ${{ env.POSTGRES_DB }}
        ports:
          - 5432:5432
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5

    steps:
      - uses: actions/checkout@v4

      - name: Set up Go
        uses: actions/setup-go@v4
        with:
          go-version: "1.22"

      - name: Install dbmate for golang migrations
        run: |
          sudo curl -fsSL -o /usr/local/bin/dbmate https://github.com/amacneil/dbmate/releases/latest/download/dbmate-linux-amd64
          sudo chmod +x /usr/local/bin/dbmate
          which dbmate

      - name: Construct DB URL
        id: construct_url
        run: echo "DB_URL=postgres://${{ env.POSTGRES_USER }}:${{ env.POSTGRES_PASSWORD }}@localhost:5432/${{ env.POSTGRES_DB }}?sslmode=disable" >> $GITHUB_ENV

      - run: env

      - name: Make Migrations
        run: make migrations URL=${{ env.DB_URL }}

      - name: Seed test DB
        run: go run db/seed.go

      - name: Test
        run: make test

Yaml 설명

• 첫 번째 부분은 이 경우 작업 이름을 ci-test로 지정하는 것입니다.

워크플로 트리거

• 두 번째 섹션에서는 트리거에 대해 설명합니다. 작업을 트리거하는 이벤트입니다. 이 파일에는 이 작업 실행을 트리거하는 두 가지 이벤트, 즉 기본 분기를 대상으로 하는 푸시 및 풀 요청이 있습니다. 이렇게 하면 프로덕션을 위한 모든 코드 변경 사항을 병합하기 전에 테스트하여 프로젝트의 무결성을 유지할 수 있습니다.

환경 변수

Github 워크플로는 전역 및 작업별 환경 변수를 지원합니다. 이 변수는 나중에 yaml 파일에서 사용할 postgres 자격 증명을 설명합니다.

직업

name: ci-test

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

env:
  POSTGRES_USER: postgres
  POSTGRES_PASSWORD: Password123
  POSTGRES_DB: crud_db

jobs:
  build:
    name: tests
    runs-on: ubuntu-latest
    services:
      postgres:
        image: postgres
        env:
          POSTGRES_USER: ${{ env.POSTGRES_USER }}
          POSTGRES_PASSWORD: ${{ env.POSTGRES_PASSWORD }}
          POSTGRES_DB: ${{ env.POSTGRES_DB }}
        ports:
          - 5432:5432
        options: >-
          --health-cmd pg_isready
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5

    steps:
      - uses: actions/checkout@v4

      - name: Set up Go
        uses: actions/setup-go@v4
        with:
          go-version: "1.22"

      - name: Install dbmate for golang migrations
        run: |
          sudo curl -fsSL -o /usr/local/bin/dbmate https://github.com/amacneil/dbmate/releases/latest/download/dbmate-linux-amd64
          sudo chmod +x /usr/local/bin/dbmate
          which dbmate

      - name: Construct DB URL
        id: construct_url
        run: echo "DB_URL=postgres://${{ env.POSTGRES_USER }}:${{ env.POSTGRES_PASSWORD }}@localhost:5432/${{ env.POSTGRES_DB }}?sslmode=disable" >> $GITHUB_ENV

      - run: env

      - name: Make Migrations
        run: make migrations URL=${{ env.DB_URL }}

      - name: Seed test DB
        run: go run db/seed.go

      - name: Test
        run: make test

여기서는 코드를 구축하고 테스트하는 핵심 작업을 수행할 작업에 이름을 지정했습니다.
러너 - Ubuntu 가상 머신인 워크플로가 실행되는 위치를 설명합니다.

서비스

Github Actions 워크플로를 사용하면 서비스를 정의할 수 있습니다. 이 경우 테스트를 실행할 postgres 데이터베이스가 필요합니다.

• PostgreSQL 컨테이너는 공식 PostgreSQL Docker 이미지를 사용하여 생성됩니다.
• 컨테이너는 앞서 선언한 환경 변수로 구성됩니다

워크플로 단계

• 첫 번째 단계는 저장소 코드를 체크아웃하는 것입니다.

jobs:
  build:
    name: tests
    runs-on: ubuntu-latest

이 줄은 저장소의 최신 버전을 가져와 모든 소스 파일에 대한 액세스를 제공합니다.

• 두 번째 단계는 러너에 golang을 설정하는 것입니다.

- uses: actions/checkout@v4

• 세 번째 단계는 러너에 dbmate를 설치하는 것입니다. Dbmate는 애플리케이션 마이그레이션을 관리하는 마이그레이션 도구입니다.

- name: Set up Go
  uses: actions/setup-go@v4
  with:
    go-version: "1.22"

• 넷째는 DB URL을 구성하는 것입니다.

- name: Install dbmate for golang migrations
  run: |
    sudo curl -fsSL -o /usr/local/bin/dbmate https://github.com/amacneil/dbmate/releases/latest/download/dbmate-linux-amd64
    sudo chmod +x /usr/local/bin/dbmate
    which dbmate

• 다섯 번째는 날짜가 포함된 관계를 설정하기 위해 DB 마이그레이션을 실행하는 것입니다.

- name: Construct DB URL
  id: construct_url
  run: echo "DB_URL=postgres://${{ env.POSTGRES_USER }}:${{ env.POSTGRES_PASSWORD }}@localhost:5432/${{ env.POSTGRES_DB }}?sslmode=disable" >> $GITHUB_ENV

• 두 번째 마지막 작업은 테스트 데이터로 데이터베이스를 시드하는 것입니다.

- name: Make Migrations
  run: make migrations URL=${{ env.DB_URL }}

seed.go 파일은 테스트 데이터로 데이터 에이스를 시드합니다. 현실적인 테스트 환경을 설정합니다. 이 파일을 더 자세히 검사하려면 여기를 방문하세요

마지막 단계는 make 파일을 사용하여 go 테스트를 실행하는 것입니다

- name: Seed test DB
  run: go run db/seed.go

이제 이 워크플로는 풀 요청을 하거나 메인 브랜치에 코드를 푸시할 때마다 실행됩니다

Github Action 채택의 몇 가지 장점.

우리가 본 것처럼 github 액션을 통해 다음을 수행할 수 있습니다.

1. 자동화된 테스트 - 코드가 변경될 때마다 일관되게 테스트를 실행합니다.
2. 데이터베이스 통합 보유 - 테스트 및 생산 조건 시뮬레이션을 위한 실제 Postgres 환경 제공
3. 재현 가능한 환경 - Github 작업은 컨테이너화된 서비스와 사전 정의된 단계를 사용하여 모든 실행에서 일관된 결과를 보장합니다.
4. 빠른 피드백 루프 - 문제가 발생하는 경우 개발자가 빠른 피드백을 받을 수 있어 더 빠른 문제 해결이 가능합니다.
5. 간단한 협업 - 코드 품질과 프로젝트 안정성을 유지하면서 모든 기여자의 변경 사항이 나타나기 전에 확인되도록 보장합니다

결론

이 워크플로는 GitHub Actions를 활용하여 테스트 및 데이터베이스 설정을 간소화하고 강력하고 안정적인 소프트웨어 개발을 보장합니다.
위에서 설명한 작업으로 테스트 중인 코드를 보려면 github 저장소를 방문하세요.

위 내용은 PostgreSQL을 사용하여 GitHub Actions에서 Go 애플리케이션에 대한 원활한 통합 테스트의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!