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
195
196
197
198
199
200
201
202
203
|
/*
SPDX-FileCopyrightText: 2022 Volker Krause <vkrause@kde.org>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#include <KUnifiedPush/Connector>
#include "managementinterface.h"
#include "../src/distributor/distributor.h"
#include "../src/shared/unifiedpush-constants.h"
#include <QDBusConnection>
#include <QLoggingCategory>
#include <QProcess>
#include <QProcessEnvironment>
#include <QSettings>
#include <QSignalSpy>
#include <QStandardPaths>
#include <QTest>
using namespace Qt::Literals;
class ConnectorTest : public QObject
{
Q_OBJECT
private Q_SLOTS:
void initTestCase()
{
QStandardPaths::setTestModeEnabled(true);
qputenv("UNIFIEDPUSH_DISTRIBUTOR", "mock");
qRegisterMetaType<KUnifiedPush::Connector::State>();
QCoreApplication::setOrganizationDomain(QStringLiteral("kde.org"));
QCoreApplication::setOrganizationName(QStringLiteral("KDE"));
QSettings settings(QStandardPaths::writableLocation(QStandardPaths::ConfigLocation) + "/KDE/mockdistributor.conf"_L1, QSettings::NativeFormat);
settings.clear();
settings.setValue(QStringLiteral("PushProvider/Type"), QStringLiteral("Mock"));
settings.sync();
QLoggingCategory::setFilterRules(QStringLiteral("org.kde.kunifiedpush.*=true"));
}
void init()
{
QSettings stateSettings(QStandardPaths::writableLocation(QStandardPaths::ConfigLocation) + QLatin1String("/kunifiedpush-org.kde.kunifiedpush.connectortest"), QSettings::IniFormat);
stateSettings.clear();
}
void testNoDistributor()
{
KUnifiedPush::Connector con(QStringLiteral("org.kde.kunifiedpush.connectortest"));
QCOMPARE(con.endpoint(), QString());
QCOMPARE(con.state(), KUnifiedPush::Connector::NoDistributor);
}
void testWithDistributor()
{
QSKIP("no network in debian builds");
using namespace KUnifiedPush;
std::unique_ptr<Connector> con;
std::unique_ptr<QSignalSpy> stateSpy;
std::unique_ptr<QSignalSpy> endpointSpy;
QVERIFY(QDBusConnection::sessionBus().registerService(QStringLiteral("org.kde.kunifiedpush.connectortest")));
con.reset(new Connector(QStringLiteral("org.kde.kunifiedpush.connectortest")));
QCOMPARE(con->state(), KUnifiedPush::Connector::NoDistributor);
stateSpy.reset(new QSignalSpy(con.get(), &Connector::stateChanged));
endpointSpy.reset(new QSignalSpy(con.get(), &Connector::endpointChanged));
// start mock distributor and wait for it to become available on D-Bus
QProcess dist;
dist.setProcessChannelMode(QProcess::ForwardedChannels);
auto env = QProcessEnvironment::systemEnvironment();
env.insert(u"QT_LOGGING_RULES"_s, u"org.kde.kunifiedpush.*=true"_s);
dist.setProcessEnvironment(env);
dist.start(QCoreApplication::applicationDirPath() + "/mockdistributor"_L1);
QVERIFY(dist.waitForStarted());
QDBusServiceWatcher dbusWatcher("org.unifiedpush.Distributor.mock"_L1, QDBusConnection::sessionBus());
QSignalSpy dbusRegistrationSpy(&dbusWatcher, &QDBusServiceWatcher::serviceRegistered);
QSignalSpy dbusUnregistrationSpy(&dbusWatcher, &QDBusServiceWatcher::serviceUnregistered);
QVERIFY(dbusRegistrationSpy.wait());
// D-Bus interfaces to interact with the distributor
org::kde::kunifiedpush::Management distIface("org.unifiedpush.Distributor.mock"_L1, KDE_DISTRIBUTOR_MANAGEMENT_PATH, QDBusConnection::sessionBus());
QVERIFY(distIface.isValid());
QSignalSpy distStatusSpy(&distIface, &org::kde::kunifiedpush::Management::statusChanged);
QDBusInterface ctrlIface("org.unifiedpush.Distributor.mock"_L1, "/MockController"_L1, "org.kde.unifiedpush.MockController"_L1, QDBusConnection::sessionBus());
QVERIFY(ctrlIface.isValid());
// initial idle state with no client registered
QCOMPARE(distIface.status(), KUnifiedPush::DistributorStatus::Idle);
QCOMPARE(con->state(), KUnifiedPush::Connector::Unregistered);
// register a client
con->setVapidPublicKeyRequired(true);
con->registerClient(QStringLiteral("Push notification unit test."));
QCOMPARE(con->state(), KUnifiedPush::Connector::Unregistered);
con->setVapidPublicKey(u"<vapid-key-1>"_s);
QCOMPARE(con->state(), KUnifiedPush::Connector::Registering);
QVERIFY(stateSpy->wait());
QCOMPARE(con->state(), KUnifiedPush::Connector::Registered);
QCOMPARE(endpointSpy->size(), 1);
QCOMPARE(con->endpoint(), QLatin1String("https://localhost/push-endpoint"));
QCOMPARE(distIface.status(), KUnifiedPush::DistributorStatus::Connected);
// connector restart does not register at the provider but uses existing state
{
con.reset();
QTest::qWait(10); // propagate connector D-Bus tear-down
con.reset(new Connector(QStringLiteral("org.kde.kunifiedpush.connectortest")));
QCOMPARE(con->endpoint(), QLatin1String("https://localhost/push-endpoint"));
QCOMPARE(con->state(), KUnifiedPush::Connector::Registering);
stateSpy.reset(new QSignalSpy(con.get(), &Connector::stateChanged));
endpointSpy.reset(new QSignalSpy(con.get(), &Connector::endpointChanged));
QVERIFY(stateSpy->wait());
QCOMPARE(con->state(), KUnifiedPush::Connector::Registered);
}
// distributor goes away and comes back
ctrlIface.call("quit"_L1);
QVERIFY(dist.waitForFinished());
QVERIFY(dbusUnregistrationSpy.wait());
QCOMPARE(con->state(), KUnifiedPush::Connector::NoDistributor);
dist.start(QCoreApplication::applicationDirPath() + "/mockdistributor"_L1);
QVERIFY(dist.waitForStarted());
QVERIFY(dbusRegistrationSpy.wait());
QCOMPARE(con->state(), KUnifiedPush::Connector::Registering);
QVERIFY(stateSpy->wait());
QCOMPARE(con->state(), KUnifiedPush::Connector::Registered);
QCOMPARE(distIface.status(), KUnifiedPush::DistributorStatus::Connected);
// changing VAPID key forces a re-registration
endpointSpy->clear();
con->setVapidPublicKey(u"<vapid-key-2>"_s);
QVERIFY(stateSpy->wait());
QCOMPARE(con->state(), KUnifiedPush::Connector::Registering);
QCOMPARE(endpointSpy->size(), 1);
QCOMPARE(endpointSpy->at(0).at(0).toString(), QString());
QVERIFY(stateSpy->wait());
QCOMPARE(con->state(), KUnifiedPush::Connector::Registered);
QCOMPARE(endpointSpy->size(), 2);
QCOMPARE(endpointSpy->at(1).at(0).toString(), "https://localhost/push-endpoint"_L1);
endpointSpy->clear();
// receiving a message
QSignalSpy msgSpy(con.get(), &Connector::messageReceived);
ctrlIface.callWithArgumentList(QDBus::AutoDetect, "receiveMessage"_L1, { u"<client-remote-id>"_s, QByteArray("hello world"), QString()});
QVERIFY(msgSpy.wait());
QCOMPARE(msgSpy.at(0).at(0).toByteArray(), "hello world");
// receive a message with acknowledgement
msgSpy.clear();
ctrlIface.callWithArgumentList(QDBus::AutoDetect, "receiveMessage"_L1, { u"<client-remote-id>"_s, QByteArray("acknowledged message"), u"<msg-id>"_s});
QVERIFY(msgSpy.wait());
QCOMPARE(msgSpy.at(0).at(0).toByteArray(), "acknowledged message");
// reconfigure distributor to a different push provider
distIface.setPushProvider(QStringLiteral("Broken"), {});
QVERIFY(endpointSpy->wait());
QCOMPARE(con->endpoint(), QString());
QVERIFY(distStatusSpy.wait());
QCOMPARE(distIface.status(), KUnifiedPush::DistributorStatus::NoSetup);
distIface.setPushProvider(QStringLiteral("Mock"), {});
QVERIFY(distStatusSpy.wait());
QCOMPARE(distIface.status(), KUnifiedPush::DistributorStatus::NoSetup);
QVERIFY(distStatusSpy.wait());
QCOMPARE(distIface.status(), KUnifiedPush::DistributorStatus::Connected);
QVERIFY(endpointSpy->wait());
QCOMPARE(con->state(), KUnifiedPush::Connector::Registered);
QCOMPARE(con->endpoint(), QLatin1String("https://localhost/push-endpoint"));
QVariantMap config;
config.insert(QStringLiteral("setting"), true);
distIface.setPushProvider(QStringLiteral("Mock"), config);
QVERIFY(endpointSpy->wait());
QCOMPARE(con->endpoint(), QString());
QVERIFY(endpointSpy->wait());
QCOMPARE(con->state(), KUnifiedPush::Connector::Registered);
QCOMPARE(con->endpoint(), QLatin1String("https://localhost/push-endpoint"));
QCOMPARE(endpointSpy->size(), 4);
// connector unregisters
endpointSpy->clear();
con->unregisterClient();
QVERIFY(stateSpy->wait());
QCOMPARE(con->state(), KUnifiedPush::Connector::Unregistered);
QCOMPARE(endpointSpy->size(), 1);
QCOMPARE(con->endpoint(), QString());
QVERIFY(distStatusSpy.wait());
QCOMPARE(distIface.status(), KUnifiedPush::DistributorStatus::Idle);
ctrlIface.call("quit"_L1);
QVERIFY(dist.waitForFinished());
}
};
QTEST_GUILESS_MAIN(ConnectorTest)
#include "connectortest.moc"
#include "../src/shared/moc_distributorstatus_p.cpp"
|
