sefiutils 1.0.46 → 1.0.47

package/src/localSetup.ts

@@ -0,0 +1,128 @@
+import dotenv from "dotenv";
+dotenv.config() // read ".env"
+
+import { Builder, Capabilities, WebDriver } from "selenium-webdriver";
+import { getRemoteAddressAndPort, setBrowserWindowSize, setViewPortSize } from "./seUtils";
+import { debug, verbose } from "./log";
+
+export const LOCAL_SETUP_TIMEOUT = 20000;
+
+export async function localSetup(page: string, width = 500, height = 500, acceptUntrustedCertificates = true): Promise<WebDriver> {
+    debug(() => `localSetup("${page}", ${width}, ${height}, ${acceptUntrustedCertificates}), getWebDriver ...`);
+    const driver = await getWebDriver(acceptUntrustedCertificates);
+    verbose(() => `Driver started, load page: ${page}`);
+    await driver.get(page);
+    debug(() => `Page loaded, set browser window size: ${width}x${height}`);
+    await setBrowserWindowSize(driver, width, height);
+    debug("Page loaded and window size set, local setup done, return driver.")
+    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(acceptUntrustedCertificates: boolean) {
+    const browser = (process.env.SEFI_BROWSER as "chrome" | "firefox" | "remote") || "remote";
+
+    debug(() => `Use browser: ${browser}`);
+    try {
+        if (browser === "chrome") {
+            return await setUpWebDriverChrome(acceptUntrustedCertificates);
+        } else if (browser === "firefox") {
+            return await setUpWebDriverFirefox(acceptUntrustedCertificates);
+        } else if (browser === "remote") {
+            return await setUpWebDriverInDocker(acceptUntrustedCertificates);
+        } else {
+            throw new Error(`Unknown browser: ${browser}`);
+        }
+    } catch (err) {
+        console.error(`Error setting up driver: ${err}`);
+        throw err;
+    }
+}
+
+
+async function setUpWebDriverInDocker(acceptUntrustedCertificates: boolean) {
+    debug("Dynamic import of selenium-webdriver/firefox");
+    debug("Remote browser, load firefox webdriver");
+    const firefox = await import('selenium-webdriver/firefox');
+
+    const { address } = getRemoteAddressAndPort();
+    const start = Date.now();
+
+    const options = new firefox.Options().addArguments("-headless");
+    options.setAcceptInsecureCerts(acceptUntrustedCertificates);
+
+    debug(() => `Start headless firefox, remote server at ${address}`)
+    const driver = await new Builder()
+        .usingServer(address)
+        .withCapabilities(Capabilities.firefox())
+        .setFirefoxOptions(options)
+        .build();
+
+    debug(() => {
+        const duration = (Date.now() - start) / 1000;
+        return `Driver resolved and connected, 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(acceptUntrustedCertificates: boolean) {
+    debug("Dynamic import of chromedriver and selenium-webdriver/chrome");
+    //@ts-ignore
+    await import('chromedriver');
+    const chrome = await import('selenium-webdriver/chrome');
+
+    const options = new chrome.Options().addArguments("--headless=new");
+    options.setAcceptInsecureCerts(acceptUntrustedCertificates);
+
+    debug(() => `Start headless chrome`)
+    const driver = await new Builder()
+        .forBrowser('chrome')
+        .setChromeOptions(options)
+        .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(acceptUntrustedCertificates: boolean) {
+    debug("Dynamic import of geckodriver and selenium-webdriver/firefox");
+    //@ts-ignore
+    await import('geckodriver'); // installed geckodriver will cause remote configuration to fail in docker...
+    const firefox = await import('selenium-webdriver/firefox');
+
+    const options = new firefox.Options().addArguments("-headless");
+    options.setAcceptInsecureCerts(acceptUntrustedCertificates);
+
+    debug(() => `Start headless firefox`)
+    const driver = await new Builder()
+        .forBrowser('firefox')
+        .setFirefoxOptions(options)
+        .build();
+
+    return driver;
+}

package/src/localTeardown.ts

@@ -0,0 +1,14 @@
+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/log.ts

@@ -0,0 +1,19 @@
+const logLevel = (process.env.SEFI_LOG_LEVEL || "info").toLowerCase();
+
+export function verbose(msg: any) {
+    if (logLevel=="debug" || logLevel=="verbose") {
+        if (msg instanceof Function) {
+            msg = msg();
+        }
+        console.log(msg);
+    }
+}
+
+export function debug(msg: any) {
+    if (logLevel=="debug") {
+        if (msg instanceof Function) {
+            msg = msg();
+        }
+        console.log(msg);
+    }
+}