EventHandler Nullptr checks

So I got lazy halfway through doing this the first time. Add missing checks for null m_room and m_event to EventHandler and add tests for them.
2023-10-29 14:51:25 +00:00
parent f3c4d9449a
commit 57978b1a6e
2 changed files with 355 additions and 2 deletions
--- a/autotests/eventhandlertest.cpp
+++ b/autotests/eventhandlertest.cpp
@@ -39,34 +39,61 @@ private:
    Connection *connection = nullptr;
    TestRoom *room = nullptr;
    EventHandler eventHandler;
+    EventHandler emptyHandler;
+    EventHandler noEventHandler;

 private Q_SLOTS:
    void initTestCase();

+    void nullSetEvent();
    void eventId();
+    void nullEventId();
    void delegateType_data();
    void delegateType();
+    void nullDelegateType();
    void author();
+    void nullAuthor();
    void authorDisplayName();
+    void nullAuthorDisplayName();
    void time();
+    void nullTime();
    void timeString();
+    void nullTimeString();
    void highlighted();
+    void nullHighlighted();
    void hidden();
+    void nullHidden();
    void body();
+    void nullBody();
    void genericBody_data();
    void genericBody();
+    void nullGenericBody();
    void mediaInfo();
+    void nullMediaInfo();
    void linkPreviewer();
+    void nullLinkPreviewer();
    void reactions();
+    void nullReactions();
    void hasReply();
+    void nullHasReply();
    void replyId();
+    void nullReplyId();
    void replyDelegateType();
+    void nullReplyDelegateType();
    void replyAuthor();
+    void nullReplyAuthor();
    void replyBody();
+    void nullReplyBody();
    void replyMediaInfo();
+    void nullReplyMediaInfo();
    void thread();
+    void nullThread();
    void location();
+    void nullLocation();
    void readMarkers();
+    void nullReadMarkers();
+
+    void cleanup();
 };

 void EventHandlerTest::initTestCase()
@@ -82,6 +109,13 @@ void EventHandlerTest::initTestCase()
    room->update(std::move(roomData));

    eventHandler.setRoom(room);
+    noEventHandler.setRoom(room);
+}
+
+void EventHandlerTest::nullSetEvent()
+{
+    QTest::ignoreMessage(QtWarningMsg, "cannot setEvent when m_room is set to nullptr.");
+    emptyHandler.setEvent(room->messageEvents().at(0).get());
 }

 void EventHandlerTest::eventId()
@@ -91,6 +125,12 @@ void EventHandlerTest::eventId()
    QCOMPARE(eventHandler.getId(), QStringLiteral("$153456789:example.org"));
 }

+void EventHandlerTest::nullEventId()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getId called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getId(), QString());
+}
+
 void EventHandlerTest::delegateType_data()
 {
    QTest::addColumn<int>("eventNum");
@@ -114,6 +154,12 @@ void EventHandlerTest::delegateType()
    QCOMPARE(eventHandler.getDelegateType(), delegateType);
 }

+void EventHandlerTest::nullDelegateType()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getDelegateType called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getDelegateType(), DelegateType::Other);
+}
+
 void EventHandlerTest::author()
 {
    auto event = room->messageEvents().at(0).get();
@@ -131,6 +177,15 @@ void EventHandlerTest::author()
    QCOMPARE(eventHandlerAuthor["object"_ls], QVariant::fromValue(author));
 }

+void EventHandlerTest::nullAuthor()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getAuthor called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.getAuthor(), QVariantMap());
+
+    QTest::ignoreMessage(QtWarningMsg, "getAuthor called with m_event set to nullptr. Returning empty user.");
+    QCOMPARE(noEventHandler.getAuthor(), room->getUser(nullptr));
+}
+
 void EventHandlerTest::authorDisplayName()
 {
    auto event = room->messageEvents().at(1).get();
@@ -139,6 +194,15 @@ void EventHandlerTest::authorDisplayName()
    QCOMPARE(eventHandler.getAuthorDisplayName(), QStringLiteral("before"));
 }

+void EventHandlerTest::nullAuthorDisplayName()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getAuthorDisplayName called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.getAuthorDisplayName(), QString());
+
+    QTest::ignoreMessage(QtWarningMsg, "getAuthorDisplayName called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getAuthorDisplayName(), QString());
+}
+
 void EventHandlerTest::time()
 {
    auto event = room->messageEvents().at(0).get();
@@ -148,6 +212,16 @@ void EventHandlerTest::time()
    QCOMPARE(eventHandler.getTime(true, QDateTime::fromMSecsSinceEpoch(1234, Qt::UTC)), QDateTime::fromMSecsSinceEpoch(1234, Qt::UTC));
 }

+void EventHandlerTest::nullTime()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getTime called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getTime(), QDateTime());
+
+    eventHandler.setEvent(room->messageEvents().at(0).get());
+    QTest::ignoreMessage(QtWarningMsg, "a value must be provided for lastUpdated for a pending event.");
+    QCOMPARE(eventHandler.getTime(true), QDateTime());
+}
+
 void EventHandlerTest::timeString()
 {
    auto event = room->messageEvents().at(0).get();
@@ -169,6 +243,16 @@ void EventHandlerTest::timeString()
             format.formatRelativeDate(QDateTime::fromMSecsSinceEpoch(1690699214545, Qt::UTC).toLocalTime().date(), QLocale::LongFormat));
 }

+void EventHandlerTest::nullTimeString()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getTimeString called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getTimeString(false), QString());
+
+    eventHandler.setEvent(room->messageEvents().at(0).get());
+    QTest::ignoreMessage(QtWarningMsg, "a value must be provided for lastUpdated for a pending event.");
+    QCOMPARE(eventHandler.getTimeString(false, QLocale::ShortFormat, true), QString());
+}
+
 void EventHandlerTest::highlighted()
 {
    auto event = room->messageEvents().at(2).get();
@@ -182,6 +266,15 @@ void EventHandlerTest::highlighted()
    QCOMPARE(eventHandler.isHighlighted(), false);
 }

+void EventHandlerTest::nullHighlighted()
+{
+    QTest::ignoreMessage(QtWarningMsg, "isHighlighted called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.isHighlighted(), false);
+
+    QTest::ignoreMessage(QtWarningMsg, "isHighlighted called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.isHighlighted(), false);
+}
+
 void EventHandlerTest::hidden()
 {
    auto event = room->messageEvents().at(3).get();
@@ -195,6 +288,15 @@ void EventHandlerTest::hidden()
    QCOMPARE(eventHandler.isHidden(), false);
 }

+void EventHandlerTest::nullHidden()
+{
+    QTest::ignoreMessage(QtWarningMsg, "isHidden called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.isHidden(), false);
+
+    QTest::ignoreMessage(QtWarningMsg, "isHidden called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.isHidden(), false);
+}
+
 void EventHandlerTest::body()
 {
    auto event = room->messageEvents().at(0).get();
@@ -206,6 +308,15 @@ void EventHandlerTest::body()
    QCOMPARE(eventHandler.getPlainBody(true), QStringLiteral("This is an example text message"));
 }

+void EventHandlerTest::nullBody()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getRichBody called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getRichBody(), QString());
+
+    QTest::ignoreMessage(QtWarningMsg, "getPlainBody called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getPlainBody(), QString());
+}
+
 void EventHandlerTest::genericBody_data()
 {
    QTest::addColumn<int>("eventNum");
@@ -228,6 +339,12 @@ void EventHandlerTest::genericBody()
    QCOMPARE(eventHandler.getGenericBody(), output);
 }

+void EventHandlerTest::nullGenericBody()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getGenericBody called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getGenericBody(), QString());
+}
+
 void EventHandlerTest::mediaInfo()
 {
    auto event = room->messageEvents().at(4).get();
@@ -251,6 +368,15 @@ void EventHandlerTest::mediaInfo()
    QCOMPARE(thumbnailInfo["height"_ls], 450);
 }

+void EventHandlerTest::nullMediaInfo()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getMediaInfo called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.getMediaInfo(), QVariantMap());
+
+    QTest::ignoreMessage(QtWarningMsg, "getMediaInfo called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getMediaInfo(), QVariantMap());
+}
+
 void EventHandlerTest::linkPreviewer()
 {
    auto event = room->messageEvents().at(2).get();
@@ -264,6 +390,15 @@ void EventHandlerTest::linkPreviewer()
    QCOMPARE(eventHandler.getLinkPreviewer(), nullptr);
 }

+void EventHandlerTest::nullLinkPreviewer()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getLinkPreviewer called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.getLinkPreviewer(), nullptr);
+
+    QTest::ignoreMessage(QtWarningMsg, "getLinkPreviewer called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getLinkPreviewer(), nullptr);
+}
+
 void EventHandlerTest::reactions()
 {
    auto event = room->messageEvents().at(0).get();
@@ -272,6 +407,15 @@ void EventHandlerTest::reactions()
    QCOMPARE(eventHandler.getReactions()->rowCount(), 1);
 }

+void EventHandlerTest::nullReactions()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getReactions called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.getReactions(), nullptr);
+
+    QTest::ignoreMessage(QtWarningMsg, "getReactions called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getReactions(), nullptr);
+}
+
 void EventHandlerTest::hasReply()
 {
    auto event = room->messageEvents().at(5).get();
@@ -285,6 +429,12 @@ void EventHandlerTest::hasReply()
    QCOMPARE(eventHandler.hasReply(), false);
 }

+void EventHandlerTest::nullHasReply()
+{
+    QTest::ignoreMessage(QtWarningMsg, "hasReply called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.hasReply(), false);
+}
+
 void EventHandlerTest::replyId()
 {
    auto event = room->messageEvents().at(5).get();
@@ -298,6 +448,12 @@ void EventHandlerTest::replyId()
    QCOMPARE(eventHandler.getReplyId(), QStringLiteral(""));
 }

+void EventHandlerTest::nullReplyId()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getReplyId called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getReplyId(), QString());
+}
+
 void EventHandlerTest::replyDelegateType()
 {
    auto event = room->messageEvents().at(5).get();
@@ -311,6 +467,15 @@ void EventHandlerTest::replyDelegateType()
    QCOMPARE(eventHandler.getReplyDelegateType(), DelegateType::Other);
 }

+void EventHandlerTest::nullReplyDelegateType()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getReplyDelegateType called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.getReplyDelegateType(), DelegateType::Other);
+
+    QTest::ignoreMessage(QtWarningMsg, "getReplyDelegateType called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getReplyDelegateType(), DelegateType::Other);
+}
+
 void EventHandlerTest::replyAuthor()
 {
    auto event = room->messageEvents().at(5).get();
@@ -334,6 +499,15 @@ void EventHandlerTest::replyAuthor()
    QCOMPARE(eventHandler.getReplyAuthor(), room->getUser(nullptr));
 }

+void EventHandlerTest::nullReplyAuthor()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getReplyAuthor called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.getReplyAuthor(), QVariantMap());
+
+    QTest::ignoreMessage(QtWarningMsg, "getReplyAuthor called with m_event set to nullptr. Returning empty user.");
+    QCOMPARE(noEventHandler.getReplyAuthor(), room->getUser(nullptr));
+}
+
 void EventHandlerTest::replyBody()
 {
    auto event = room->messageEvents().at(5).get();
@@ -345,6 +519,15 @@ void EventHandlerTest::replyBody()
    QCOMPARE(eventHandler.getReplyPlainBody(true), QStringLiteral("This is an example text message"));
 }

+void EventHandlerTest::nullReplyBody()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getReplyRichBody called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getReplyRichBody(), QString());
+
+    QTest::ignoreMessage(QtWarningMsg, "getReplyPlainBody called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getReplyPlainBody(), QString());
+}
+
 void EventHandlerTest::replyMediaInfo()
 {
    auto event = room->messageEvents().at(6).get();
@@ -369,6 +552,15 @@ void EventHandlerTest::replyMediaInfo()
    QCOMPARE(thumbnailInfo["height"_ls], 450);
 }

+void EventHandlerTest::nullReplyMediaInfo()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getReplyMediaInfo called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.getReplyMediaInfo(), QVariantMap());
+
+    QTest::ignoreMessage(QtWarningMsg, "getReplyMediaInfo called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getReplyMediaInfo(), QVariantMap());
+}
+
 void EventHandlerTest::thread()
 {
    auto event = room->messageEvents().at(0).get();
@@ -392,6 +584,15 @@ void EventHandlerTest::thread()
    QCOMPARE(eventHandler.getReplyId(), QStringLiteral("$threadmessage1:example.org"));
 }

+void EventHandlerTest::nullThread()
+{
+    QTest::ignoreMessage(QtWarningMsg, "isThreaded called with m_event set to nullptr.");
+    QCOMPARE(emptyHandler.isThreaded(), false);
+
+    QTest::ignoreMessage(QtWarningMsg, "threadRoot called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.threadRoot(), QString());
+}
+
 void EventHandlerTest::location()
 {
    auto event = room->messageEvents().at(7).get();
@@ -402,6 +603,18 @@ void EventHandlerTest::location()
    QCOMPARE(eventHandler.getLocationAssetType(), QStringLiteral("m.pin"));
 }

+void EventHandlerTest::nullLocation()
+{
+    QTest::ignoreMessage(QtWarningMsg, "getLatitude called with m_event set to nullptr.");
+    QCOMPARE(emptyHandler.getLatitude(), -100.0);
+
+    QTest::ignoreMessage(QtWarningMsg, "getLongitude called with m_event set to nullptr.");
+    QCOMPARE(emptyHandler.getLongitude(), -200.0);
+
+    QTest::ignoreMessage(QtWarningMsg, "getLocationAssetType called with m_event set to nullptr.");
+    QCOMPARE(emptyHandler.getLocationAssetType(), QString());
+}
+
 void EventHandlerTest::readMarkers()
 {
    auto event = room->messageEvents().at(0).get();
@@ -431,5 +644,37 @@ void EventHandlerTest::readMarkers()
    QCOMPARE(eventHandler.getReadMarkersString().startsWith(QStringLiteral("6 users:")), true);
 }

+void EventHandlerTest::nullReadMarkers()
+{
+    QTest::ignoreMessage(QtWarningMsg, "hasReadMarkers called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.hasReadMarkers(), false);
+
+    QTest::ignoreMessage(QtWarningMsg, "getReadMarkers called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.getReadMarkers(), QVariantList());
+
+    QTest::ignoreMessage(QtWarningMsg, "getNumberExcessReadMarkers called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.getNumberExcessReadMarkers(), QString());
+
+    QTest::ignoreMessage(QtWarningMsg, "getReadMarkersString called with m_room set to nullptr.");
+    QCOMPARE(emptyHandler.getReadMarkersString(), QString());
+
+    QTest::ignoreMessage(QtWarningMsg, "hasReadMarkers called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.hasReadMarkers(), false);
+
+    QTest::ignoreMessage(QtWarningMsg, "getReadMarkers called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getReadMarkers(), QVariantList());
+
+    QTest::ignoreMessage(QtWarningMsg, "getNumberExcessReadMarkers called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getNumberExcessReadMarkers(), QString());
+
+    QTest::ignoreMessage(QtWarningMsg, "getReadMarkersString called with m_event set to nullptr.");
+    QCOMPARE(noEventHandler.getReadMarkersString(), QString());
+}
+
+void EventHandlerTest::cleanup()
+{
+    eventHandler.setEvent(nullptr);
+}
+
 QTEST_MAIN(EventHandlerTest)
 #include "eventhandlertest.moc"