diff options
Diffstat (limited to 'tests/manual/wasm/qtwasmtestlib')
| -rw-r--r-- | tests/manual/wasm/qtwasmtestlib/README.md | 9 | ||||
| -rw-r--r-- | tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.cpp | 70 | ||||
| -rw-r--r-- | tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.h | 46 | ||||
| -rw-r--r-- | tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.js | 188 |
4 files changed, 179 insertions, 134 deletions
diff --git a/tests/manual/wasm/qtwasmtestlib/README.md b/tests/manual/wasm/qtwasmtestlib/README.md index e122fb26bc..6de81fe8b4 100644 --- a/tests/manual/wasm/qtwasmtestlib/README.md +++ b/tests/manual/wasm/qtwasmtestlib/README.md @@ -14,7 +14,10 @@ Implementing a basic test case In the test cpp file, define the test functions as private slots. All test functions must call completeTestFunction() exactly once, or will time out -otherwise. The can can be made after the test function itself has returned. +otherwise. Subsequent calls to completeTestFunction will be disregarded. +It is advised to use QWASMSUCCESS/QWASMFAIL for reporting the test execution +status and QWASMCOMPARE/QWASMVERIFY to assert on test conditions. The call can +be made after the test function itself has returned. class TestTest: public QObject { @@ -45,7 +48,7 @@ Finally provide an html file which hosts the test runner and calls runTestCase() <script type="text/javascript" src="test_case.js"></script> <script> window.onload = async () => { - runTestCase(document.getElementById("log")); + runTestCase(entryFunction, document.getElementById("log")); }; </script> <p>Running Foo auto test.</p> @@ -64,7 +67,7 @@ html file provides container elements which becomes QScreens for the test code. window.onload = async () => { let log = document.getElementById("log") let containers = [document.getElementById("container")]; - runTestCase(log, containers); + runTestCase(entryFunction, log, containers); }; </script> <p>Running Foo auto test.</p> diff --git a/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.cpp b/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.cpp index eeac82a266..ec03c7209a 100644 --- a/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.cpp +++ b/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.cpp @@ -1,5 +1,5 @@ // Copyright (C) 2022 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only #include "qtwasmtestlib.h" @@ -10,9 +10,11 @@ #include <emscripten/threading.h> namespace QtWasmTest { - +namespace { QObject *g_testObject = nullptr; +std::string g_currentTestName; std::function<void ()> g_cleanup; +} void runOnMainThread(std::function<void(void)> fn); static bool isValidSlot(const QMetaMethod &sl); @@ -30,31 +32,56 @@ void initTestCase(QObject *testObject, std::function<void ()> cleanup) g_cleanup = cleanup; } +void verify(bool condition, std::string_view conditionString, std::string_view file, int line) +{ + if (!condition) { + completeTestFunction( + TestResult::Fail, + formatMessage(file, line, "Condition failed: " + std::string(conditionString))); + } +} + // Completes the currently running test function with a result. This function is // thread-safe and call be called from any thread. -void completeTestFunction(TestResult result) +void completeTestFunction(TestResult result, std::string message) { - // Report test result to JavaScript test runner, on the main thread - runOnMainThread([result](){ - const char *resultString; + auto resultString = [](TestResult result) { switch (result) { - case TestResult::Pass: - resultString = "PASS"; - break; - case TestResult::Fail: - resultString = "FAIL"; - break; - }; + case TestResult::Pass: + return "PASS"; + break; + case TestResult::Fail: + return "FAIL"; + break; + case TestResult::Skip: + return "SKIP"; + break; + } + }; + + // Report test result to JavaScript test runner, on the main thread + runOnMainThread([resultString = resultString(result), message](){ EM_ASM({ - completeTestFunction(UTF8ToString($0)); - }, resultString); + completeTestFunction(UTF8ToString($0), UTF8ToString($1), UTF8ToString($2)); + }, g_currentTestName.c_str(), resultString, message.c_str()); }); } +// Completes the currently running test function with a Pass result. +void completeTestFunction() +{ + completeTestFunction(TestResult::Pass, std::string()); +} + // // Private API for the Javascript test runnner // +std::string formatMessage(std::string_view file, int line, std::string_view message) +{ + return "[" + std::string(file) + ":" + QString::number(line).toStdString() + "] " + std::string(message); +} + void cleanupTestCase() { g_testObject = nullptr; @@ -83,13 +110,26 @@ std::string getTestFunctions() void runTestFunction(std::string name) { + g_currentTestName = name; QMetaObject::invokeMethod(g_testObject, name.c_str()); } +void failTest(std::string message) +{ + completeTestFunction(QtWasmTest::Fail, std::move(message)); +} + +void passTest() +{ + completeTestFunction(QtWasmTest::Pass, ""); +} + EMSCRIPTEN_BINDINGS(qtwebtestrunner) { emscripten::function("cleanupTestCase", &cleanupTestCase); emscripten::function("getTestFunctions", &getTestFunctions); emscripten::function("runTestFunction", &runTestFunction); + emscripten::function("qtWasmFail", &failTest); + emscripten::function("qtWasmPass", &passTest); } // diff --git a/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.h b/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.h index 8bf0c20259..2307ed1ccd 100644 --- a/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.h +++ b/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.h @@ -1,5 +1,5 @@ // Copyright (C) 2022 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only #ifndef QT_WASM_TESTRUNNER_H #define QT_WASM_TESTRUNNER_H @@ -13,11 +13,20 @@ namespace QtWasmTest { enum TestResult { Pass, Fail, + Skip, }; -void completeTestFunction(TestResult result = TestResult::Pass); + +std::string formatMessage(std::string_view file, + int line, + std::string_view message); + +void completeTestFunction(TestResult result, std::string message); +void completeTestFunction(); void initTestCase(QObject *testObject, std::function<void ()> cleanup); template <typename App> -void initTestCase(int argc, char **argv, std::shared_ptr<QObject> testObject) +void initTestCase(int argc, + char **argv, + std::shared_ptr<QObject> testObject) { auto app = std::make_shared<App>(argc, argv); auto cleanup = [testObject, app]() mutable { @@ -28,8 +37,37 @@ void initTestCase(int argc, char **argv, std::shared_ptr<QObject> testObject) }; initTestCase(testObject.get(), cleanup); } +void verify(bool condition, + std::string_view conditionString, + std::string_view file, + int line); +template<class L, class R> +void compare(const L& lhs, + const R& rhs, + std::string_view lhsString, + std::string_view rhsString, + std::string_view file, + int line) { + if (lhs != rhs) { + completeTestFunction( + TestResult::Fail, + formatMessage(file, line, "Comparison failed: " + std::string(lhsString) + " == " + std::string(rhsString))); + } } -#endif +} // namespace QtWasmTest + +#define QWASMVERIFY(condition) \ + QtWasmTest::verify((condition), #condition, __FILE__, __LINE__); +#define QWASMCOMPARE(left, right) \ + QtWasmTest::compare((left), (right), #left, #right, __FILE__, __LINE__); + +#define QWASMSUCCESS() \ + QtWasmTest::completeTestFunction(QtWasmTest::Pass, "") + +#define QWASMFAIL(message) \ + QtWasmTest::completeTestFunction(QtWasmTest::Fail, QtWasmTest::formatMessage(__FILE__, __LINE__, message)) + +#endif diff --git a/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.js b/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.js index add3c46619..d4f815b887 100644 --- a/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.js +++ b/tests/manual/wasm/qtwasmtestlib/qtwasmtestlib.js @@ -1,52 +1,5 @@ -/**************************************************************************** -** -** 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$ -** -****************************************************************************/ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only // A minimal async test runner for Qt async auto tests. // @@ -68,72 +21,81 @@ // is the part which enables async testing). Test functions which fail // to call completeTestFunction() will time out after 2000ms. // -let g_maxTime = 2000; -var g_timeoutId = undefined; -var g_testResolve = undefined; -var g_testResult = undefined; +const g_maxTime = 2000; -function completeTestFunction(result) -{ - // Reset timeout - if (g_timeoutId !== undefined) { - clearTimeout(g_timeoutId); - g_timeoutId = undefined; +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 : ''}`); } - // Set test result directy, or resolve the pending promise - if (g_testResolve === undefined) { - g_testResult = result - } else { - g_testResolve(result); - g_testResolve = undefined; + 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); } -function runTestFunction(instance, name) -{ - if (g_timeoutId !== undefined) - console.log("existing timer found"); - - // Set timer which will catch test functions - // which fail to call completeTestFunction() - g_timeoutId = setTimeout( () => { - if (g_timeoutId === undefined) - return; - g_timeoutId = undefined; - completeTestFunction("FAIL") - }, g_maxTime); - - instance.runTestFunction(name); - - // If the test function completed with a result immediately then return - // the result directly, otherwise return a Promise to the result. - if (g_testResult !== undefined) { - let result = g_testResult; - g_testResult = undefined; +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; - } else { - return new Promise((resolve) => { - g_testResolve = resolve; - }); + } finally { + delete window.currentTestFunction; } } -async function runTestCaseImpl(testFunctionStarted, testFunctionCompleted, qtContainers) +async function runTestCaseImpl(entryFunction, testFunctionStarted, testFunctionCompleted, qtContainers) { // Create test case instance - let config = { - qtContainerElements : qtContainers || [] + const config = { + qtContainerElements: qtContainers || [] } - let instance = await createQtAppInstance(config); + const instance = await entryFunction(config); // Run all test functions - let functionsString = instance.getTestFunctions(); - let functions = functionsString.split(" ").filter(Boolean); - for (name of functions) { + const functionsString = instance.getTestFunctions(); + const functions = functionsString.split(" ").filter(Boolean); + for (const name of functions) { testFunctionStarted(name); - let result = await runTestFunction(instance, name); - testFunctionCompleted(name, result); + try { + const result = await runTestFunction(instance, name); + testFunctionCompleted(result); + } catch (err) { + testFunctionCompleted(err.message ?? err); + } } // Cleanup @@ -147,25 +109,27 @@ function testFunctionStarted(name) { g_htmlLogElement.innerHTML += line; } -function testFunctionCompleted(name, status) { - var color = "black"; - switch (status) { - case "PASS": - color = "green"; - break; - case "FAIL": - color = "red"; - break; - } - let line = "<text style='color:" + color + ";'>" + status + "</text><br>"; +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) +async function runTestCase(entryFunction, htmlLogElement, qtContainers) { g_htmlLogElement = htmlLogElement; try { - await runTestCaseImpl(testFunctionStarted, testFunctionCompleted, qtContainers); + await runTestCaseImpl(entryFunction, testFunctionStarted, testFunctionCompleted, qtContainers); g_htmlLogElement.innerHTML += "<br> DONE" } catch (err) { g_htmlLogElement.innerHTML += err |