sefiutils 1.0.0 → 1.0.2

package/README.md

@@ -9,6 +9,8 @@ It also adds some utilities for React Fiber in order to make it easier to test R
 however it has no dependency to React itself.
 Additionally setup and teardown functions for Jest are provided.
 
+If you want to test your web app, you probably want to use other frameworks. This package is intended for use in teaching, in particular for grading student's projects. Thus it provides some utilities which are usually not available in other frameworks (as they are usually not required at all).
+
 ## Install
 
 Install with npm:
@@ -22,26 +24,22 @@ npm install --save-dev sefiutils
 In your jest.config.js file add the following lines:
 
 ```
-globalSetup: "<rootDir>/check/tests/swd/globalSetup.ts",
-globalTeardown: "<rootDir>/check/tests/swd/globalTeardown.ts",
+globalSetup: "<rootDir>/node_modules/sefiutils/lib/globalSetup.js",
+  globalTeardown: "<rootDir>/node_modules/sefiutils/lib/globalTeardown.js"
 ```
 
 Depending on the environment variable `BROWSER` either a browser is started or a
 selenium server is started. The following values are supported:
 
-- `remote`: A selenium server is started. This requires the following additional packages to be installed in your project:
-  - selenium-server-standalone-jar -- which needs Java as well!
-- `chrome`: A Chrome browser is started. This requires the following additional packages to be installed in your project:
-  - chromedriver
-  - selenium-webdriver
-- `firefox`: A Firefox browser is started. This requires the following additional packages to be installed in your project:
-  - selenium-webdriver
+- `remote`: A selenium server is started. This requires  Java as well!
+- `chrome`: A Chrome browser is started. 
+- `firefox`: A Firefox browser is started.
 
 In your tests, add the following lines (or similar) to setup and teardown the driver and load the page:
 
 ```
-import { localSetup, LOCAL_SETUP_TIMEOUT } from "seutils/lib/localSetup";
-import { localTeardown } from "seutils/lib/localTeardown";
+import { LOCAL_SETUP_TIMEOUT, localSetup} from "sefiutils/lib/localSetup"
+import { localTeardown} from "sefiutils/lib/localTeardown"
 
 const page = "http://localhost:3000/" // or any other page
 let driver: WebDriver;
@@ -61,6 +59,24 @@ afterAll(async () => {
 
 ## Utils for accessing information from the DOM via Selenium Webdriver injected JavaScript
 
+Most utility functions are provided via module 'seUtils', e.g.
+
+- `waitFor` -- similar to React Testing Library's waitFor
+- `saveScreenshot` -- saves a screenshot to a file
+- `getElementById`, `getElementByClass`, `getElementByTag` -- returns the (first) element with the given id, class or tag
+- `getElementContainingText` -- returns the (first) element containing the given text
+- `getBoundingClientRect`, `getBoundingClientRects` -- returns the bounding rectangle(s) of the given element(s)
+- `getComputedStyle` -- returns the computed style of the given element
+- `getInheritedBackgroundColorsByJS`, `getInheritedColorsByJS` -- returns the inherited (background) color of the given element
+- `getInnerSizeOfWindow`, `getViewPortSize` -- returns the inner size of the window or the viewport size
+- `setBrowserWindowSize` -- sets the size of the browser window (this is directly supported by newer Selenium webdriver versions and only required for older versions)
+- `waitForSetRect` -- waits until the given element has the given bounding rectangle
+- `setViewPortSize` -- sets the size of the viewport
+- `getButtonsAndHRefs` -- returns all buttons and anchors with hrefs of the given element
+
+Most of these functions are scripts executed in the browser via Selenium Webdriver's `executeScript` function.
+
+
 
 
 ## Utils for React Fiber
@@ -68,7 +84,8 @@ afterAll(async () => {
 If you want to test the React components hierarchy, you can use the following functions:
 
 ```
-import { getReactComponentTree, findInComponentTree, equalsIgnoreCase } from "seutils/fiberUtils";
+import { ComponentNode, dumpComponentTree, findAllInComponentTree, 
+         findInComponentTree, getReactComponentTree} from "sefiutils/lib/fiberUtils"
 
 await waitFor(async () => {
     cmpTree = await getReactComponentTree(driver);
@@ -83,6 +100,23 @@ For debugging, you can also dump the tree;
 console.log("Component Tree:\n" + dumpComponentTree(cmpTree));
 ```
 
+## Docker Hints
+
+If you want to run your tests in a docker container on macos with M1 or M2 processor, you can use the following Dockerfile:
+
+```
+FROM seleniarm/standalone-firefox:latest
+
+# install Node 18 and NPM
+RUN sudo apt update
+RUN sudo apt install nodejs npm -y
+
+CMD ["/bin/bash"]
+```
+
+The default user ist "seluser", i.e. home folder is found in "/home/seluser".
+
+
 ## License
 
 This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at https://www.eclipse.org/legal/epl-2.0.

package/lib/fiberUtils.d.ts

@@ -0,0 +1,13 @@
+import { WebDriver } from "selenium-webdriver";
+export type ComponentType = "html" | "function" | "root" | "null" | "other";
+export interface ComponentNode {
+    name: string;
+    kind: ComponentType;
+    props?: string[];
+    children: ComponentNode[];
+}
+export declare function getReactComponentTree(driver: WebDriver): Promise<ComponentNode>;
+export declare function dumpComponentTree(node: ComponentNode): string;
+export declare function findInComponentTree(node: ComponentNode, predicate: (node: ComponentNode) => boolean): ComponentNode | undefined;
+export declare function findAllInComponentTree(node: ComponentNode, predicate: (node: ComponentNode) => boolean): ComponentNode[];
+//# sourceMappingURL=fiberUtils.d.ts.map

package/lib/fiberUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fiberUtils.d.ts","sourceRoot":"","sources":["../src/fiberUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAG/C,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAE5E,MAAM,WAAW,aAAa;IAE1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,aAAa,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,QAAQ,EAAE,aAAa,EAAE,CAAA;CAC5B;AAED,wBAAsB,qBAAqB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,CAIrF;AAGD,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,aAAa,UAWpD;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,OAAO,GAAG,aAAa,GAAG,SAAS,CAW/H;AACD,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,OAAO,mBActG"}

package/lib/fiberUtils.js

@@ -0,0 +1,60 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findAllInComponentTree = exports.findInComponentTree = exports.dumpComponentTree = exports.getReactComponentTree = void 0;
+const seUtils_1 = require("./seUtils");
+function getReactComponentTree(driver) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmpTree = yield (0, seUtils_1.execScript)(driver, "execScripts/fiber.js", "uniDirFunctionComponentsTree");
+        return cmpTree;
+    });
+}
+exports.getReactComponentTree = getReactComponentTree;
+function dumpComponentTree(node) {
+    let out = "";
+    dump(node);
+    return out;
+    function dump(node, indent = "") {
+        out += `${indent}${node.name} (${node.kind})${(node.props && node.props.length > 0) ? ": " + node.props.join(", ") : ""}\n`;
+        for (const child of node.children) {
+            dump(child, indent + "  ");
+        }
+    }
+}
+exports.dumpComponentTree = dumpComponentTree;
+function findInComponentTree(node, predicate) {
+    if (predicate(node)) {
+        return node;
+    }
+    for (const child of node.children) {
+        const found = findInComponentTree(child, predicate);
+        if (found) {
+            return found;
+        }
+    }
+    return undefined;
+}
+exports.findInComponentTree = findInComponentTree;
+function findAllInComponentTree(node, predicate) {
+    const res = [];
+    findAll(node);
+    return res;
+    function findAll(node) {
+        if (predicate(node)) {
+            return res.push(node);
+        }
+        for (const child of node.children) {
+            findAll(child);
+        }
+    }
+}
+exports.findAllInComponentTree = findAllInComponentTree;
+//# sourceMappingURL=fiberUtils.js.map

package/lib/fiberUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fiberUtils.js","sourceRoot":"","sources":["../src/fiberUtils.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,uCAAuC;AAYvC,SAAsB,qBAAqB,CAAC,MAAiB;;QACzD,MAAM,OAAO,GAAkB,MAAM,IAAA,oBAAU,EAAC,MAAM,EAClD,sBAAsB,EAAE,8BAA8B,CAAC,CAAC;QAC5D,OAAO,OAAO,CAAC;IACnB,CAAC;CAAA;AAJD,sDAIC;AAGD,SAAgB,iBAAiB,CAAC,IAAmB;IACjD,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,IAAI,CAAC,IAAI,CAAC,CAAA;IACV,OAAO,GAAG,CAAC;IAEX,SAAS,IAAI,CAAC,IAAmB,EAAE,SAAiB,EAAE;QAClD,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;QAC5H,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC/B,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;SAC9B;IACL,CAAC;AACL,CAAC;AAXD,8CAWC;AAED,SAAgB,mBAAmB,CAAC,IAAmB,EAAE,SAA2C;IAChG,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;QACjB,OAAO,IAAI,CAAC;KACf;IACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE;QAC/B,MAAM,KAAK,GAAG,mBAAmB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACpD,IAAI,KAAK,EAAE;YACP,OAAO,KAAK,CAAC;SAChB;KACJ;IACD,OAAO,SAAS,CAAC;AACrB,CAAC;AAXD,kDAWC;AACD,SAAgB,sBAAsB,CAAC,IAAmB,EAAE,SAA2C;IAEnG,MAAM,GAAG,GAAoB,EAAE,CAAC;IAChC,OAAO,CAAC,IAAI,CAAC,CAAC;IACd,OAAO,GAAG,CAAC;IAEX,SAAS,OAAO,CAAC,IAAmB;QAChC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;YACjB,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACzB;QACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC/B,OAAO,CAAC,KAAK,CAAC,CAAC;SAClB;IACL,CAAC;AACL,CAAC;AAdD,wDAcC"}

package/lib/globalSetup.d.ts

@@ -0,0 +1,22 @@
+declare global {
+    var server: any;
+}
+/**
+ * This function is called by Jest once before all tests are executed.
+ * In order to get called, it must be referenced in the jest configuration file:
+ * ```
+ * "globalSetup": "<rootDir>/tests/globalSetup.ts"
+ * ```
+ *
+ * **Important Note**: "Any global variables that are defined through globalSetup can only be
+ * read in globalTeardown. You cannot retrieve globals defined here in your test suites."
+ * [Jest Documentation](https://jestjs.io/docs/configuration#globalsetup-string)
+ *
+ * We only start the selenium server here if we are running in remote mode, which is the default.
+ * The mode can configured by setting the environment variable BROWSER to "chrome", "firefox" or "remote".
+ *
+ * Do not forget a global teardown function, which is called after all tests are executed,
+ * cf. globalTeardown.ts
+ */
+export default function setGlobalObjects(): Promise<void>;
+//# sourceMappingURL=globalSetup.d.ts.map

package/lib/globalSetup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalSetup.d.ts","sourceRoot":"","sources":["../src/globalSetup.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACX,IAAI,MAAM,EAAE,GAAG,CAAC;CAEnB;AACD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAA8B,gBAAgB,kBAY7C"}

package/lib/globalSetup.js

@@ -0,0 +1,88 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * This function is called by Jest once before all tests are executed.
+ * In order to get called, it must be referenced in the jest configuration file:
+ * ```
+ * "globalSetup": "<rootDir>/tests/globalSetup.ts"
+ * ```
+ *
+ * **Important Note**: "Any global variables that are defined through globalSetup can only be
+ * read in globalTeardown. You cannot retrieve globals defined here in your test suites."
+ * [Jest Documentation](https://jestjs.io/docs/configuration#globalsetup-string)
+ *
+ * We only start the selenium server here if we are running in remote mode, which is the default.
+ * The mode can configured by setting the environment variable BROWSER to "chrome", "firefox" or "remote".
+ *
+ * Do not forget a global teardown function, which is called after all tests are executed,
+ * cf. globalTeardown.ts
+ */
+function setGlobalObjects() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const browser = process.env.BROWSER || "remote";
+        // console.log(`Using browser: ${browser}`);
+        try {
+            if (browser === "remote") {
+                yield setUpSeleniumServer();
+            }
+        }
+        catch (err) {
+            console.error(`Error setting up server: ${err}`);
+            throw err;
+        }
+    });
+}
+exports.default = setGlobalObjects;
+function setUpSeleniumServer() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const remote = yield Promise.resolve().then(() => __importStar(require("selenium-webdriver/remote")));
+        //@ts-ignore
+        const jar = yield Promise.resolve().then(() => __importStar(require('selenium-server-standalone-jar')));
+        if (globalThis.server) {
+            yield globalThis.server.kill();
+            console.log(`Server killed before starting again`);
+        }
+        // console.log(`Load selenium server from ${jar.path}`);
+        const s = new remote.SeleniumServer(jar.path, {
+            port: 4444,
+            env: Object.assign(Object.assign({}, process.env), { "SE_NODE_MAX_SESSIONS": "4", "SE_NODE_OVERRIDE_MAX_SESSIONS": "true" })
+        });
+        const address = yield s.start(3000);
+        globalThis.server = s;
+        // const address = await globalThis.server.address()
+        // console.log(`Selenium server started at address: ${address}`);
+    });
+}
+//# sourceMappingURL=globalSetup.js.map

package/lib/globalSetup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalSetup.js","sourceRoot":"","sources":["../src/globalSetup.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA;;;;;;;;;;;;;;;;GAgBG;AACH,SAA8B,gBAAgB;;QAC1C,MAAM,OAAO,GAAI,OAAO,CAAC,GAAG,CAAC,OAA2C,IAAI,QAAQ,CAAC;QAErF,4CAA4C;QAC5C,IAAI;YACA,IAAI,OAAO,KAAK,QAAQ,EAAE;gBACtB,MAAM,mBAAmB,EAAE,CAAC;aAC/B;SACJ;QAAC,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,4BAA4B,GAAG,EAAE,CAAC,CAAC;YACjD,MAAM,GAAG,CAAC;SACb;IACL,CAAC;CAAA;AAZD,mCAYC;AAGD,SAAe,mBAAmB;;QAE9B,MAAM,MAAM,GAAG,wDAAa,2BAA2B,GAAC,CAAC;QACzD,YAAY;QACZ,MAAM,GAAG,GAAG,wDAAa,gCAAgC,GAAC,CAAC;QAE3D,IAAI,UAAU,CAAC,MAAM,EAAE;YACnB,MAAM,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YAC/B,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;SACtD;QAED,wDAAwD;QACxD,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE;YAC1C,IAAI,EAAE,IAAI;YACV,GAAG,kCACI,OAAO,CAAC,GAAG,KACd,sBAAsB,EAAE,GAAG,EAC3B,+BAA+B,EAAE,MAAM,GAE1C;SACJ,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;QACtB,oDAAoD;QACpD,iEAAiE;IACrE,CAAC;CAAA"}

package/{src/globalTeardown.ts → lib/globalTeardown.d.ts}

@@ -1,21 +1,14 @@
-
 /**
- * This function is called by Jest once after tests have been executed. 
+ * This function is called by Jest once after tests have been executed.
  * In order to get called, it must be referenced in the jest configuration file:
  * ```
  * "globalTeardown": "<rootDir>/tests/globalTeardown.ts"
  * ```
- * **Important Note**: "Any global variables that are defined through globalSetup can only be 
+ * **Important Note**: "Any global variables that are defined through globalSetup can only be
  * read in globalTeardown. You cannot retrieve globals defined here in your test suites."
  * [Jest Documentation](https://jestjs.io/docs/configuration#globalsetup-string)
- * 
+ *
  * Here, we stop the remote selenium server if it was started in globalSetup.ts.
  */
-export default async function killServer() {
-    if (globalThis.server) {
-        await server.kill();
-        console.log(`Server killed`);
-
-    }
-    globalThis.server = undefined;
-}
+export default function killServer(): Promise<void>;
+//# sourceMappingURL=globalTeardown.d.ts.map

package/lib/globalTeardown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalTeardown.d.ts","sourceRoot":"","sources":["../src/globalTeardown.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;GAWG;AACH,wBAA8B,UAAU,kBAOvC"}

package/lib/globalTeardown.js

@@ -0,0 +1,34 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * This function is called by Jest once after tests have been executed.
+ * In order to get called, it must be referenced in the jest configuration file:
+ * ```
+ * "globalTeardown": "<rootDir>/tests/globalTeardown.ts"
+ * ```
+ * **Important Note**: "Any global variables that are defined through globalSetup can only be
+ * read in globalTeardown. You cannot retrieve globals defined here in your test suites."
+ * [Jest Documentation](https://jestjs.io/docs/configuration#globalsetup-string)
+ *
+ * Here, we stop the remote selenium server if it was started in globalSetup.ts.
+ */
+function killServer() {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (globalThis.server) {
+            yield server.kill();
+            console.log(`Server killed`);
+        }
+        globalThis.server = undefined;
+    });
+}
+exports.default = killServer;
+//# sourceMappingURL=globalTeardown.js.map

package/lib/globalTeardown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalTeardown.js","sourceRoot":"","sources":["../src/globalTeardown.ts"],"names":[],"mappings":";;;;;;;;;;;AACA;;;;;;;;;;;GAWG;AACH,SAA8B,UAAU;;QACpC,IAAI,UAAU,CAAC,MAAM,EAAE;YACnB,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;SAEhC;QACD,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC;IAClC,CAAC;CAAA;AAPD,6BAOC"}

package/lib/localSetup.d.ts

@@ -0,0 +1,4 @@
+import { WebDriver } from "selenium-webdriver";
+export declare const LOCAL_SETUP_TIMEOUT = 20000;
+export declare function localSetup(page: string, width?: number, height?: number): Promise<WebDriver>;
+//# sourceMappingURL=localSetup.d.ts.map

package/lib/localSetup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localSetup.d.ts","sourceRoot":"","sources":["../src/localSetup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAGtE,eAAO,MAAM,mBAAmB,QAAQ,CAAC;AAEzC,wBAAsB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,SAAM,EAAE,MAAM,SAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAM5F"}

package/lib/localSetup.js

@@ -0,0 +1,139 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.localSetup = exports.LOCAL_SETUP_TIMEOUT = void 0;
+const selenium_webdriver_1 = require("selenium-webdriver");
+const seUtils_1 = require("./seUtils");
+exports.LOCAL_SETUP_TIMEOUT = 20000;
+function localSetup(page, width = 500, height = 500) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const driver = yield getWebDriver();
+        console.log(`Load page: ${page}`);
+        yield driver.get(page);
+        yield (0, seUtils_1.setBrowserWindowSize)(driver, width, height);
+        return driver;
+    });
+}
+exports.localSetup = localSetup;
+/**
+ * To be configured in jest setup file via globalSetup as it needs to be run before any tests in all files.
+ * Additionally,
+ * ```
+ * await driver.get(page);
+ * await setViewPortSize(500, 500);
+ * ```
+ * are to be called.
+*/
+function getWebDriver() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const browser = process.env.BROWSER || "remote";
+        // console.log(`Using browser: ${browser}`);
+        try {
+            if (browser === "chrome") {
+                return yield setUpWebDriverChrome();
+            }
+            else if (browser === "firefox") {
+                return yield setUpWebDriverFirefox();
+            }
+            else if (browser === "remote") {
+                return yield setUpWebDriverInDocker();
+            }
+            else {
+                throw new Error(`Unknown browser: ${browser}`);
+            }
+        }
+        catch (err) {
+            console.error(`Error setting up driver: ${err}`);
+            throw err;
+        }
+    });
+}
+function setUpWebDriverInDocker() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const firefox = yield Promise.resolve().then(() => __importStar(require('selenium-webdriver/firefox')));
+        let address = "http://localhost:4444/wd/hub";
+        let start = Date.now();
+        const driver = yield new selenium_webdriver_1.Builder()
+            .usingServer(address)
+            .withCapabilities(selenium_webdriver_1.Capabilities.firefox())
+            .setFirefoxOptions(new firefox.Options().headless())
+            .build();
+        let duration = (Date.now() - start) / 1000;
+        // console.log(`Driver resolved and connected to ${address}, required ${duration}s.`);
+        return driver;
+    });
+}
+/**
+ * To be called in the beforeAll() function of a test suite.
+ * Additionally,
+ * ```
+ * await driver.get(page);
+ * await setViewPortSize(500, 500);
+ * ```
+ * are to be called.
+ */
+function setUpWebDriverChrome() {
+    return __awaiter(this, void 0, void 0, function* () {
+        //@ts-ignore
+        yield Promise.resolve().then(() => __importStar(require('chromedriver')));
+        const chrome = yield Promise.resolve().then(() => __importStar(require('selenium-webdriver/chrome')));
+        const driver = yield new selenium_webdriver_1.Builder()
+            .forBrowser('chrome')
+            .setChromeOptions(new chrome.Options().headless())
+            .build();
+        return driver;
+    });
+}
+/**
+ * To be called in the beforeAll() function of a test suite.
+ * Additionally,
+ * ```
+ * await driver.get(page);
+ * await setViewPortSize(500, 500);
+ * ```
+ * are to be called.
+ */
+function setUpWebDriverFirefox() {
+    return __awaiter(this, void 0, void 0, function* () {
+        //@ts-ignore
+        yield Promise.resolve().then(() => __importStar(require('geckodriver'))); // installed geckodriver will cause remote configuration to fail in docker...
+        const firefox = yield Promise.resolve().then(() => __importStar(require('selenium-webdriver/firefox')));
+        const driver = yield new selenium_webdriver_1.Builder()
+            .forBrowser('firefox')
+            .setFirefoxOptions(new firefox.Options().headless())
+            .build();
+        return driver;
+    });
+}
+//# sourceMappingURL=localSetup.js.map

package/lib/localSetup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localSetup.js","sourceRoot":"","sources":["../src/localSetup.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2DAAsE;AACtE,uCAAkE;AAErD,QAAA,mBAAmB,GAAG,KAAK,CAAC;AAEzC,SAAsB,UAAU,CAAC,IAAY,EAAE,KAAK,GAAG,GAAG,EAAE,MAAM,GAAG,GAAG;;QACpE,MAAM,MAAM,GAAG,MAAM,YAAY,EAAE,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC;QAClC,MAAM,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,IAAA,8BAAoB,EAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,MAAM,CAAC;IAClB,CAAC;CAAA;AAND,gCAMC;AAED;;;;;;;;EAQE;AACF,SAAe,YAAY;;QACvB,MAAM,OAAO,GAAI,OAAO,CAAC,GAAG,CAAC,OAA2C,IAAI,QAAQ,CAAC;QAErF,4CAA4C;QAC5C,IAAI;YACA,IAAI,OAAO,KAAK,QAAQ,EAAE;gBACtB,OAAO,MAAM,oBAAoB,EAAE,CAAC;aACvC;iBAAM,IAAI,OAAO,KAAK,SAAS,EAAE;gBAC9B,OAAO,MAAM,qBAAqB,EAAE,CAAC;aACxC;iBAAM,IAAI,OAAO,KAAK,QAAQ,EAAE;gBAC7B,OAAO,MAAM,sBAAsB,EAAE,CAAC;aACzC;iBAAM;gBACH,MAAM,IAAI,KAAK,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAC;aAClD;SACJ;QAAC,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,4BAA4B,GAAG,EAAE,CAAC,CAAC;YACjD,MAAM,GAAG,CAAC;SACb;IACL,CAAC;CAAA;AAGD,SAAe,sBAAsB;;QAEjC,MAAM,OAAO,GAAG,wDAAa,4BAA4B,GAAC,CAAC;QAE3D,IAAI,OAAO,GAAG,8BAA8B,CAAC;QAC7C,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,MAAM,IAAI,4BAAO,EAAE;aAC7B,WAAW,CAAC,OAAO,CAAC;aACpB,gBAAgB,CAAC,iCAAY,CAAC,OAAO,EAAE,CAAC;aACxC,iBAAiB,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;aACnD,KAAK,EAAE,CAAC;QACb,IAAI,QAAQ,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC;QAC3C,sFAAsF;QACtF,OAAO,MAAM,CAAC;IAClB,CAAC;CAAA;AAGD;;;;;;;;GAQG;AACH,SAAe,oBAAoB;;QAC/B,YAAY;QACZ,wDAAa,cAAc,GAAC,CAAC;QAC7B,MAAM,MAAM,GAAG,wDAAa,2BAA2B,GAAC,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,IAAI,4BAAO,EAAE;aAC7B,UAAU,CAAC,QAAQ,CAAC;aACpB,gBAAgB,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;aACjD,KAAK,EAAE,CAAC;QACb,OAAO,MAAM,CAAC;IAClB,CAAC;CAAA;AAED;;;;;;;;GAQG;AACH,SAAe,qBAAqB;;QAChC,YAAY;QACZ,wDAAa,aAAa,GAAC,CAAC,CAAC,6EAA6E;QAC1G,MAAM,OAAO,GAAG,wDAAa,4BAA4B,GAAC,CAAC;QAC3D,MAAM,MAAM,GAAG,MAAM,IAAI,4BAAO,EAAE;aAC7B,UAAU,CAAC,SAAS,CAAC;aACrB,iBAAiB,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;aACnD,KAAK,EAAE,CAAC;QAEb,OAAO,MAAM,CAAC;IAClB,CAAC;CAAA"}

package/lib/localTeardown.d.ts

@@ -0,0 +1,6 @@
+import { WebDriver } from "selenium-webdriver";
+/**
+ * To be called in the afterAll() function of a test suite.
+ */
+export declare function localTeardown(driver: WebDriver): Promise<void>;
+//# sourceMappingURL=localTeardown.d.ts.map

package/lib/localTeardown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localTeardown.d.ts","sourceRoot":"","sources":["../src/localTeardown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C;;GAEG;AACH,wBAAsB,aAAa,CAAC,MAAM,EAAE,SAAS,iBAQpD"}

package/lib/localTeardown.js

@@ -0,0 +1,28 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.localTeardown = void 0;
+/**
+ * To be called in the afterAll() function of a test suite.
+ */
+function localTeardown(driver) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (driver) {
+            yield driver.quit();
+            // console.log(`Driver quit`);
+        }
+        else {
+            throw new Error("Driver not started yet");
+        }
+    });
+}
+exports.localTeardown = localTeardown;
+//# sourceMappingURL=localTeardown.js.map

package/lib/localTeardown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localTeardown.js","sourceRoot":"","sources":["../src/localTeardown.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA;;GAEG;AACH,SAAsB,aAAa,CAAC,MAAiB;;QACjD,IAAI,MAAM,EAAE;YACR,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,8BAA8B;SACjC;aAAM;YACH,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAE7C;IACL,CAAC;CAAA;AARD,sCAQC"}