iancmyers / whiteglove Goto Github PK

Find the dirty tests making a mess of your test suite!

License: MIT License

JavaScript 100.00%

whiteglove's Introduction

whiteglove

$ npm install -g whiteglove

Find the dirty tests making a mess of your test suite! whiteglove helps you find tests that aren't cleaning up after themselves (failing to restore stubs, polluting the global namespace) and tests that are inadvertently relying on the mess.

Usage: whiteglove <command> [options]

Commands:
  bisect <test> <directory>  find leaky tests affecting a target test
  iso <directory>            find tests that fail in isolation

Options:
  --runner, -r    Command used to run the test suite  [string] [default: "node"]
  --patterns, -p  Filename patterns matching your spec files
                                       [array] [default: [".js",".jsx",".node"]]
  --verbose       Output a ridiculous amount of information            [boolean]
  -h, --help      Show help                                            [boolean]
  -v, --version   Show version number                                  [boolean]

Examples:
  whiteglove bisect ./tests/foo.js ./tests
  whiteglove iso ./tests

whiteglove bisect

Use whiteglove bisect when you have a test that passes in isolation, but fails when run with the larger test suite. The bisect function will determine which tests are affecting your target test.

whiteglove iso

Use whiteglove iso to find tests that are inadvertently relying other leaky tests in order to pass.

whiteglove's People

Contributors

Stargazers

Watchers

Forkers

strugee

whiteglove's Issues

Add timing to output

We should output how long it took to complete the task.

Support multiple paths representing "the suite"

Just like mocha accepts N paths, it would be ideal if whiteglove accepted them too.

Concurrency of 0 with only one CPU

I'm working on a virtualized server which only has one CPU allocated to it. When I run Whiteglove like so:

$ ./node_modules/.bin/whiteglove --verbose -p '[-test.js]' -r ./node_modules/.bin/vows bisect test/event-test.js test

I get:

runner: ./node_modules/.bin/vows, patterns: [-test.js]
verbose: Finding all test paths in test
verbose: Found 190 test files
verbose: Starting search with concurrency of 0

and then the command exits.

Improve performance by optimizing parallelism

Add tests for error cases

Warn when test runner does not run correctly

Suggest bisect command to run after successful iso

As seen in #79 (review), after a successful iso run, Whiteglove should suggest the next logical bisect command to run.

Output language should specify when spec the leaky tests affect

Add verbose flag for logging and debugging

`--help` errors out

$ whiteglove --help
whiteglove spec.js dir [options]

  -r, --runner String      Command used to run the test suite - default: node
  -p, --patterns [String]  Filename patterns matching your spec files - default: ['.js']
  --verbose                Output a ridiculous amount of information
  -h, --help               Display this helpful help menu
$(npm root -g)/whiteglove/bin/whiteglove.js:5
  if (!run || run.reportedTests().length) {
                  ^

TypeError: run.reportedTests is not a function
    at $(npm root -g)/whiteglove/bin/whiteglove.js:5:19
    at Object.execute ($(npm root -g)/whiteglove/lib/cli.js:188:12)
    at Object.<anonymous> ($(npm root -g)/whiteglove/bin/whiteglove.js:4:5)
    at Module._compile (module.js:435:26)
    at Object.Module._extensions..js (module.js:442:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:313:12)
    at Function.Module.runMain (module.js:467:10)
    at startup (node.js:136:18)
    at node.js:963:3