eslint-plugin-jest 27.2.1 → 27.2.2

package/lib/rules/__tests__/no-done-callback.test.js

@@ -0,0 +1,424 @@
+"use strict";
+
+var _utils = require("@typescript-eslint/utils");
+var _dedent = _interopRequireDefault(require("dedent"));
+var _noDoneCallback = _interopRequireDefault(require("../no-done-callback"));
+var _testUtils = require("./test-utils");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const ruleTester = new _utils.TSESLint.RuleTester({
+  parser: _testUtils.espreeParser,
+  parserOptions: {
+    ecmaVersion: 2017
+  }
+});
+ruleTester.run('no-done-callback', _noDoneCallback.default, {
+  valid: ['test("something", () => {})', 'test("something", async () => {})', 'test("something", function() {})', 'test.each``("something", ({ a, b }) => {})', 'test.each()("something", ({ a, b }) => {})', 'it.each()("something", ({ a, b }) => {})', 'it.each([])("something", (a, b) => {})', 'it.each``("something", ({ a, b }) => {})', 'it.each([])("something", (a, b) => { a(); b(); })', 'it.each``("something", ({ a, b }) => { a(); b(); })', 'test("something", async function () {})', 'test("something", someArg)', 'beforeEach(() => {})', 'beforeAll(async () => {})', 'afterAll(() => {})', 'afterAll(async function () {})', 'afterAll(async function () {}, 5)'],
+  invalid: [{
+    code: 'test("something", (...args) => {args[0]();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 20
+    }]
+  }, {
+    code: 'test("something", done => {done();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 19,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'test("something", () => {return new Promise(done => {done();})})'
+      }]
+    }]
+  }, {
+    code: 'test("something", (done,) => {done();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 20,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'test("something", () => {return new Promise(done => {done();})})'
+      }]
+    }]
+  }, {
+    code: 'test("something", finished => {finished();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 19,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'finished'
+        },
+        output: 'test("something", () => {return new Promise(finished => {finished();})})'
+      }]
+    }]
+  }, {
+    code: 'test("something", (done) => {done();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 20,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'test("something", () => {return new Promise(done => {done();})})'
+      }]
+    }]
+  }, {
+    code: 'test("something", done => done())',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 19,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'test("something", () => new Promise(done => done()))'
+      }]
+    }]
+  }, {
+    code: 'test("something", (done) => done())',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 20,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'test("something", () => new Promise(done => done()))'
+      }]
+    }]
+  }, {
+    code: 'test("something", function(done) {done();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 28,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'test("something", function() {return new Promise(done => {done();})})'
+      }]
+    }]
+  }, {
+    code: 'test("something", function (done) {done();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 29,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'test("something", function () {return new Promise(done => {done();})})'
+      }]
+    }]
+  }, {
+    code: 'test("something", async done => {done();})',
+    errors: [{
+      messageId: 'useAwaitInsteadOfCallback',
+      line: 1,
+      column: 25
+    }]
+  }, {
+    code: 'test("something", async done => done())',
+    errors: [{
+      messageId: 'useAwaitInsteadOfCallback',
+      line: 1,
+      column: 25
+    }]
+  }, {
+    code: 'test("something", async function (done) {done();})',
+    errors: [{
+      messageId: 'useAwaitInsteadOfCallback',
+      line: 1,
+      column: 35
+    }]
+  }, {
+    code: (0, _dedent.default)`
+        test('my test', async (done) => {
+          await myAsyncTask();
+          expect(true).toBe(false);
+          done();
+        });
+      `,
+    errors: [{
+      messageId: 'useAwaitInsteadOfCallback',
+      line: 1,
+      column: 24
+    }]
+  }, {
+    code: (0, _dedent.default)`
+        test('something', (done) => {
+          done();
+        });
+      `,
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 20,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: (0, _dedent.default)`
+                test('something', () => {return new Promise(done => {
+                  done();
+                })});
+              `
+      }]
+    }]
+  }, {
+    code: 'afterEach((...args) => {args[0]();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 12
+    }]
+  }, {
+    code: 'beforeAll(done => {done();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 11,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'beforeAll(() => {return new Promise(done => {done();})})'
+      }]
+    }]
+  }, {
+    code: 'beforeAll(finished => {finished();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 11,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'finished'
+        },
+        output: 'beforeAll(() => {return new Promise(finished => {finished();})})'
+      }]
+    }]
+  }, {
+    code: 'beforeEach((done) => {done();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 13,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'beforeEach(() => {return new Promise(done => {done();})})'
+      }]
+    }]
+  }, {
+    code: 'afterAll(done => done())',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 10,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'afterAll(() => new Promise(done => done()))'
+      }]
+    }]
+  }, {
+    code: 'afterEach((done) => done())',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 12,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'afterEach(() => new Promise(done => done()))'
+      }]
+    }]
+  }, {
+    code: 'beforeAll(function(done) {done();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 20,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'beforeAll(function() {return new Promise(done => {done();})})'
+      }]
+    }]
+  }, {
+    code: 'afterEach(function (done) {done();})',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 21,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: 'afterEach(function () {return new Promise(done => {done();})})'
+      }]
+    }]
+  }, {
+    code: 'beforeAll(async done => {done();})',
+    errors: [{
+      messageId: 'useAwaitInsteadOfCallback',
+      line: 1,
+      column: 17
+    }]
+  }, {
+    code: 'beforeAll(async done => done())',
+    errors: [{
+      messageId: 'useAwaitInsteadOfCallback',
+      line: 1,
+      column: 17
+    }]
+  }, {
+    code: 'beforeAll(async function (done) {done();})',
+    errors: [{
+      messageId: 'useAwaitInsteadOfCallback',
+      line: 1,
+      column: 27
+    }]
+  }, {
+    code: (0, _dedent.default)`
+        afterAll(async (done) => {
+          await myAsyncTask();
+          done();
+        });
+      `,
+    errors: [{
+      messageId: 'useAwaitInsteadOfCallback',
+      line: 1,
+      column: 17
+    }]
+  }, {
+    code: (0, _dedent.default)`
+        beforeEach((done) => {
+          done();
+        });
+      `,
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 13,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: (0, _dedent.default)`
+                beforeEach(() => {return new Promise(done => {
+                  done();
+                })});
+              `
+      }]
+    }]
+  }, {
+    code: (0, _dedent.default)`
+        import { beforeEach } from '@jest/globals';
+
+        beforeEach((done) => {
+          done();
+        });
+      `,
+    parserOptions: {
+      sourceType: 'module'
+    },
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 3,
+      column: 13,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: (0, _dedent.default)`
+                import { beforeEach } from '@jest/globals';
+
+                beforeEach(() => {return new Promise(done => {
+                  done();
+                })});
+              `
+      }]
+    }]
+  }, {
+    code: (0, _dedent.default)`
+        import { beforeEach as atTheStartOfEachTest } from '@jest/globals';
+
+        atTheStartOfEachTest((done) => {
+          done();
+        });
+      `,
+    parserOptions: {
+      sourceType: 'module'
+    },
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 3,
+      column: 23,
+      suggestions: [{
+        messageId: 'suggestWrappingInPromise',
+        data: {
+          callback: 'done'
+        },
+        output: (0, _dedent.default)`
+                import { beforeEach as atTheStartOfEachTest } from '@jest/globals';
+
+                atTheStartOfEachTest(() => {return new Promise(done => {
+                  done();
+                })});
+              `
+      }]
+    }]
+  }, {
+    code: 'test.each``("something", ({ a, b }, done) => { done(); })',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 37
+    }]
+  }, {
+    code: 'it.each``("something", ({ a, b }, done) => { done(); })',
+    errors: [{
+      messageId: 'noDoneCallback',
+      line: 1,
+      column: 35
+    }]
+  }]
+});