Merge pull request #5 from Springworks/top-describe-path-context

Allow use of context alias in top-describe-path

Author: jishi

docs/rules/top-describe-path.md

@@ -1,4 +1,4 @@
-# Ensure that the top `describe` call in each test file use the correct path (top-describe-path)
+# Ensure that the top `describe` or `context` call in each test file use the correct path (top-describe-path)
 
 We use `mocha` in many of our projects and have adopted the convention of using `__filename` as the description in the root `describe` in each test file. That way it's easy to find a failing test.
 It is easier and less error-prone to write `__filename` then the actual path.

lib/rules/top-describe-path.js

@@ -12,7 +12,7 @@ module.exports = function(context) {
     return n.type === 'ExpressionStatement' &&
            n.expression.type === 'CallExpression' &&
            n.expression.callee.type === 'Identifier' &&
-           n.expression.callee.name === 'describe';
+          (n.expression.callee.name === 'describe' || n.expression.callee.name === 'context');
   }
 
   function getTopDescribeCallExpression(program_node) {
@@ -39,7 +39,7 @@ module.exports = function(context) {
 
       context.report({
         node: arg,
-        message: 'Unexpected path in top describe',
+        message: 'Unexpected path in top ' + top_desc.callee.name,
         fix: fixer => fixer.replaceText(arg, '\'' + filepath + '\''),
       });
     },

tests/lib/rules/top-describe-path.js

@@ -18,6 +18,18 @@ ruleTester.run("top-describe-path", rule, {
       code: "var x = 1; describe('tests/lib/rules/top-describe-path.js', function() {  describe('foo', function() { });  });",
       filename: __filename,
     },
+    {
+      code: "context('tests/lib/rules/top-describe-path.js', function() { });",
+      filename: __filename,
+    },
+    {
+      code: "context('tests/lib/rules/top-describe-path.js', function() {  describe('foo', function() { });  });",
+      filename: __filename,
+    },
+    {
+      code: "var x = 1; context('tests/lib/rules/top-describe-path.js', function() {  describe('foo', function() { });  });",
+      filename: __filename,
+    },
   ],
 
   invalid: [
@@ -57,5 +69,41 @@ ruleTester.run("top-describe-path", rule, {
         type: "Literal"
       }],
     },
+    {
+      code: "context(__filename, function() { });",
+      output: "context('tests/lib/rules/top-describe-path.js', function() { });",
+      filename: __filename,
+      errors: [{
+        message: "Unexpected path in top context",
+        type: "Identifier"
+      }],
+    },
+    {
+      code: "context(__filename, function() {  describe('foo', function() { });  });",
+      output: "context('tests/lib/rules/top-describe-path.js', function() {  describe('foo', function() { });  });",
+      filename: __filename,
+      errors: [{
+        message: "Unexpected path in top context",
+        type: "Identifier"
+      }],
+    },
+    {
+      code: "context('incorrect path', function() { });",
+      output: "context('tests/lib/rules/top-describe-path.js', function() { });",
+      filename: __filename,
+      errors: [{
+        message: "Unexpected path in top context",
+        type: "Literal"
+      }],
+    },
+    {
+      code: "context('incorrect path', function() {  describe('foo', function() { });  });",
+      output: "context('tests/lib/rules/top-describe-path.js', function() {  describe('foo', function() { });  });",
+      filename: __filename,
+      errors: [{
+        message: "Unexpected path in top context",
+        type: "Literal"
+      }],
+    },
   ],
 });