Print out warning in verbose & mini reporter when .only() tests are used

Author: Thomas

lib/colors.js

@@ -10,5 +10,5 @@ module.exports = {
 	duration: chalk.gray.dim,
 	errorStack: chalk.gray,
 	stack: chalk.red,
-	failFast: chalk.magenta
+	information: chalk.magenta
 };

lib/main.js

@@ -55,7 +55,7 @@ function exit() {
 
 globals.setImmediate(() => {
 	const hasExclusive = runner.tests.hasExclusive;
-	const numberOfTests = runner.tests.tests.concurrent.length + runner.tests.tests.serial.length;
+	const numberOfTests = runner.tests.testCount;
 
 	if (numberOfTests === 0) {
 		send('no-tests', {avaRequired: true});

lib/reporters/mini.js

@@ -216,7 +216,11 @@ MiniReporter.prototype.finish = function (runStatus) {
 	}
 
 	if (runStatus.failFastEnabled === true) {
-		status += '\n\n  ' + colors.failFast('`--fail-fast` is on. Any number of tests may have been skipped');
+		status += '\n\n  ' + colors.information('`--fail-fast` is on. Any number of tests may have been skipped');
+	}
+
+	if (runStatus.hasExclusive === true && runStatus.remainingCount > 0) {
+		status += '\n\n  ' + colors.information('The .only() modifier is used in some tests.', runStatus.remainingCount, 'test(s) were not run.');
 	}
 
 	return status + '\n\n';

lib/reporters/verbose.js

@@ -115,7 +115,11 @@ VerboseReporter.prototype.finish = function (runStatus) {
 	}
 
 	if (runStatus.failFastEnabled === true) {
-		output += '\n\n\n  ' + colors.failFast('`--fail-fast` is on. Any number of tests may have been skipped');
+		output += '\n\n\n  ' + colors.information('`--fail-fast` is on. Any number of tests may have been skipped');
+	}
+
+	if (runStatus.hasExclusive === true && runStatus.remainingCount > 0) {
+		output += '\n\n\n  ' + colors.information('The .only() modifier is used in some tests.', runStatus.remainingCount, 'test(s) were not run.');
 	}
 
 	return output + '\n';

lib/run-status.js

@@ -45,6 +45,7 @@ class RunStatus extends EventEmitter {
 		this.failCount = 0;
 		this.fileCount = 0;
 		this.testCount = 0;
+		this.remainingCount = 0;
 		this.previousFailCount = 0;
 		this.knownFailures = [];
 		this.errors = [];
@@ -89,13 +90,8 @@ class RunStatus extends EventEmitter {
 	handleStats(stats) {
 		this.emit('stats', stats, this);
 
-		if (this.hasExclusive && !stats.hasExclusive) {
-			return;
-		}
-
-		if (!this.hasExclusive && stats.hasExclusive) {
+		if (stats.hasExclusive) {
 			this.hasExclusive = true;
-			this.testCount = 0;
 		}
 
 		this.testCount += stats.testCount;
@@ -139,6 +135,7 @@ class RunStatus extends EventEmitter {
 		this.skipCount = sum(this.stats, 'skipCount');
 		this.todoCount = sum(this.stats, 'todoCount');
 		this.failCount = sum(this.stats, 'failCount');
+		this.remainingCount = this.testCount - this.passCount - this.failCount - this.skipCount - this.todoCount - this.knownFailureCount;
 	}
 }
 

lib/test-collection.js

@@ -10,6 +10,7 @@ class TestCollection extends EventEmitter {
 		super();
 
 		this.hasExclusive = false;
+		this.testCount = 0;
 
 		this.tests = {
 			concurrent: [],
@@ -66,6 +67,8 @@ class TestCollection extends EventEmitter {
 			return;
 		}
 
+		this.testCount++;
+
 		// Add `.only()` tests if `.only()` was used previously
 		if (this.hasExclusive && !metadata.exclusive) {
 			return;

test/api.js

@@ -33,7 +33,7 @@ test('Without Pool: test file with exclusive tests causes non-exclusive tests in
 	return api.run(files)
 		.then(result => {
 			t.ok(result.hasExclusive);
-			t.is(result.testCount, 2);
+			t.is(result.testCount, 5);
 			t.is(result.passCount, 2);
 			t.is(result.failCount, 0);
 		});
@@ -48,7 +48,7 @@ test('Without Pool: test files can be forced to run in exclusive mode', t => {
 		{runOnlyExclusive: true}
 	).then(result => {
 		t.ok(result.hasExclusive);
-		t.is(result.testCount, 0);
+		t.is(result.testCount, 1);
 		t.is(result.passCount, 0);
 		t.is(result.failCount, 0);
 	});

test/reporters/mini.js

@@ -424,7 +424,7 @@ test('results when fail-fast is enabled', function (t) {
 	compareLineOutput(t, output, [
 		'',
 		'',
-		'  ' + colors.failFast('`--fail-fast` is on. Any number of tests may have been skipped')
+		'  ' + colors.information('`--fail-fast` is on. Any number of tests may have been skipped')
 	]);
 	t.end();
 });
@@ -589,3 +589,36 @@ test('stderr and stdout should call _update', function (t) {
 	reporter._update.restore();
 	t.end();
 });
+
+test('results when hasExclusive is enabled, but there are no known remaining tests', function (t) {
+	var reporter = miniReporter();
+	var runStatus = {
+		hasExclusive: true
+	};
+
+	var output = reporter.finish(runStatus);
+	t.is(output, '\n\n');
+	t.end();
+});
+
+test('results when hasExclusive is enabled, but there are remaining tests', function (t) {
+	var reporter = miniReporter();
+
+	var runStatus = {
+		hasExclusive: true,
+		testCount: 2,
+		passCount: 1,
+		remainingCount: 1
+	};
+
+	var actualOutput = reporter.finish(runStatus);
+	var expectedOutput = [
+		'',
+		'',
+		'  ' + colors.information('The .only() modifier is used in some tests. 1 test(s) were not run.'),
+		'\n'
+	].join('\n');
+	t.is(actualOutput, expectedOutput);
+	t.end();
+});
+

test/reporters/verbose.js

@@ -396,7 +396,7 @@ test('results when fail-fast is enabled', function (t) {
 		'  ' + chalk.red('1 test failed') + time,
 		'',
 		'',
-		'  ' + colors.failFast('`--fail-fast` is on. Any number of tests may have been skipped'),
+		'  ' + colors.information('`--fail-fast` is on. Any number of tests may have been skipped'),
 		''
 	].join('\n');
 
@@ -467,6 +467,46 @@ test('reporter.stdout and reporter.stderr both use process.stderr.write', functi
 	t.end();
 });
 
+test('results when hasExclusive is enabled, but there are no known remaining tests', function (t) {
+	var reporter = verboseReporter();
+	var runStatus = createRunStatus();
+	runStatus.hasExclusive = true;
+	runStatus.passCount = 1;
+
+	var output = reporter.finish(runStatus);
+	var expectedOutput = [
+		'',
+		'  ' + chalk.green('1 test passed') + time,
+		''
+	].join('\n');
+
+	t.is(output, expectedOutput);
+	t.end();
+});
+
+test('results when hasExclusive is enabled, but there are remaining tests', function (t) {
+	var reporter = verboseReporter();
+	var runStatus = createRunStatus();
+	runStatus.hasExclusive = true;
+	runStatus.testCount = 2;
+	runStatus.passCount = 1;
+	runStatus.failCount = 0;
+	runStatus.remainingCount = 1;
+
+	var output = reporter.finish(runStatus);
+	var expectedOutput = [
+		'',
+		'  ' + chalk.green('1 test passed') + time,
+		'',
+		'',
+		'  ' + colors.information('The .only() modifier is used in some tests. 1 test(s) were not run.'),
+		''
+	].join('\n');
+
+	t.is(output, expectedOutput);
+	t.end();
+});
+
 function fooFunc() {
 	barFunc();
 }

test/run-status.js

@@ -66,3 +66,24 @@ test('successfully initializes without any options provided', t => {
 	t.is(runStatus.base, '');
 	t.end();
 });
+
+test('calculate remaining test count', t => {
+	const runStatus = new RunStatus();
+	runStatus.testCount = 10;
+
+	var results = [{
+		stats: {
+			passCount: 1,
+			failCount: 1,
+			skipCount: 1,
+			todoCount: 1,
+			knownFailureCount: 1
+		}
+	}];
+
+	runStatus.processResults(results);
+
+	t.is(runStatus.remainingCount, 5);
+	t.end();
+});
+