Skip to content

Refactor API #713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 7, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
438 changes: 128 additions & 310 deletions api.js

Large diffs are not rendered by default.

17 changes: 10 additions & 7 deletions cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,14 @@ var logger = new Logger(reporter);

logger.start();

api.on('test', logger.test);
api.on('error', logger.unhandledError);
api.on('test-run', function (runStatus) {
reporter.api = runStatus;
runStatus.on('test', logger.test);
runStatus.on('error', logger.unhandledError);

api.on('stdout', logger.stdout);
api.on('stderr', logger.stderr);
runStatus.on('stdout', logger.stdout);
runStatus.on('stderr', logger.stderr);
});

var files = cli.input.length ? cli.input : arrify(conf.files);
if (files.length === 0) {
Expand All @@ -173,9 +176,9 @@ if (cli.flags.watch) {
}
} else {
api.run(files)
.then(function () {
logger.finish();
logger.exit(api.failCount > 0 || api.rejectionCount > 0 || api.exceptionCount > 0 ? 1 : 0);
.then(function (runStatus) {
logger.finish(runStatus);
logger.exit(runStatus.failCount > 0 || runStatus.rejectionCount > 0 || runStatus.exceptionCount > 0 ? 1 : 0);
})
.catch(function (err) {
// Don't swallow exceptions. Note that any expected error should already
Expand Down
74 changes: 74 additions & 0 deletions lib/ava-files.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
var fs = require('fs');
var path = require('path');
var Promise = require('bluebird');
var slash = require('slash');
var globby = require('globby');
var flatten = require('arr-flatten');

function defaultExcludePatterns() {
return [
'!**/node_modules/**',
'!**/fixtures/**',
'!**/helpers/**'
];
}

function defaultIncludePatterns() {
return [
'test.js',
'test-*.js',
'test'
];
}

function AvaFiles(files) {
if (!(this instanceof AvaFiles)) {
throw new TypeError('Class constructor AvaFiles cannot be invoked without \'new\'');
}

if (!files || !files.length) {
files = defaultIncludePatterns();
}

this.excludePatterns = defaultExcludePatterns();

this.files = files;
}

AvaFiles.prototype.findTestFiles = function () {
return handlePaths(this.files, this.excludePatterns);
};

function handlePaths(files, excludePatterns) {
// convert pinkie-promise to Bluebird promise
files = Promise.resolve(globby(files.concat(excludePatterns)));

return files
.map(function (file) {
if (fs.statSync(file).isDirectory()) {
var pattern = path.join(file, '**', '*.js');

if (process.platform === 'win32') {
// Always use / in patterns, harmonizing matching across platforms.
pattern = slash(pattern);
}

return handlePaths([pattern], excludePatterns);
}

// globby returns slashes even on Windows. Normalize here so the file
// paths are consistently platform-accurate as tests are run.
return path.normalize(file);
})
.then(flatten)
.filter(function (file) {
return path.extname(file) === '.js' && path.basename(file)[0] !== '_';
})
.map(function (file) {
return path.resolve(file);
});
}

module.exports = AvaFiles;
module.exports.defaultIncludePatterns = defaultIncludePatterns;
module.exports.defaultExcludePatterns = defaultExcludePatterns;
32 changes: 16 additions & 16 deletions lib/logger.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,64 +14,64 @@ function Logger(reporter) {

module.exports = Logger;

Logger.prototype.start = function () {
Logger.prototype.start = function (runStatus) {
if (!this.reporter.start) {
return;
}

this.write(this.reporter.start());
this.write(this.reporter.start(runStatus), runStatus);
};

Logger.prototype.reset = function () {
Logger.prototype.reset = function (runStatus) {
if (!this.reporter.reset) {
return;
}

this.write(this.reporter.reset());
this.write(this.reporter.reset(runStatus), runStatus);
};

Logger.prototype.test = function (test) {
this.write(this.reporter.test(test));
Logger.prototype.test = function (test, runStatus) {
this.write(this.reporter.test(test, runStatus), runStatus);
};

Logger.prototype.unhandledError = function (err) {
Logger.prototype.unhandledError = function (err, runStatus) {
if (!this.reporter.unhandledError) {
return;
}

this.write(this.reporter.unhandledError(err));
this.write(this.reporter.unhandledError(err, runStatus), runStatus);
};

Logger.prototype.finish = function () {
Logger.prototype.finish = function (runStatus) {
if (!this.reporter.finish) {
return;
}

this.write(this.reporter.finish());
this.write(this.reporter.finish(runStatus), runStatus);
};

Logger.prototype.write = function (str) {
Logger.prototype.write = function (str, runStatus) {
if (typeof str === 'undefined') {
return;
}

this.reporter.write(str);
this.reporter.write(str, runStatus);
};

Logger.prototype.stdout = function (data) {
Logger.prototype.stdout = function (data, runStatus) {
if (!this.reporter.stdout) {
return;
}

this.reporter.stdout(data);
this.reporter.stdout(data, runStatus);
};

Logger.prototype.stderr = function (data) {
Logger.prototype.stderr = function (data, runStatus) {
if (!this.reporter.stderr) {
return;
}

this.reporter.stderr(data);
this.reporter.stderr(data, runStatus);
};

Logger.prototype.exit = function (code) {
Expand Down
6 changes: 3 additions & 3 deletions lib/reporters/mini.js
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ MiniReporter.prototype.reportCounts = function () {
return status;
};

MiniReporter.prototype.finish = function () {
MiniReporter.prototype.finish = function (runStatus) {
this.clearInterval();

var status = this.reportCounts();
Expand All @@ -151,7 +151,7 @@ MiniReporter.prototype.finish = function () {
var i = 0;

if (this.failCount > 0) {
this.api.errors.forEach(function (test) {
runStatus.errors.forEach(function (test) {
if (!test.error || !test.error.message) {
return;
}
Expand All @@ -173,7 +173,7 @@ MiniReporter.prototype.finish = function () {
}

if (this.rejectionCount > 0 || this.exceptionCount > 0) {
this.api.errors.forEach(function (err) {
runStatus.errors.forEach(function (err) {
if (err.title) {
return;
}
Expand Down
14 changes: 7 additions & 7 deletions lib/reporters/tap.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,19 +75,19 @@ TapReporter.prototype.unhandledError = function (err) {
return output.join('\n');
};

TapReporter.prototype.finish = function () {
TapReporter.prototype.finish = function (runStatus) {
var output = [
'',
'1..' + (this.api.passCount + this.api.failCount + this.api.skipCount),
'# tests ' + (this.api.passCount + this.api.failCount + this.api.skipCount),
'# pass ' + this.api.passCount
'1..' + (runStatus.passCount + runStatus.failCount + runStatus.skipCount),
'# tests ' + (runStatus.passCount + runStatus.failCount + runStatus.skipCount),
'# pass ' + runStatus.passCount
];

if (this.api.skipCount > 0) {
output.push('# skip ' + this.api.skipCount);
if (runStatus.skipCount > 0) {
output.push('# skip ' + runStatus.skipCount);
}

output.push('# fail ' + (this.api.failCount + this.api.rejectionCount + this.api.exceptionCount), '');
output.push('# fail ' + (runStatus.failCount + runStatus.rejectionCount + runStatus.exceptionCount), '');

return output.join('\n');
};
Expand Down
32 changes: 16 additions & 16 deletions lib/reporters/verbose.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ VerboseReporter.prototype.start = function () {
return '';
};

VerboseReporter.prototype.test = function (test) {
VerboseReporter.prototype.test = function (test, runStatus) {
if (test.error) {
return ' ' + colors.error(figures.cross) + ' ' + test.title + ' ' + colors.error(test.error.message);
}
Expand All @@ -31,7 +31,7 @@ VerboseReporter.prototype.test = function (test) {
return ' ' + colors.skip('- ' + test.title);
}

if (this.api.fileCount === 1 && this.api.testCount === 1 && test.title === '[anonymous]') {
if (runStatus.fileCount === 1 && runStatus.testCount === 1 && test.title === '[anonymous]') {
return undefined;
}

Expand Down Expand Up @@ -65,37 +65,37 @@ VerboseReporter.prototype.unhandledError = function (err) {
return output;
};

VerboseReporter.prototype.finish = function () {
VerboseReporter.prototype.finish = function (runStatus) {
var output = '\n';

if (this.api.failCount > 0) {
output += ' ' + colors.error(this.api.failCount, plur('test', this.api.failCount), 'failed') + '\n';
if (runStatus.failCount > 0) {
output += ' ' + colors.error(runStatus.failCount, plur('test', runStatus.failCount), 'failed') + '\n';
} else {
output += ' ' + colors.pass(this.api.passCount, plur('test', this.api.passCount), 'passed') + '\n';
output += ' ' + colors.pass(runStatus.passCount, plur('test', runStatus.passCount), 'passed') + '\n';
}

if (this.api.skipCount > 0) {
output += ' ' + colors.skip(this.api.skipCount, plur('test', this.api.skipCount), 'skipped') + '\n';
if (runStatus.skipCount > 0) {
output += ' ' + colors.skip(runStatus.skipCount, plur('test', runStatus.skipCount), 'skipped') + '\n';
}

if (this.api.todoCount > 0) {
output += ' ' + colors.todo(this.api.todoCount, plur('test', this.api.todoCount), 'todo') + '\n';
if (runStatus.todoCount > 0) {
output += ' ' + colors.todo(runStatus.todoCount, plur('test', runStatus.todoCount), 'todo') + '\n';
}

if (this.api.rejectionCount > 0) {
output += ' ' + colors.error(this.api.rejectionCount, 'unhandled', plur('rejection', this.api.rejectionCount)) + '\n';
if (runStatus.rejectionCount > 0) {
output += ' ' + colors.error(runStatus.rejectionCount, 'unhandled', plur('rejection', runStatus.rejectionCount)) + '\n';
}

if (this.api.exceptionCount > 0) {
output += ' ' + colors.error(this.api.exceptionCount, 'uncaught', plur('exception', this.api.exceptionCount)) + '\n';
if (runStatus.exceptionCount > 0) {
output += ' ' + colors.error(runStatus.exceptionCount, 'uncaught', plur('exception', runStatus.exceptionCount)) + '\n';
}

if (this.api.failCount > 0) {
if (runStatus.failCount > 0) {
output += '\n';

var i = 0;

this.api.tests.forEach(function (test) {
runStatus.tests.forEach(function (test) {
if (!(test.error && test.error.message)) {
return;
}
Expand Down
Loading