qt5base-lts/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.js

/****************************************************************************
**
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the examples of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:BSD$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** BSD License Usage
** Alternatively, you may use this file under the terms of the BSD license
** as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
**   * Redistributions of source code must retain the above copyright
**     notice, this list of conditions and the following disclaimer.
**   * Redistributions in binary form must reproduce the above copyright
**     notice, this list of conditions and the following disclaimer in
**     the documentation and/or other materials provided with the
**     distribution.
**   * Neither the name of The Qt Company Ltd nor the names of its
**     contributors may be used to endorse or promote products derived
**     from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/

// A minimal async test runner for Qt async auto tests.
//
// Usage: Call runTest(name, testFunctionCompleted), where "name" is the name of the app
// (the .wasm file name), and testFunctionCompleted is a test-function-complete
// callback. The test runner will then instantiate the app and run tests.
//
// The test runner expects that the app instance defines the following
// functions:
//
//  void cleanupTestCase()
//  string getTestFunctions()
//  runTestFunction(string)
//
// Further, the test runner expects that the app instance calls
// completeTestFunction() (below - note that both the instance and this
// file have a function with that name) when a test function finishes. This
// can be done during runTestFunction(), or after it has returned (this
// is the part which enables async testing). Test functions which fail
// to call completeTestFunction() will time out after 2000ms.
//
const g_maxTime = 2000;

class TestFunction {
    constructor(instance, name) {
        this.instance = instance;
        this.name = name;
        this.resolve = undefined;
        this.reject = undefined;
        this.timeoutId = undefined;
    }

    complete(result, details) {
        // Reset timeout
        clearTimeout(this.timeoutId);
        this.timeoutId = undefined;

        const callback = result.startsWith('FAIL') ? this.reject : this.resolve;
        callback(`${result}${details ? ': ' + details : ''}`);
    }

    run() {
        // Set timer which will catch test functions
        // which fail to call completeTestFunction()
        this.timeoutId = setTimeout(() => {
            completeTestFunction(this.name, 'FAIL', `Timeout after ${g_maxTime} ms`)
        }, g_maxTime);

        return new Promise((resolve, reject) => {
            this.resolve = resolve;
            this.reject = reject;

            this.instance.runTestFunction(this.name);
        });
    }
};

function completeTestFunction(testFunctionName, result, details) {
    if (!window.currentTestFunction || testFunctionName !== window.currentTestFunction.name)
        return;

    window.currentTestFunction.complete(result, details);
}

async function runTestFunction(instance, name) {
    if (window.currentTestFunction) {
        throw new Error(`While trying to run ${name}: Last function hasn't yet finished`);
    }
    window.currentTestFunction = new TestFunction(instance, name);
    try {
        const result = await window.currentTestFunction.run();
        return result;
    } finally {
        delete window.currentTestFunction;
    }
}

async function runTestCaseImpl(testFunctionStarted, testFunctionCompleted, qtContainers) {
    // Create test case instance
    const config = {
        qtContainerElements: qtContainers || []
    }
    const instance = await createQtAppInstance(config);

    // Run all test functions
    const functionsString = instance.getTestFunctions();
    const functions = functionsString.split(" ").filter(Boolean);
    for (const name of functions) {
        testFunctionStarted(name);
        try {
            const result = await runTestFunction(instance, name);
            testFunctionCompleted(result);
        } catch (err) {
            testFunctionCompleted(err.message ?? err);
        }
    }

    // Cleanup
    instance.cleanupTestCase();
}

var g_htmlLogElement = undefined;

function testFunctionStarted(name) {
    let line = name + ": ";
    g_htmlLogElement.innerHTML += line;
}

function testFunctionCompleted(status) {

    const color = (status) => {
        if (status.startsWith("PASS"))
            return "green";
        if (status.startsWith("FAIL"))
            return "red";
        if (status.startsWith("SKIP"))
            return "tan";
        return "black";
    };

    const line = `<span style='color: ${color(status)};'>${status}</text><br>`;
    g_htmlLogElement.innerHTML += line;
}

async function runTestCase(htmlLogElement, qtContainers) {
    g_htmlLogElement = htmlLogElement;
    try {
        await runTestCaseImpl(testFunctionStarted, testFunctionCompleted, qtContainers);
        g_htmlLogElement.innerHTML += "<br> DONE"
    } catch (err) {
        g_htmlLogElement.innerHTML += err
    }
}