wait-for-expect
Version:
Wait for expectation to be true, useful for integration and end to end testing
206 lines (205 loc) • 12.8 kB
JavaScript
;
require("./toBeInRangeMatcher");
var _index = _interopRequireDefault(require("./index"));
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
function _regenerator() { /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */ var e, t, r = "function" == typeof Symbol ? Symbol : {}, n = r.iterator || "@@iterator", o = r.toStringTag || "@@toStringTag"; function i(r, n, o, i) { var c = n && n.prototype instanceof Generator ? n : Generator, u = Object.create(c.prototype); return _regeneratorDefine2(u, "_invoke", function (r, n, o) { var i, c, u, f = 0, p = o || [], y = !1, G = { p: 0, n: 0, v: e, a: d, f: d.bind(e, 4), d: function d(t, r) { return i = t, c = 0, u = e, G.n = r, a; } }; function d(r, n) { for (c = r, u = n, t = 0; !y && f && !o && t < p.length; t++) { var o, i = p[t], d = G.p, l = i[2]; r > 3 ? (o = l === n) && (u = i[(c = i[4]) ? 5 : (c = 3, 3)], i[4] = i[5] = e) : i[0] <= d && ((o = r < 2 && d < i[1]) ? (c = 0, G.v = n, G.n = i[1]) : d < l && (o = r < 3 || i[0] > n || n > l) && (i[4] = r, i[5] = n, G.n = l, c = 0)); } if (o || r > 1) return a; throw y = !0, n; } return function (o, p, l) { if (f > 1) throw TypeError("Generator is already running"); for (y && 1 === p && d(p, l), c = p, u = l; (t = c < 2 ? e : u) || !y;) { i || (c ? c < 3 ? (c > 1 && (G.n = -1), d(c, u)) : G.n = u : G.v = u); try { if (f = 2, i) { if (c || (o = "next"), t = i[o]) { if (!(t = t.call(i, u))) throw TypeError("iterator result is not an object"); if (!t.done) return t; u = t.value, c < 2 && (c = 0); } else 1 === c && (t = i["return"]) && t.call(i), c < 2 && (u = TypeError("The iterator does not provide a '" + o + "' method"), c = 1); i = e; } else if ((t = (y = G.n < 0) ? u : r.call(n, G)) !== a) break; } catch (t) { i = e, c = 1, u = t; } finally { f = 1; } } return { value: t, done: y }; }; }(r, o, i), !0), u; } var a = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} t = Object.getPrototypeOf; var c = [][n] ? t(t([][n]())) : (_regeneratorDefine2(t = {}, n, function () { return this; }), t), u = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(c); function f(e) { return Object.setPrototypeOf ? Object.setPrototypeOf(e, GeneratorFunctionPrototype) : (e.__proto__ = GeneratorFunctionPrototype, _regeneratorDefine2(e, o, "GeneratorFunction")), e.prototype = Object.create(u), e; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, _regeneratorDefine2(u, "constructor", GeneratorFunctionPrototype), _regeneratorDefine2(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = "GeneratorFunction", _regeneratorDefine2(GeneratorFunctionPrototype, o, "GeneratorFunction"), _regeneratorDefine2(u), _regeneratorDefine2(u, o, "Generator"), _regeneratorDefine2(u, n, function () { return this; }), _regeneratorDefine2(u, "toString", function () { return "[object Generator]"; }), (_regenerator = function _regenerator() { return { w: i, m: f }; })(); }
function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try { i({}, "", {}); } catch (e) { i = 0; } _regeneratorDefine2 = function _regeneratorDefine(e, r, n, t) { function o(r, n) { _regeneratorDefine2(e, r, function (e) { return this._invoke(r, n, e); }); } r ? i ? i(e, r, { value: n, enumerable: !t, configurable: !t, writable: !t }) : e[r] = n : (o("next", 0), o("throw", 1), o("return", 2)); }, _regeneratorDefine2(e, r, n, t); }
function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /* eslint-env jest */
var originalDefaults = _objectSpread({}, _index["default"].defaults);
beforeEach(function () {
Object.assign(_index["default"].defaults, originalDefaults);
});
test("it waits for expectation to pass", /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee() {
var numberToChange, randomTimeout;
return _regenerator().w(function (_context) {
while (1) switch (_context.n) {
case 0:
numberToChange = 10; // we are using random timeout here to simulate a real-time example
// of an async operation calling a callback at a non-deterministic time
randomTimeout = Math.floor(Math.random() * 300);
setTimeout(function () {
numberToChange = 100;
}, randomTimeout);
_context.n = 1;
return (0, _index["default"])(function () {
expect(numberToChange).toEqual(100);
});
case 1:
return _context.a(2);
}
}, _callee);
})));
test("it fails properly with jest error message when it times out without expectation passing", /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2() {
var numberNotToChange, _t;
return _regenerator().w(function (_context2) {
while (1) switch (_context2.p = _context2.n) {
case 0:
numberNotToChange = 200;
_context2.p = 1;
_context2.n = 2;
return (0, _index["default"])(function () {
expect(numberNotToChange).toEqual(2000);
}, 300);
case 2:
_context2.n = 4;
break;
case 3:
_context2.p = 3;
_t = _context2.v;
expect(_t.message).toMatchSnapshot();
case 4:
return _context2.a(2);
}
}, _callee2, null, [[1, 3]]);
})), 1000);
test("it fails when the change didn't happen fast enough, based on the waitForExpect timeout", /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3() {
var numberToChangeTooLate, timeToPassForTheChangeToHappen, _t2;
return _regenerator().w(function (_context3) {
while (1) switch (_context3.p = _context3.n) {
case 0:
numberToChangeTooLate = 300;
timeToPassForTheChangeToHappen = 1000;
setTimeout(function () {
numberToChangeTooLate = 3000;
}, timeToPassForTheChangeToHappen);
_context3.p = 1;
_context3.n = 2;
return (0, _index["default"])(function () {
expect(numberToChangeTooLate).toEqual(3000);
}, timeToPassForTheChangeToHappen - 200);
case 2:
_context3.n = 4;
break;
case 3:
_context3.p = 3;
_t2 = _context3.v;
expect(_t2.message).toMatchSnapshot();
case 4:
return _context3.a(2);
}
}, _callee3, null, [[1, 3]]);
})), 1500);
test("it reruns the expectation every x ms, as provided with the second argument", /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee4() {
var timesRun, timeout, interval, expectedTimesToRun, _t3;
return _regenerator().w(function (_context4) {
while (1) switch (_context4.p = _context4.n) {
case 0:
// using this would be preferable but somehow jest shares the expect.assertions between tests!
// expect.assertions(1 + Math.floor(timeout / interval));
timesRun = 0;
timeout = 600;
interval = 150;
_context4.p = 1;
_context4.n = 2;
return (0, _index["default"])(function () {
timesRun += 1;
expect(true).toEqual(false);
}, timeout, interval);
case 2:
_context4.n = 4;
break;
case 3:
_context4.p = 3;
_t3 = _context4.v;
// initial run + reruns
expectedTimesToRun = 1 + Math.floor(timeout / interval);
expect(timesRun).toEqual(expectedTimesToRun);
expect(timesRun).toBeInRange({
min: expectedTimesToRun - 1,
max: expectedTimesToRun + 1
});
case 4:
return _context4.a(2);
}
}, _callee4, null, [[1, 3]]);
})));
test("it reruns the expectation every x ms, as provided by the default timeout and interval", /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee5() {
var timeout, interval, mockExpectation, expectedTimesToRun, _t4;
return _regenerator().w(function (_context5) {
while (1) switch (_context5.p = _context5.n) {
case 0:
timeout = 600;
interval = 150;
_index["default"].defaults.timeout = timeout;
_index["default"].defaults.interval = interval;
mockExpectation = jest.fn();
mockExpectation.mockImplementation(function () {
return expect(true).toEqual(false);
});
_context5.p = 1;
_context5.n = 2;
return (0, _index["default"])(mockExpectation);
case 2:
throw Error("waitForExpect should have thrown");
case 3:
_context5.p = 3;
_t4 = _context5.v;
// initial run + reruns
expectedTimesToRun = 1 + Math.floor(timeout / interval);
expect(mockExpectation).toHaveBeenCalledTimes(expectedTimesToRun);
case 4:
return _context5.a(2);
}
}, _callee5, null, [[1, 3]]);
})));
test("it works with promises", /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee7() {
var numberToChange, randomTimeout, sleep;
return _regenerator().w(function (_context7) {
while (1) switch (_context7.n) {
case 0:
numberToChange = 10;
randomTimeout = Math.floor(Math.random() * 300);
setTimeout(function () {
numberToChange = 100;
}, randomTimeout);
sleep = function sleep(ms) {
return new Promise(function (resolve) {
return setTimeout(function () {
return resolve();
}, ms);
});
};
_context7.n = 1;
return (0, _index["default"])(/*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee6() {
return _regenerator().w(function (_context6) {
while (1) switch (_context6.n) {
case 0:
_context6.n = 1;
return sleep(10);
case 1:
expect(numberToChange).toEqual(100);
case 2:
return _context6.a(2);
}
}, _callee6);
})));
case 1:
return _context7.a(2);
}
}, _callee7);
})));
test("it works with a zero interval", /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee8() {
var numberToChange;
return _regenerator().w(function (_context8) {
while (1) switch (_context8.n) {
case 0:
numberToChange = 1;
setTimeout(function () {
numberToChange = 2;
}, 10);
_context8.n = 1;
return (0, _index["default"])(function () {
expect(numberToChange).toEqual(2);
}, 100, 0);
case 1:
return _context8.a(2);
}
}, _callee8);
})));