Add QUICK_TEST_MAIN_WITH_SETUP to allow executing C++ before a QML test

This macro is the same as QUICK_TEST_MAIN, but takes the user's
QObject subclass as an argument, and calls pre-defined slots/invokable
functions on it, similar to how e.g. init() is called for C++ tests.

This allows e.g. context properties to be set for the QML tests.

By basing the API on invokable functions, we give ourselves the freedom
to easily add more functions in the future.

[ChangeLog][QtQuickTest] Added QUICK_TEST_MAIN_WITH_SETUP macro to
allow executing C++ before a QML test (such as registering context
properties).

Task-number: QTBUG-50064
Change-Id: Id566e388553811c220871248403d32545f8ae1eb
Reviewed-by: Shawn Rutledge <[email protected]>

1 files changed, 21 insertions, 2 deletions

diff --git a/src/qmltest/quicktest.h b/src/qmltest/quicktest.h
index 6486accb9e..62ed749722 100644
--- a/src/qmltest/quicktest.h
+++ b/src/qmltest/quicktest.h
@@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE
 QTEST_ADD_GPU_BLACKLIST_SUPPORT_DEFS
 
 Q_QUICK_TEST_EXPORT int quick_test_main(int argc, char **argv, const char *name, const char *sourceDir);
+Q_QUICK_TEST_EXPORT int quick_test_main_with_setup(int argc, char **argv, const char *name, const char *sourceDir, QObject *setup);
 
 #ifdef QUICK_TEST_SOURCE_DIR
 
@@ -67,6 +68,15 @@ Q_QUICK_TEST_EXPORT int quick_test_main(int argc, char **argv, const char *name,
         return quick_test_main(argc, argv, #name, QUICK_TEST_SOURCE_DIR); \
     }
 
+#define QUICK_TEST_MAIN_WITH_SETUP(name, QuickTestSetupClass) \
+    int main(int argc, char **argv) \
+    { \
+        QTEST_ADD_GPU_BLACKLIST_SUPPORT \
+        QTEST_SET_MAIN_SOURCE_PATH \
+        QuickTestSetupClass setup; \
+        return quick_test_main_with_setup(argc, argv, #name, QUICK_TEST_SOURCE_DIR, &setup); \
+    }
+
 #else
 
 #define QUICK_TEST_MAIN(name) \
@@ -74,7 +84,7 @@ Q_QUICK_TEST_EXPORT int quick_test_main(int argc, char **argv, const char *name,
     { \
         QTEST_ADD_GPU_BLACKLIST_SUPPORT \
         QTEST_SET_MAIN_SOURCE_PATH \
-        return quick_test_main(argc, argv, #name, 0); \
+        return quick_test_main(argc, argv, #name, nullptr); \
     }
 
 #define QUICK_TEST_OPENGL_MAIN(name) \
@@ -82,7 +92,16 @@ Q_QUICK_TEST_EXPORT int quick_test_main(int argc, char **argv, const char *name,
     { \
         QTEST_ADD_GPU_BLACKLIST_SUPPORT \
         QTEST_SET_MAIN_SOURCE_PATH \
-        return quick_test_main(argc, argv, #name, 0); \
+        return quick_test_main(argc, argv, #name, nullptr); \
+    }
+
+#define QUICK_TEST_MAIN_WITH_SETUP(name, QuickTestSetupClass) \
+    int main(int argc, char **argv) \
+    { \
+        QTEST_ADD_GPU_BLACKLIST_SUPPORT \
+        QTEST_SET_MAIN_SOURCE_PATH \
+        QuickTestSetupClass setup; \
+        return quick_test_main_with_setup(argc, argv, #name, nullptr, &setup); \
     }
 
 #endif