如何使用Karate契约测试处理多API版本兼容测试？

作为Karate契约测试新手，你已经基于Spring Boot应用编写了基础测试用例，要实现当前版本、过往及所有支持旧版本的API测试，可按以下步骤操作：

1. 版本化管理OpenAPI规范文件 #

先把不同版本的OpenAPI规范、请求/响应示例按版本号分类存放，比如：

schemas/
├─ v1/
│  ├─ filtering.json
│  ├─ valid-request.json
│  └─ invalid-request.json
├─ v2/
│  └─ ...（同v1结构）
└─ v3/
   └─ ...（同v1结构）

这样能清晰区分各版本的Schema定义和测试数据。

2. 参数化复用测试用例 #

利用Karate的数据驱动测试特性，用版本号作为参数，复用核心测试逻辑，不用重复编写测试代码：

改造后的.feature测试文件 #

Background:
  * call read('docker-operations.feature')
  # 从外部参数或默认值获取API版本
  * def apiVersion = karate.properties['api.version'] ?: 'v3'
  # 读取对应版本的API地址（如果不同版本部署在不同地址，可扩展参数）
  * url 'http://localhost:8080'
  * def path = 'myController/filter'
  # 加载对应版本的OpenAPI规范
  * def openApiSpec = read('schemas/' + apiVersion + '/filtering.json')
  * def requestSchema = openApiSpec.components.schemas.filtering_request
  * def responseSchema = openApiSpec.components.schemas.filtering_200_response
  * def requestSchemaString = karate.toString(requestSchema)
  * def responseSchemaString = karate.toString(responseSchema)
  # 加载对应版本的测试数据
  * def validRequest = read('schemas/' + apiVersion + '/valid-request.json')
  * def invalidRequest = read('schemas/' + apiVersion + '/invalid-request.json')
  * def invalidResponse = read('schemas/' + apiVersion + '/invalid-response.json')

Scenario Outline: 验证<version>版本API的合法响应
  Given path path
  And request validRequest
  When method POST
  Then status 200
  * def responseString = karate.toString(response)
  And assert Java.type('feature.JsonValidator').isValid(responseSchemaString, responseString)

# 列出所有需要测试的版本
Examples:
  | version |
  | v1      |
  | v2      |
  | v3      |

灵活控制测试范围 #

如果只想测试单个版本，不用修改测试文件，直接通过命令行传入参数即可：

mvn test -Dapi.version=v2

3. 适配多版本API部署（可选） #

如果不同版本的API部署在不同端口或域名，只需扩展参数化逻辑：

• 在Examples表格中增加apiUrl列：

Examples:
  | version | apiUrl               |
  | v1      | http://localhost:8081 |
  | v2      | http://localhost:8082 |
  | v3      | http://localhost:8080 |

• 在Background中替换url配置：

* url apiUrl

4. 结合Maven批量执行测试 #

如果需要像Spring Cloud那样通过Maven批量触发多版本测试，可在pom.xml中配置多Profile或批量执行任务：

pom.xml配置示例 #

<profiles>
    <profile>
        <id>api-v1</id>
        <properties>
            <api.version>v1</api.version>
        </properties>
    </profile>
    <profile>
        <id>api-v2</id>
        <properties>
            <api.version>v2</api.version>
        </properties>
    </profile>
    <profile>
        <id>api-all</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <build>
            <plugins>
                <plugin>
                    <groupId>com.intuit.karate</groupId>
                    <artifactId>karate-maven-plugin</artifactId>
                    <version>${karate.version}</version>
                    <executions>
                        <execution>
                            <id>test-v1</id>
                            <goals>
                                <goal>test</goal>
                            </goals>
                            <configuration>
                                <systemPropertyVariables>
                                    <api.version>v1</api.version>
                                </systemPropertyVariables>
                            </configuration>
                        </execution>
                        <execution>
                            <id>test-v2</id>
                            <goals>
                                <goal>test</goal>
                            </goals>
                            <configuration>
                                <systemPropertyVariables>
                                    <api.version>v2</api.version>
                                </systemPropertyVariables>
                            </configuration>
                        </execution>
                        <execution>
                            <id>test-v3</id>
                            <goals>
                                <goal>test</goal>
                            </goals>
                            <configuration>
                                <systemPropertyVariables>
                                    <api.version>v3</api.version>
                                </systemPropertyVariables>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>
    </profile>
</profiles>

执行命令 #

• 执行所有版本测试：

mvn test -Papi-all

• 执行单个版本测试：

mvn test -Papi-v1

内容的提问来源于stack exchange，提问作者user22504890