Add no-ignored-test-files rule (fixes #51)

Author: jfmengels

docs/rules/no-ignored-test-files.md

@@ -0,0 +1,41 @@
+# Ensure no tests are written in ignored files
+
+When searching for tests, AVA ignores files contained in folders named `fixtures` or `helpers`.
+
+
+## Fail
+
+```js
+// File: test/foo/fixtures/bar.js
+import test from 'ava';
+
+test('foo', t => {
+	t.pass();
+});
+
+// File: test/foo/helpers/bar.js
+import test from 'ava';
+
+test('foo', t => {
+	t.pass();
+});
+```
+
+
+## Pass
+
+```js
+// File: test/foo/not-fixtures/bar.js
+import test from 'ava';
+
+test('foo', t => {
+	t.pass();
+});
+
+// File: test/foo/not-helpers/bar.js
+import test from 'ava';
+
+test('foo', t => {
+	t.pass();
+});
+```

index.js

@@ -5,6 +5,7 @@ module.exports = {
 		'max-asserts': require('./rules/max-asserts'),
 		'no-cb-test': require('./rules/no-cb-test'),
 		'no-identical-title': require('./rules/no-identical-title'),
+		'no-ignored-test-files': require('./rules/no-ignored-test-files'),
 		'no-invalid-end': require('./rules/no-invalid-end'),
 		'no-only-test': require('./rules/no-only-test'),
 		'no-skip-assert': require('./rules/no-skip-assert'),
@@ -31,6 +32,7 @@ module.exports = {
 				'ava/max-asserts': [0, 5],
 				'ava/no-cb-test': 0,
 				'ava/no-identical-title': 2,
+				'ava/no-ignored-test-files': 2,
 				'ava/no-invalid-end': 2,
 				'ava/no-only-test': 2,
 				'ava/no-skip-assert': 2,

readme.md

@@ -32,6 +32,7 @@ Configure it in `package.json`.
 			"ava/max-asserts": [2, 5],
 			"ava/no-cb-test": 0,
 			"ava/no-identical-title": 2,
+			"ava/no-ignored-test-files": 2,
 			"ava/no-invalid-end": 2,
 			"ava/no-only-test": 2,
 			"ava/no-skip-assert": 2,
@@ -57,6 +58,7 @@ The rules will only activate in test files.
 - [max-asserts](docs/rules/max-asserts.md) - Limit the number of assertions in a test.
 - [no-cb-test](docs/rules/no-cb-test.md) - Ensure no `test.cb()` is used.
 - [no-identical-title](docs/rules/no-identical-title.md) - Ensure no tests have the same title.
+- [no-ignored-test-files](docs/rules/no-ignored-test-files.md) - Ensure no tests are written in ignored files.
 - [no-invalid-end](docs/rules/no-invalid-end.md) - Ensure `t.end()` is only called inside `test.cb()`.
 - [no-only-test](docs/rules/no-only-test.md) - Ensure no `test.only()` are present.
 - [no-skip-assert](docs/rules/no-skip-assert.md) - Ensure no assertions are skipped.

rules/no-ignored-test-files.js

@@ -0,0 +1,50 @@
+'use strict';
+var path = require('path');
+var createAvaRule = require('../create-ava-rule');
+
+function isInIgnoredFolder(folders) {
+	if (folders.indexOf('fixtures') !== -1) {
+		return 'fixtures';
+	}
+
+	if (folders.indexOf('helpers') !== -1) {
+		return 'helpers';
+	}
+
+	return null;
+}
+
+function isIgnored(filename) {
+	var folders = filename.split(path.sep);
+	var ignoredFolder = isInIgnoredFolder(folders);
+	if (!ignoredFolder) {
+		return null;
+	}
+
+	return 'Test file is ignored because it is inside a `' + ignoredFolder + '` folder';
+}
+
+/* eslint quote-props: [2, "as-needed"] */
+module.exports = function (context) {
+	var ava = createAvaRule();
+	var hasTestCall = false;
+
+	return ava.merge({
+		CallExpression: function (node) {
+			if (ava.isTestFile && ava.currentTestNode === node) {
+				hasTestCall = true;
+			}
+		},
+		'Program:exit': function (node) {
+			if (!hasTestCall) {
+				return;
+			}
+
+			var ignoredReason = isIgnored(context.getFilename());
+			if (ignoredReason) {
+				context.report(node, ignoredReason);
+			}
+			hasTestCall = false;
+		}
+	});
+};

test/no-ignored-test-files.js

@@ -0,0 +1,58 @@
+import test from 'ava';
+import {RuleTester} from 'eslint';
+import rule from '../rules/no-ignored-test-files';
+
+const ruleTester = new RuleTester({
+	env: {
+		es6: true
+	}
+});
+
+const header = `const test = require('ava');\n`;
+
+test(() => {
+	ruleTester.run('no-ignored-test-files', rule, {
+		valid: [
+			{
+				code: header + 'test(t => { t.pass(); });',
+				filename: '/foo/bar/baz.js'
+			},
+			{
+				code: header + 'test(t => { t.pass(); });',
+				filename: '/foo/not-fixtures/bar.js'
+			},
+			{
+				code: header + 'test(t => { t.pass(); });',
+				filename: '/foo/not-helpers/bar.js'
+			},
+			{
+				code: header + 'foo(t => { t.pass(); });',
+				filename: '/foo/bar/fixtures/baz.js'
+			},
+			{
+				code: header + 'foo(t => { t.pass(); });',
+				filename: '/foo/bar/helpers/baz.js'
+			},
+			{
+				code: 'test(t => { t.pass(); });',
+				filename: '/foo/bar/fixtures/baz.js'
+			},
+			{
+				code: 'test(t => { t.pass(); });',
+				filename: '/foo/bar/helpers/baz.js'
+			}
+		],
+		invalid: [
+			{
+				code: header + 'test(t => { t.pass(); });',
+				filename: '/foo/bar/fixtures/baz.js',
+				errors: [{message: 'Test file is ignored because it is inside a `fixtures` folder'}]
+			},
+			{
+				code: header + 'test(t => { t.pass(); });',
+				filename: '/foo/bar/helpers/baz.js',
+				errors: [{message: 'Test file is ignored because it is inside a `helpers` folder'}]
+			}
+		]
+	});
+});