sefiutils 1.0.0 → 1.0.1

package/src/globalSetup.ts

@@ -1,62 +0,0 @@
-declare global {
-    var server: any; // only loaded in remote case; this global variable is only visible in globalTeardown.ts
-        // and not in the tests, cf. https://jestjs.io/docs/configuration#globalsetup-string
-}
-/**
- * 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 async function setGlobalObjects() {
-    const browser = (process.env.BROWSER as "chrome" | "firefox" | "remote") || "remote";
-
-    // console.log(`Using browser: ${browser}`);
-    try {
-        if (browser === "remote") {
-            await setUpSeleniumServer();
-        }
-    } catch (err) {
-        console.error(`Error setting up server: ${err}`);
-        throw err;
-    }
-}
-
-
-async function setUpSeleniumServer() {
-
-    const remote = await import("selenium-webdriver/remote");
-    //@ts-ignore
-    const jar = await import('selenium-server-standalone-jar');
-
-    if (globalThis.server) {
-        await 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: {
-            ...process.env,
-            "SE_NODE_MAX_SESSIONS": "4",
-            "SE_NODE_OVERRIDE_MAX_SESSIONS": "true",
-            // "JAVA_OPTS": "-XX:ActiveProcessorCount=4"
-        }
-    });
-    const address = await s.start(3000);
-    globalThis.server = s;
-    // const address = await globalThis.server.address()
-    // console.log(`Selenium server started at address: ${address}`);
-}

package/src/localSetup.ts

@@ -1,100 +0,0 @@
-import { Builder, Capabilities, WebDriver } from "selenium-webdriver";
-import { setBrowserWindowSize, setViewPortSize } from "./seUtils";
-
-export const LOCAL_SETUP_TIMEOUT = 20000;
-
-export async function localSetup(page: string, width = 500, height = 500): Promise<WebDriver> {
-    const driver = await getWebDriver();
-    console.log(`Load page: ${page}`);
-    await driver.get(page);
-    await setBrowserWindowSize(driver, width, height);
-    return driver;
-}
-
-/**
- * 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.
-*/
-async function getWebDriver() {
-    const browser = (process.env.BROWSER as "chrome" | "firefox" | "remote") || "remote";
-
-    // console.log(`Using browser: ${browser}`);
-    try {
-        if (browser === "chrome") {
-            return await setUpWebDriverChrome();
-        } else if (browser === "firefox") {
-            return await setUpWebDriverFirefox();
-        } else if (browser === "remote") {
-            return await setUpWebDriverInDocker();
-        } else {
-            throw new Error(`Unknown browser: ${browser}`);
-        }
-    } catch (err) {
-        console.error(`Error setting up driver: ${err}`);
-        throw err;
-    }
-}
-
-
-async function setUpWebDriverInDocker() {
-
-    const firefox = await import('selenium-webdriver/firefox');
-
-    let address = "http://localhost:4444/wd/hub";
-    let start = Date.now();
-    const driver = await new Builder()
-        .usingServer(address)
-        .withCapabilities(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.
- */
-async function setUpWebDriverChrome() {
-    //@ts-ignore
-    await import('chromedriver');
-    const chrome = await import('selenium-webdriver/chrome');
-    const driver = await new 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.
- */
-async function setUpWebDriverFirefox() {
-    //@ts-ignore
-    await import('geckodriver'); // installed geckodriver will cause remote configuration to fail in docker...
-    const firefox = await import('selenium-webdriver/firefox');
-    const driver = await new Builder()
-        .forBrowser('firefox')
-        .setFirefoxOptions(new firefox.Options().headless())
-        .build();
-
-    return driver;
-}

package/src/localTeardown.ts

@@ -1,14 +0,0 @@
-import { WebDriver } from "selenium-webdriver";
-
-/**
- * To be called in the afterAll() function of a test suite.
- */
-export async function localTeardown(driver: WebDriver) {
-    if (driver) {
-        await driver.quit();
-        // console.log(`Driver quit`);
-    } else {
-        throw new Error("Driver not started yet");
-
-    }
-}

package/src/seUtils.ts

@@ -1,448 +0,0 @@
-/**
- * (C) Jens von Pilgrim, 2022
- */
-import * as fs from "fs";
-import * as fsPromises from "fs/promises";
-import path from "path";
-import { By, Locator, WebDriver, WebElement } from 'selenium-webdriver';
-
-export async function execScript<T>(driver: WebDriver, scriptName: string, fct: string): Promise<T> {
-    const scriptPath = path.join(path.dirname(__filename), scriptName);
-    const script = fs.readFileSync(scriptPath, "utf-8");
-    const res = await driver.executeScript(script + `
-        return ${fct}();
-    `);
-    return res as T;
-}
-
-export interface Bounds {
-    top: number;
-    left: number;
-    bottom: number;
-    right: number;
-}
-
-
-export function boundsToString(bounds: Bounds) {
-    return `(${bounds.left};${bounds.top})x(${bounds.right};${bounds.bottom})`
-}
-
-export function toFloor(bounds: Bounds[]) {
-    const floors: Bounds[] = [];
-    for (const b of bounds) {
-        floors.push({
-            top: Math.floor(b.top),
-            bottom: Math.floor(b.bottom),
-            left: Math.floor(b.left),
-            right: Math.floor(b.right)
-        })
-    }
-    return floors;
-}
-
-/**
- * Coordinates are sometimes floats. We compare two numbers with a delta of 1 to ignore rounding problems. 
- */
-export function circa(n1: number, n2: number) {
-    const delta = n1 - n2;
-    return Math.abs(delta) < 1;
-}
-
-
-
-export async function waitFor<T>(callback: () => Promise<T>, timeout=1000, intervalTime=100): Promise<T> {
-    // try first time
-    const start = new Date().getTime();
-    try {
-        const result = await callback();
-        return result;
-    } catch (error) {
-        // ignore error
-    }
-    // if error, try until timeout ms have passed
-    return new Promise<T>((resolve, reject) => {
-        const interval = setInterval(async () => {
-            try {
-                const result = await callback();
-                clearInterval(interval);
-                resolve(result);
-            } catch (error) {
-                const duration = new Date().getTime() - start;
-                if (duration > timeout) {
-                    clearInterval(interval);
-                    reject(error);
-                }
-            }
-        }, intervalTime);
-    });
-}
-
-
-/**
- * Takes screenshot of current window and saves it to the given file.
- * The folder is created if it does not yet exists.
- */
-export async function saveScreenshot(driver: WebDriver, fileName: string): Promise<void> {
-    const pngBase64 = await driver.takeScreenshot();
-    const dirName = path.dirname(fileName);
-    if (!fs.existsSync(dirName)) {
-        await fsPromises.mkdir(dirName, { recursive: true });
-    }
-    await fsPromises.writeFile(fileName, pngBase64, 'base64');
-}
-
-
-
-/**
- * Helper function for printing out an element (tag, id if present)
- */
-export async function describe(we: WebElement) {
-    let s = await we.getTagName();
-    const id = await we.getAttribute("id");
-    if (id) {
-        s += "#" + id;
-    } else {
-        const clazz = await we.getAttribute("class");
-        if (clazz) {
-            s += "." + clazz;
-        }
-        let text = await we.getText();
-        s += ` ("${text.substring(0, 7)}${text.length > 7 ? '…' : ''})"`;
-    }
-    return s;
-}
-
-/**
- * Gets the element by means of `WebElement` by its id attribute.
- */
-export async function getElementById(driver: WebDriver, id: string): Promise<WebElement> {
-    const el = await driver.findElement(By.id(id));
-    return el;
-}
-
-/**
- * Gets the first element by means of `WebElement` by its class attribute.
- */
-export async function getElementByClass(driver: WebDriver, clazz: string): Promise<WebElement> {
-    const el = await driver.findElement(By.className(clazz));
-    return el;
-}
-
-/**
- * Gets the first element by means of `WebElement` by its tag name.
- */
-export async function getElementByTag(driver: WebDriver, tagName: string): Promise<WebElement> {
-    const el = await driver.findElement(By.css(tagName));
-    return el;
-}
-
-/**
- * Returns first element containing given text or undefined.
- * 
- * Test in browser console: `$x("//*[contains(text(), 'Hello')]")`
- */
-export async function getElementContainingText(driver: WebDriver, text: string): Promise<WebElement|undefined> {
-    try {
-        // cf. https://stackoverflow.com/questions/3655549/xpath-containstext-some-string-doesnt-work-when-used-with-node-with-more
-        //const el = await driver.findElement(By.xpath(`//*[contains(text(), "${text}")]`));
-        const el = await driver.findElement(By.xpath(`//*[text()[contains(., '${text}')]]`));
-        return el;
-    } catch (error) {
-        return undefined;
-    }
-}
-
-
-/**
- * Returns the bounding client rect (the bounding box relative to the viewport)
- * of an element (found by its is attribute) by means of a JavaScript call.
- */
-export async function getBoundingClientRect(driver: WebDriver, id: string): Promise<DOMRect> {
-    const bcr = await driver.executeScript('return document.getElementById("' + id + '").getBoundingClientRect()');
-    return bcr as DOMRect;
-}
-
-/**
- * Returns all {@link getBoundingClientRect} values of the elements
- * found in the given element list.
- * The element list is computed by means of JavaScript code,
- * e.g. `document.getElementsByClassName('grid').item(0).children`.
- * 
- * @param elementList JavaScript code to determine the element list
- */
-export async function getBoundingClientRects(driver: WebDriver, jsElementList: string): Promise<DOMRect[]> {
-    const bcr = await driver.executeScript(
-        `return (()=>{ 
-            const elements = ${jsElementList};
-            const bounds=[];
-            for (let el of elements) { bounds.push(el.getBoundingClientRect()) }
-            return bounds;
-        })()`) as DOMRect[];
-    return bcr;
-}
-
-/**
- * Returns the rects using the driver API.
- */
-export async function getRects(driver: WebDriver, locator: Locator): Promise<Bounds[]> {
-    const elements = await driver.findElements(locator);
-    const bounds: Bounds[] = [];
-    for (const element of elements) {
-        const rect = await element.getRect();
-        bounds.push({
-            top: rect.x, left: rect.y,
-            bottom: rect.x + rect.width, right: rect.y + rect.height
-        });
-    }
-    return bounds;
-}
-
-/**
- * Returns the rects of the first child (of each found element) using the driver API.
- */
-export async function getRectsOfContent(driver: WebDriver, locator: Locator): Promise<Bounds[]> {
-    const elements = await driver.findElements(locator);
-    const bounds: Bounds[] = [];
-    for (const element of elements) {
-        const rect = await element.getRect();
-        bounds.push({
-            top: rect.x, left: rect.y,
-            bottom: rect.x + rect.width, right: rect.y + rect.height
-        });
-    }
-    return bounds;
-}
-
-
-
-
-/**
- * Returns all text content of the elements
- * found in the given element list.
- * The elements list is computed by means of JavaScript code,
- * e.g. `document.getElementsByClassName('grid').item(0).children`.
- * 
- * This is useful in combination with {@link getBoundingClientRects} in 
- * order to describe the items.
- * 
- * @param elementList JavaScript code to determine the element list
- */
-export async function getTextContents(driver: WebDriver, jsElementList: string): Promise<string[]> {
-    const tcs = await driver.executeScript(
-        `const elements = ${jsElementList};
-         const tcs=[];
-         for (let el of elements) { tcs.push(el.textContent) }
-         return tcs;
-        `) as string[];
-    return tcs;
-}
-
-/**
- * Returns all computed styles of the elements
- * found in the given element list.
- * The elements list is computed by means of JavaScript code,
- * e.g. `document.getElementsByClassName('grid').item(0).children`.
- * 
- * @param elementList JavaScript code to determine the element list
- */
-export async function getComputedStyles(driver: WebDriver, jsElementList: string, style: string): Promise<string[]> {
-    const tcs = await driver.executeScript(
-        `const elements = ${jsElementList};
-         const tcs=[];
-         for (let el of elements) { tcs.push(getComputedStyle(el).${style}) }
-         return tcs;
-        `) as string[];
-    return tcs;
-}
-
-
-/**
- * Returns the inner size of the windows bounding client rect (the bounding box relative to the viewport)
- * of an element (found by its is attribute) by means of a JavaScript call.
- * The window size contains the scrollbars. I.e. it is a bit larger than {@link getViewPortSize}.
- */
-export async function getInnerSizeOfWindow(driver: WebDriver): Promise<{ width: number, height: number }> {
-    const w = await driver.executeScript('return window.innerWidth') as number;
-    const h = await driver.executeScript('return window.innerHeight') as number;
-    return { width: w, height: h };
-}
-
-/**
- * Returns the viewport size, which is the inner window size but not with the scrollbars.
- * I.e. the viewport size is a bit smaller than {@link getInnerSizeOfWindow} (if scrollbars are visible).
- * The value is retrieved by means of JavaScript.
- */
-export async function getViewPortSize(driver: WebDriver): Promise<{ width: number, height: number }> {
-    const [clientWidthOfHTML, clientHeightOfHTML] = await Promise.all([
-        driver.executeScript("return document.documentElement.clientWidth"),
-        driver.executeScript("return document.documentElement.clientHeight")]) as number[];
-    return { width: clientWidthOfHTML, height: clientHeightOfHTML };
-}
-
-/**
- * Returns true if the element identified by its id attribute is with the view port.
- * That does not necessarily means that it is visible, since its display or visible attribute may
- * hide the element.
- */
-export async function isInViewPort(driver: WebDriver, id: string) {
-    const innerSize = await getInnerSizeOfWindow(driver);
-    const [x, y] = await Promise.all([
-        driver.executeScript('return window.scrollX'),
-        driver.executeScript('return window.scrollY')]) as number[];
-    const bounds = await getBoundingClientRect(driver, id);
-    return bounds.x + bounds.width >= x && bounds.y + bounds.height >= y
-        && bounds.x < x + innerSize.width && bounds.y < y + innerSize.height
-}
-
-/**
- * Sets the window so that the {@link getViewPortSize} matches the given width and height.
- */
-export async function setBrowserWindowSize(driver: WebDriver, width: number, height: number): Promise<void> {
-    // const rect = await driver.manage().window().getRect();
-    await waitForSetRect(driver, width, height);
-    // await driver.manage().window().setRect({ width: width, height: height });
-    // return waitFor(async () => {
-    //     const rectAfter = await driver.manage().window().getRect();
-
-    //     if (check && (rectAfter.width != width || rectAfter.height != height)) {
-    //         throw new Error(`Cannot set window to size (${width}, ${height}). Size is probably too small or too large, got ${rectAfter.width}/${rectAfter.height},  was before ${rect.width}/${rect.height}.`);
-    //     }
-    // });
-}
-
-async function waitForSetRect(driver: WebDriver, width: number, height: number): Promise<void> {
-    const rectBefore = await driver.manage().window().getRect();
-
-    await driver.manage().window().setRect({ width: width, height: height });
-    return waitFor(async () => {
-        const rectAfter = await driver.manage().window().getRect();
-        if (rectAfter.width != width || rectAfter.height != height) {
-            throw new Error(`Cannot set window to size (${width}, ${height}). Size is probably too small or too large, got ${rectAfter.width}/${rectAfter.height}, was before ${rectBefore.width}/${rectBefore.height}.`);
-        }
-    });
-}
-
-/**
- * Sets the window so that the {@link getViewPortSize} matches the given width and height. Warning: This does not work reliably.
- */
-export async function setViewPortSize(driver: WebDriver, width: number, height: number): Promise<void> {
-    const rect = await driver.manage().window().getRect();
-    const innerBefore = await getInnerSizeOfWindow(driver);
-    const deltaX = rect.width - innerBefore.width;
-    const deltaY = rect.height - innerBefore.height;
-    await waitForSetRect(driver, width + deltaX, height + deltaY);
-
-    const [innerAfter, viewport] = await Promise.all([getInnerSizeOfWindow(driver), getViewPortSize(driver)]);
-
-    // adjust scrollbars if necessary
-    const sbHeight = innerAfter.height - viewport.height;
-    const sbWidth = innerAfter.width - viewport.width;
-    await waitForSetRect(driver, width + deltaX + sbWidth, height + deltaY + sbHeight);
-}
-
-export async function getInheritedBackgroundColorsByJS(driver: WebDriver, nodelist: string) {
-    const colors = await driver.executeScript(`
-        const list = ${nodelist};
-        function getDefaultBackground() {
-            var div = document.createElement("div")
-            document.head.appendChild(div)
-            var bg = getComputedStyle(div).backgroundColor
-            document.head.removeChild(div)
-            return bg
-        }
-        const defaultStyle = getDefaultBackground()
-        function getInheritedBackgroundColor(el) {
-            var backgroundColor = getComputedStyle(el).backgroundColor
-            if (backgroundColor != defaultStyle) return backgroundColor
-            if (!el.parentElement) return defaultStyle
-            return getInheritedBackgroundColor(el.parentElement)
-        }
-        const colors = []
-        for (let e of list) {
-            colors.push(getInheritedBackgroundColor(e));
-        }
-        return colors;
-      `) as string[];
-    return colors;
-}
-
-export async function getInheritedColorsByJS(driver: WebDriver, nodelist: string) {
-    const colors = await driver.executeScript(`
-        const list = ${nodelist};
-        function getDefaultColor() {
-            var div = document.createElement("div")
-            document.head.appendChild(div)
-            var bg = getComputedStyle(div).color
-            document.head.removeChild(div)
-            return bg
-        }
-        const defaultStyle = getDefaultColor()
-        function getInheritedColor(el) {
-            var color = getComputedStyle(el).color
-            if (color != defaultStyle) return color
-            if (!el.parentElement) return defaultStyle
-            return getInheritedColor(el.parentElement)
-        }
-        const colors = []
-        for (let e of list) {
-            colors.push(getInheritedColor(e));
-        }
-        return colors;
-      `) as string[];
-    return colors;
-}
-
-function rgb2hex(rgba: string) {
-    return "#" +
-        rgba.match(/^rgba?\((\d+),\s*(\d+),\s*(\d+)(?:,\s*(\d+\.{0,1}\d*))?\)$/)!
-            .slice(1)
-            .map((n, i) => (i === 3
-                ? Math.round(parseFloat(n) * 255)
-                : parseFloat(n)).toString(16).padStart(2, '0').replace('NaN', ''))
-            .join('');
-}
-
-export async function getAllTextNodes(driver: WebDriver): Promise<{ text: string; color: string; background: string; line: string; }[]> {
-    const res = await driver.executeScript(`
-    
-const TRANSPARENT = "rgba(0, 0, 0, 0)";
-const all = []; 
-const view = document.defaultView;
-function collect(e) {
-    const styles = view.getComputedStyle(e);
-    const pStyles = view.getComputedStyle(e.parentElement);
-    const childNodes = e.childNodes;
-    for (let i=0; i<childNodes.length; i++) {
-        const node = childNodes.item(i);
-        if (node instanceof Element) {
-           collect(node);
-        } else if (node instanceof Text && node.textContent.trim().length>0) {
-            all.push({ 
-                text: node.textContent.trim(), 
-                color: styles?.color!==TRANSPARENT?styles?.color:pStyles?.color,
-                background: styles?.backgroundColor!==TRANSPARENT?styles?.backgroundColor:pStyles?.backgroundColor,
-                line: styles?.textDecorationLine==='none'?pStyles?.textDecorationLine:styles?.textDecorationLine
-            });
-        }
-    }
-}
-collect(document.body);
-
-
-    return all;
-    `) as { text: string, color: string, background: string, line: string }[];
-
-    res.forEach(e => {
-        e.color = rgb2hex(e.color);
-        e.background = rgb2hex(e.background);
-    });
-
-
-    return res;
-}
-
-export async function getButtonsAndHRefs(driver: WebDriver): Promise<WebElement[]> {
-    const elements: WebElement[] = await execScript(driver,
-        "execScripts/dom.js", "getButtonsAndHRefs");
-    return elements;
-}

package/tests/tsconfig.json

@@ -1,7 +0,0 @@
-{
-    "extends": "../tsconfig.json",
-    "compilerOptions": {
-      "noEmit": true
-    },
-    "include": ["../src/**/*", "./**/*"]
-}