mocha-list-tests

List all mocha suites and tests without running them.

This is a standalone mocha-compatible companion, with no dependencies (not even mocha), to get a parseable json list of all suites and tests that would be executed in a folder.

The purpose of listing suites/tests might differ from project to project. I wanted it in order to parallelize some integration tests across multiple machines.

This script would be useful as long as this functionality is not included in mocha itself. At the time of this writing (2018), there seems to be no motivation to do so, since a patch was submitted in the past and rejected.

Install

  npm install --save-dev mocha-list-tests

Usage

Programmatically (require)

let mochaListTests = require('mocha-list-tests')
let result = mochaListTests.findSuitesAndTests ('./test-folder/')

console.log (result.suites)
console.log (result.tests)
console.log (result.tree)
console.log (result.extended_tree)

Command-line interface (shell)

To get a list of all suites and tests, just run:

  node ./node_modules/mocha-list-tests/mocha-list-tests.js your-test-dir/

Output will be a valid json, although there is some data in this example that has been removed for simplification purposes:

{
  "suites": [
    "suite-1",
    "suite-2",
    "suite-2.suite-2.1",
    "suite-3",
    ...
  ],

  "tests": [
    "test-0",
    "suite-1.test-1",
    "suite-2.suite-2.1.test-2.1.1",
    "suite-3.test-3.1",
    ...
  ],

  "tree": {
    "test-0": "test/example.js:3",
    "suite-1": {
      "test-1": "test/example.js:8"
    },
    "suite-2": {
      "suite-2.1": {
        "test-2.1.1": "test/example.js:15"
      }
    },
    ...
  },

  "extended_tree": {
    "test-0": {
      "type": "it",
      "file": "test/example.js",
      "line": 3
    },
    "suite-1": {
      "type": "describe",
      "file": "test/example.js",
      "line": 7,
      "children": {
        "test-1": {
          "type": "it",
          "file": "test/example.js",
          "line": 8
        }
      }
    },
    "suite-2": {
      "type": "describe",
      "file": "test/example.js",
      "line": 13,
      "children": {
        "suite-2.1": {
          "type": "describe",
          "file": "test/example.js",
          "line": 14,
          "children": {
            "test-2.1.1": {
              "type": "it",
              "file": "test/example.js",
              "line": 15
            }
          }
        }
      }
    },
    ...
  }
}

License

MIT License

Copyright (c) 2018 Pau Sanchez

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.