Differential D27678 Diff 76719 Tests/kstars_ui/kstars_ui_tests.cpp

Changeset View

Standalone View

View Options

Tests/kstars_ui/kstars_ui_tests.cpp

1/* KStars UI tests 1​/* KStars UI tests
2 Copyright (C) 2017 Csaba Kertesz <csaba.kertesz@gmail.com> 2​ Copyright (C) 2017 Csaba Kertesz <csaba.kertesz@gmail.com>
3 3​
4 This application is free software; you can redistribute it and/or 4​ This application is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public 5​ modify it under the terms of the GNU General Public
6 License as published by the Free Software Foundation; either 6​ License as published by the Free Software Foundation; either
7 version 2 of the License, or (at your option) any later version. 7​ version 2 of the License, or (at your option) any later version.
8 */ 8​ */
9 9​
10#include "kstars_ui_tests.h" 10​#include "kstars_ui_tests.h"
11​#include "test_ekos.h"
12​#include "test_ekos_simulator.h"
11 13​
12#include "auxiliary/kspaths.h" 14​#include "auxiliary/kspaths.h"
13#if defined(HAVE_INDI) 15​#if defined(HAVE_INDI)
14#include "ekos/manager.h" 16​#include "ekos/manager.h"
15#include "ekos/profileeditor.h" 17​#include "ekos/profileeditor.h"
16#endif 18​#endif
17#include "kstars.h" 19​#include "kstars.h"
18 20​
19#include <KActionCollection> 21​#include <KActionCollection>
20#include <KTipDialog> 22​#include <KTipDialog>
21#include <KCrash/KCrash> 23​#include <KCrash/KCrash>
22 24​
23#include <QFuture> 25​#include <QFuture>
24#include <QtConcurrentRun> 26​#include <QtConcurrentRun>
25#include <QtTest> 27​#include <QtTest>
28​#include <QTest>
29​#include <QDateTime>
26 30​
27#include <ctime> 31​#include <ctime>
28#include <unistd.h> 32​#include <unistd.h>
29 33​
30KStarsUiTests::KStarsUiTests() 34​struct KStarsUiTests::_InitialConditions const KStarsUiTests::m_InitialConditions;
31{ ​
32 srand((unsigned int)time(nullptr)); ​
33 // Create writable data dir if it does not exist ​
34 QDir writableDir; ​
35 35​
36 writableDir.mkdir(KSPaths::writableLocation(QStandardPaths::GenericDataLocation)); 36​KStarsUiTests::KStarsUiTests(QObject *parent): QObject(parent)
37 KCrash::initialize(); 37​{
38} 38​}
39 39​
40void KStarsUiTests::initTestCase() 40​void KStarsUiTests::initTestCase()
41{ 41​{
42 KTipDialog::setShowOnStart(false); ​
43 K = KStars::createInstance(true); ​
44} 42​}
45 43​
46void KStarsUiTests::cleanupTestCase() 44​void KStarsUiTests::cleanupTestCase()
47{ 45​{
48 K->close(); ​
49 delete K; ​
50 K = nullptr; ​
51} 46​}
52 47​
53void KStarsUiTests::init() 48​void KStarsUiTests::init()
54{ 49​{
55 KStars* const K = KStars::Instance(); 50​ if (KStars::Instance() != nullptr)
56 QVERIFY(K != nullptr); 51​ KTRY_SHOW_KSTARS();
57 KTRY_SHOW_KSTARS(K); ​
58 ​
59#if defined(HAVE_INDI) ​
60 initEkos(); ​
61#endif ​
62} 52​}
63 53​
64void KStarsUiTests::cleanup() 54​void KStarsUiTests::cleanup()
65{ 55​{
66 foreach (QDialog * d, KStars::Instance()->findChildren<QDialog*>()) 56​ foreach (QDialog * d, KStars::Instance()->findChildren<QDialog*>())
67 if (d->isVisible()) 57​ if (d->isVisible())
68 d->hide(); 58​ d->hide();
69 ​
70#if defined(HAVE_INDI) ​
71 cleanupEkos(); ​
72#endif ​
73} 59​}
74 60​
75// All QTest features are macros returning with no error code. 61​// All QTest features are macros returning with no error code.
76// 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. 62​// 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.
77 63​
78 void KStarsUiTests::basicTest() 64​void KStarsUiTests::createInstanceTest()
79{ 65​{
80 QVERIFY(true); 66​ // Initialize our instance
67​ /*QBENCHMARK_ONCE*/ {
68​ // Create our test instance
69​ KTipDialog::setShowOnStart(false);
70​ KStars::createInstance(true, KStarsUiTests::m_InitialConditions.clockRunning, KStarsUiTests::m_InitialConditions.dateTime.toString());
71​ QApplication::processEvents();
81} 72​ }
73​ QVERIFY(KStars::Instance() != nullptr);
82 74​
83void KStarsUiTests::warnTest() 75​ // Initialize our location
84{ 76​ GeoLocation * const g = KStars::Instance()->data()->locationNamed("Greenwich");
TallFurryManAuthorUnsubmitted
Not Done

This was cheating: I used the city database, while I should have used arbitrary latitude and longitude, eventually verifying this was Greenwhich.

TallFurryMan: This was cheating: I used the city database, while I should have used arbitrary latitude and…
85 QWARN("This is a test expected to print a warning message."); 77​ QVERIFY(g != nullptr);
78​ KStars::Instance()->data()->setLocation(*g);
79​ QCOMPARE(KStars::Instance()->data()->geo()->lat()->Degrees(), g->lat()->Degrees());
80​ QCOMPARE(KStars::Instance()->data()->geo()->lng()->Degrees(), g->lng()->Degrees());
86} 81​}
87 82​
88void KStarsUiTests::raiseKStarsTest() 83​void KStarsUiTests::raiseKStarsTest()
89{ 84​{
90 KTRY_SHOW_KSTARS(K); 85​ KTRY_SHOW_KSTARS();
86​}
87​
88​void KStarsUiTests::initialConditionsTest()
89​{
90​ QVERIFY(KStars::Instance() != nullptr);
91​ QVERIFY(KStars::Instance()->data() != nullptr);
92​ QVERIFY(KStars::Instance()->data()->clock() != nullptr);
93​
94​ QCOMPARE(KStars::Instance()->data()->clock()->isActive(), m_InitialConditions.clockRunning);
95​
96​ QEXPECT_FAIL("", "Initial KStars clock is set from system local time, not geolocation, and is untestable for now.", Continue);
TallFurryManAuthorUnsubmitted
Not Done

There's apparently no way to *not* use the system properties when initializing KStars, due to KStarsDateTime management of UTC/localtime. This should be tested in a unitary test elsewhere.

TallFurryMan: There's apparently no way to *not* use the system properties when initializing KStars, due to…
97​ QCOMPARE(KStars::Instance()->data()->clock()->utc().toString(), m_InitialConditions.dateTime.toString());
98​
99​ QEXPECT_FAIL("", "Precision of KStars local time conversion to local time does not allow strict millisecond comparison.", Continue);
TallFurryManAuthorUnsubmitted
Not Done

I always end up with a comparison between xxx.999ms and xxx.000ms. Rounding issues somewhere on the QDateTime/KStarsDataTime chain.

TallFurryMan: I always end up with a comparison between xxx.999ms and xxx.000ms. Rounding issues somewhere on…
100​ QCOMPARE(KStars::Instance()->data()->clock()->utc().toLocalTime(), m_InitialConditions.dateTime);
101​
102​ // However comparison down to nearest second is expected to be OK
103​ QCOMPARE(llround(KStars::Instance()->data()->clock()->utc().toLocalTime().toMSecsSinceEpoch()/1000.0), m_InitialConditions.dateTime.toSecsSinceEpoch());
91} 104​}
92 105​
93// We want to launch the application before running our tests 106​// We want to launch the application before running our tests
94// Thus we want to explicitly call QApplication::exec(), and run our tests in parallel of the event loop 107​// Thus we want to explicitly call QApplication::exec(), and run our tests in parallel of the event loop
95// We then reimplement QTEST_MAIN(KStarsUiTests); 108​// We then reimplement QTEST_MAIN(KStarsUiTests);
96// The same will have to be done when interacting with a modal dialog: exec() in main thread, tests in timer-based thread 109​// The same will have to be done when interacting with a modal dialog: exec() in main thread, tests in timer-based thread
97 110​
98QT_BEGIN_NAMESPACE 111​QT_BEGIN_NAMESPACE
99QTEST_ADD_GPU_BLACKLIST_SUPPORT_DEFS 112​QTEST_ADD_GPU_BLACKLIST_SUPPORT_DEFS
100QT_END_NAMESPACE 113​QT_END_NAMESPACE
101 114​
102int main(int argc, char *argv[]) 115​int main(int argc, char *argv[])
103{ 116​{
117​ // Create our test application
104 QApplication app(argc, argv); 118​ QApplication app(argc, argv);
105 app.setAttribute(Qt::AA_Use96Dpi, true); 119​ app.setAttribute(Qt::AA_Use96Dpi, true);
106 QTEST_ADD_GPU_BLACKLIST_SUPPORT 120​ QTEST_ADD_GPU_BLACKLIST_SUPPORT
121​ QTEST_SET_MAIN_SOURCE_PATH
107 QApplication::processEvents(); 122​ QApplication::processEvents();
123​
124​ // Prepare our configuration
125​ srand((unsigned int)time(nullptr));
126​ QDir writableDir;
127​ writableDir.mkdir(KSPaths::writableLocation(QStandardPaths::GenericDataLocation));
TallFurryManAuthorUnsubmitted
Not Done

This is currently useless.

TallFurryMan: This is currently useless.
128​ KCrash::initialize();
129​
130​ // The instance will be created (and benchmarked) as first test in KStarsUiTests
131​ qDebug("Deferring instance creation to tests.");
132​
133​ // This holds the final result of the test session
134​ int result = 0;
135​
136​ // Execute tests in sequence, eventually skipping sub-tests based on prior ones
137​ QTimer::singleShot(1000, &app, [&]
138​ {
139​ qDebug("Starting tests...");
140​
141​ // This creates our KStars instance
108 KStarsUiTests * tc = new KStarsUiTests(); 142​ KStarsUiTests * tc = new KStarsUiTests();
109 QTEST_SET_MAIN_SOURCE_PATH 143​ result = QTest::qExec(tc, argc, argv);
110 QTimer::singleShot(1000, &app, [=]() { return QTest::qExec(tc, argc, argv); }); 144​
111 QTimer::singleShot(30000, &app, &QCoreApplication::quit); 145​#if defined(HAVE_INDI)
146​ if (!result)
147​ {
148​ TestEkos * ek = new TestEkos();
149​ result |= QTest::qExec(ek, argc, argv);
150​ }
151​
152​ if (!result)
153​ {
154​ TestEkosSimulator * eks = new TestEkosSimulator();
155​ result |= QTest::qExec(eks, argc, argv);
156​ }
157​#endif
TallFurryManAuthorUnsubmitted
Not Done

I had to use this method in order to use multiple test classes that execute in parallel with the GUI.

TallFurryMan: I had to use this method in order to use multiple test classes that execute in parallel with…
158​
159​ // Done testing, successful or not
160​ qDebug("Tests are done.");
161​ app.quit();
162​ });
163​
164​ // Limit execution duration
165​ QTimer::singleShot(5*60*1000, &app, &QCoreApplication::quit);
TallFurryManAuthorUnsubmitted
Not Done

This value hard-codes a limit to the duration of the test. I'll probably remove it and rely on another method to detect the end of the asynchronous tests. Normally QTest::qExec calls should not break out of the singleShot() call above, so this is more a safeguard against lock-up. But that safeguard would be better done with a timeout shell wrapper.

TallFurryMan: This value hard-codes a limit to the duration of the test. I'll probably remove it and rely on…
166​
112 app.exec(); 167​ app.exec();
168​ KStars::Instance()->close();
169​ delete KStars::Instance();
170​
171​ return result;
113} 172​}
114 173​