StrykerJS中使用Vitest测试运行器的完整指南

StrykerJS中使用Vitest测试运行器的完整指南

stryker-js Mutation testing for JavaScript and friends 项目地址: https://gitcode.com/gh_mirrors/st/stryker-js

前言

StrykerJS是一个强大的变异测试框架，用于评估测试套件的质量。本文将详细介绍如何在StrykerJS中使用Vitest作为测试运行器，帮助开发者更高效地进行变异测试。

什么是Vitest运行器

Vitest是一个基于Vite的快速单元测试框架，与StrykerJS结合使用时，可以提供更快的测试执行速度。从StrykerJS v7.0版本开始，官方提供了@stryker-mutator/vitest-runner插件，使两者能够无缝集成。

安装与配置

安装步骤

1. 首先需要安装Vitest运行器插件：

npm install --save-dev @stryker-mutator/vitest-runner

2. 由于插件采用"自带测试运行器"（BYOR）模式，您还需要单独安装Vitest：

npm install --save-dev vitest

注意：请确保安装的Vitest版本满足插件的最低要求。

基础配置

在StrykerJS的配置文件（通常是stryker.config.json或stryker.config.js）中，进行如下配置：

{
  "testRunner": "vitest",
  "vitest": {
    "configFile": "vitest.config.js",
    "dir": "packages"
  }
}

配置选项详解

1. configFile（可选）：

   • 类型：string
   • 默认值：undefined
   • 说明：指定Vitest的配置文件路径。如果不指定，Vitest会自动在项目根目录查找vitest.config.js或vitest.config.ts文件。

2. dir（可选，自v7.1起）：

   • 类型：string
   • 默认值：undefined
   • 说明：相当于Vitest CLI的--dir选项，指定测试运行的目录。

强制配置项

StrykerJS会自动设置以下Vitest选项，这些配置无法被覆盖：

{
  threads: true,
  coverage: { enabled: false },
  singleThread: true,
  watch: false,
  bail: options.disableBail ? 0 : 1,
  onConsoleLog: () => false,
}

这些强制配置的原因如下：

1. 单线程运行：虽然设置为threads: true，但实际会以单线程运行，因为StrykerJS使用自己的并行工作器机制来优化性能。

2. 快速失败：默认情况下，测试会在第一个失败时停止（除非显式设置disableBail: true），这可以显著提高变异测试的效率。

3. 禁用覆盖率报告：StrykerJS使用自己的覆盖率分析机制，因此需要禁用Vitest内置的覆盖率收集。

源代码内测试支持

Vitest的源代码内测试（In-source testing）功能在StrykerJS中完全支持。但由于测试代码和被测代码位于同一文件中，需要特别注意防止测试代码被变异。

最佳实践

在测试代码块前添加StrykerJS的禁用注释：

export function add(...args: number[]) {
  return args.reduce((a, b) => a + b, 0)
}

// Stryker disable all: Unit tests start here
if (import.meta.vitest) {
  const { it, expect } = import.meta.vitest
  it('add', () => {
    expect(add(1, 2, 3)).toBe(6)
  })
}

当前限制

使用Vitest运行器时需要注意以下限制：

1. 线程模式：目前仅支持threads: true模式，如果需要禁用线程模式，需要提交功能请求。

2. 浏览器模式：Vitest的浏览器模式目前不受支持。

3. 覆盖率分析：无论配置如何，插件总是使用"perTest"级别的覆盖率分析，这是性能最优的选择。

性能优化建议

1. 合理设置disableBail选项：在开发初期可以设为false快速发现问题，稳定后可设为true进行全面测试。

2. 使用.stryker-tmp目录：确保将其添加到.gitignore中，避免临时文件干扰版本控制。

3. 针对大型项目，考虑分模块运行测试，利用dir配置项提高效率。

总结

StrykerJS与Vitest的结合为JavaScript/TypeScript项目的变异测试提供了高效的解决方案。通过本文的介绍，您应该已经掌握了配置和使用的基本方法。在实际项目中，建议根据项目规模和特点，灵活调整配置参数，以获得最佳的测试效果和性能平衡。

stryker-js Mutation testing for JavaScript and friends 项目地址: https://gitcode.com/gh_mirrors/st/stryker-js