xielongdragon/gripmock

镜像概述

Gripmock Docker镜像是一个轻量级工具，旨在帮助开发者快速搭建gRPC模拟服务器。它允许用户通过提供gRPC服务的.proto文件，自动生成模拟服务器，无需编写实际后端代码即可定义服务接口和响应规则，适用于gRPC客户端的开发、测试和调试场景。

核心功能与特性

• 快速生成gRPC模拟服务器：基于提供的.proto文件自动生成完整的gRPC服务模拟实现，无需手动编写服务代码。
• 支持标准proto文件：兼容gRPC标准的.proto文件定义，直接使用现有服务描述文件即可启动模拟服务。
• 灵活的响应规则配置：支持通过简单的JSON配置文件定义请求匹配规则和响应内容，包括静态响应、动态模板、错误码返回等。
• 多端口支持：默认暴露两个端口（4770用于gRPC服务，4771用于管理接口），方便客户端连接和配置管理。
• 轻量级设计：镜像体积小，启动速度快，适合本地开发和CI/CD环境集成。

适用场景

• gRPC客户端开发测试：在后端服务未就绪时，前端/客户端开发者可通过Gripmock模拟服务接口，验证请求格式、数据处理逻辑。
• 集成测试环境：在CI/CD流程中作为临时后端服务，配合测试用例验证客户端与服务端的交互逻辑。
• 服务契约验证：基于proto文件定义的服务契约，快速验证客户端是否符合接口规范。
• 故障模拟：通过配置错误码响应，测试客户端对服务异常（如超时、错误码）的处理能力。

使用方法与配置说明

基本使用步骤

1. 准备proto文件：创建包含gRPC服务定义的.proto文件（如service.proto）。
2. 启动Gripmock容器：通过挂载proto文件目录和映射端口启动容器。

示例：启动Gripmock模拟服务器

1. 准备proto文件

创建protos目录并添加服务定义文件（如helloworld.proto）：

protobuf
syntax = "proto3";

package helloworld;

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply);
}

message HelloRequest {
  string name = 1;
}

message Reply {
  string message = 1;
}

2. 启动容器

通过以下命令启动Gripmock容器，挂载proto文件目录并映射端口：

bash
docker run -d \
  -v $(pwd)/protos:/protos \  # 挂载本地proto文件目录到容器内/protos
  -p 4770:4770 \              # 映射gRPC服务端口（默认4770）
  -p 4771:4771 \              # 映射管理接口端口（默认4771）
  --name gripmock-server \
  gripmock /protos/helloworld.proto

3. 配置响应规则（可选）

通过管理接口或JSON配置文件定义响应规则（如根据请求参数返回特定响应）。配置文件（如mock.json）示例：

json
{
  "HelloRequest": [
    {
      "when": { "name": "Alice" },
      "then": { "message": "Hello, Alice!" }
    },
    {
      "when": { "name": "Bob" },
      "then": { "message": "Hello, Bob!" }
    }
  ]
}

挂载配置文件到容器内/mocks目录：

bash
docker run -v $(pwd)/protos:/protos -v $(pwd)/mocks:/mocks -p 4770:4770 -p 4771:4771 gripmock /protos/helloworld.proto --mock-config /mocks/mock.json

端口说明

注意事项

• 确保挂载的.proto文件路径正确，容器内路径需与启动命令中指定的路径一致。
• 响应规则配置文件需符合JSON格式，键名需与proto文件中定义的消息名一致。
• 如需自定义端口，可通过-p参数映射宿主机端口到容器内4770/4771端口。