Mock a module using qmltestrunner ? Is it possible? - qt

Question

I am running some QML Unit tests and they being tested using "qmltestrunner" However, I am stuck on something that I am not sure it is possible to mock it.
Here a snipped on my "TitleBusyIndicator.qml":
import QtQuick.Layouts
import QtQuick.Controls.Material
import GUI.PageNavigatorPT 1.0
Rectangle
{
width: parent.width
height: parent.height
... a bunch of stuff
here is part of my unit test that will test the QML above
import QtQuick
import QtQuick.Controls
import QtTest
Rectangle
{
TitleBusyIndicator
{
id : titleBusyIndicatorId
}
However the import below is not known to the QMLTestRunner because it does not have the full project. It just testing one single qml file.
import GUI.PageNavigatorPT 1.0
When I try to run the unittest I get this (expected):
Running test = %QMLTESTRUNNER%\qmltestrunner -input tst_TitleBusyIndicator.qml
********* Start testing of qmltestrunner *********
Config: Using QtTest library 6.3.1, Qt 6.3.1 (x86_64-little_endian-llp64 shared (dynamic) release build; by GCC 11.2.0), windows 10
QWARN : qmltestrunner::tst_TitleBusyIndicator::compile()
tst_TitleBusyIndicator.qml produced 2 error(s):
tst_TitleBusyIndicator.qml:18,5: Type TitleBusyIndicator unavailable
TitleBusyIndicator.qml:21,1: module "GUI.PageNavigatorPT" is not installed
Is there a way to make qmltestrunner ignore the module or mock it? I could not find much documention on how to mock modules inside qml files for qml runner.
thank you.

Answer 1

Since you're using Qt6.3.1 you should consult https://doc.qt.io/qt-6/qtqml-syntax-imports.html specifically the section on QML Import Path in particular the section regarding setting the QML_IMPORT_PATH environment variable.
In short, you should consider setting QML_IMPORT_PATH prior to running qmltestrunner. This allows you to nominate additional Qt QML plugins that may not be part of the standard Qt install.
You can use QML_IMPORT_PATH to point to production, QA, dev, or even stub versions of your Qt QML Plugin.
If those plugins have additional dependencies, you may need to also append those to the PATH environment variable so that the qmltestrunner can find those as well.
For completeness, for those who are on older Qt5.15.x or older, the environment variable is QML2_IMPORT_PATH. For more details, see https://doc.qt.io/qt-5/qtqml-syntax-imports.html