Gonkey 项目教程

1. 项目的目录结构及介绍

Gonkey 项目的目录结构如下：

gonkey/
├── cmd/
│   └── gonkey/
│       └── main.go
├── fixtures/
│   └── example_fixture.yaml
├── cases/
│   └── example_case.yaml
├── mocks/
│   └── example_mock.yaml
├── internal/
│   ├── fixtures/
│   │   └── loader.go
│   ├── mocks/
│   │   └── server.go
│   └── runner/
│       └── runner.go
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的启动文件，通常是 main.go。
• fixtures/: 存放测试数据文件，通常是 YAML 格式的文件。
• cases/: 存放测试用例文件，通常是 YAML 格式的文件。
• mocks/: 存放模拟服务的配置文件，通常是 YAML 格式的文件。
• internal/: 包含项目的内部实现代码，通常不对外公开。
  • fixtures/: 包含加载测试数据的实现代码。
  • mocks/: 包含模拟服务的实现代码。
  • runner/: 包含测试运行器的实现代码。
• go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。
• README.md: 项目的介绍文档。

2. 项目的启动文件介绍

Gonkey 项目的启动文件位于 cmd/gonkey/main.go。该文件是项目的入口点，负责初始化并启动 Gonkey 的测试运行器。

main.go 文件内容概览

package main

import (
    "github.com/lamoda/gonkey/runner"
    "github.com/lamoda/gonkey/mocks"
    "github.com/lamoda/gonkey/fixtures"
)

func main() {
    // 初始化模拟服务
    mocks.Init()
    
    // 加载测试数据
    fixtures.Load()
    
    // 运行测试用例
    runner.Run()
}

启动文件功能介绍

• 初始化模拟服务: 通过 mocks.Init() 初始化模拟服务，用于在测试过程中模拟外部服务的响应。
• 加载测试数据: 通过 fixtures.Load() 加载测试数据，这些数据通常用于填充数据库或配置文件。
• 运行测试用例: 通过 runner.Run() 运行测试用例，执行测试并生成测试报告。

3. 项目的配置文件介绍

Gonkey 项目的配置文件主要位于 fixtures/ 和 mocks/ 目录下，通常是 YAML 格式的文件。

fixtures/example_fixture.yaml 文件内容概览

inherits:
  - template1
  - template2
templates:
  keys:
    - $name: parentKeyTemplate
      values:
        baseKey:
          expiration: 1s
          value: 1
    - $name: childKeyTemplate
      $extend: parentKeyTemplate
      values:
        otherKey:
          value: 2

mocks/example_mock.yaml 文件内容概览

mocks:
  - name: exampleMock
    requestConstraints:
      method: GET
      path: /api/v1/example
    response:
      status: 200
      body: '{"status": "ok"}'

配置文件功能介绍

• fixtures/example_fixture.yaml: 定义测试数据的模板和继承关系，用于在测试前加载数据。
• mocks/example_mock.yaml: 定义模拟服务的请求约束和响应策略，用于在测试过程中模拟外部服务的响应。

通过这些配置文件，Gonkey 可以在测试过程中灵活地加载数据和模拟外部服务，确保测试的准确性和可靠性。