File indexing completed on 2024-04-21 14:47:20

 /*
     SPDX-FileCopyrightText: 2017 Csaba Kertesz <csaba.kertesz@gmail.com>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #pragma once
 
 #include "../testhelpers.h"
 #include "kstarsdata.h"
 
 #include <QMutex>
 #include <QTimer>
 #include <QApplication>
 #include <QSystemTrayIcon>
 
 class KStars;
 
 // Helper for on-screen test messages
 #define KTELL_BEGIN() do { KStarsUiTests::notifierBegin(); } while(false)
 #define KTELL_HIDE() do { KStarsUiTests::notifierHide(); } while(false)
 #define KTELL_END() do { KStarsUiTests::notifierEnd(); } while(false)
 #define KTELL(message) do { KStarsUiTests::notifierMessage(__FUNCTION__, message); } while(false)
 
 // We need to call a set of preliminary operations for each UI test, such as the KStars Wizard setup.
 // We also need QtCreator to detect our tests - that application scans class definitions for qExec calls.
 
 // If no KSTARS_UI_TEST is defined, this is our default main
 //extern int main(int argc, char *argv[]) __attribute__((weak));
 
 // The KSTARS_UI_TEST macro is used like QTEST_MAIN, and runs:
 // - The Qt UI configuration
 // - The KStars environment configuration
 // - The KStars wizard, and eventually the Ekos wizard if INDI is available
 // - The designated test class
 // Execution of the application is asynchronous, and tests are delayed as if an end-user was using the app
 
 extern void prepare_tests();
 extern int run_wizards(int argc, char **argv);
 extern void execute_tests();
 
 #define QTEST_KSTARS_MAIN(klass) \
     int main(int argc, char *argv[]) { \
         klass tc; \
         for (int i = 0; i < argc; i++) \
             if (!strcmp("-functions", argv[i])) \
                 return QTest::qExec(&tc, argc, argv); \
         QApplication* app = new QApplication(argc, argv); \
         KTEST_BEGIN(); \
         prepare_tests(); \
         int failure = 0; \
         QTimer::singleShot(1000, app, [&] { \
             qDebug("Starting wizard..."); \
             failure |= run_wizards(argc, argv); \
             if (!failure) { \
                 KTELL_BEGIN(); \
                 failure |= QTest::qExec(&tc, app->arguments()); \
                 KTELL_END(); \
             } \
             qDebug("Tests are done."); \
             app->quit(); \
         }); \
         execute_tests(); \
         KTEST_END(); \
         return failure; }
 
 // on top of QTEST_KSTARS_MAIN, this macro offers a guider selection
 // The option "-guider <name>" selects the guider name from the test
 // arguments and hands the name (as QString) over to the test case constructor
 
 #define QTEST_KSTARS_WITH_GUIDER_MAIN(klass) \
     int main(int argc, char *argv[]) { \
         QString guider = "Internal"; \
         std::vector<char *> testargv; \
         bool showfunctions = false; \
         for (int i = 0; i < argc; i++) { \
             if (!strcmp("-functions", argv[i])) \
             {testargv.push_back(argv[i]); showfunctions = true;} \
             else if (!strcmp("-guider", argv[i]) && i+1 < argc) \
             { guider = argv[i+1]; i++; } \
             else testargv.push_back(argv[i]); } \
         klass tc(guider); \
         if (showfunctions) return QTest::qExec(&tc, static_cast<int>(testargv.size()), testargv.data()); \
         QApplication* app = new QApplication(argc, argv); \
         KTEST_BEGIN(); \
         prepare_tests(); \
         int failure = 0; \
         QTimer::singleShot(1000, app, [&] { \
             qDebug("Starting tests..."); \
             failure |= run_wizards(static_cast<int>(testargv.size()), testargv.data()); \
             if (!failure) { \
                 KTELL_BEGIN(); \
                 failure |= QTest::qExec(&tc, static_cast<int>(testargv.size()), testargv.data()); \
                 KTELL_END(); \
             } \
             qDebug("Tests are done."); \
             app->quit(); }); \
         execute_tests(); \
         KTEST_END(); \
         return failure; }
 
 
 // All QTest features are macros returning with no error code.
 // Therefore, in order to bail out at first failure, tests cannot use functions to run sub-tests and are required to use grouping macros too.
 // Tests classes in this folder should attempt to provide new macro shortcuts once their details are properly validated
 
 // This is an example of a test class.
 // It inherits from QObject, and defines private slots as test functions
 class KStarsUiTests : public QObject
 {
     Q_OBJECT
 public:
     explicit KStarsUiTests(QObject *parent = nullptr): QObject(parent) {};
 
 public:
     static QSystemTrayIcon * m_Notifier;
     static void notifierBegin();
     static void notifierHide();
     static void notifierMessage(QString, QString);
     static void notifierEnd();
 
 private slots:
 
     /** @brief Members "initTestCase" and "cleanupTestCase" trigger when the framework processes this class.
      * Member "initTestCase" is executed before any other declared test.
      * Member "cleanupTestCase" is executed after all tests are done.
      */
     /** @{ */
     void initTestCase() {};
     void cleanupTestCase() {};
     /** @} */
 
     /** @brief Members "init" and "cleanup" trigger when the framework process one test from this class.
      * Member "init" is executed before each declared test.
      * Member "cleanup" is executed after each test is done.
      */
     /** @{ */
     void init() {};
     void cleanup() {};
     /** @} */
 
     /** @brief Tests should be defined as "test<a-particular-feature>" for homogeneity.
      * Use QVERIFY and others to validate tests that reply immediately.
      * If the application needs to process events while you wait for something, use QTRY_VERIFY_WITH_TIMEOUT.
      * If the application needs to process signals while you wait for something, use QTimer::singleShot to run your QVERIFY checks with an arbitrary delay.
      * If the application opens dialogs inside signals while you wait for something but you cannot determine the delay, use
      * QTimer::singleShot with a lambda, and retrigger the timer until your check can be verified.
      */
 
     void testSomethingThatWorks()
     {
         QVERIFY(QString("this string contains").contains("string"));
     };
 
     /** @brief Tests that require fixtures can define those in "test<a-particular-feature>_data" as a record list.
      * Condition your test with QT_VERSION >= 0x050900 as this is the minimal version that supports this.
      * Add data columns to your fixture with QTest::addColum<column-type>("column-name").
      * In the same order, add data rows to your fixture with QTest::addRow("<arbitrary-row-identifier>") << column1 << column2 << ...
      * Afterwards, in your test, use QFETCH(<column-type>, <column-name>) to obtain values for one row of your fixture.
      * Your test will be run as many times as there are rows, so use initTestCase and cleanupTestCase.
      */
     /** @{ */
     void testAnotherThingThatWorks_data()
     {
 #if QT_VERSION < 0x050900
         QSKIP("Skipping fixture-based test on old QT version.");
 #else
         QTest::addColumn <int> ("A");
         QTest::addColumn <int> ("B");
         QTest::addColumn <int> ("C");
         QTest::addRow("1+1=2") << 1 << 1 << 2;
         QTest::addRow("1+4=5") << 1 << 4 << 5;
 #endif
     };
 
     void testAnotherThingThatWorks()
     {
 #if QT_VERSION < 0x050900
         QSKIP("Skipping fixture-based test on old QT version.");
 #else
         QFETCH(int, A);
         QFETCH(int, B);
         QFETCH(int, C);
         QVERIFY(A+B == C);
 #endif
     };
     /** @} */
 
     /** @brief Tests that are built to reproduce a bug should expect failures with QEXPECT_FAIL.
      * When the bug is resolved, that test will trigger a failure to verify the fix and may then be updated to remove the expected failure.
      * The first argument of QEXPECT_FAIL provides a way to fail on a particular fixture only.
      * If the test is not using a fixture or if the failure should trigger for all fixtures, the first argument must be "".
      */
     void testSomethingThatFails()
     {
         QEXPECT_FAIL("", "The next verification will fail, but the test will continue", Continue);
         QVERIFY(1+1 == 3);
     }
 };