eslint-plugin-jest 27.2.1 → 27.2.2

package/lib/rules/__tests__/prefer-mock-promise-shorthand.test.js

@@ -0,0 +1,360 @@
+"use strict";
+
+var _utils = require("@typescript-eslint/utils");
+var _dedent = _interopRequireDefault(require("dedent"));
+var _preferMockPromiseShorthand = _interopRequireDefault(require("../prefer-mock-promise-shorthand"));
+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: 6
+  }
+});
+ruleTester.run('prefer-mock-shorthand', _preferMockPromiseShorthand.default, {
+  valid: ['describe()', 'it()', 'describe.skip()', 'it.skip()', 'test()', 'test.skip()', 'var appliedOnly = describe.only; appliedOnly.apply(describe)', 'var calledOnly = it.only; calledOnly.call(it)', 'it.each()()', 'it.each`table`()', 'test.each()()', 'test.each`table`()', 'test.concurrent()', 'jest.fn().mockResolvedValue(42)', 'jest.fn(() => Promise.resolve(42))', 'jest.fn(() => Promise.reject(42))', 'aVariable.mockImplementation', 'aVariable.mockImplementation()', 'aVariable.mockImplementation([])', 'aVariable.mockImplementation(() => {})', 'aVariable.mockImplementation(() => [])', 'aVariable.mockReturnValue(() => Promise.resolve(1))', 'aVariable.mockReturnValue(Promise.resolve(1).then(() => 1))', 'aVariable.mockReturnValue(Promise.reject(1).then(() => 1))', 'aVariable.mockReturnValue(Promise.reject().then(() => 1))', 'aVariable.mockReturnValue(new Promise(resolve => resolve(1)))', 'aVariable.mockReturnValue(new Promise((_, reject) => reject(1)))', "jest.spyOn(Thingy, 'method').mockImplementation(param => Promise.resolve(param));", (0, _dedent.default)`
+      aVariable.mockImplementation(() => {
+        const value = new Date();
+
+        return Promise.resolve(value);
+      });
+    `, (0, _dedent.default)`
+      aVariable.mockImplementation(() => {
+        return Promise.resolve(value)
+          .then(value => value + 1);
+      });
+    `, (0, _dedent.default)`
+      aVariable.mockImplementation(() => {
+        return Promise.all([1, 2, 3]);
+      });
+    `, 'aVariable.mockImplementation(() => Promise.all([1, 2, 3]));', 'aVariable.mockReturnValue(Promise.all([1, 2, 3]));'],
+  invalid: [{
+    code: 'jest.fn().mockImplementation(() => Promise.resolve(42))',
+    output: 'jest.fn().mockResolvedValue(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'jest.fn().mockImplementation(() => Promise.reject(42))',
+    output: 'jest.fn().mockRejectedValue(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'aVariable.mockImplementation(() => Promise.resolve(42))',
+    output: 'aVariable.mockResolvedValue(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: (0, _dedent.default)`
+        aVariable.mockImplementation(() => {
+          return Promise.resolve(42)
+        })
+      `,
+    output: 'aVariable.mockResolvedValue(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'aVariable.mockImplementation(() => Promise.reject(42))',
+    output: 'aVariable.mockRejectedValue(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'aVariable.mockImplementation(() => Promise.reject(42),)',
+    output: 'aVariable.mockRejectedValue(42,)',
+    parserOptions: {
+      ecmaVersion: 2017
+    },
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'aVariable.mockImplementationOnce(() => Promise.resolve(42))',
+    output: 'aVariable.mockResolvedValueOnce(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValueOnce'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'aVariable.mockImplementationOnce(() => Promise.reject(42))',
+    output: 'aVariable.mockRejectedValueOnce(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValueOnce'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'jest.fn().mockReturnValue(Promise.resolve(42))',
+    output: 'jest.fn().mockResolvedValue(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'jest.fn().mockReturnValue(Promise.reject(42))',
+    output: 'jest.fn().mockRejectedValue(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'aVariable.mockReturnValue(Promise.resolve(42))',
+    output: 'aVariable.mockResolvedValue(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'aVariable.mockReturnValue(Promise.reject(42))',
+    output: 'aVariable.mockRejectedValue(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'aVariable.mockReturnValueOnce(Promise.resolve(42))',
+    output: 'aVariable.mockResolvedValueOnce(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValueOnce'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'aVariable.mockReturnValueOnce(Promise.reject(42))',
+    output: 'aVariable.mockRejectedValueOnce(42)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValueOnce'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: (0, _dedent.default)`
+        aVariable.mockReturnValue(Promise.resolve({
+          target: 'world',
+          message: 'hello'
+        }))
+      `,
+    output: (0, _dedent.default)`
+        aVariable.mockResolvedValue({
+          target: 'world',
+          message: 'hello'
+        })
+      `,
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: (0, _dedent.default)`
+        aVariable
+          .mockImplementation(() => Promise.reject(42))
+          .mockImplementation(() => Promise.resolve(42))
+          .mockReturnValue(Promise.reject(42))
+      `,
+    output: (0, _dedent.default)`
+        aVariable
+          .mockRejectedValue(42)
+          .mockResolvedValue(42)
+          .mockRejectedValue(42)
+      `,
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValue'
+      },
+      column: 4,
+      line: 2
+    }, {
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValue'
+      },
+      column: 4,
+      line: 3
+    }, {
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValue'
+      },
+      column: 4,
+      line: 4
+    }]
+  }, {
+    code: (0, _dedent.default)`
+        aVariable
+          .mockReturnValueOnce(Promise.reject(42))
+          .mockImplementation(() => Promise.resolve(42))
+          .mockReturnValueOnce(Promise.reject(42))
+      `,
+    output: (0, _dedent.default)`
+        aVariable
+          .mockRejectedValueOnce(42)
+          .mockResolvedValue(42)
+          .mockRejectedValueOnce(42)
+      `,
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValueOnce'
+      },
+      column: 4,
+      line: 2
+    }, {
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValue'
+      },
+      column: 4,
+      line: 3
+    }, {
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValueOnce'
+      },
+      column: 4,
+      line: 4
+    }]
+  }, {
+    code: (0, _dedent.default)`
+        aVariable.mockReturnValueOnce(
+          Promise.reject(
+            new Error('oh noes!')
+          )
+        )
+      `,
+    output: (0, _dedent.default)`
+        aVariable.mockRejectedValueOnce(
+          new Error('oh noes!')
+        )
+      `,
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValueOnce'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'jest.fn().mockReturnValue(Promise.resolve(42), xyz)',
+    output: 'jest.fn().mockResolvedValue(42, xyz)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'jest.fn().mockImplementation(() => Promise.reject(42), xyz)',
+    output: 'jest.fn().mockRejectedValue(42, xyz)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValue'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'aVariable.mockReturnValueOnce(Promise.resolve(42, xyz))',
+    output: null,
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValueOnce'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'aVariable.mockReturnValueOnce(Promise.resolve())',
+    output: 'aVariable.mockResolvedValueOnce(undefined)',
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockResolvedValueOnce'
+      },
+      column: 11,
+      line: 1
+    }]
+  }, {
+    code: 'jest.spyOn(fs, "readFile").mockReturnValue(Promise.reject(new Error("oh noes!")))',
+    output: `jest.spyOn(fs, "readFile").mockRejectedValue(new Error("oh noes!"))`,
+    errors: [{
+      messageId: 'useMockShorthand',
+      data: {
+        replacement: 'mockRejectedValue'
+      },
+      column: 28,
+      line: 1
+    }]
+  }]
+});