@telefonica/acceptance-testing 4.0.0 → 4.1.0

package/README.md

@@ -200,7 +200,10 @@ test('example screenshot test', async () => {
 });
 ```
 
-`createApiEndpointMock` automatically mocks CORS response headers and preflight (`OPTIONS`) requests for you.
+- `createApiEndpointMock` automatically mocks CORS response headers and preflight (`OPTIONS`) requests for
+  you.
+- Both `interceptRequest` and `createApiEndpointMock` return a jest
+  [mock function](https://jestjs.io/docs/mock-function-api/#reference).
 
 ### Using globs
 

package/dist/acceptance-testing.cjs.development.js

@@ -879,22 +879,41 @@ var getPageApi = function getPageApi(page) {
 };
 var needsRequestInterception = false;
 var requestHandlers = [];
-var requestInterceptor = function requestInterceptor(req) {
-  var _requestHandlers$find;
-  var _ref11 = (_requestHandlers$find = requestHandlers.find(function (_ref12) {
-      var matcher = _ref12.matcher;
-      return matcher(req);
-    })) != null ? _requestHandlers$find : {
-      handler: null
-    },
-    handler = _ref11.handler;
-  if (!handler) {
-    req["continue"]();
-    return;
-  }
-  var response = handler(req);
-  req.respond(response);
-};
+var requestInterceptor = /*#__PURE__*/function () {
+  var _ref11 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee7(req) {
+    var _requestHandlers$find;
+    var _ref12, handler, response;
+    return _regeneratorRuntime().wrap(function _callee7$(_context7) {
+      while (1) switch (_context7.prev = _context7.next) {
+        case 0:
+          _ref12 = (_requestHandlers$find = requestHandlers.find(function (_ref13) {
+            var matcher = _ref13.matcher;
+            return matcher(req);
+          })) != null ? _requestHandlers$find : {
+            handler: null
+          }, handler = _ref12.handler;
+          if (handler) {
+            _context7.next = 4;
+            break;
+          }
+          req["continue"]();
+          return _context7.abrupt("return");
+        case 4:
+          _context7.next = 6;
+          return handler(req);
+        case 6:
+          response = _context7.sent;
+          req.respond(response);
+        case 8:
+        case "end":
+          return _context7.stop();
+      }
+    }, _callee7);
+  }));
+  return function requestInterceptor(_x11) {
+    return _ref11.apply(this, arguments);
+  };
+}();
 var interceptRequest = function interceptRequest(matcher) {
   needsRequestInterception = true;
   var spy = jest.fn();
@@ -905,11 +924,11 @@ var interceptRequest = function interceptRequest(matcher) {
   return spy;
 };
 var createApiEndpointMock = function createApiEndpointMock(_temp3) {
-  var _ref14;
-  var _ref13 = _temp3 === void 0 ? {} : _temp3,
-    origin = _ref13.origin,
-    baseUrl = _ref13.baseUrl;
-  var originRegExp = globToRegExp((_ref14 = origin != null ? origin : baseUrl) != null ? _ref14 : '*');
+  var _ref15;
+  var _ref14 = _temp3 === void 0 ? {} : _temp3,
+    origin = _ref14.origin,
+    baseUrl = _ref14.baseUrl;
+  var originRegExp = globToRegExp((_ref15 = origin != null ? origin : baseUrl) != null ? _ref15 : '*');
   interceptRequest(function (req) {
     var _URL = new URL(req.url()),
       origin = _URL.origin;
@@ -938,31 +957,48 @@ var createApiEndpointMock = function createApiEndpointMock(_temp3) {
         return req.method() === method && !!origin.match(originRegExp) && matchPath(spiedPath, pathWithParams);
       };
       var spy = jest.fn();
-      interceptRequest(matcher).mockImplementation(function (req) {
-        var _spyResult$status;
-        var spyResult = spy(req);
-        var status = (_spyResult$status = spyResult.status) != null ? _spyResult$status : 200;
-        var resBody = spyResult.body || spyResult;
-        return {
-          status: status,
-          headers: {
-            'Access-Control-Allow-Origin': '*'
-          },
-          contentType: 'application/json',
-          body: JSON.stringify(resBody)
+      interceptRequest(matcher).mockImplementation( /*#__PURE__*/function () {
+        var _ref16 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee8(req) {
+          var _spyResult$status;
+          var spyResult, status, resBody;
+          return _regeneratorRuntime().wrap(function _callee8$(_context8) {
+            while (1) switch (_context8.prev = _context8.next) {
+              case 0:
+                _context8.next = 2;
+                return spy(req);
+              case 2:
+                spyResult = _context8.sent;
+                status = (_spyResult$status = spyResult.status) != null ? _spyResult$status : 200;
+                resBody = spyResult.body || spyResult;
+                return _context8.abrupt("return", {
+                  status: status,
+                  headers: {
+                    'Access-Control-Allow-Origin': '*'
+                  },
+                  contentType: 'application/json',
+                  body: JSON.stringify(resBody)
+                });
+              case 6:
+              case "end":
+                return _context8.stop();
+            }
+          }, _callee8);
+        }));
+        return function (_x12) {
+          return _ref16.apply(this, arguments);
         };
-      });
+      }());
       return spy;
     }
   };
 };
 var openPage = /*#__PURE__*/function () {
-  var _ref16 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee7(_ref15) {
+  var _ref18 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee9(_ref17) {
     var userAgent, isDarkMode, viewport, cookies, urlConfig, url, currentUserAgent, page, connectionError;
-    return _regeneratorRuntime().wrap(function _callee7$(_context7) {
-      while (1) switch (_context7.prev = _context7.next) {
+    return _regeneratorRuntime().wrap(function _callee9$(_context9) {
+      while (1) switch (_context9.prev = _context9.next) {
         case 0:
-          userAgent = _ref15.userAgent, isDarkMode = _ref15.isDarkMode, viewport = _ref15.viewport, cookies = _ref15.cookies, urlConfig = /*#__PURE__*/_objectWithoutPropertiesLoose(_ref15, _excluded2);
+          userAgent = _ref17.userAgent, isDarkMode = _ref17.isDarkMode, viewport = _ref17.viewport, cookies = _ref17.cookies, urlConfig = /*#__PURE__*/_objectWithoutPropertiesLoose(_ref17, _excluded2);
           url = function () {
             if (urlConfig.url !== undefined) {
               return urlConfig.url;
@@ -982,45 +1018,45 @@ var openPage = /*#__PURE__*/function () {
             return protocol + "://" + hostname + ":" + port + path;
           }();
           debug('Opening page:', url);
-          _context7.t0 = userAgent;
-          if (_context7.t0) {
-            _context7.next = 8;
+          _context9.t0 = userAgent;
+          if (_context9.t0) {
+            _context9.next = 8;
             break;
           }
-          _context7.next = 7;
+          _context9.next = 7;
           return getGlobalBrowser().userAgent();
         case 7:
-          _context7.t0 = _context7.sent;
+          _context9.t0 = _context9.sent;
         case 8:
-          currentUserAgent = _context7.t0;
+          currentUserAgent = _context9.t0;
           page = getGlobalPage$1();
-          _context7.next = 12;
+          _context9.next = 12;
           return page.bringToFront();
         case 12:
           if (!viewport) {
-            _context7.next = 15;
+            _context9.next = 15;
             break;
           }
-          _context7.next = 15;
+          _context9.next = 15;
           return page.setViewport(viewport);
         case 15:
           if (!cookies) {
-            _context7.next = 18;
+            _context9.next = 18;
             break;
           }
-          _context7.next = 18;
+          _context9.next = 18;
           return page.setCookie.apply(page, cookies);
         case 18:
-          _context7.next = 20;
+          _context9.next = 20;
           return page.setUserAgent(currentUserAgent + " acceptance-test");
         case 20:
-          _context7.next = 22;
+          _context9.next = 22;
           return page.emulateMediaFeatures([{
             name: 'prefers-color-scheme',
             value: isDarkMode ? 'dark' : 'light'
           }]);
         case 22:
-          _context7.next = 24;
+          _context9.next = 24;
           return page.evaluateOnNewDocument(function (viewport) {
             var _viewport$safeAreaIns;
             var overriddenSafeAreaInsets = !viewport ? [] : Object.keys((_viewport$safeAreaIns = viewport == null ? void 0 : viewport.safeAreaInset) != null ? _viewport$safeAreaIns : {}).map(function (key) {
@@ -1036,57 +1072,57 @@ var openPage = /*#__PURE__*/function () {
           }, viewport);
         case 24:
           if (!needsRequestInterception) {
-            _context7.next = 28;
+            _context9.next = 28;
             break;
           }
-          _context7.next = 27;
+          _context9.next = 27;
           return page.setRequestInterception(true);
         case 27:
           page.on('request', requestInterceptor);
         case 28:
-          _context7.prev = 28;
-          _context7.next = 31;
+          _context9.prev = 28;
+          _context9.next = 31;
           return page["goto"](url);
         case 31:
-          _context7.next = 42;
+          _context9.next = 42;
           break;
         case 33:
-          _context7.prev = 33;
-          _context7.t1 = _context7["catch"](28);
-          if (!_context7.t1.message.includes('net::ERR_CONNECTION_REFUSED')) {
-            _context7.next = 41;
+          _context9.prev = 33;
+          _context9.t1 = _context9["catch"](28);
+          if (!_context9.t1.message.includes('net::ERR_CONNECTION_REFUSED')) {
+            _context9.next = 41;
             break;
           }
           connectionError = new Error("Could not connect to " + url + ". Is the server running?");
           Error.captureStackTrace(connectionError, openPage);
           throw connectionError;
         case 41:
-          throw _context7.t1;
+          throw _context9.t1;
         case 42:
-          _context7.next = 44;
+          _context9.next = 44;
           return page.waitForFunction('document.fonts.status === "loaded"');
         case 44:
-          return _context7.abrupt("return", getPageApi(page));
+          return _context9.abrupt("return", getPageApi(page));
         case 45:
         case "end":
-          return _context7.stop();
+          return _context9.stop();
       }
-    }, _callee7, null, [[28, 33]]);
+    }, _callee9, null, [[28, 33]]);
   }));
-  return function openPage(_x11) {
-    return _ref16.apply(this, arguments);
+  return function openPage(_x13) {
+    return _ref18.apply(this, arguments);
   };
 }();
 var buildQueryMethods = function buildQueryMethods(_temp4) {
-  var _ref17 = _temp4 === void 0 ? {} : _temp4,
-    page = _ref17.page,
-    element = _ref17.element;
+  var _ref19 = _temp4 === void 0 ? {} : _temp4,
+    page = _ref19.page,
+    element = _ref19.element;
   var boundQueries = {};
   var _loop = function _loop() {
     var _Object$entries$_i = _Object$entries[_i],
       queryName = _Object$entries$_i[0],
       queryFn = _Object$entries$_i[1];
-    boundQueries[queryName] = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee12() {
+    boundQueries[queryName] = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee14() {
       var doc,
         body,
         _len2,
@@ -1095,20 +1131,20 @@ var buildQueryMethods = function buildQueryMethods(_temp4) {
         queryArgs,
         elementHandle,
         newElementHandle,
-        _args12 = arguments;
-      return _regeneratorRuntime().wrap(function _callee12$(_context12) {
-        while (1) switch (_context12.prev = _context12.next) {
+        _args14 = arguments;
+      return _regeneratorRuntime().wrap(function _callee14$(_context14) {
+        while (1) switch (_context14.prev = _context14.next) {
           case 0:
-            _context12.next = 2;
+            _context14.next = 2;
             return pptrTestingLibrary.getDocument(page != null ? page : getGlobalPage$1());
           case 2:
-            doc = _context12.sent;
-            _context12.next = 5;
+            doc = _context14.sent;
+            _context14.next = 5;
             return doc.$('body');
           case 5:
-            body = _context12.sent;
-            for (_len2 = _args12.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-              args[_key2] = _args12[_key2];
+            body = _context14.sent;
+            for (_len2 = _args14.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+              args[_key2] = _args14[_key2];
             }
             queryArgs = [].concat(args);
             if (queryName.startsWith('findBy')) {
@@ -1119,98 +1155,98 @@ var buildQueryMethods = function buildQueryMethods(_temp4) {
                 timeout: 10000
               });
             }
-            _context12.next = 11;
+            _context14.next = 11;
             return queryFn.apply(void 0, [element != null ? element : body].concat(queryArgs));
           case 11:
-            elementHandle = _context12.sent;
+            elementHandle = _context14.sent;
             newElementHandle = Object.create(elementHandle);
             newElementHandle.screenshot = /*#__PURE__*/function () {
-              var _ref19 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee8(options) {
-                return _regeneratorRuntime().wrap(function _callee8$(_context8) {
-                  while (1) switch (_context8.prev = _context8.next) {
+              var _ref21 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee10(options) {
+                return _regeneratorRuntime().wrap(function _callee10$(_context10) {
+                  while (1) switch (_context10.prev = _context10.next) {
                     case 0:
                       if (options != null && options.skipNetworkWait) {
-                        _context8.next = 3;
+                        _context10.next = 3;
                         break;
                       }
-                      _context8.next = 3;
+                      _context10.next = 3;
                       return (page != null ? page : getGlobalPage$1()).waitForNetworkIdle();
                     case 3:
-                      _context8.next = 5;
+                      _context10.next = 5;
                       return waitForPaintEnd(elementHandle, _extends({}, options, {
                         fullPage: false
                       }));
                     case 5:
-                      return _context8.abrupt("return", elementHandle.screenshot(normalizeSreenshotOptions(options)));
+                      return _context10.abrupt("return", elementHandle.screenshot(normalizeSreenshotOptions(options)));
                     case 6:
                     case "end":
-                      return _context8.stop();
+                      return _context10.stop();
                   }
-                }, _callee8);
+                }, _callee10);
               }));
-              return function (_x12) {
-                return _ref19.apply(this, arguments);
+              return function (_x14) {
+                return _ref21.apply(this, arguments);
               };
             }();
             newElementHandle.click = /*#__PURE__*/function () {
-              var _ref20 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee9(options) {
-                return _regeneratorRuntime().wrap(function _callee9$(_context9) {
-                  while (1) switch (_context9.prev = _context9.next) {
+              var _ref22 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee11(options) {
+                return _regeneratorRuntime().wrap(function _callee11$(_context11) {
+                  while (1) switch (_context11.prev = _context11.next) {
                     case 0:
-                      _context9.next = 2;
+                      _context11.next = 2;
                       return scrollIntoView(elementHandle);
                     case 2:
-                      return _context9.abrupt("return", elementHandle.click(options));
+                      return _context11.abrupt("return", elementHandle.click(options));
                     case 3:
                     case "end":
-                      return _context9.stop();
+                      return _context11.stop();
                   }
-                }, _callee9);
+                }, _callee11);
               }));
-              return function (_x13) {
-                return _ref20.apply(this, arguments);
+              return function (_x15) {
+                return _ref22.apply(this, arguments);
               };
             }();
             newElementHandle.type = /*#__PURE__*/function () {
-              var _ref21 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee10(text, options) {
-                return _regeneratorRuntime().wrap(function _callee10$(_context10) {
-                  while (1) switch (_context10.prev = _context10.next) {
+              var _ref23 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee12(text, options) {
+                return _regeneratorRuntime().wrap(function _callee12$(_context12) {
+                  while (1) switch (_context12.prev = _context12.next) {
                     case 0:
-                      _context10.next = 2;
+                      _context12.next = 2;
                       return scrollIntoView(elementHandle);
                     case 2:
-                      return _context10.abrupt("return", elementHandle.type(text, options));
+                      return _context12.abrupt("return", elementHandle.type(text, options));
                     case 3:
                     case "end":
-                      return _context10.stop();
+                      return _context12.stop();
                   }
-                }, _callee10);
+                }, _callee12);
               }));
-              return function (_x14, _x15) {
-                return _ref21.apply(this, arguments);
+              return function (_x16, _x17) {
+                return _ref23.apply(this, arguments);
               };
             }();
-            newElementHandle.select = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee11() {
-              var _args11 = arguments;
-              return _regeneratorRuntime().wrap(function _callee11$(_context11) {
-                while (1) switch (_context11.prev = _context11.next) {
+            newElementHandle.select = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee13() {
+              var _args13 = arguments;
+              return _regeneratorRuntime().wrap(function _callee13$(_context13) {
+                while (1) switch (_context13.prev = _context13.next) {
                   case 0:
-                    _context11.next = 2;
+                    _context13.next = 2;
                     return scrollIntoView(elementHandle);
                   case 2:
-                    return _context11.abrupt("return", elementHandle.select.apply(elementHandle, _args11));
+                    return _context13.abrupt("return", elementHandle.select.apply(elementHandle, _args13));
                   case 3:
                   case "end":
-                    return _context11.stop();
+                    return _context13.stop();
                 }
-              }, _callee11);
+              }, _callee13);
             }));
-            return _context12.abrupt("return", newElementHandle);
+            return _context14.abrupt("return", newElementHandle);
           case 18:
           case "end":
-            return _context12.stop();
+            return _context14.stop();
         }
-      }, _callee12);
+      }, _callee14);
     }));
   };
   for (var _i = 0, _Object$entries = Object.entries(pptrTestingLibrary.queries); _i < _Object$entries.length; _i++) {
@@ -1229,73 +1265,73 @@ var within = function within(element) {
     element: element
   });
 };
-beforeEach( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee13() {
-  return _regeneratorRuntime().wrap(function _callee13$(_context13) {
-    while (1) switch (_context13.prev = _context13.next) {
+beforeEach( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee15() {
+  return _regeneratorRuntime().wrap(function _callee15$(_context15) {
+    while (1) switch (_context15.prev = _context15.next) {
       case 0:
-        _context13.next = 2;
+        _context15.next = 2;
         return getGlobalPage$1().setRequestInterception(false);
       case 2:
-        _context13.next = 4;
+        _context15.next = 4;
         return global.jestPuppeteer.resetPage();
       case 4:
       case "end":
-        return _context13.stop();
+        return _context15.stop();
     }
-  }, _callee13);
+  }, _callee15);
 })));
-afterEach( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee14() {
+afterEach( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee16() {
   var page;
-  return _regeneratorRuntime().wrap(function _callee14$(_context14) {
-    while (1) switch (_context14.prev = _context14.next) {
+  return _regeneratorRuntime().wrap(function _callee16$(_context16) {
+    while (1) switch (_context16.prev = _context16.next) {
       case 0:
         if (!process.env.COLLECT_ACCEPTANCE_COVERAGE) {
-          _context14.next = 3;
+          _context16.next = 3;
           break;
         }
-        _context14.next = 3;
+        _context16.next = 3;
         return collectFrontendCoverage({
           coveragePath: coveragePath
         });
       case 3:
-        _context14.prev = 3;
+        _context16.prev = 3;
         page = getGlobalPage$1();
         requestHandlers = [];
         needsRequestInterception = false;
         page.off('request', requestInterceptor);
         // clear tab, this way we clear the DOM and stop js execution or pending requests
-        _context14.next = 10;
+        _context16.next = 10;
         return page["goto"]('about:blank');
       case 10:
-        _context14.next = 14;
+        _context16.next = 14;
         break;
       case 12:
-        _context14.prev = 12;
-        _context14.t0 = _context14["catch"](3);
+        _context16.prev = 12;
+        _context16.t0 = _context16["catch"](3);
       case 14:
       case "end":
-        return _context14.stop();
+        return _context16.stop();
     }
-  }, _callee14, null, [[3, 12]]);
+  }, _callee16, null, [[3, 12]]);
 })));
-afterAll( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee15() {
-  return _regeneratorRuntime().wrap(function _callee15$(_context15) {
-    while (1) switch (_context15.prev = _context15.next) {
+afterAll( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee17() {
+  return _regeneratorRuntime().wrap(function _callee17$(_context17) {
+    while (1) switch (_context17.prev = _context17.next) {
       case 0:
         if (!process.env.COLLECT_ACCEPTANCE_COVERAGE) {
-          _context15.next = 3;
+          _context17.next = 3;
           break;
         }
-        _context15.next = 3;
+        _context17.next = 3;
         return collectBackendCoverage({
           coveragePath: coveragePath,
           coverageUrls: coverageUrls
         });
       case 3:
       case "end":
-        return _context15.stop();
+        return _context17.stop();
     }
-  }, _callee15);
+  }, _callee17);
 })));
 /**
  * Returns a new path to the file that can be used by chromium in acceptance tests
@@ -1371,44 +1407,44 @@ var waitForElementToBeRemoved = function waitForElementToBeRemoved(element, time
   }
   var startStack = new Error().stack;
   var wait = /*#__PURE__*/function () {
-    var _ref26 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee16() {
+    var _ref28 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee18() {
       var t0, box;
-      return _regeneratorRuntime().wrap(function _callee16$(_context16) {
-        while (1) switch (_context16.prev = _context16.next) {
+      return _regeneratorRuntime().wrap(function _callee18$(_context18) {
+        while (1) switch (_context18.prev = _context18.next) {
           case 0:
             t0 = Date.now();
           case 1:
             if (!(Date.now() - t0 < timeout)) {
-              _context16.next = 11;
+              _context18.next = 11;
               break;
             }
-            _context16.next = 4;
+            _context18.next = 4;
             return element.boundingBox();
           case 4:
-            box = _context16.sent;
+            box = _context18.sent;
             if (box) {
-              _context16.next = 7;
+              _context18.next = 7;
               break;
             }
-            return _context16.abrupt("return");
+            return _context18.abrupt("return");
           case 7:
-            _context16.next = 9;
+            _context18.next = 9;
             return new Promise(function (resolve) {
               return setTimeout(resolve, interval);
             });
           case 9:
-            _context16.next = 1;
+            _context18.next = 1;
             break;
           case 11:
             throw new Error('Element not removed');
           case 12:
           case "end":
-            return _context16.stop();
+            return _context18.stop();
         }
-      }, _callee16);
+      }, _callee18);
     }));
     return function wait() {
-      return _ref26.apply(this, arguments);
+      return _ref28.apply(this, arguments);
     };
   }();
   return wait()["catch"](function (error) {