Introduction

Basic setup for running unit and integration tests in your project. This package can optionally provide code coverage reporting using Istanbul, and can report test results to TeamCity.

Getting Started

Installation

npm install --save-dev lib_dev-test-tools

Once installed, you'll be able to use the lib_dev-test-tools command in npm scripts in your project's package.json file. For example:

{
    "scripts": {
        "test": "lib_dev-test-tools unit",
        "test:integration": "lib_dev-test-tools integration",
        "test:all": "lib_dev-test-tools all"
    }
}

The test tool presumes that your tests live in their own tests folder as a child of the root, and sister to the folder that contains your application code. It will not find or run tests that are intermingled with code.

Command Usage

lib_dev-test-tools [testType] [showCoverage]

Searches your project's tests folder for files that look like they might be tests, and runs them using Mocha. It assumes the tests folder is at the root of your project.

• testType - (string) One of unit, integration, or all
  • unit - Looks for file names that end with *.unit.js
  • integration - Looks for file names that end with *.integration.js or *.spec.js
  • all - Combines unit and integration
• showCoverage - (boolean) If true, will output an Istanbul code coverage report after the test results. Defaults to false. This option requires administrator mode.

TeamCity Output

This library uses our internal TeamCity Mocha reporter tool to communicate with TeamCity.

To enable this option, you'll need to set the sendReportsToTeamCity environment variable to true. You can do this by either adding the following line to your .bash_profile file in your home directory, or, by simply typing this in to your bash shell prompt:

export sendReportsToTeamCity=true

Package.json Configuration

TeamCity and code coverage output may also be governed by config values in your project's package.json file:

{
    "config": {
        "doCodeCoverageWithTests": false,
        "sendReportsToTeamCity": false
  }
}

Additional Notes

The tool uses Mocha as its test runner, and transpiles javascript (ES2016) using Babel. This means you can write your tests using nifty new Javascript syntax without having to do any extra work. However, if you also want to write your code in ES2016, you'll need to add Babel and the appropriate Babel plugins to your project.

The tool does not make any assumptions about how you want to assert your tests, so you'll need to import your library of choice to get any of your tests to pass properly (I recommend expect).