Skip to content

Commit

Permalink
Add silent flag to doReport options object
Browse files Browse the repository at this point in the history
  • Loading branch information
@pineapplemachine
pineapplemachine committed Mar 28, 2018
1 parent 72bb91c commit e0b9022
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 22 deletions.
52 changes: 30 additions & 22 deletions canary.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1121,6 +1121,9 @@ class CanaryTest{
// Optional attributes for the optional options argument:
// concise: Report only a small amount of information regarding the test
// process and its results, and set all tests to run silently.
// silent: Report no information at all regarding the test process.
// When keepAlive is not set, the process exit status code can be used
// to see whether the test was successful or not.
// verbose: Report a great deal of information regarding the test process
// and set all tests to run verbosely.
// keepAlive: Don't terminate the process after running tests and reporting
Expand All @@ -1140,35 +1143,40 @@ class CanaryTest{
try{
// Set a default empty options object when none was specified.
options = options || {};
function log(...message){
if(!options.silent){
console.log(...message);
}
}
// Indicate that tests are about to be run!
console.log(`Running tests via Canary...`);
log(`Running tests via Canary...`);
// When "concise" is set, instruct tests to run silently.
if(options.concise){
this.silent();
}else if(options.verbose){
this.verbose();
}
// Expand groups so that filters can be accurately applied.
// Expand test groups
this.expandGroups();
// Construct a list of filter functions. Only run tests which
// satisfy at least one of these filters, or whose parent satisifies
// a filter, or parent's parent, etc.
const filters = [];
// Heed an explicitly defined filter function
if(options.filter){
console.log("Filtering tests by a provided filter function.");
log("Filtering tests by a provided filter function.");
filters.push(options.filter);
}
// When "names" is set, run tests with a fitting name, or that are
// a child of a test with such a name.
if(options.names){
console.log(`Filtering tests by name: "${options.names.join(`", "`)}"`),
log(`Filtering tests by name: "${options.names.join(`", "`)}"`),
filters.push(test => options.names.indexOf(test.name) >= 0);
}
// When "tags" is set, run tests with one of the given tags, or
// that are a descendant of such a test.
if(options.tags){
console.log(`Filtering tests by tags: "${options.tags.join(`", "`)}"`);
log(`Filtering tests by tags: "${options.tags.join(`", "`)}"`);
filters.push(test => {
for(let tag of options.tags){
if(test.tagDictionary[tag]){
Expand All @@ -1184,10 +1192,10 @@ class CanaryTest{
const paths = options.paths.map(
path => this.normalizePath(path)
);
console.log(`Filtering tests by file paths: "${paths.join(`", "`)}"`);
log(`Filtering tests by file paths: "${paths.join(`", "`)}"`);
filters.push(test => {
for(let path of paths){
console.log(test.filePath);
log(test.filePath);
if(test.filePath && test.filePath.startsWith(path)){
return true;
}
Expand Down Expand Up @@ -1216,43 +1224,43 @@ class CanaryTest{
report.passed.length + report.failed.length + report.skipped.length
);
// Log information about test status.
console.log(`Finished running ${totalTests} tests.`);
log(`Finished running ${totalTests} tests.`);
if(report.errors.length === 1){
console.log(red("Encountered 1 error."));
log(red("Encountered 1 error."));
}else if(report.errors.length){
console.log(red(`Encountered ${report.errors.length} errors.`));
log(red(`Encountered ${report.errors.length} errors.`));
}
if(!options.concise){
this.logVerbose("Getting a text summary...");
console.log(this.getSummary());
log(this.getSummary());
this.logVerbose("Showing all errors...");
for(let error of report.errors){
const title = error.getLocationTitle();
if(title){
console.log(red(`Error at "${title}": ${error.stack}`));
log(red(`Error at "${title}": ${error.stack}`));
}else{
console.log(red(`Error: ${error.stack}`));
log(red(`Error: ${error.stack}`));
}
}
}
if(report.passed.length === totalTests){
console.log(green(`${totalTests} of ${totalTests} tests passed.`));
log(green(`${totalTests} of ${totalTests} tests passed.`));
}else{
console.log(`${report.passed.length} of ${totalTests} tests ${green("passed")}.`);
log(`${report.passed.length} of ${totalTests} tests ${green("passed")}.`);
}
if(report.skipped.length){
console.log(`${report.skipped.length} of ${totalTests} tests ${yellow("skipped")}.`);
log(`${report.skipped.length} of ${totalTests} tests ${yellow("skipped")}.`);
}
if(report.failed.length){
console.log(`${report.failed.length} of ${totalTests} tests ${red("failed")}.`);
console.log(red("Status: Failed"));
log(`${report.failed.length} of ${totalTests} tests ${red("failed")}.`);
log(red("Status: Failed"));
if(!options.keepAlive){
// Since there were any failed tests, exit with a nonzero status code.
this.logVerbose("Some tests failed: Exiting with a nonzero status code.");
process.exit(1);
}
}else{
console.log(green("Status: OK"));
log(green("Status: OK"));
if(!options.keepAlive){
// Since there were no failed tests, exit with a zero status code.
this.logVerbose("Tests ran without errors: Exiting with a zero status code.");
Expand All @@ -1261,9 +1269,9 @@ class CanaryTest{
}
}catch(error){
// Report an unhandled error and exit with a nonzero status code.
console.log(red("Encountered an unhandled error while running tests."));
console.log(red(error.stack));
console.log(red("Status: Failed"));
log(red("Encountered an unhandled error while running tests."));
log(red(error.stack));
log(red("Status: Failed"));
if(!options.keepAlive){
this.logVerbose("Test runner failed: Exiting with a nonzero status code.");
process.exit(1);
Expand Down
1 change: 1 addition & 0 deletions docs/api-running-tests.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ A single, one-size-fits-most call to run tests, output a report to the console,
These are the attributes of the options object which the `doReport` function will consider:

- `{boolean} concise`: Log only a small of information regarding testing and the results.
- `{boolean} silent`: Log no information whatsoever about tests or their results. If the `keepAlive` flag was not set, the process will still exit with an appropriate status code to indicate success or failure.
- `{boolean} verbose`: Log a great deal of information while running tests.
- `{boolean} keepAlive`: Normally, the process is terminated with a zero status code after running all tests successfully or a nonzero status code after running tests with any errors. When this flag is specified, `doReport` will not terminate the process.
- `{function} filter`: A function which accepts a [`CanaryTest`](api-introduction.md) instance and returns a truthy value when the test should be run and a falsey value when the test should be skipped.
Expand Down

0 comments on commit e0b9022

Please sign in to comment.