如何在基于TestNG的Java测试中调用Cypress测试用例？

核心逻辑说明：Rest-Assured是Java技术栈工具，Cypress是Node.js技术栈工具，二者的集成本质是在Java代码中启动子进程调用Cypress的执行命令，待Cypress用例执行完成后，再运行后续的Rest-Assured接口校验逻辑。

前置准备 #

• 本地/执行环境同时安装符合版本要求的JDK（匹配Rest-Assured项目依赖）、Node.js（匹配Cypress项目依赖）
• Cypress项目已完成依赖安装（在Cypress项目根目录执行过npm install），单独执行指定Cypress用例可以正常运行
• 提前整理好需要被Rest-Assured项目调用的Cypress用例，可单独存放在指定的spec目录（例如cypress/e2e/external-trigger/），保证用例可独立执行、无上下文依赖

具体实现步骤 #

1. Java侧调用Cypress执行命令 #

使用Java的ProcessBuilder类启动子进程执行Cypress无头运行命令，示例代码如下：

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.Scanner;

public class CypressTrigger {
    public int runCypressSpec(String specPath) throws IOException, InterruptedException {
        // 构造Cypress执行命令，按需替换参数
        ProcessBuilder pb = new ProcessBuilder(
                "npx", "cypress", "run",
                "--spec", specPath, // 指定要执行的用例文件路径
                "--env", "testEnv=staging,userId=123" // 可选：传递环境变量给Cypress
        );
        // 指定Cypress项目的根目录，替换为你本地的实际路径
        pb.directory(new File("/path/to/your/cypress/project/root"));
        // 把Cypress的日志输出到Java控制台，方便排查问题
        pb.redirectErrorStream(true);
        Process process = pb.start();
        
        // 打印Cypress执行日志
        try (InputStream is = process.getInputStream();
             Scanner scanner = new Scanner(is, "UTF-8")) {
            while (scanner.hasNextLine()) {
                System.out.println("[Cypress Log] " + scanner.nextLine());
            }
        }
        
        // 等待Cypress执行完成，返回退出码：0=执行成功，非0=执行失败
        return process.waitFor();
    }
}

2. 执行Rest-Assured校验逻辑 #

在Cypress执行成功后，直接编写原有Rest-Assured接口校验逻辑即可，示例如下：

import io.restassured.RestAssured;
import static io.restassured.RestAssured.given;
import static org.hamcrest.Matchers.equalTo;

public class ApiTestAfterCypress {
    public void verifyApiResult() {
        RestAssured.baseURI = "https://your-test-api.com";
        // 执行接口请求校验Cypress操作后的结果
        given()
            .header("Authorization", "Bearer your-token")
        .when()
            .get("/user/123/operation-result")
        .then()
            .statusCode(200)
            .body("status", equalTo("success"))
            .body("operationCount", equalTo(1));
    }
}

3. 串联执行逻辑 #

把两个步骤串联到测试用例中即可：

import org.testng.Assert;
import org.testng.annotations.Test;

@Test
public void cypressAndApiIntegrationTest() throws IOException, InterruptedException {
    CypressTrigger cypressTrigger = new CypressTrigger();
    int exitCode = cypressTrigger.runCypressSpec("cypress/e2e/external-trigger/test-spec.cy.js");
    // 如果Cypress执行失败，直接终止测试
    Assert.assertEquals(exitCode, 0, "Cypress用例执行失败");
    
    // Cypress执行成功后执行API校验
    ApiTestAfterCypress apiTest = new ApiTestAfterCypress();
    apiTest.verifyApiResult();
}

注意事项 #

• 路径配置：必须正确指定Cypress项目根目录，否则会出现找不到cypress.config.js配置文件、用例路径不存在的报错
• 数据隔离：被调用的Cypress用例要做好数据前置清理，避免残留数据影响后续Rest-Assured的校验结果
• 超时控制：可以给进程添加超时判断，避免Cypress执行卡住导致整个Java测试任务挂起，可使用process.waitFor(30, TimeUnit.MINUTES)设置最大等待时间
• 结果校验：除了判断退出码，也可以让Cypress执行后生成JSON格式的测试报告，Java侧读取报告内容获取更详细的用例执行结果，判断是否符合预期
• 跨环境适配：Windows环境下执行命令需要调整ProcessBuilder的参数，改为new ProcessBuilder("cmd.exe", "/c", "npx cypress run ......")，避免系统找不到npx命令

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