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
|
// SPDX-FileCopyrightText: 2021 Linus Jahn <lnj@kaidan.im>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
#ifndef CLIENTTESTING_H
#define CLIENTTESTING_H
#include "QXmppClient.h"
#include "QXmppClientExtension.h" // needed for qDeleteAll(d->extensions)
#include "QXmppClient_p.h"
#include "QXmppOutgoingClient.h"
#include "util.h"
class TestClient : public QXmppClient
{
Q_OBJECT
public:
TestClient(bool enableDebug = false, bool enableAutoReset = true)
: QXmppClient(),
debugEnabled(enableDebug),
autoResetEnabled(enableAutoReset)
{
// clear extensions
qDeleteAll(d->extensions);
d->extensions.clear();
// enable stream management (so IQ requests are not stopped)
d->stream->enableStreamManagement(true);
// setup logging (for expect())
logger()->setLoggingType(QXmppLogger::SignalLogging);
connect(logger(), &QXmppLogger::message, this, &TestClient::onLoggerMessage);
// In all case, start with a 0 default id
resetIdCount();
}
~TestClient() override = default;
QXmppOutgoingClient *stream() const { return d->stream; }
QXmppOutgoingClientPrivate *streamPrivate() const { return d->stream->d.get(); }
template<typename String>
void inject(const String &xml)
{
d->stream->handleIqResponse(xmlToDom(xml));
QCoreApplication::processEvents();
if (autoResetEnabled) {
resetIdCount();
}
}
void expect(QString &&packet)
{
QVERIFY2(!m_sentPackets.empty(), "No packet was sent!");
auto expectedXml = rewriteXml(packet);
auto actualXml = rewriteXml(m_sentPackets.takeFirst());
QCOMPARE(actualXml, expectedXml);
if (autoResetEnabled) {
resetIdCount();
}
}
// compares packets, ignoring different IDs and order of sending
// returns ID of the packet that matched
QString expectPacketRandomOrder(QString &&expected)
{
VERIFY2(!m_sentPackets.empty(), "No packet was sent!");
auto [expectedXml, _] = rewriteXmlWithoutStanzaId(expected);
for (const auto &packet : std::as_const(m_sentPackets)) {
auto [packetFormattedXml, stanzaId] = rewriteXmlWithoutStanzaId(packet);
if (packetFormattedXml == expectedXml) {
[]() { QVERIFY(true); }();
m_sentPackets.removeOne(packet);
return stanzaId;
}
}
// Failure
qDebug() << "Expected:";
qDebug() << expectedXml;
qDebug() << "Got:";
for (const auto &packet : m_sentPackets) {
auto [xml, id] = rewriteXmlWithoutStanzaId(packet);
qDebug() << xml;
}
[]() { QFAIL("Expected packet was not sent!"); }();
return {};
}
QString takePacket()
{
[this]() { QVERIFY(!m_sentPackets.isEmpty()); }();
return m_sentPackets.takeFirst();
}
QString takeLastPacket()
{
[this]() { QVERIFY(!m_sentPackets.isEmpty()); }();
return m_sentPackets.takeLast();
}
void expectNoPacket() const
{
if (!m_sentPackets.empty()) {
qDebug() << "Unexpected:";
for (const auto &packet : m_sentPackets) {
qDebug().noquote() << " *" << packet;
}
}
VERIFY2(m_sentPackets.empty(), "Unexpected packet sent!");
}
void ignore()
{
m_sentPackets.takeFirst();
if (autoResetEnabled) {
resetIdCount();
}
}
void resetIdCount()
{
QXmpp::Private::globalStanzaIdCounter = 0;
}
void setStreamManagementState(QXmppClient::StreamManagementState state)
{
switch (state) {
case QXmppClient::StreamManagementState::NoStreamManagement:
d->stream->c2sStreamManager().setEnabled(false);
break;
case QXmppClient::StreamManagementState::NewStream:
d->stream->c2sStreamManager().setEnabled(true);
d->stream->c2sStreamManager().setResumed(false);
break;
case QXmppClient::StreamManagementState::ResumedStream:
d->stream->c2sStreamManager().setEnabled(true);
d->stream->c2sStreamManager().setResumed(true);
break;
}
}
private:
void onLoggerMessage(QXmppLogger::MessageType type, const QString &text)
{
if (text == u"<r xmlns=\"urn:xmpp:sm:3\"/>") {
return;
}
if (debugEnabled) {
QStringView typeString;
switch (type) {
case QXmppLogger::DebugMessage:
typeString = u"DEBUG";
break;
case QXmppLogger::InformationMessage:
typeString = u"INFO";
break;
case QXmppLogger::WarningMessage:
typeString = u"WARNING";
break;
case QXmppLogger::ReceivedMessage:
typeString = u"RECEIVED";
break;
case QXmppLogger::SentMessage:
typeString = u"SENT";
break;
default:
Q_UNREACHABLE();
}
qDebug().noquote() << typeString << text;
}
if (type == QXmppLogger::SentMessage) {
m_sentPackets << text;
}
}
bool debugEnabled;
bool autoResetEnabled;
QList<QString> m_sentPackets;
};
#endif // CLIENTTESTING_H
|