┌   ┐
54
└   ┘

summaryrefslogtreecommitdiff
path: root/src/tests/dolphinquerytest.cpp
blob: 14eb03620cc71e27772dbc17dd403095b26184b3 (plain)
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
/***************************************************************************
 *   Copyright (C) 2019 by Ismael Asensio <[email protected]>              *
 *                                                                         *
 *   This program is free 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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
 ***************************************************************************/

#include "search/dolphinquery.h"

#include <QTest>

#include <QJsonDocument>
#include <QJsonObject>
#include <QStringList>
#include <QUrl>
#include <QUrlQuery>

class DolphinSearchBoxTest : public QObject
{
    Q_OBJECT

private slots:
    void testBalooSearchParsing_data();
    void testBalooSearchParsing();
};

/**
 * Defines the parameters for the test cases in testBalooSearchParsing()
 */
void DolphinSearchBoxTest::testBalooSearchParsing_data()
{
    const QString text = QStringLiteral("xyz");
    const QString filename = QStringLiteral("filename:\"xyz\"");
    const QString rating = QStringLiteral("rating>=2");
    const QString modified = QString("modified>=2019-08-07");

    QTest::addColumn<QString>("searchString");
    QTest::addColumn<QString>("expectedText");
    QTest::addColumn<QStringList>("expectedTerms");

    // Test for "Content"
    QTest::newRow("content")              << text    << text << QStringList();
    QTest::newRow("content/empty")        << ""      << ""   << QStringList();
    QTest::newRow("content/singleQuote")  << "\""    << ""   << QStringList();
    QTest::newRow("content/doubleQuote")  << "\"\""  << ""   << QStringList();
    // Test for empty `filename`
    QTest::newRow("filename")             << filename         << text << QStringList();
    QTest::newRow("filename/empty")       << "filename:"      << ""   << QStringList();
    QTest::newRow("filename/singleQuote") << "filename:\""    << ""   << QStringList();
    QTest::newRow("filename/doubleQuote") << "filename:\"\""  << ""   << QStringList();

    // Test for rating
    QTest::newRow("rating")          << rating                  << ""   << QStringList({rating});
    QTest::newRow("rating+content")  << rating + " " + text     << text << QStringList({rating});
    QTest::newRow("rating+filename") << rating + " " + filename << text << QStringList({rating});
    // Test for modified date
    QTest::newRow("modified")          << modified                  << ""   << QStringList({modified});
    QTest::newRow("modified+content")  << modified + " " + text     << text << QStringList({modified});
    QTest::newRow("modified+filename") << modified + " " + filename << text << QStringList({modified});
    // Combined tests
    QTest::newRow("rating+modified")          << rating + " AND " + modified                  << ""   << QStringList({modified, rating});
    QTest::newRow("rating+modified+content")  << rating + " AND " + modified + " " + text     << text << QStringList({modified, rating});
    QTest::newRow("rating+modified+filename") << rating + " AND " + modified + " " + filename << text << QStringList({modified, rating});
}

/**
 * Helper function to compose the baloo query URL used for searching
 */
QUrl composeQueryUrl(const QString& searchString)
{
    const QJsonObject jsonObject {
        {"searchString", searchString}
    };

    const QJsonDocument doc(jsonObject);
    const QString queryString = QString::fromUtf8(doc.toJson(QJsonDocument::Compact));

    QUrlQuery urlQuery;
    urlQuery.addQueryItem(QStringLiteral("json"), queryString);

    QUrl searchUrl;
    searchUrl.setScheme(QLatin1String("baloosearch"));
    searchUrl.setQuery(urlQuery);

    return searchUrl;
}

/**
 * The test verifies whether the different terms of a Baloo search URL ("baloosearch:") are
 * properly handled by the searchbox, and only "user" or filename terms are added to the
 * text bar of the searchbox.
 */
void DolphinSearchBoxTest::testBalooSearchParsing()
{
    QFETCH(QString, searchString);
    QFETCH(QString, expectedText);
    QFETCH(QStringList, expectedTerms);

    const QUrl testUrl = composeQueryUrl(searchString);
    const DolphinQuery query = DolphinQuery::fromBalooSearchUrl(testUrl);

    QStringList searchTerms = query.searchTerms();
    searchTerms.sort();

    // FIXME: Current parsing bugs
    QEXPECT_FAIL("content/singleQuote", "Quotes around text are shown", Continue);
    QEXPECT_FAIL("content/doubleQuote", "Quotes around text are shown", Continue);

    QEXPECT_FAIL("filename",             "Quotes around text are shown", Continue);
    QEXPECT_FAIL("filename/singleQuote", "Quotes around text are shown", Continue);
    QEXPECT_FAIL("filename/doubleQuote", "Quotes around text are shown", Continue);

    QEXPECT_FAIL("rating"                  , "Text includes also search terms", Continue);
    QEXPECT_FAIL("rating+content"          , "Text includes also search terms", Continue);
    QEXPECT_FAIL("rating+filename"         , "Text includes also search terms", Continue);
    QEXPECT_FAIL("modified"                , "Text includes also search terms", Continue);
    QEXPECT_FAIL("modified+content"        , "Text includes also search terms", Continue);
    QEXPECT_FAIL("modified+filename"       , "Text includes also search terms", Continue);
    QEXPECT_FAIL("rating+modified"         , "Text includes also search terms", Continue);
    QEXPECT_FAIL("rating+modified+content" , "Text includes also search terms", Continue);
    QEXPECT_FAIL("rating+modified+filename", "Text includes also search terms", Continue);

    // Check for parsed text (would be displayed on the input search bar)
    QCOMPARE(query.text(), expectedText);

    // Check for parsed search terms (would be displayed by the facetsWidget)
    QCOMPARE(searchTerms.count(), expectedTerms.count());
    for (int i = 0; i < expectedTerms.count(); i++) {
        QCOMPARE(searchTerms.at(i), expectedTerms.at(i));
    }
}

QTEST_MAIN(DolphinSearchBoxTest)

#include "dolphinquerytest.moc"