Differential D25258 Diff 69665 src/tests/dolphinquerytest.cpp

Changeset View

Standalone View

src/tests/dolphinquerytest.cpp

This file was added.

1		/***************************************************************************
2		* Copyright (C) 2019 by Ismael Asensio <isma.af@gmail.com> *
3		* *
4		* This program is free software; you can redistribute it and/or modify *
5		* it under the terms of the GNU General Public License as published by *
6		* the Free Software Foundation; either version 2 of the License, or *
7		* (at your option) any later version. *
8		* *
9		* This program is distributed in the hope that it will be useful, *
10		* but WITHOUT ANY WARRANTY; without even the implied warranty of *
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12		* GNU General Public License for more details. *
13		* *
14		* You should have received a copy of the GNU General Public License *
15		* along with this program; if not, write to the *
16		* Free Software Foundation, Inc., *
17		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
18		***************************************************************************/
19
20		#include "search/dolphinquery.h"
21
22		#include <QTest>
23
24		#include <QJsonDocument>
25		#include <QJsonObject>
26		#include <QStringList>
27		#include <QUrl>
28		#include <QUrlQuery>
29
30		class DolphinSearchBoxTest : public QObject
31		{
32		Q_OBJECT
33
34		private slots:
35		void init();
36		void cleanup();
37
38		void testBalooSearchParsing_data();
39		void testBalooSearchParsing();
40		};
41
42		void DolphinSearchBoxTest::init()
43		{
44		}
45
46		void DolphinSearchBoxTest::cleanup()
47		{
48		}
	elvisangelaccioUnsubmitted Done Why empty? We should just remove them if we don't need any custom init/cleanup logic. elvisangelaccio: Why empty? We should just remove them if we don't need any custom init/cleanup logic.
49
50		/**
51		* Defines the parameters for the test cases in testBalooSearchParsing()
52		*/
53		void DolphinSearchBoxTest::testBalooSearchParsing_data()
54		{
55		const QString text = QStringLiteral("xyz");
56		const QString filename = QStringLiteral("filename:\"xyz\"");
57		const QString rating = QStringLiteral("rating>=2");
58		const QString modified = QString("modified>=2019-08-07");
59
60		QTest::addColumn<QString>("searchString");
61		QTest::addColumn<QString>("expectedText");
62		QTest::addColumn<QStringList>("expectedTerms");
63
64		// Test for "Content"
65		QTest::newRow("content") << text << text << QStringList();
66		QTest::newRow("content/empty") << "" << "" << QStringList();
67		QTest::newRow("content/singleQuote") << "\"" << "" << QStringList();
68		QTest::newRow("content/doubleQuote") << "\"\"" << "" << QStringList();
69		// Test for empty `filename`
70		QTest::newRow("filename") << filename << text << QStringList();
71		QTest::newRow("filename/empty") << "filename:" << "" << QStringList();
72		QTest::newRow("filename/singleQuote") << "filename:\"" << "" << QStringList();
73		QTest::newRow("filename/doubleQuote") << "filename:\"\"" << "" << QStringList();
74
75		// Test for rating
76		QTest::newRow("rating") << rating << "" << QStringList({rating});
77		QTest::newRow("rating+content") << rating + " " + text << text << QStringList({rating});
78		QTest::newRow("rating+filename") << rating + " " + filename << text << QStringList({rating});
79		// Test for modified date
80		QTest::newRow("modified") << modified << "" << QStringList({modified});
81		QTest::newRow("modified+content") << modified + " " + text << text << QStringList({modified});
82		QTest::newRow("modified+filename") << modified + " " + filename << text << QStringList({modified});
83		// Combined tests
84		QTest::newRow("rating+modified") << rating + " AND " + modified << "" << QStringList({modified, rating});
85		QTest::newRow("rating+modified+content") << rating + " AND " + modified + " " + text << text << QStringList({modified, rating});
86		QTest::newRow("rating+modified+filename") << rating + " AND " + modified + " " + filename << text << QStringList({modified, rating});
87		}
88
89		/**
90		* Helper function to compose the baloo query URL used for searching
91		*/
92		QUrl composeQueryUrl(const QString& searchString)
93		{
94		QJsonObject jsonObject {
95		{"searchString", searchString}
96		};
97
98		QJsonDocument doc(jsonObject);
99		QString queryString = QString::fromUtf8(doc.toJson(QJsonDocument::Compact));
	elvisangelaccioUnsubmitted Done `const` elvisangelaccio: `const`
100
101		QUrlQuery urlQuery;
102		urlQuery.addQueryItem(QStringLiteral("json"), queryString);
103
104		QUrl searchUrl;
105		searchUrl.setScheme(QLatin1String("baloosearch"));
106		searchUrl.setQuery(urlQuery);
107
108		return searchUrl;
109		}
110
111		/**
112		* The test verifies whether the different terms of a Baloo search URL ("baloosearch:") are
113		* properly handled by the searchbox, and only "user" or filename terms are added to the
114		* text bar of the searchbox.
115		*/
116		void DolphinSearchBoxTest::testBalooSearchParsing()
117		{
118		QFETCH(QString, searchString);
119		QFETCH(QString, expectedText);
120		QFETCH(QStringList, expectedTerms);
121
122		const QUrl testUrl = composeQueryUrl(searchString);
123		DolphinQuery queryModel = DolphinQuery::fromBalooSearchUrl(testUrl);
	elvisangelaccioUnsubmitted Done just `query` as variable name. elvisangelaccio: just `query` as variable name.
124
125		QStringList searchTerms = queryModel.searchTerms();
126		searchTerms.sort();
127
128		// FIXME: Current parsing bugs
129		QEXPECT_FAIL("content/singleQuote", "Quotes around text are shown", Continue);
130		QEXPECT_FAIL("content/doubleQuote", "Quotes around text are shown", Continue);
131
132		QEXPECT_FAIL("filename", "Quotes around text are shown", Continue);
133		QEXPECT_FAIL("filename/singleQuote", "Quotes around text are shown", Continue);
134		QEXPECT_FAIL("filename/doubleQuote", "Quotes around text are shown", Continue);
135
136		QEXPECT_FAIL("rating" , "Text includes also search terms", Continue);
137		QEXPECT_FAIL("rating+content" , "Text includes also search terms", Continue);
138		QEXPECT_FAIL("rating+filename" , "Text includes also search terms", Continue);
139		QEXPECT_FAIL("modified" , "Text includes also search terms", Continue);
140		QEXPECT_FAIL("modified+content" , "Text includes also search terms", Continue);
141		QEXPECT_FAIL("modified+filename" , "Text includes also search terms", Continue);
142		QEXPECT_FAIL("rating+modified" , "Text includes also search terms", Continue);
143		QEXPECT_FAIL("rating+modified+content" , "Text includes also search terms", Continue);
144		QEXPECT_FAIL("rating+modified+filename", "Text includes also search terms", Continue);
145
146		// Check for parsed text (would be displayed on the input search bar)
147		QCOMPARE(queryModel.text(), expectedText);
148
149		// Check for parsed search terms (would be displayed by the facetsWidget)
150		QCOMPARE(searchTerms.count(), expectedTerms.count());
151		for (int i = 0; i < expectedTerms.count(); i++) {
152		QCOMPARE(searchTerms.at(i), expectedTerms.at(i));
153		}
154		}
155
156		QTEST_MAIN(DolphinSearchBoxTest)
157
158		#include "dolphinquerytest.moc"