module qunit
1. function qunit.run (files, callback)
2. function qunit.setup (opts)
3. object qunit.generators
4. object qunit.index
5. object qunit.log
6. object qunit.log.print
7. object qunit.options
module qunit.generators
1. boolean qunit.generators.support
2. function qunit.generators.isGeneratorFn (fn)
module qunit.index
1. function qunit.index.run (files, callback)
2. function qunit.index.setup (opts)
3. object qunit.index.log
4. object qunit.index.options
module qunit.log
1. function qunit.log.add (type, obj)
2. function qunit.log.reset ()
3. function qunit.log.stats ()
4. object qunit.log.print
module qunit.log.print

module qunit

function qunit.run (files, callback)

description and source-code

run = function (files, callback) {
    var filesCount = 0;

    callback || (callback = noop);

    if (!Array.isArray(files)) {
        files = [files];
    }

    if (options.coverage || files[0].coverage) coverage.setup(options.coverage);

    files.forEach(function(file) {
        var opts = _.extend({}, options, file);

        !opts.log && (opts.log = {});
        opts.deps = absPaths(opts.deps);
        opts.code = absPath(opts.code);
        opts.tests = absPaths(opts.tests);

        runOne(opts, function(err) {
            if (err) {
                return callback(err, log.stats());
            }

            filesCount++;

            if (filesCount >= files.length) {
                _.each(opts.log, function(val, name) {
                    if (val && log.print[name]) {
                        log.print[name]();
                    }
                });

                // Write coverage report.
                if (opts.coverage) coverage.report();
                callback(null, log.stats());
            }
        });
    });
}

example usage

...
log: {
    summary: true
}
});


// one code and tests file
testrunner.run({
code: "/path/to/your/code.js",
tests: "/path/to/your/tests.js"
}, callback);

// require code into a namespace object, rather than globally
testrunner.run({
code: {path: "/path/to/your/code.js", namespace: "code"},
...

function qunit.setup (opts)

description and source-code

setup = function (opts) {
    _.extend(options, opts);
}

example usage

...
```

```javascript
// change any option for all tests globally
testrunner.options.optionName = value;

// or use setup function
testrunner.setup({
    log: {
        summary: true
    }
});


// one code and tests file
...

module qunit.generators

function qunit.generators.isGeneratorFn (fn)

description and source-code

isGeneratorFn = function (fn) {
    return fn.constructor.name == 'GeneratorFunction';
}

example usage

...

    /**
     * Support generators.
     */
    global.test = QUnit.test = function(testName, callback) {
var fn;

if (generators.isGeneratorFn(callback)) {
    fn = function(assert) {
        var done = assert.async();
        co.wrap(callback).call(this, assert).then(function() {
            done();
        }).catch(function (err) {
            console.log(err.stack);
            done();
...

module qunit.index

function qunit.index.run (files, callback)

description and source-code

run = function (files, callback) {
    var filesCount = 0;

    callback || (callback = noop);

    if (!Array.isArray(files)) {
        files = [files];
    }

    if (options.coverage || files[0].coverage) coverage.setup(options.coverage);

    files.forEach(function(file) {
        var opts = _.extend({}, options, file);

        !opts.log && (opts.log = {});
        opts.deps = absPaths(opts.deps);
        opts.code = absPath(opts.code);
        opts.tests = absPaths(opts.tests);

        runOne(opts, function(err) {
            if (err) {
                return callback(err, log.stats());
            }

            filesCount++;

            if (filesCount >= files.length) {
                _.each(opts.log, function(val, name) {
                    if (val && log.print[name]) {
                        log.print[name]();
                    }
                });

                // Write coverage report.
                if (opts.coverage) coverage.report();
                callback(null, log.stats());
            }
        });
    });
}

example usage

...
log: {
    summary: true
}
});


// one code and tests file
testrunner.run({
code: "/path/to/your/code.js",
tests: "/path/to/your/tests.js"
}, callback);

// require code into a namespace object, rather than globally
testrunner.run({
code: {path: "/path/to/your/code.js", namespace: "code"},
...

function qunit.index.setup (opts)

description and source-code

setup = function (opts) {
    _.extend(options, opts);
}

example usage

...
```

```javascript
// change any option for all tests globally
testrunner.options.optionName = value;

// or use setup function
testrunner.setup({
    log: {
        summary: true
    }
});


// one code and tests file
...

module qunit.log

function qunit.log.add (type, obj)

description and source-code

add = function (type, obj) {
    if (obj) {
        data[type].push(obj);
    }
    return data[type];
}

example usage

...
case 'ping':
    clearTimeout(pingCheckTimeoutId);
    pingCheckTimeoutId = setTimeout(function() {
        complete(new Error('Process blocked for too long'));
    }, opts.maxBlockDuration);
    break;
case 'assertionDone':
    log.add('assertions', msg.data);
    break;
case 'testDone':
    log.add('tests', msg.data);
    break;
case 'done':
    clearTimeout(pingCheckTimeoutId);
    msg.data.code = opts.code.path;
...

function qunit.log.reset ()

description and source-code

reset = function () {
    data = {
        assertions: [],
        tests: [],
        summaries: [],
        coverages: []
    };
}

example usage

...
// globalCoverage: true,
// log currently testing code file
testing: true
};

// reset log stats every time .next is called
chain.next = function() {
log.reset();
return chainer.prototype.next.apply(this, arguments);
};

chain.add('base testrunner', function() {
tr.run({
    code: fixtures + '/testrunner-code.js',
    tests: fixtures + '/testrunner-tests.js',
...

function qunit.log.stats ()

description and source-code

stats = function () {
    var stats = {
        files: 0,
        assertions: 0,
        failed: 0,
        passed: 0,
        runtime: 0
    };

    data.summaries.forEach(function(file) {
        stats.files++;
        stats.assertions += file.total;
        stats.failed += file.failed;
        stats.passed += file.passed;
        stats.runtime += file.runtime;
    });

    stats.tests = data.tests.length;

    stats.coverage = {
        files: 0,
        statements: { covered: 0, total: 0 },
        branches: { covered: 0, total: 0 },
        functions: { covered: 0, total: 0 },
        lines: { covered: 0, total: 0 }
    };

    data.coverages.forEach(function(file) {
        stats.coverage.files++;
        stats.coverage.statements.covered += file.statements.covered;
        stats.coverage.statements.total += file.statements.total;
        stats.coverage.branches.covered += file.branches.covered;
        stats.coverage.branches.total += file.branches.total;
        stats.coverage.functions.covered += file.functions.covered;
        stats.coverage.functions.total += file.functions.total;
        stats.coverage.lines.covered += file.lines.covered;
        stats.coverage.lines.total += file.lines.total;
    });

    return stats;
}

example usage

...
});

log('\nSummary:\n' + table.toString());
};

print.globalSummary = function() {
var table,
    data = exports.stats();

table = new Table({
    head: ['Files', 'Tests', 'Assertions', 'Failed', 'Passed', 'Runtime&#
x27;]
});

table.push([data.files, data.tests, data.assertions, data.failed,
    data.passed, data.runtime]);
...

module qunit.log.print

function qunit.log.print.assertions ()

description and source-code

assertions = function () {
    var table,
        currentModule, module,
        currentTest, test;

    table = new Table({
        head: ['Module', 'Test', 'Assertion', 'Result']
    });

    data.assertions.forEach(function(data) {
        // just easier to read the table
        if (data.module === currentModule) {
            module = '';
        } else {
            module = currentModule = data.module;
        }

        // just easier to read the table
        if (data.test === currentTest) {
            test = '';
        } else {
            test = currentTest = data.test;
        }

        table.push([module, test, data.message || '', data.result ? 'ok' : 'fail']);
    });

    log('\nAssertions:\n' + table.toString());
}

example usage
```
n/a
```

function qunit.log.print.coverage ()

description and source-code

coverage = function () {
    var table;

    if (!data.coverages.length) return;

    table = new Table({
        head: ['File', 'Statements', 'Branches', 'Functions', 'Lines']
    });

    data.coverages.forEach(function(coverage) {
        table.push([
            truncFile(coverage.code),
            getMet(coverage.statements),
            getMet(coverage.branches),
            getMet(coverage.functions),
            getMet(coverage.lines)]);
    });

    log('\nCoverage:\n' + table.toString());
}

example usage
```
n/a
```

function qunit.log.print.errors ()

description and source-code

errors = function () {
    var errors = [];

    data.assertions.forEach(function(data) {
        if (!data.result) {
            errors.push(data);
        }
    });

    if (errors.length) {
        log('\n\nErrors:');
        errors.forEach(function(data) {
            log('\nModule: ' + data.module + ' Test: ' + data.test);
            if (data.message) {
                log(data.message);
            }

            if (data.source) {
                log(data.source);
            }

            if (data.expected != null || data.actual != null) {
                //it will be an error if data.expected !== data.actual, but if they're
                //both undefined, it means that they were just not filled out because
                //no assertions were hit (likely due to code error that would have been logged as source or message).
                log('Actual value:');
                log(data.actual);
                log('Expected value:');
                log(data.expected);
            }
        });
    }
}

example usage
```
n/a
```

function qunit.log.print.globalCoverage ()

description and source-code

globalCoverage = function () {
    var coverage, table;

    if (!data.coverages.length) return;

    coverage = exports.stats().coverage;
    table = new Table({
        head: ['Files', 'Statements', 'Branches', 'Functions', 'Lines']
    });

    table.push([
        coverage.files,
        getMet(coverage.statements),
        getMet(coverage.branches),
        getMet(coverage.functions),
        getMet(coverage.lines)
    ]);

    log('\nGlobal coverage:\n' + table.toString());
}

example usage
```
n/a
```

function qunit.log.print.globalSummary ()

description and source-code

globalSummary = function () {
    var table,
        data = exports.stats();

    table = new Table({
        head: ['Files', 'Tests', 'Assertions', 'Failed', 'Passed', 'Runtime']
    });

    table.push([data.files, data.tests, data.assertions, data.failed,
        data.passed, data.runtime]);

    log('\nGlobal summary:\n' + table.toString());
}

example usage
```
n/a
```

function qunit.log.print.summary ()

description and source-code

summary = function () {
    var table;

    table = new Table({
        head: ['File', 'Failed', 'Passed', 'Total', 'Runtime']
    });

    data.summaries.forEach(function(data) {
        table.push([truncFile(data.code), data.failed, data.passed, data.total, data.runtime]);
    });

    log('\nSummary:\n' + table.toString());
}

example usage
```
n/a
```

function qunit.log.print.tests ()

description and source-code

tests = function () {
    var table,
        currentModule, module;

    table = new Table({
        head: ['Module', 'Test', 'Failed', 'Passed', 'Total']
    });

    data.tests.forEach(function(data) {
        // just easier to read the table
        if (data.module === currentModule) {
            module = '';
        } else {
            module = currentModule = data.module;
        }

        table.push([module, data.name, data.failed, data.passed, data.total]);
    });

    log('\nTests:\n' + table.toString());
}

example usage
```
n/a
```

api documentation for qunit (v1.0.0)

QUnit testing framework for Node.js

table of contents

module qunit

function qunit.run (files, callback)

function qunit.setup (opts)

module qunit.generators

function qunit.generators.isGeneratorFn (fn)

module qunit.index

function qunit.index.run (files, callback)

function qunit.index.setup (opts)

module qunit.log

function qunit.log.add (type, obj)

function qunit.log.reset ()

function qunit.log.stats ()

module qunit.log.print

function qunit.log.print.assertions ()

function qunit.log.print.coverage ()

function qunit.log.print.errors ()

function qunit.log.print.globalCoverage ()

function qunit.log.print.globalSummary ()

function qunit.log.print.summary ()

function qunit.log.print.tests ()