File: offlinemsgengine_test.cpp

package info (click to toggle)
qtox 1.17.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 25,628 kB
  • sloc: cpp: 40,089; xml: 10,393; sh: 2,401; ansic: 1,520; objc: 208; perl: 28; makefile: 13
file content (194 lines) | stat: -rw-r--r-- 6,363 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*
    Copyright © 2019 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/model/friend.h"
#include "src/model/status.h"
#include "src/persistence/offlinemsgengine.h"

#include <QtTest/QtTest>

struct MockFriendMessageSender : public QObject, public ICoreFriendMessageSender
{
    Q_OBJECT
public:
    MockFriendMessageSender(Friend* f)
        : f(f){};
    bool sendAction(uint32_t friendId, const QString& action, ReceiptNum& receipt) override
    {
        return false;
    }
    bool sendMessage(uint32_t friendId, const QString& message, ReceiptNum& receipt) override
    {
        if (Status::isOnline(f->getStatus())) {
            receipt.get() = receiptNum++;
            if (!dropReceipts) {
                msgs.push_back(message);
                emit receiptReceived(receipt);
            }
            numMessagesSent++;
        } else {
            numMessagesFailed++;
        }
        return Status::isOnline(f->getStatus());
    }

signals:
    void receiptReceived(ReceiptNum receipt);

public:
    Friend* f;
    bool dropReceipts = false;
    size_t numMessagesSent = 0;
    size_t numMessagesFailed = 0;
    int receiptNum = 0;
    std::vector<QString> msgs;
};

class TestOfflineMsgEngine : public QObject
{
    Q_OBJECT

private slots:
    void testReceiptResolution();
    void testOfflineFriend();
    void testSentUnsentCoordination();
    void testCallback();
};

class OfflineMsgEngineFixture
{
public:
    OfflineMsgEngineFixture()
        : f(0, ToxPk(QByteArray(32, 0)))
        , friendMessageSender(&f)
        , offlineMsgEngine(&f, &friendMessageSender)
    {
        f.setStatus(Status::Status::Online);
        QObject::connect(&friendMessageSender, &MockFriendMessageSender::receiptReceived,
                         &offlineMsgEngine, &OfflineMsgEngine::onReceiptReceived);
    }

    Friend f;
    MockFriendMessageSender friendMessageSender;
    OfflineMsgEngine offlineMsgEngine;
};

void completionFn() {}

void TestOfflineMsgEngine::testReceiptResolution()
{
    OfflineMsgEngineFixture fixture;

    Message msg{false, QString(), QDateTime()};

    ReceiptNum receipt;
    fixture.friendMessageSender.sendMessage(0, msg.content, receipt);
    fixture.offlineMsgEngine.addSentMessage(receipt, msg, completionFn);

    // We should have no offline messages to deliver if we resolved our receipt
    // correctly
    fixture.offlineMsgEngine.deliverOfflineMsgs();
    fixture.offlineMsgEngine.deliverOfflineMsgs();
    fixture.offlineMsgEngine.deliverOfflineMsgs();

    QVERIFY(fixture.friendMessageSender.numMessagesSent == 1);

    // If we drop receipts we should keep trying to send messages every time we
    // "deliverOfflineMsgs"
    fixture.friendMessageSender.dropReceipts = true;
    fixture.friendMessageSender.sendMessage(0, msg.content, receipt);
    fixture.offlineMsgEngine.addSentMessage(receipt, msg, completionFn);
    fixture.offlineMsgEngine.deliverOfflineMsgs();
    fixture.offlineMsgEngine.deliverOfflineMsgs();
    fixture.offlineMsgEngine.deliverOfflineMsgs();

    QVERIFY(fixture.friendMessageSender.numMessagesSent == 5);

    // And once we stop dropping and try one more time we should run out of
    // messages to send again
    fixture.friendMessageSender.dropReceipts = false;
    fixture.offlineMsgEngine.deliverOfflineMsgs();
    fixture.offlineMsgEngine.deliverOfflineMsgs();
    fixture.offlineMsgEngine.deliverOfflineMsgs();
    QVERIFY(fixture.friendMessageSender.numMessagesSent == 6);
}

void TestOfflineMsgEngine::testOfflineFriend()
{
    OfflineMsgEngineFixture fixture;

    Message msg{false, QString(), QDateTime()};

    fixture.f.setStatus(Status::Status::Offline);

    fixture.offlineMsgEngine.addUnsentMessage(msg, completionFn);
    fixture.offlineMsgEngine.addUnsentMessage(msg, completionFn);
    fixture.offlineMsgEngine.addUnsentMessage(msg, completionFn);
    fixture.offlineMsgEngine.addUnsentMessage(msg, completionFn);
    fixture.offlineMsgEngine.addUnsentMessage(msg, completionFn);

    fixture.f.setStatus(Status::Status::Online);
    fixture.offlineMsgEngine.deliverOfflineMsgs();


    QVERIFY(fixture.friendMessageSender.numMessagesFailed == 0);
    QVERIFY(fixture.friendMessageSender.numMessagesSent == 5);
}

void TestOfflineMsgEngine::testSentUnsentCoordination()
{
    OfflineMsgEngineFixture fixture;
    Message msg{false, QString("a"), QDateTime()};
    ReceiptNum receipt;

    fixture.offlineMsgEngine.addUnsentMessage(msg, completionFn);
    msg.content = "b";
    fixture.friendMessageSender.dropReceipts = true;
    fixture.friendMessageSender.sendMessage(0, msg.content, receipt);
    fixture.friendMessageSender.dropReceipts = false;
    fixture.offlineMsgEngine.addSentMessage(receipt, msg, completionFn);
    msg.content = "c";
    fixture.offlineMsgEngine.addUnsentMessage(msg, completionFn);

    fixture.offlineMsgEngine.deliverOfflineMsgs();

    auto expectedResponseOrder = std::vector<QString>{"a", "b", "c"};
    QVERIFY(fixture.friendMessageSender.msgs == expectedResponseOrder);
}

void TestOfflineMsgEngine::testCallback()
{
    OfflineMsgEngineFixture fixture;

    size_t numCallbacks = 0;
    auto callback = [&numCallbacks] { numCallbacks++; };
    Message msg{false, QString(), QDateTime()};
    ReceiptNum receipt;

    fixture.friendMessageSender.sendMessage(0, msg.content, receipt);
    fixture.offlineMsgEngine.addSentMessage(receipt, msg, callback);
    fixture.offlineMsgEngine.addUnsentMessage(msg, callback);

    fixture.offlineMsgEngine.deliverOfflineMsgs();
    QVERIFY(numCallbacks == 2);
}

QTEST_GUILESS_MAIN(TestOfflineMsgEngine)
#include "offlinemsgengine_test.moc"