StarMirror/qTox
1
0
Fork 0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
Code Issues Projects Releases Wiki Activity

feat(tests): Merge core and core_online tests

Browse Source 
Re-use tox instances between tests to avoid re-bootstrapping or re-requesting
friendship, saving time. Test case order within core_test is now important.
This commit is contained in:
Anthony Bilinski 2022-03-13 01:56:59 -08:00
parent 5f870c28e5
commit 7d773930c1
No known key found for this signature in database
GPG Key ID: 2AA8E0DA1B31FB3C
3 changed files with 161 additions and 262 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
cmake/Testing.cmake
View File

@ -38,7 +38,6 @@ endfunction()
add_subdirectory(test/mock) add_subdirectory(test/mock)
auto_test(core core "${${PROJECT_NAME}_RESOURCES}") auto_test(core core "${${PROJECT_NAME}_RESOURCES}")
auto_test(core core_online "${${PROJECT_NAME}_RESOURCES}")
auto_test(core contactid "") auto_test(core contactid "")
auto_test(core toxid "") auto_test(core toxid "")
auto_test(core toxstring "") auto_test(core toxstring "")

242
test/core/core_online_test.cpp
View File

@ -1,242 +0,0 @@
/*
Copyright © 2022 by The qTox Project Contributors
This file is part of qTox, a Qt-based graphical interface for Tox.
qTox is libre software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
qTox is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with qTox. If not, see <http://www.gnu.org/licenses/>.
*/
#include "src/core/core.h"
#include "src/core/icoresettings.h"
#include "src/core/toxoptions.h"
#include "src/model/ibootstraplistgenerator.h"
#include "src/net/bootstrapnodeupdater.h"
#include "src/persistence/settings.h"
#include "mock/mockcoresettings.h"
#include <QSignalSpy>
#include <QtGlobal>
#include <QtTest/QtTest>
#include <QTest>
#include <QtGlobal>
#include <cassert>
#include <limits>
#include <iostream>
#include <memory>
Q_DECLARE_METATYPE(QList<DhtServer>)
Q_DECLARE_METATYPE(ToxPk)
Q_DECLARE_METATYPE(uint32_t)
Q_DECLARE_METATYPE(Status::Status)
class MockNodeListGenerator : public IBootstrapListGenerator
{
public:
MockNodeListGenerator()
{
qRegisterMetaType<QList<DhtServer>>("QList<DhtServer>");
}
QList<DhtServer> getBootstrapnodes() const override;
};
QList<DhtServer> MockNodeListGenerator::getBootstrapnodes() const {
return BootstrapNodeUpdater::loadDefaultBootstrapNodes();
}
namespace {
const int very_long_timeout = 10 * 60 * 1000;
const int connected_message_wait = 15000; // timeout for alice and bob messaging
}
class TestCoreOnline : public QObject
{
Q_OBJECT
public:
TestCoreOnline();
private slots:
void init();
void deinit();
// actual test cases
void change_name();
void change_status_message();
void change_status();
private:
/* Test Variables */
ToxCorePtr alice;
ToxCorePtr bob;
};
TestCoreOnline::TestCoreOnline()
{
qRegisterMetaType<ToxPk>("ToxPk");
qRegisterMetaType<uint32_t>("uint32_t");
qRegisterMetaType<Status::Status>("Status::Status");
auto timeout = QString("%1").arg(very_long_timeout);
assert(qputenv("QTEST_FUNCTION_TIMEOUT", timeout.toLatin1()));
}
void TestCoreOnline::init()
{
auto settings = std::unique_ptr<MockSettings>(new MockSettings());
MockNodeListGenerator nodesGenerator{};
alice = Core::makeToxCore(QByteArray{}, *settings, nodesGenerator, nullptr);
QVERIFY2(alice != nullptr, "alice initialization failed");
bob = Core::makeToxCore(QByteArray{}, *settings, nodesGenerator, nullptr);
QVERIFY2(bob != nullptr, "bob initialization failed");
QSignalSpy spyAliceOnline(alice.get(), &Core::connected);
QSignalSpy spyBobOnline(bob.get(), &Core::connected);
alice->start();
bob->start();
// Wait for both instances coming online
QTRY_VERIFY_WITH_TIMEOUT(spyAliceOnline.count() >= 1 && spyBobOnline.count() >= 1, very_long_timeout);
// Make a friend request from alice to bob
const QLatin1String friendMsg{"Test Invite Message"};
QSignalSpy spyBobFriendMsg(bob.get(), &Core::friendRequestReceived);
QSignalSpy spyAliceFriendMsg(alice.get(), &Core::requestSent);
alice->requestFriendship(bob->getSelfId(), friendMsg);
// Wait for friend message to be received
QTRY_VERIFY_WITH_TIMEOUT(spyBobFriendMsg.count() == 1 && spyAliceFriendMsg.count() == 1, very_long_timeout);
// Check for expected signal content
QVERIFY(qvariant_cast<ToxPk>(spyBobFriendMsg[0][0]) == alice->getSelfPublicKey());
QVERIFY(spyBobFriendMsg[0][1].toString() == friendMsg);
QVERIFY(qvariant_cast<ToxPk>(spyAliceFriendMsg[0][0]) == bob->getSelfPublicKey());
QVERIFY(spyAliceFriendMsg[0][1].toString() == friendMsg);
// Let Bob accept the friend request from Alice
bob->acceptFriendRequest(alice->getSelfPublicKey());
// Wait until both see each other
QSignalSpy spyAliceFriendOnline(alice.get(), &Core::friendStatusChanged);
QSignalSpy spyBobFriendOnline(bob.get(), &Core::friendStatusChanged);
QTRY_VERIFY_WITH_TIMEOUT(spyAliceFriendOnline.count() >= 1 && spyBobFriendOnline.count() >= 1, very_long_timeout);
// Check for expected signal content
QVERIFY(spyAliceFriendOnline[0][0].toInt() == static_cast<int>(Status::Status::Online));
QVERIFY(spyBobFriendOnline[0][0].toInt() == static_cast<int>(Status::Status::Online));
}
void TestCoreOnline::deinit()
{
alice.reset();
bob.reset();
}
void TestCoreOnline::change_name()
{
// Change the name of Alice to "Alice"
const QLatin1String aliceName{"Alice"};
QSignalSpy aliceSaveRequest(alice.get(), &Core::saveRequest);
QSignalSpy aliceUsernameChanged(alice.get(), &Core::usernameSet);
QSignalSpy bobUsernameChangeReceived(bob.get(), &Core::friendUsernameChanged);
alice->setUsername(aliceName);
QTRY_VERIFY_WITH_TIMEOUT(aliceSaveRequest.count() == 1, very_long_timeout);
QTRY_VERIFY_WITH_TIMEOUT(aliceUsernameChanged.count() == 1 &&
aliceUsernameChanged[0][0].toString() == aliceName,
very_long_timeout);
QTRY_VERIFY_WITH_TIMEOUT(bobUsernameChangeReceived.count() == 1 &&
bobUsernameChangeReceived[0][1].toString() == aliceName, very_long_timeout);
// Setting the username again to the same value shoud NOT trigger any signals
alice->setUsername(aliceName);
// Need to sleep here, because we're testing that these don't increase based on
// Alice re-setting her username, so QTRY_VERIFY_WITH_TIMEOUT would return immediately.
QTest::qSleep(connected_message_wait);
QVERIFY(aliceSaveRequest.count() == 1);
QVERIFY(aliceUsernameChanged.count() == 1);
QVERIFY(bobUsernameChangeReceived.count() == 1);
}
void TestCoreOnline::change_status_message()
{
// Change the status message of Alice
const QLatin1String aliceStatusMsg{"Testing a lot"};
QSignalSpy aliceSaveRequest(alice.get(), &Core::saveRequest);
QSignalSpy aliceStatusMsgChanged(alice.get(), &Core::statusMessageSet);
QSignalSpy bobStatusMsgChangeReceived(bob.get(), &Core::friendStatusMessageChanged);
alice->setStatusMessage(aliceStatusMsg);
QTRY_VERIFY_WITH_TIMEOUT(aliceSaveRequest.count() == 1, very_long_timeout);
QTRY_VERIFY_WITH_TIMEOUT(aliceStatusMsgChanged.count() == 1 &&
aliceStatusMsgChanged[0][0].toString() == aliceStatusMsg,
very_long_timeout);
QTRY_VERIFY_WITH_TIMEOUT(bobStatusMsgChangeReceived.count() == 1 &&
bobStatusMsgChangeReceived[0][1].toString() == aliceStatusMsg, very_long_timeout);
// Setting the status message again to the same value shoud NOT trigger any signals
alice->setStatusMessage(aliceStatusMsg);
// Need to sleep here, because we're testing that these don't increase based on
// Alice re-setting her status message, so QTRY_VERIFY_WITH_TIMEOUT would return immediately.
QTest::qSleep(connected_message_wait);
QVERIFY(aliceSaveRequest.count() == 1);
QVERIFY(aliceStatusMsgChanged.count() == 1);
QVERIFY(bobStatusMsgChangeReceived.count() == 1);
}
void TestCoreOnline::change_status()
{
QSignalSpy aliceSaveRequest(alice.get(), &Core::saveRequest);
QSignalSpy aliceStatusChanged(alice.get(), &Core::statusSet);
QSignalSpy bobStatusChangeReceived(bob.get(), &Core::friendStatusChanged);
alice->setStatus(Status::Status::Away);
QTRY_VERIFY_WITH_TIMEOUT(aliceSaveRequest.count() == 1, very_long_timeout);
QTRY_VERIFY_WITH_TIMEOUT(aliceStatusChanged.count() == 1 &&
qvariant_cast<Status::Status>(aliceStatusChanged[0][0]) == Status::Status::Away,
very_long_timeout);
QTRY_VERIFY_WITH_TIMEOUT(bobStatusChangeReceived.count() == 1 &&
qvariant_cast<Status::Status>(bobStatusChangeReceived[0][1]) == Status::Status::Away,
very_long_timeout);
// Setting the status message again to the same value again triggers all signals
alice->setStatus(Status::Status::Away);
// TODO(sudden6): Emitting these again odd and should probably be changed, lets codify it for now though
QTRY_VERIFY_WITH_TIMEOUT(aliceSaveRequest.count() == 2, very_long_timeout);
QTRY_VERIFY_WITH_TIMEOUT(aliceStatusChanged.count() == 2 &&
qvariant_cast<Status::Status>(aliceStatusChanged[1][0]) == Status::Status::Away,
very_long_timeout);
// Need to sleep here, because we're testing that we don't get a new signal for the re-set but
// unchanged status, so QTRY_VERIFY_WITH_TIMEOUT would return immediately.
QTest::qSleep(connected_message_wait);
QVERIFY(bobStatusChangeReceived.count() == 1);
}
QTEST_GUILESS_MAIN(TestCoreOnline)
#include "core_online_test.moc"

180
test/core/core_test.cpp
View File

@ -35,14 +35,29 @@
#include <memory> #include <memory>
Q_DECLARE_METATYPE(QList<DhtServer>) Q_DECLARE_METATYPE(QList<DhtServer>)
Q_DECLARE_METATYPE(ToxPk)
Q_DECLARE_METATYPE(uint32_t)
Q_DECLARE_METATYPE(Status::Status)
class TestCoreProxy : public QObject class TestCore : public QObject
{ {
Q_OBJECT Q_OBJECT
public:
TestCore()
{
qRegisterMetaType<ToxPk>("ToxPk");
qRegisterMetaType<uint32_t>("uint32_t");
qRegisterMetaType<Status::Status>("Status::Status");
}
private slots: private slots:
void startup_without_proxy();
void startup_with_invalid_socks5_proxy(); void startup_with_invalid_socks5_proxy();
void startup_with_invalid_http_proxy(); void startup_with_invalid_http_proxy();
void bootstrap();
void make_friends();
void change_name();
void change_status_message();
void change_status();
private: private:
/* Test Variables */ /* Test Variables */
@ -54,9 +69,9 @@ private:
MockBootstrapListGenerator bobsNodes{}; MockBootstrapListGenerator bobsNodes{};
}; };
namespace { namespace {
const int timeout = 15000; const int bootstrap_timeout = 15000;
const int connected_message_wait = 5000;
void bootstrapToxes(Core& alice, MockBootstrapListGenerator& alicesNodes, void bootstrapToxes(Core& alice, MockBootstrapListGenerator& alicesNodes,
Core& bob, MockBootstrapListGenerator& bobsNodes) Core& bob, MockBootstrapListGenerator& bobsNodes)
@ -71,11 +86,33 @@ void bootstrapToxes(Core& alice, MockBootstrapListGenerator& alicesNodes,
bob.start(); bob.start();
QTRY_VERIFY_WITH_TIMEOUT(spyAlice.count() == 1 && QTRY_VERIFY_WITH_TIMEOUT(spyAlice.count() == 1 &&
spyBob.count() == 1, timeout); spyBob.count() == 1, bootstrap_timeout);
} }
} // namespace } // namespace
void TestCoreProxy::startup_without_proxy() void TestCore::startup_with_invalid_socks5_proxy()
{
settings.setProxyAddr("Test");
settings.setProxyPort(9985);
settings.setProxyType(MockSettings::ProxyType::ptSOCKS5);
alice = Core::makeToxCore({}, settings, alicesNodes, err);
QVERIFY(!alice);
}
void TestCore::startup_with_invalid_http_proxy()
{
settings.setProxyAddr("Test");
settings.setProxyPort(9985);
settings.setProxyType(MockSettings::ProxyType::ptHTTP);
alice = Core::makeToxCore({}, settings, alicesNodes, err);
QVERIFY(!alice);
}
void TestCore::bootstrap()
{ {
// No proxy // No proxy
settings.setProxyAddr(""); settings.setProxyAddr("");
@ -90,27 +127,132 @@ void TestCoreProxy::startup_without_proxy()
bootstrapToxes(*alice, alicesNodes, *bob, bobsNodes); bootstrapToxes(*alice, alicesNodes, *bob, bobsNodes);
} }
void TestCoreProxy::startup_with_invalid_socks5_proxy() void TestCore::make_friends()
{ {
settings.setProxyAddr("Test"); // Make a friend request from alice to bob
settings.setProxyPort(9985); const QLatin1String friendMsg{"Test Invite Message"};
settings.setProxyType(MockSettings::ProxyType::ptSOCKS5);
alice = Core::makeToxCore({}, settings, alicesNodes, err); QSignalSpy spyBobFriendMsg(bob.get(), &Core::friendRequestReceived);
QSignalSpy spyAliceFriendMsg(alice.get(), &Core::requestSent);
alice->requestFriendship(bob->getSelfId(), friendMsg);
QVERIFY(!alice); // Wait for friend message to be received
QTRY_VERIFY_WITH_TIMEOUT(spyBobFriendMsg.count() == 1 && spyAliceFriendMsg.count() == 1, connected_message_wait);
// Check for expected signal content
QVERIFY(qvariant_cast<ToxPk>(spyBobFriendMsg[0][0]) == alice->getSelfPublicKey());
QVERIFY(spyBobFriendMsg[0][1].toString() == friendMsg);
QVERIFY(qvariant_cast<ToxPk>(spyAliceFriendMsg[0][0]) == bob->getSelfPublicKey());
QVERIFY(spyAliceFriendMsg[0][1].toString() == friendMsg);
// Let Bob accept the friend request from Alice
bob->acceptFriendRequest(alice->getSelfPublicKey());
// Wait until both see each other
QSignalSpy spyAliceFriendOnline(alice.get(), &Core::friendStatusChanged);
QSignalSpy spyBobFriendOnline(bob.get(), &Core::friendStatusChanged);
QTRY_VERIFY_WITH_TIMEOUT(spyAliceFriendOnline.count() >= 1 && spyBobFriendOnline.count() >= 1, connected_message_wait);
// Check for expected signal content
QVERIFY(spyAliceFriendOnline[0][0].toInt() == static_cast<int>(Status::Status::Online));
QVERIFY(spyBobFriendOnline[0][0].toInt() == static_cast<int>(Status::Status::Online));
} }
void TestCoreProxy::startup_with_invalid_http_proxy() void TestCore::change_name()
{ {
settings.setProxyAddr("Test"); // Change the name of Alice to "Alice"
settings.setProxyPort(9985); const QLatin1String aliceName{"Alice"};
settings.setProxyType(MockSettings::ProxyType::ptHTTP);
alice = Core::makeToxCore({}, settings, alicesNodes, err); QSignalSpy aliceSaveRequest(alice.get(), &Core::saveRequest);
QSignalSpy aliceUsernameChanged(alice.get(), &Core::usernameSet);
QSignalSpy bobUsernameChangeReceived(bob.get(), &Core::friendUsernameChanged);
QVERIFY(!alice); alice->setUsername(aliceName);
QTRY_VERIFY_WITH_TIMEOUT(aliceSaveRequest.count() == 1, bootstrap_timeout);
QTRY_VERIFY_WITH_TIMEOUT(aliceUsernameChanged.count() == 1 &&
aliceUsernameChanged[0][0].toString() == aliceName,
bootstrap_timeout);
QTRY_VERIFY_WITH_TIMEOUT(bobUsernameChangeReceived.count() == 1 &&
bobUsernameChangeReceived[0][1].toString() == aliceName,
bootstrap_timeout);
// Setting the username again to the same value shoud NOT trigger any signals
alice->setUsername(aliceName);
// Need to sleep here, because we're testing that these don't increase based on
// Alice re-setting her username, so QTRY_VERIFY_WITH_TIMEOUT would return immediately.
QTest::qSleep(connected_message_wait);
QVERIFY(aliceSaveRequest.count() == 1);
QVERIFY(aliceUsernameChanged.count() == 1);
QVERIFY(bobUsernameChangeReceived.count() == 1);
} }
QTEST_GUILESS_MAIN(TestCoreProxy) void TestCore::change_status_message()
{
// Change the status message of Alice
const QLatin1String aliceStatusMsg{"Testing a lot"};
QSignalSpy aliceSaveRequest(alice.get(), &Core::saveRequest);
QSignalSpy aliceStatusMsgChanged(alice.get(), &Core::statusMessageSet);
QSignalSpy bobStatusMsgChangeReceived(bob.get(), &Core::friendStatusMessageChanged);
alice->setStatusMessage(aliceStatusMsg);
QTRY_VERIFY_WITH_TIMEOUT(aliceSaveRequest.count() == 1, connected_message_wait);
QTRY_VERIFY_WITH_TIMEOUT(aliceStatusMsgChanged.count() == 1 &&
aliceStatusMsgChanged[0][0].toString() == aliceStatusMsg,
connected_message_wait);
QTRY_VERIFY_WITH_TIMEOUT(bobStatusMsgChangeReceived.count() == 1 &&
bobStatusMsgChangeReceived[0][1].toString() == aliceStatusMsg,
connected_message_wait);
// Setting the status message again to the same value shoud NOT trigger any signals
alice->setStatusMessage(aliceStatusMsg);
// Need to sleep here, because we're testing that these don't increase based on
// Alice re-setting her status message, so QTRY_VERIFY_WITH_TIMEOUT would return immediately.
QTest::qSleep(connected_message_wait);
QVERIFY(aliceSaveRequest.count() == 1);
QVERIFY(aliceStatusMsgChanged.count() == 1);
QVERIFY(bobStatusMsgChangeReceived.count() == 1);
}
void TestCore::change_status()
{
QSignalSpy aliceSaveRequest(alice.get(), &Core::saveRequest);
QSignalSpy aliceStatusChanged(alice.get(), &Core::statusSet);
QSignalSpy bobStatusChangeReceived(bob.get(), &Core::friendStatusChanged);
alice->setStatus(Status::Status::Away);
QTRY_VERIFY_WITH_TIMEOUT(aliceSaveRequest.count() == 1, connected_message_wait);
QTRY_VERIFY_WITH_TIMEOUT(aliceStatusChanged.count() == 1 &&
qvariant_cast<Status::Status>(aliceStatusChanged[0][0]) == Status::Status::Away,
connected_message_wait);
QTRY_VERIFY_WITH_TIMEOUT(bobStatusChangeReceived.count() == 1 &&
qvariant_cast<Status::Status>(bobStatusChangeReceived[0][1]) == Status::Status::Away,
connected_message_wait);
// Setting the status message again to the same value again triggers all signals
alice->setStatus(Status::Status::Away);
// TODO(sudden6): Emitting these again odd and should probably be changed, lets codify it for now though
QTRY_VERIFY_WITH_TIMEOUT(aliceSaveRequest.count() == 2, connected_message_wait);
QTRY_VERIFY_WITH_TIMEOUT(aliceStatusChanged.count() == 2 &&
qvariant_cast<Status::Status>(aliceStatusChanged[1][0]) == Status::Status::Away,
connected_message_wait);
// Need to sleep here, because we're testing that we don't get a new signal for the re-set but
// unchanged status, so QTRY_VERIFY_WITH_TIMEOUT would return immediately.
QTest::qSleep(connected_message_wait);
QVERIFY(bobStatusChangeReceived.count() == 1);
}
QTEST_GUILESS_MAIN(TestCore)
#include "core_test.moc" #include "core_test.moc"