Mock Resource 镜像文档

镜像概述和主要用途

概述

Mock Resource 是一个用于测试资源（及资源类型）操作的 Docker 镜像，旨在模拟资源交互过程，无需依赖外部环境或真实服务。

主要用途

提供独立的资源操作模拟环境，支持开发、测试阶段对资源类型插件、资源交互逻辑的验证，尤其适用于需要隔离外部依赖的场景。

核心功能和特性

• 资源操作模拟：支持模拟资源的常见操作（如获取、创建、更新、删除等），返回预定义或自定义响应。
• 无外部依赖：独立运行，不依赖外部服务、API 或数据库，确保测试环境的一致性和稳定性。
• 灵活配置：可通过配置文件或环境变量自定义模拟行为，支持模拟成功、失败及异常响应场景。
• 轻量高效：基于轻量级基础镜像构建，启动快速，资源占用低，适合集成到自动化测试流程。
• Concourse CI 集成：针对 Concourse CI/CD 流水线设计（源自 concourse/mock-resource 项目），可直接用于测试 Concourse 资源类型插件。

使用场景和适用范围

• Concourse CI 插件测试：在 Concourse CI/CD 流水线中，验证自定义资源类型插件的交互逻辑（如版本检查、资源获取、输出生成等）。
• 资源交互逻辑验证：单元测试或集成测试中，模拟外部资源（如 API 服务、文件存储、数据库）的交互行为，验证业务逻辑对资源响应的处理能力。
• 开发环境替代：开发阶段替代真实资源服务，避免因外部资源不可用、权限限制或数据安全问题影响开发进度。
• 异常场景测试：模拟网络超时、权限错误、数据格式异常等边缘情况，验证系统的容错和错误处理机制。

详细的使用方法和配置说明

基础使用流程

1. 拉取镜像
   从 Docker Hub 或源码仓库构建镜像：

   docker pull concourse/mock-resource:latest
   

2. 启动容器
   通过 docker run 命令启动容器，支持挂载配置文件或设置环境变量自定义行为。

3. 配置模拟规则
   通过配置文件定义模拟响应，或通过环境变量调整基础行为（如日志级别、配置路径等）。

配置方式

配置文件

支持通过挂载配置文件自定义模拟行为，配置文件需定义资源操作（如 get、create、update）的响应内容、状态码等。
示例配置文件（路径：./config/mock-config.yml，具体格式以源码文档为准）：

resources:
  - name: test-resource  # 资源名称
    actions:             # 支持的操作列表
      get:               # 模拟资源获取操作
        response: '{"version": "1.0.0", "data": "mock-payload"}'  # 响应内容
        status: 200                                                # 响应状态码
      create:            # 模拟资源创建操作
        response: '{"error": "duplicate resource"}'                # 模拟失败响应
        status: 409                                                # 失败状态码

环境变量

可通过环境变量调整基础行为（具体支持的变量请参考官方源码文档），常见变量包括：

• MOCK_CONFIG_PATH：自定义配置文件路径（默认：/config/mock-config.yml）。
• LOG_LEVEL：日志级别（可选：debug、info、warn、error，默认：info）。
• PORT：服务监听端口（若提供 HTTP 接口，默认可能为 8080）。

Docker 部署方案示例

1. 使用 docker run 启动

基础启动（默认配置）

docker run -d --name mock-resource concourse/mock-resource:latest

挂载自定义配置

docker run -d --name mock-resource \
  -v $(pwd)/config:/config  # 挂载本地配置目录至容器内 /config
  -e MOCK_CONFIG_PATH=/config/mock-config.yml  # 指定自定义配置文件路径
  -e LOG_LEVEL=debug  # 开启调试日志
  concourse/mock-resource:latest

2. 使用 docker-compose 部署

创建 docker-compose.yml：

version: '3'
services:
  mock-resource:
    image: concourse/mock-resource:latest
    container_name: mock-resource
    volumes:
      - ./config:/config  # 挂载本地配置目录
    environment:
      - MOCK_CONFIG_PATH=/config/mock-config.yml  # 自定义配置文件路径
      - LOG_LEVEL=info  # 日志级别
    # 若镜像提供 HTTP 服务，可映射端口（示例）
    # ports:
    #   - "8080:8080"

启动服务：

docker-compose up -d

注意事项

• 详细配置参考：本文档基于项目概述及常见 mock 工具特性整理，具体配置参数、行为规则及高级用法请参考官方源码仓库文档：[***]
• 版本兼容性：建议使用指定版本标签（如 :v1.0.0）而非 latest，以确保环境一致性。
• 日志调试：通过 LOG_LEVEL=debug 开启调试日志，便于排查配置或模拟行为问题。