File: tst_accessibilityclient.cpp

package info (click to toggle)
libqaccessibilityclient 0.6.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 612 kB
  • sloc: cpp: 3,632; makefile: 9; sh: 7
file content (477 lines) | stat: -rw-r--r-- 15,468 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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
/*
    SPDX-FileCopyrightText: 2012 Frederik Gladhorn <gladhorn@kde.org>

    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/

#include <QTest>

#include <QMainWindow>
#include <QPushButton>
#include <QTextEdit>
#include <QLabel>
#include <QLineEdit>
#include <QBoxLayout>
#include <QAccessible>
#include <QDebug>
#include <QProcess>
#include <QFileInfo>

#include "qaccessibilityclient/registry.h"
#include "qaccessibilityclient/accessibleobject.h"

#include "atspi/dbusconnection.h"

typedef QSharedPointer<QAccessibleInterface> QAIPointer;

using namespace QAccessibleClient;

struct Event {
    Event(const AccessibleObject &obj)
        : object(obj)
    {}

    AccessibleObject object;
};

class EventListener : public QObject
{
    Q_OBJECT
public Q_SLOTS:
    void focus(const QAccessibleClient::AccessibleObject &object) {
        focusEvents.append(Event(object));
    }

public:
    QList<Event> focusEvents;
};

class AccessibilityClientTest :public QObject
{
    Q_OBJECT

private Q_SLOTS:
    void initTestCase();
    void cleanup();

    void tst_registry();
    void tst_accessibleObject();
    void tst_hashable();
    void tst_application();
    void tst_navigation();
    void tst_focus();
    void tst_states();

    void tst_extents();

    void tst_characterExtents();

private:
    bool startHelperProcess();
    Registry registry;
    QProcess helperProcess;
};

void AccessibilityClientTest::initTestCase()
{
}


AccessibleObject getAppObject(const Registry &r, const QString &appName)
{
    AccessibleObject accApp;

    QApplication::processEvents();
    const QList<AccessibleObject> apps = r.applications();
    for (const AccessibleObject &app : apps) {
        if (app.name() == appName) {
            accApp = app;
            break;
        }
    }
    return accApp;
}

void AccessibilityClientTest::cleanup()
{
    registry.subscribeEventListeners(Registry::NoEventListeners);
}

void AccessibilityClientTest::tst_registry()
{
    QVERIFY(registry.subscribedEventListeners() == Registry::NoEventListeners);
    registry.subscribeEventListeners(Registry::Window);
    QVERIFY(registry.subscribedEventListeners() == Registry::Window);
    registry.subscribeEventListeners(Registry::Focus);
    QVERIFY(registry.subscribedEventListeners() == Registry::Focus);
    registry.subscribeEventListeners(Registry::Focus | Registry::Window);
    QVERIFY(registry.subscribedEventListeners() == (Registry::Focus | Registry::Window));

    registry.subscribeEventListeners(Registry::NoEventListeners);
    QVERIFY(registry.subscribedEventListeners() == Registry::NoEventListeners);
    registry.subscribeEventListeners(Registry::AllEventListeners);
    QVERIFY(registry.subscribedEventListeners() == Registry::AllEventListeners);
    QVERIFY(registry.subscribedEventListeners() & Registry::Window);
}

void AccessibilityClientTest::tst_accessibleObject()
{
    AccessibleObject invalidObject;
    QVERIFY(!invalidObject.isValid());
    AccessibleObject invalid2(invalidObject);
    QVERIFY(!invalid2.isValid());
}

void AccessibilityClientTest::tst_hashable()
{
    AccessibleObject testObject;
    QHash<AccessibleObject, int> testHash;
    testHash[testObject] = 1;
    QCOMPARE(testHash[testObject], 1);
}

void AccessibilityClientTest::tst_application()
{
    QString appName = QLatin1String("Lib QAccessibleClient test");
    qApp->setApplicationName(appName);
    QWidget w;
    w.setAccessibleName(QStringLiteral("Foobar 99"));
    w.show();

    AccessibleObject accApp;
    QVERIFY(!accApp.isValid());
    accApp = getAppObject(registry, appName);
    QVERIFY(accApp.isValid());
    QCOMPARE(accApp.name(), appName);
    QCOMPARE(accApp.childCount(), 1);

    AccessibleObject copy1(accApp);
    AccessibleObject copy2 = accApp;
    QVERIFY(copy1.isValid());
    QCOMPARE(copy1.name(), appName);
    QVERIFY(copy2.isValid());
    QCOMPARE(copy2.name(), appName);
}

void AccessibilityClientTest::tst_navigation()
{
    QString appName = QLatin1String("Lib QAccessibleClient test");
    qApp->setApplicationName(appName);
    QWidget w;
    w.setAccessibleName(QStringLiteral("Root Widget"));
    w.setAccessibleDescription(QStringLiteral("This is a useless widget"));
    QVBoxLayout *layout = new QVBoxLayout;
    w.setLayout(layout);

    QPushButton *button = new QPushButton;
    layout->addWidget(button);
    button->setText(QLatin1String("Hello a11y"));
    QString desc = QStringLiteral("This is a button...");
    button->setAccessibleDescription(desc);
    w.show();
    w.activateWindow();
    button->setFocus();

    QVERIFY(QTest::qWaitForWindowExposed(&w));
    QVERIFY(QTest::qWaitForWindowActive(&w));

    // App
    AccessibleObject accApp = getAppObject(registry, appName);
    QVERIFY(accApp.isValid());
    QCOMPARE(accApp.name(), appName);
    QCOMPARE(accApp.childCount(), 1);

    // What should this return?
    QCOMPARE(accApp.indexInParent(), -1);

    // Root widget
    AccessibleObject accW = accApp.child(0);
    QVERIFY(accW.isValid());
    qDebug() << "NAME: " << accW.name();
    QCOMPARE(accW.name(), w.accessibleName());
    QCOMPARE(accW.description(), w.accessibleDescription());
    QCOMPARE(accW.role(), AccessibleObject::Filler);
    QCOMPARE(accW.roleName(), QLatin1String("filler"));
    QCOMPARE(accW.childCount(), 1);
    QCOMPARE(accW.indexInParent(), 0);
    QVERIFY(accW.isActive());

    // Button
    AccessibleObject accButton = accW.child(0);
    QVERIFY(accButton.isValid());
    QCOMPARE(accButton.name(), button->text());
    QCOMPARE(accButton.description(), desc);
    QCOMPARE(accButton.role(), AccessibleObject::Button);
    QCOMPARE(accButton.roleName(), QLatin1String("push button"));
    QVERIFY(!accButton.localizedRoleName().isEmpty());
    QCOMPARE(accButton.indexInParent(), 0);

    AccessibleObject accButton2 = accW.children().first();
    QCOMPARE(accButton, accButton2);
    AccessibleObject parent = accButton.parent();
    QCOMPARE(parent, accW);
    AccessibleObject parentParent = parent.parent();
    QCOMPARE(parentParent, accApp);

    AccessibleObject invalidChild = accButton.child(0);
    QVERIFY(!invalidChild.isValid());
    QVERIFY(invalidChild.name().isEmpty());

    AccessibleObject invalidParent = accApp.parent();
    QVERIFY(!invalidParent.isValid());
    QVERIFY(invalidParent.name().isEmpty());

    // Add a label and line edit
    QLabel *label = new QLabel;
    label->setText(QStringLiteral("Name:"));
    layout->addWidget(label);
    QLineEdit *line = new QLineEdit;
    layout->addWidget(line);
    label->setBuddy(line);
    QApplication::processEvents();
    QCOMPARE(accW.childCount(), 3);

    AccessibleObject accLabel = accW.child(1);
    QVERIFY(accLabel.isValid());
    QCOMPARE(accLabel.name(), label->text());
    QCOMPARE(accLabel.role(), AccessibleObject::Label);
    QCOMPARE(accLabel.roleName(), QLatin1String("label"));
    QCOMPARE(accLabel.indexInParent(), 1);
    QVERIFY(accLabel.isVisible());
    QVERIFY(!accLabel.isCheckable());
    QVERIFY(!accLabel.isChecked());
    QVERIFY(!accLabel.isFocusable());
    QVERIFY(!accLabel.isFocused());
    QVERIFY(!accLabel.isEditable());

    AccessibleObject accLine = accW.child(2);
    QVERIFY(accLine.isValid());
    QCOMPARE(accLine.name(), label->text());
    QCOMPARE(accLine.role(), AccessibleObject::Text);
    QCOMPARE(accLine.roleName(), QLatin1String("text"));
    QCOMPARE(accLine.indexInParent(), 2);
    QVERIFY(accLine.isEditable());
    AccessibleObject parent1 = accLine.parent();
    QCOMPARE(parent1, accW);

    QVERIFY(accLine.isFocusable());
    QVERIFY(accButton.isFocusable());
    QVERIFY(accButton.isFocused());
    QVERIFY(!accLine.isFocused());
    line->setFocus();
    QApplication::processEvents();
    QVERIFY(accLine.isFocused());
    QVERIFY(!accButton.isFocused());

    label->setVisible(false);
    line->setVisible(false);
    QApplication::processEvents();
    QTest::qWait(1000);
    QVERIFY(!accLabel.isVisible());
    QVERIFY(!accLine.isVisible());
}

bool AccessibilityClientTest::startHelperProcess()
{
    if (!QFileInfo(QCoreApplication::applicationDirPath() + QStringLiteral("/simplewidgetapp")).exists()) {
        qWarning() << "WARNING: Could not find test case helper executable."
            " Please run this test in the path where the executable is located.";
        return false;
    }

    // start peer server
    helperProcess.setProgram(QCoreApplication::applicationDirPath() + QStringLiteral("/simplewidgetapp"));
    helperProcess.start();
    if (!helperProcess.waitForStarted()) {
        qWarning() << "WARNING: Could not start helper executable. Test will not run.";
        return false;
    }
    return true;
}

void AccessibilityClientTest::tst_focus()
{
    registry.subscribeEventListeners(Registry::Focus);
    EventListener *listener = new EventListener;
    connect(&registry, SIGNAL(focusChanged(QAccessibleClient::AccessibleObject)), listener, SLOT(focus(QAccessibleClient::AccessibleObject)));

    QVERIFY(startHelperProcess());

    AccessibleObject remoteApp;
    QString appName = QLatin1String("LibKdeAccessibilityClient Simple Widget App");
    // startup and init takes some time, give up to two seconds and a few dbus calls
    int attempts = 0;
    while (attempts < 20) {
        ++attempts;
        QTest::qWait(100);
        remoteApp = getAppObject(registry, appName);
        if (remoteApp.isValid())
            break;
    }

    // waiting for two events, may take some time
    for (int i = 0; i < 20; ++i) {
        QTest::qWait(10);
        if (listener->focusEvents.size() >= 2)
            break;
    }

    QVERIFY(remoteApp.isValid());
    QCOMPARE(remoteApp.name(), appName);

    AccessibleObject window = remoteApp.child(0);
    AccessibleObject button1 = window.child(0);
    AccessibleObject button2 = window.child(1);

    // we can get other focus events, check that we only use the ones from our app
    for (int i = 0; i < listener->focusEvents.count(); ++i) {
        AccessibleObject ev = listener->focusEvents.at(i).object;
        if (ev.application() != remoteApp)
            listener->focusEvents.removeAt(i);;
    }
    QVERIFY(listener->focusEvents.size() == 2);
    QCOMPARE(listener->focusEvents.at(0).object, button1);
    QCOMPARE(listener->focusEvents.at(1).object, button2);

    // use action interface to select the first button again and check that we get an event

    delete listener;
    helperProcess.terminate();
}

void AccessibilityClientTest::tst_states()
{
    registry.subscribeEventListeners(Registry::StateChanged);

    QString appName = QLatin1String("Lib QAccessibleClient test");
    qApp->setApplicationName(appName);
    QWidget w;
    w.setAccessibleName(QStringLiteral("Root Widget"));
    w.setAccessibleDescription(QStringLiteral("This is a useless widget"));
    QVBoxLayout *layout = new QVBoxLayout;
    w.setLayout(layout);

    QPushButton *button1 = new QPushButton;
    layout->addWidget(button1);
    button1->setText(QLatin1String("Hello a11y"));
    QString desc = QStringLiteral("This is a button...");
    button1->setAccessibleDescription(desc);

    QPushButton *button2 = new QPushButton;
    layout->addWidget(button2);
    button2->setText(QLatin1String("Hello a11y"));

    w.show();
    button1->setFocus();

    QVERIFY(QTest::qWaitForWindowExposed(&w));
    AccessibleObject accApp = getAppObject(registry, appName);
    QVERIFY(accApp.isValid());

    // Root widget
    AccessibleObject accW = accApp.child(0);
    QVERIFY(accW.isValid());

    // Buttons
    AccessibleObject accButton1 = accW.child(0);
    QVERIFY(accButton1.isValid());
    QCOMPARE(accButton1.name(), button1->text());

    AccessibleObject accButton2 = accW.child(1);
    QVERIFY(accButton2.isValid());
    QCOMPARE(accButton2.name(), button2->text());

    QVERIFY(accButton1.isVisible());
    button1->setVisible(false);
    QVERIFY(!accButton1.isVisible());
    button1->setVisible(true);
    QVERIFY(accButton1.isVisible());

    QVERIFY(accButton1.isEnabled());
    button1->setEnabled(false);
    QVERIFY(!accButton1.isEnabled());
    button1->setEnabled(true);
    QVERIFY(accButton1.isEnabled());
}

void AccessibilityClientTest::tst_extents()
{
    QVERIFY(startHelperProcess());

    AccessibleObject remoteApp;
    QString appName = QLatin1String("LibKdeAccessibilityClient Simple Widget App");

    int attempts = 0;
    while(attempts < 20) {
        ++attempts;
        QTest::qWait(100);
        remoteApp = getAppObject(registry,appName);
        if(remoteApp.isValid())
            break;
    }

    QVERIFY(remoteApp.isValid());
    QCOMPARE(remoteApp.name(), appName);

    AccessibleObject window = remoteApp.child(0);
    QVERIFY(window.supportedInterfaces() & QAccessibleClient::AccessibleObject::ComponentInterface);
    QCOMPARE(window.boundingRect().size(), QSize(200,100));

    AccessibleObject button1 = window.child(0);
    QVERIFY(button1.name()==QStringLiteral("Button 1"));
    QCOMPARE(button1.boundingRect().size(), QSize(100,20));
    helperProcess.terminate();
}

void AccessibilityClientTest::tst_characterExtents()
{
    QString appName = QLatin1String("Lib QAccessibleClient test");

    QWidget w;
    w.setAccessibleName(QStringLiteral("Root Widget"));
    QTextEdit *textEdit = new QTextEdit(&w);
    textEdit->setGeometry(10,10,600,400);
    w.show();
    QVERIFY(QTest::qWaitForWindowExposed(&w));
    AccessibleObject app = getAppObject(registry, appName);

    //Check if the widget is correct
    QVERIFY(app.isValid());
    QCOMPARE(app.name(), appName);
    QCOMPARE(app.childCount(), 1);

    AccessibleObject textArea = app.child(0).child(0);
    QVERIFY(textArea.supportedInterfaces() & QAccessibleClient::AccessibleObject::TextInterface);

    textEdit->setText(QStringLiteral("This is useless text that is being used to test this text area.\n I \n hope \n this will get correct\n\t\t\tCharacterExtents!"));
    QPoint pos = w.pos();

    int start;
    int end;
    QString textWord = textArea.textWithBoundary(0, AccessibleObject::WordStartBoundary, &start, &end);
    QCOMPARE(textWord, QStringLiteral("This"));
    QCOMPARE(start, 0);
    QCOMPARE(end, 4);
    textWord = textArea.textWithBoundary(6, AccessibleObject::WordStartBoundary, &start, &end);
    QCOMPARE(textWord , QStringLiteral("is"));
    QCOMPARE(start, 5);
    QCOMPARE(end, 7);
    textWord = textArea.textWithBoundary(3, AccessibleObject::WordEndBoundary);
    QCOMPARE(textWord , QStringLiteral("This"));

    QString textSentence = textArea.textWithBoundary(0, AccessibleObject::SentenceEndBoundary);
    QCOMPARE(textSentence, QStringLiteral("This is useless text that is being used to test this text area."));
    QString textLine = textArea.textWithBoundary(0, AccessibleObject::LineEndBoundary);
    QCOMPARE(textLine, QStringLiteral("This is useless text that is being used to test this text area."));
    textLine = textArea.textWithBoundary(0, AccessibleObject::LineEndBoundary);
    QCOMPARE(textLine, QStringLiteral("This is useless text that is being used to test this text area."));

    QAccessibleInterface *textEditInterface = QAccessible::queryAccessibleInterface(textEdit);
    QCOMPARE(textArea.characterRect(0), textEditInterface->textInterface()->characterRect(0));
    QCOMPARE(textArea.characterRect(1), textEditInterface->textInterface()->characterRect(1));
}


QTEST_MAIN(AccessibilityClientTest)

#include "tst_accessibilityclient.moc"