如何使用 Grunt 和 Mocha 以 mtime 顺序运行单元测试

Question

所以当您执行 TDD 时，您是否会等待它运行所有测试，直到您正在处理的测试？这需要太多时间。当我赶时间时，我将测试文件重命名为 aaaaaaaaaaaaaaa_testsomething.test.js 之类的文件，这样它会先运行，然后我会尽快看到错误。

我不喜欢这种方法，我确信有解决方案，但我找不到。那么使用 Mocha 以 mtime 顺序运行单元测试的最简单方法是什么？有 -sort 选项，但它仅按名称对文件进行排序。如何按修改时间对它们进行排序？

这是我的 Gruntfile.js：

module.exports = function(grunt) {

  grunt.initConfig({
    watch: {
      tests: {
        files: ['**/*.js', '!**/node_modules/**'],
        tasks: ['mochacli:local']
      }
    },
    mochacli: {
      options: {
        require: ['assert'],
        reporter: 'spec',
        bail: true,
        timeout: 6000,
        sort: true,
        files: ['tests/*.js']
      },
      local: {
        timeout: 25000
      }
    }
  });

  
  grunt.loadNpmTasks('grunt-mocha-cli');
  grunt.loadNpmTasks('grunt-contrib-watch');

  grunt.registerTask('test', ['mochacli:local']);
  grunt.registerTask('livetests', [ 'watch:tests']);

};

注意：它不是重复的。我不想每次保存源代码文件时都编辑我的测试或 Gruntfile.js。我在问如何修改 Grunt 任务，以便它首先从上次修改的 *.test.js 文件运行测试。如标题中所述，按 mtime 对单元测试进行排序。

简单场景：我在编辑器中打开 test1.test.js，更改它，按 Ctrl+B，它会从 test1.test.js 然后 test4.test.js 运行单元测试。我打开 test4.test.js，按 Ctrl+S、Ctrl+B 并从 test4.test.js 然后 test1.test.js 运行测试

我正在考虑一些 Grunt 插件来首先对文件进行排序，所以我可以将它的结果放在带有 grunt.config.set('mochacli.options.files', 'tests/recent.js,tests/older.js', ....); 的 'tests/*.js' 中，但我在那里找不到任何可以用作中间件的东西，不想发明自行车，因为我确信已经实现了一些东西。

Answer 1

不想发明自行车，因为我确信已经实现了一些东西。

...有时你必须骑自行车；）

---

解决方案

这可以通过在您的Gruntfile.js 中注册一个中间custom-task 来动态执行以下操作来实现：

1. 使用 grunt.file.expand 和适当的 globbing 模式获取所有单元测试文件 (.js) 的文件路径。
2. 按文件mtime/modified-date 对每个匹配的文件路径进行排序。
3. 使用grunt.config 配置具有按时间顺序排列的文件路径的mochacli.options.file 数组
4. 使用grunt.task.run运行mochacli任务中定义的localTarget

---

Gruntfile.js

如下配置您的Gruntfile.js：

module.exports = function(grunt) {

  // Additional built-in node module.
  var statSync = require('fs').statSync;

  grunt.initConfig({
    watch: {
      tests: {
        files: ['**/*.js', '!**/node_modules/**', '!Gruntfile.js'],
        tasks: ['runMochaTests']
      }
    },
    mochacli: {
      options: {
        require: ['assert'],
        reporter: 'spec',
        bail: true,
        timeout: 6000,
        files: [] // <-- Intentionally empty, to be generated dynamically.
      },
      local: {
        timeout: 25000
      }
    }
  });

  grunt.loadNpmTasks('grunt-mocha-cli');
  grunt.loadNpmTasks('grunt-contrib-watch');

  /**
   * Custom task to dynamically configure the `mochacli.options.files` Array.
   * All filepaths that match the given globbing pattern(s), which is specified
   # via the `grunt.file.expand` method, will be sorted chronologically via each
   * file(s) latest modified date (i.e. mtime).
   */
  grunt.registerTask('runMochaTests', function configMochaTask() {
    var sortedPaths = grunt.file.expand({ filter: 'isFile' }, 'tests/**/*.js')
      .map(function(filePath) {
        return {
          fpath: filePath,
          modtime: statSync(filePath).mtime.getTime()
        }
      })
      .sort(function (a, b) {
        return a.modtime - b.modtime;
      })
      .map(function (info) {
        return info.fpath;
      })
      .reverse();

    grunt.config('mochacli.options.files', sortedPaths);
    grunt.task.run(['mochacli:local']);
  });

  grunt.registerTask('test', ['runMochaTests']);
  grunt.registerTask('livetests', [ 'watch:tests']);

};

---

附加说明

使用上面的配置。通过 CLI 运行 $ grunt livetests，然后保存修改后的测试文件将导致 Mocha 根据文件上次修改日期按时间顺序运行每个测试文件（即最近修改的文件将首先运行并且最后修改的文件将最后运行）。同样的逻辑也适用于运行$ grunt test。

但是，如果您希望 Mocha 首先运行最近修改的文件，然后按正常顺序（即按名称）运行其他文件，然后在 @987654338 中自定义 runMochaTests 任务上面的@应该替换为以下逻辑：

/**
 * Custom task to dynamically configure the `mochacli.options.files` Array.
 * The filepaths that match the given globbing pattern(s), which is specified
 # via the `grunt.file.expand` method, will be in normal sort order (by name).
 * However, the most recently modified file will be repositioned as the first
 * item in the `filePaths` Array (0-index position).
 */
grunt.registerTask('runMochaTests', function configMochaTask() {
  var filePaths = grunt.file.expand({ filter: 'isFile' }, 'tests/**/*.js')
    .map(function(filePath) {
      return filePath
    });

  var latestModifiedFilePath = filePaths.map(function(filePath) {
      return {
        fpath: filePath,
        modtime: statSync(filePath).mtime.getTime()
      }
    })
    .sort(function (a, b) {
      return a.modtime - b.modtime;
    })
    .map(function (info) {
      return info.fpath;
    })
    .reverse()[0];

  filePaths.splice(filePaths.indexOf(latestModifiedFilePath), 1);
  filePaths.unshift(latestModifiedFilePath);

  grunt.config('mochacli.options.files', filePaths);
  grunt.task.run(['mochacli:local']);
});

Answer 2

如果您使用的是 mocha，您可以在您感兴趣的测试上设置 .only：

describe(function () {
  // these tests will be skipped
});
describe.only(function () {
  // these tests will run
})