如何配置Karate UI测试录像功能并获取测试执行视频

原有配置失效原因 #

videoFile不属于driver初始化的全局参数，直接写在driver配置项中不会生效，该参数为单场景自定义文件名时的配置项，全局录像需要单独配置开关和存储路径。

正确配置步骤 #

• 前置要求：确保使用的Karate版本为1.0及以上，旧版本无原生录像支持
• 第一步：在config.js中添加全局录像配置，示例如下：

function fn() {
  var config = {
    // 其余原有全局配置项保留即可
  };
  // 开启全局录像，所有UI测试场景默认自动录像
  karate.configure('video', true);
  // 配置录像存储根目录，需提前手动创建该目录，否则录像生成失败
  karate.configure('videoDir', 'src/test/java/examples/users/videos');
  // driver配置无需添加videoFile参数，可按需配置录像帧率
  karate.configure('driver', { 
    type: 'chromedriver', 
    executable: 'src/test/java/examples/users/chromedriver.exe',
    // 可选参数，录像帧率，默认值为10
    videoFps: 15
  });
  return config;
}

• 第二步：单场景自定义配置（可选，可覆盖全局设置）
  • 关闭单场景录像：在场景代码开头添加 * configure video = false
  • 自定义单场景录像文件名：在driver启动后添加 * driver.videoFile = '自定义文件名.webm'，文件会自动保存到全局配置的videoDir路径下

注意事项 #

• 配置的videoDir路径必须提前手动创建，Karate不会自动生成不存在的目录
• 生成的录像默认格式为webm，以场景ID+时间戳命名
• 测试正常结束后才会完整保存录像，强制中断进程会导致录像文件损坏

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