使用节点检查器调试 Jest 测试用例

Question

有没有办法使用节点检查器来调试带有 Jest 的单元测试？有时可以逐步了解测试失败的原因

我尝试了几种方法

node-debug jest --runInBand 

从以及首先启动检查器，例如

$ node-inspector
$ node --debug-brk .\node_modules\jest-cli --runInBand

然后导航到http://127.0.0.1:8080/debug?port=5858

我发现偶尔（大约 10 次中的 1 次），调试器会打开 jest src 文件并且可以调试它们。不过，一般来说，调试器中的脚本只包含一个“无域”文件夹和另一个不相关的文件夹。 此外，测试脚本本身也不会加载到调试器中。

以前有人试过吗？

Answer 1

看起来问题在于jest 正在使用harmonize，它会生成一个子进程以确保使用--harmony 选项。

harmonize/harmonize.js，第 30-35 行

var node = child_process.spawn(process.argv[0], ['--harmony'].concat(process.argv.slice(1)), {});
node.stdout.pipe(process.stdout);
node.stderr.pipe(process.stderr);
node.on("close", function(code) {
    process.exit(code);
});

通过注释掉 jest 用于生成协调进程的代码，我能够成功调试 jest 测试（尽管 tests that use JSX transforms are incredibly slow）。

node_modules/jest-cli/bin/jest.js，文件最后几行：

if (require.main === module) {
  //harmonize();                  <--- comment out
  _main(function (success) {
    process.exit(success ? 0 : 1);
  });
}

然后就可以运行了：

$ node-debug --nodejs --harmony ./node_modules/jest-cli/bin/jest.js --runInBand

Jest 依赖于存在的--harmony 标志，因此我们需要使用--nodejs --harmony 将其添加回来。我们还添加了--runInBand，以便测试按顺序运行，而不是并行运行。

这将打开 Web 调试器，您可以调试测试，尽管到达您想要的测试可能会很慢。如果有人知道如何使这更快，请发表评论，我会更新我的答案。

您可以将其添加到您的 package.json 以更轻松地开始：

...
    scripts: {
        "test": "jest",
        "test-debug": "node-debug --nodejs --harmony ./node_modules/jest-cli/bin/jest.js --runInBand"
    }
...

当然，这个解决方案的主要关注点是编辑jest 源代码。将考虑如何提出拉取请求以使其坚持下去。

在此处创建 Github 问题：https://github.com/facebook/jest/issues/152

Answer 2

现在正式支持 Node >= 6.3。
引用Jest documentation:

在您的任何测试中放置 debugger; 语句，然后在您的项目目录中运行：

node --debug-brk --inspect ./node_modules/.bin/jest -i [any other arguments here]

这将输出一个您可以在 Chrome 中打开的链接。打开该链接后，将显示 Chrome 开发人员工具，并在 Jest CLI 脚本的第一行设置断点（这样做只是为了让您有时间打开开发人员工具并防止 Jest 在您之前执行有时间这样做）。单击屏幕右上角看起来像“播放”按钮的按钮以继续执行。当 Jest 执行包含 debugger 语句的测试时，执行将暂停，您可以检查当前范围和调用堆栈。

注意：-i cli 选项确保 Jest 在同一进程中运行测试，而不是为单个测试生成进程。通常 Jest 会跨进程并行测试运行，但很难同时调试多个进程。

关于 V8 检查器的更多信息可以在这里找到：https://nodejs.org/api/debugger.html#debugger_v8_inspector_integration_for_node_js

Answer 3

使用 Node 7.4.0、Jest 18.x 和 jest-environment-node-debug 包（来自 this comment），现在可以使用 chrome devtools 来调试 Jest 测试：

$ npm install -D jest-environment-node-debug
$ node --inspect-brk ./node_modules/.bin/jest -i --env jest-environment-node-debug

Answer 4

这是一个 Gruntfile.js 配置，用于使用 Grunt 自动化 @Sean 的回答。

grunt testd

或

grunt testd --tests=MyTestName

或

grunt testd --tests=MyTestName,AnotherTestName

需要“node-inspector”（必须全局安装才能在您的路径中获取 node-debug bin）、“lodash”、“jest-cli”和“grunt-shell”节点模块。

var _ = require('lodash');

var commaSplitToRegex = function(input) {
  return _.map(input.split(','), function(part) {
    return '(' + part + ')';
  }).join('|');
};

var getTestRegex = function(tests) {
  if (tests) {
    return '.*' + commaSplitToRegex(tests) + '.*';
  }

  return '.*';
}

module.exports = function(grunt) {
  grunt.loadNpmTasks('grunt-shell');

  grunt.initConfig({
    shell: {
      jestd: {
        command: function() {
          var testsRegex = getTestRegex(grunt.option('tests'));
          var cmd = 'node-debug --nodejs --harmony ./node_modules/jest-cli/bin/jest.js --runInBand --config="test_utils/jest.json"';

          if (testsRegex) {
            cmd += ' "' + testsRegex + '"';
          }

          return cmd;
        }
      },
      monkeypatchjest: {
        command: 'sed -i.bak s\\/harmonize\\(\\)\\;\\/\\\\/\\\\/wtf\\/g ./node_modules/jest-cli/bin/jest.js'
      },
      unmonkeypatchjest: {
        command: 'sed -i.bak s\\/\\\\/\\\\/wtf\\/harmonize\\(\\)\\;\\/g ./node_modules/jest-cli/bin/jest.js'
      }
    }
  });

  grunt.registerTask('testd', 'Run tests with debugger.', ['shell:monkeypatchjest', 'shell:jestd']);
};