graze/cucumber-rest-bdd

Cucumber Rest BDD镜像

镜像概述

该镜像基于Cucumber框架，提供REST API端点的行为驱动测试（BDD）能力。它支持通过自然语言风格的测试用例验证API的功能正确性，可直接通过Docker运行，也可作为Gem包集成到现有测试流程中。

核心功能

• 支持REST API的CRUD操作（创建、检索、修改、删除）测试
• 通过环境变量配置测试行为（如基础URL、数据根键、字段命名规则等）
• 验证响应数据的属性类型（整数、字符串、数组、对象等）
• 支持嵌套对象和子资源的测试（通过路径或分隔符访问）
• 处理错误响应并忽略指定的错误键
• 保存和复用请求结果中的参数（如ID）

使用场景

• API开发阶段的功能验证
• 持续集成（CI）流程中的自动化测试
• API版本迭代的回归测试
• 团队协作中的API行为规范验证

配置说明

以下环境变量可调整测试行为：

• endpoint：API的基础URL（必填）
• data_key：响应数据的根键（如"data"表示响应为{"data": {...}}）
• error_key：错误响应的根键（忽略data_key的设置）
• field_separator：字段名的分隔符（默认下划线）
• field_camel：是否使用驼峰命名法（默认false）
• resource_single：资源名是否单数化（默认false）
• set_parent_id：创建子资源时自动添加父ID（默认false）

部署示例

Docker运行

bash
docker run --rm -v $(pwd):/opt/src -e endpoint=http://your-api-url graze/cucumber-rest-bdd

（注：将$(pwd)替换为本地测试用例所在目录，http://your-api-url替换为目标API地址）

测试用例示例

检索资源

gherkin
Given I am a client
When I request the post "1"
Then the request was successful
And the response has the following attributes:
    | attribute | type    | value |
    | User Id   | numeric | 1     |
    | Id        | numeric | 1     |
    | Title     | string  | sunt aut facere repellat provident occaecati excepturi optio reprehenderit |

创建资源

gherkin
Given I am a client
When I request to create a post with:
    | attribute | type    | value |
    | Title     | string  | foo   |
    | Body      | string  | bar   |
    | User Id   | numeric | 1     |
Then the request is successful and a post was created
And the response has the following attributes:
    | attribute | type    | value |
    | User Id   | numeric | 1     |
    | Title     | string  | foo   |
    | Body      | string  | bar   |