@badisi/wdio-harness/index.js

WebdriverIO support for Angular component test harnesses.

import { browser, $ } from '@wdio/globals';
import { WebdriverIOHarnessEnvironment } from './WebdriverIOHarnessEnvironment.js';
/**
 * Searches for all instances of the component corresponding to the given harness type under the
 * `HarnessLoader`'s root element, and returns a list of `ComponentHarness` for each instance.
 * @param query A query for a harness to create
 * @return A list of instances of the given harness type
 */
export const getAllHarnesses = async (query) => {
    return (await createHarnessEnvironment()).getAllHarnesses(query);
};
/**
 * Searches for an instance of the component corresponding to the given harness type or host element
 * under the `HarnessLoader`'s root element, and returns a `ComponentHarness` for that instance. If
 * multiple matching components are found, a harness for the first one is returned. If no matching
 * component is found, an error is thrown.
 * @param query A query for a harness to create
 * @param element A raw host element for a harness to create
 * @return An instance of the given harness type
 * @throws If a matching component instance can't be found
 */
export const getHarness = async (query, element) => {
    const env = await createHarnessEnvironment(element);
    if (element) {
        return env.createComponentHarness(query, element);
    }
    return env.getHarness(query);
};
/**
 * Returns a base harness environment instance.
 * @return An HarnessLoader instance for the current HTML document, rooted at the document's root element
 */
export const createHarnessEnvironment = async (rootElement) => {
    return WebdriverIOHarnessEnvironment.loader(rootElement ?? await $('//body').getElement());
};
/**
 * Returns a promise that resolves when the application is "stable".
 * The promise might be rejected due to timeouts, or async tasks in the client
 * app that never finish (timers, etc).
 */
export const waitForAngular = async () => {
    await browser.waitUntil(() => browser.executeScript(`
        return Array.isArray(window.frameworkStabilizers)
    `, []));
    await browser.executeAsyncScript(`
        const done = arguments[0];
        const promises = window.frameworkStabilizers.map(stabilizer => {
            // Stabilizer will invoke the resolve function with a
            // boolean to indicate whether any work is done.
            return new Promise(resolve => stabilizer(resolve));
        });
        Promise.all(promises).then(done);
    `, []);
};