GitHub Actions 上的 Go 应用程序与 PostgreSQL 的无缝集成测试

介绍

集成测试对于确保您的 Go 应用程序与数据库等外部依赖项完美配合至关重要。在本博客中，我们将探讨如何使用 GitHub Actions 设置和运行 Go 应用程序的集成测试。我们将在 CI 管道中配置 PostgreSQL 数据库，简化测试流程，并确保您的代码库在每次推送时都是可靠且可投入生产的。让我们开始吧！.

我们在上一篇文章中创建了单元测试和集成！。在本文中，我们希望对 github 存储库的所有提交运行这些测试。

Github 操作

它们是一个持续集成和持续交付 (CI/CD) 平台，可让您自动化构建、测试和部署管道。
Github Actions 允许您在存储库中发生其他事件时运行工作流程

Github 工作流程

工作流程是一个可配置的自动化流程，将运行一个或多个作业。工作流由签入存储库的 YAML 文件定义，并在存储库中的事件触发时运行。工作流程在 .github/workfows 中定义。

• 事件 是存储库中触发工作流运行的特定活动。在我们的例子中，这将推动我们的分支。
• 作业 是在同一运行器上执行的工作流程中的一组步骤。
• Runners 是一个在触发工作流时运行工作流的服务器。每个运行程序一次只能运行一项作业。

工作流程 YAML

• 第一步是创建 .github/workflows 文件夹，我们的 yaml 文件将位于其中。
• 下一步是创建 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

在这里，我们为将执行核心任务的作业分配了一个名称，这些任务正在构建和测试我们的代码。
Runner - 描述工作流程将在 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

• 第五是运行数据库迁移来设置我们的关系，该关系将与日期一起播种

- 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 存储库以查看正在使用上述操作进行测试的代码。

以上是GitHub Actions 上的 Go 应用程序与 PostgreSQL 的无缝集成测试的详细内容。更多信息请关注PHP中文网其他相关文章！