Add support to tags: scheme in DolphinQuery

[dolphin.git] / src / tests / dolphinquerytest.cpp

diff --git a/src/tests/dolphinquerytest.cpp b/src/tests/dolphinquerytest.cpp
index 65dc7350e9f98d07e5711953cfb0df76797816d6..9e1c7673774cf7c39c84db427906a25d3577397b 100644 (file)
--- a/src/tests/dolphinquerytest.cpp
+++ b/src/tests/dolphinquerytest.cpp
@@ -36,118 +36,156 @@ private slots:
     void testBalooSearchParsing();
 };
 
     void testBalooSearchParsing();
 };
 

+/**
+ * Helper function to compose the baloo query URL used for searching
+ */
+QUrl balooQueryUrl(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;
+}
+

 /**
  * Defines the parameters for the test cases in testBalooSearchParsing()
  */
 void DolphinSearchBoxTest::testBalooSearchParsing_data()
 {
 /**
  * Defines the parameters for the test cases in testBalooSearchParsing()
  */
 void DolphinSearchBoxTest::testBalooSearchParsing_data()
 {

-    const QString text = QStringLiteral("abc xyz");
-    const QString filename = QStringLiteral("filename:\"%1\"").arg(text);
-    const QString rating = QStringLiteral("rating>=2");
-    const QString modified = QString("modified>=2019-08-07");
-    const QString tagA = QString("tag:tagA");
-    const QString tagB = QString("tag:tagB");

 
 

-    QTest::addColumn<QString>("searchString");
+    QTest::addColumn<QUrl>("searchUrl");

     QTest::addColumn<QString>("expectedText");
     QTest::addColumn<QStringList>("expectedTerms");
     QTest::addColumn<bool>("hasContent");
     QTest::addColumn<bool>("hasFileName");
 
     QTest::addColumn<QString>("expectedText");
     QTest::addColumn<QStringList>("expectedTerms");
     QTest::addColumn<bool>("hasContent");
     QTest::addColumn<bool>("hasFileName");
 

+    const QString text = QStringLiteral("abc");
+    const QString textS = QStringLiteral("abc xyz");
+    const QString textQ = QStringLiteral("\"abc xyz\"");
+    const QString textM = QStringLiteral("\"abc xyz\" tuv");
+
+    const QString filename = QStringLiteral("filename:\"%1\"").arg(text);
+    const QString filenameS = QStringLiteral("filename:\"%1\"").arg(textS);
+    const QString filenameQ = QStringLiteral("filename:\"%1\"").arg(textQ);
+    const QString filenameM = QStringLiteral("filename:\"%1\"").arg(textM);
+
+    const QString rating = QStringLiteral("rating>=2");
+    const QString modified = QStringLiteral("modified>=2019-08-07");
+
+    const QString tag = QStringLiteral("tag:tagA");
+    const QString tagS = QStringLiteral("tag:\"tagB with spaces\"");  // in search url
+    const QString tagR = QStringLiteral("tag:tagB with spaces");      // in result term
+

     // Test for "Content"
     // Test for "Content"

-    QTest::newRow("content")              << text    << text << QStringList() << true  << false;
-    QTest::newRow("content/empty")        << ""      << ""   << QStringList() << false << false;
-    QTest::newRow("content/singleQuote")  << "\""    << ""   << QStringList() << false << false;
-    QTest::newRow("content/doubleQuote")  << "\"\""  << ""   << QStringList() << false << false;
+    QTest::newRow("content")              << balooQueryUrl(text)   << text  << QStringList() << true  << false;
+    QTest::newRow("content/space")        << balooQueryUrl(textS)  << textS << QStringList() << true  << false;
+    QTest::newRow("content/quoted")       << balooQueryUrl(textQ)  << textS << QStringList() << true  << false;
+    QTest::newRow("content/empty")        << balooQueryUrl("")     << ""    << QStringList() << false << false;
+    QTest::newRow("content/single_quote") << balooQueryUrl("\"")   << "\""  << QStringList() << true  << false;
+    QTest::newRow("content/double_quote") << balooQueryUrl("\"\"") << ""    << QStringList() << false << false;

 
     // Test for "FileName"
 
     // Test for "FileName"

-    QTest::newRow("filename")             << filename         << text << QStringList() << false << true;
-    QTest::newRow("filename/empty")       << "filename:"      << ""   << QStringList() << false << false;
-    QTest::newRow("filename/singleQuote") << "filename:\""    << ""   << QStringList() << false << false;
-    QTest::newRow("filename/doubleQuote") << "filename:\"\""  << ""   << QStringList() << false << false;
+    QTest::newRow("filename")              << balooQueryUrl(filename)        << text  << QStringList() << false << true;
+    QTest::newRow("filename/space")        << balooQueryUrl(filenameS)       << textS << QStringList() << false << true;
+    QTest::newRow("filename/quoted")       << balooQueryUrl(filenameQ)       << textQ << QStringList() << false << true;
+    QTest::newRow("filename/mixed")        << balooQueryUrl(filenameM)       << textM << QStringList() << false << true;
+    QTest::newRow("filename/empty")        << balooQueryUrl("filename:")     << ""    << QStringList() << false << false;
+    QTest::newRow("filename/single_quote") << balooQueryUrl("filename:\"")   << "\""  << QStringList() << false << true;
+    QTest::newRow("filename/double_quote") << balooQueryUrl("filename:\"\"") << ""    << QStringList() << false << false;

 
     // Combined content and filename search
 
     // Combined content and filename search

-    QTest::newRow("content+filename") << text + " " + filename << text + " " + filename << QStringList() << true << true;
+    QTest::newRow("content+filename")
+        << balooQueryUrl(text + " " + filename)
+        << text + " " + filename << QStringList() << true << true;
+
+    QTest::newRow("content+filename/quoted")
+        << balooQueryUrl(textQ + " " + filenameQ)
+        << textS + " " + filenameQ << QStringList() << true << true;

 
     // Test for rating
 
     // Test for rating

-    QTest::newRow("rating")          << rating                  << ""   << QStringList({rating}) << false << false;
-    QTest::newRow("rating+content")  << rating + " " + text     << text << QStringList({rating}) << true  << false;
-    QTest::newRow("rating+filename") << rating + " " + filename << text << QStringList({rating}) << false << true;
+    QTest::newRow("rating")          << balooQueryUrl(rating)                  << ""   << QStringList({rating}) << false << false;
+    QTest::newRow("rating+content")  << balooQueryUrl(rating + " " + text)     << text << QStringList({rating}) << true  << false;
+    QTest::newRow("rating+filename") << balooQueryUrl(rating + " " + filename) << text << QStringList({rating}) << false << true;

 
     // Test for modified date
 
     // Test for modified date

-    QTest::newRow("modified")          << modified                  << ""   << QStringList({modified}) << false << false;
-    QTest::newRow("modified+content")  << modified + " " + text     << text << QStringList({modified}) << true  << false;
-    QTest::newRow("modified+filename") << modified + " " + filename << text << QStringList({modified}) << false << true;
+    QTest::newRow("modified")          << balooQueryUrl(modified)                  << ""   << QStringList({modified}) << false << false;
+    QTest::newRow("modified+content")  << balooQueryUrl(modified + " " + text)     << text << QStringList({modified}) << true  << false;
+    QTest::newRow("modified+filename") << balooQueryUrl(modified + " " + filename) << text << QStringList({modified}) << false << true;

 
     // Test for tags
 
     // Test for tags

-    QTest::newRow("tag")          << tagA                  << ""   << QStringList({tagA})       << false << false;
-    QTest::newRow("tag/double")   << tagA + " " + tagB     << ""   << QStringList({tagA, tagB}) << false << false;
-    QTest::newRow("tag+content")  << tagA + " " + text     << text << QStringList({tagA})       << true  << false;
-    QTest::newRow("tag+filename") << tagA + " " + filename << text << QStringList({tagA})       << false << true;
+    QTest::newRow("tag")          << balooQueryUrl(tag)                  << ""   << QStringList({tag})       << false << false;
+    QTest::newRow("tag/space" )   << balooQueryUrl(tagS)                 << ""   << QStringList({tagR})      << false << false;
+    QTest::newRow("tag/double")   << balooQueryUrl(tag + " " + tagS)     << ""   << QStringList({tag, tagR}) << false << false;
+    QTest::newRow("tag+content")  << balooQueryUrl(tag + " " + text)     << text << QStringList({tag})       << true  << false;
+    QTest::newRow("tag+filename") << balooQueryUrl(tag + " " + filename) << text << QStringList({tag})       << false << true;

 
     // Combined search terms
 
     // Combined search terms

-    QTest::newRow("allTerms")
-        << rating + " AND " + modified + " AND " + tagA + " AND " + tagB
-        << "" << QStringList({modified, rating, tagA, tagB}) << false << false;
-
-    QTest::newRow("allTerms+content")
-        << rating + " AND " + modified + " " + text + " " + tagA + " AND " + tagB
-        << text << QStringList({modified, rating, tagA, tagB}) << true << false;
+    QTest::newRow("searchTerms")
+        << balooQueryUrl(rating + " AND " + modified + " AND " + tag + " AND " + tagS)
+        << "" << QStringList({modified, rating, tag, tagR}) << false << false;

 
 

-    QTest::newRow("allTerms+filename")
-        << rating + " AND " + modified + " " + filename + " " + tagA + " AND " + tagB
-        << text << QStringList({modified, rating, tagA, tagB}) << false << true;
+    QTest::newRow("searchTerms+content")
+        << balooQueryUrl(rating + " AND " + modified + " " + text + " " + tag + " AND " + tagS)
+        << text << QStringList({modified, rating, tag, tagR}) << true << false;

 
 

-    QTest::newRow("allTerms+content+filename")
-        << text + " " + filename + " " + rating + " AND " + modified + " AND " + tagA + " AND " + tagB
-        << text + " " + filename << QStringList({modified, rating, tagA, tagB}) << true << true;
-}
-
-/**
- * Helper function to compose the baloo query URL used for searching
- */
-QUrl composeQueryUrl(const QString& searchString)
-{
-    const QJsonObject jsonObject {
-        {"searchString", searchString}
-    };
+    QTest::newRow("searchTerms+filename")
+        << balooQueryUrl(rating + " AND " + modified + " " + filename + " " + tag + " AND " + tagS)
+        << text << QStringList({modified, rating, tag, tagR}) << false << true;

 
 

-    const QJsonDocument doc(jsonObject);
-    const QString queryString = QString::fromUtf8(doc.toJson(QJsonDocument::Compact));
+    QTest::newRow("allTerms")
+        << balooQueryUrl(text + " " + filename + " " + rating + " AND " + modified + " AND " + tag)
+        << text + " " + filename << QStringList({modified, rating, tag}) << true << true;

 
 

-    QUrlQuery urlQuery;
-    urlQuery.addQueryItem(QStringLiteral("json"), queryString);
+    QTest::newRow("allTerms/space")
+        << balooQueryUrl(textS + " " + filenameS + " " + rating + " AND " + modified + " AND " + tagS)
+        << textS + " " + filenameS << QStringList({modified, rating, tagR}) << true << true;

 
 

-    QUrl searchUrl;
-    searchUrl.setScheme(QLatin1String("baloosearch"));
-    searchUrl.setQuery(urlQuery);
+    // Test tags:/ URL scheme
+    const auto tagUrl   = [](const QString &tag) { return QUrl(QStringLiteral("tags:/%1/").arg(tag)); };
+    const auto tagTerms = [](const QString &tag) { return QStringList{QStringLiteral("tag:%1").arg(tag)}; };

 
 

-    return searchUrl;
+    QTest::newRow("tagsUrl")       << tagUrl("tagA")             << "" << tagTerms("tagA")             << false << false;
+    QTest::newRow("tagsUrl/space") << tagUrl("tagB with spaces") << "" << tagTerms("tagB with spaces") << false << false;
+    QTest::newRow("tagsUrl/hash")  << tagUrl("tagC#hash")        << "" << tagTerms("tagC#hash")        << false << false;
+    QTest::newRow("tagsUrl/slash") << tagUrl("tagD/with/slash")  << "" << tagTerms("tagD/with/slash")  << false << false;

 }
 
 /**
 }
 
 /**

- * The test verifies whether the different terms of a Baloo search URL ("baloosearch:") are
+ * The test verifies whether the different terms search URL (e.g. "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()
 {
  * 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(QUrl, searchUrl);

     QFETCH(QString, expectedText);
     QFETCH(QStringList, expectedTerms);
     QFETCH(bool, hasContent);
     QFETCH(bool, hasFileName);
 
     QFETCH(QString, expectedText);
     QFETCH(QStringList, expectedTerms);
     QFETCH(bool, hasContent);
     QFETCH(bool, hasFileName);
 

-    const QUrl testUrl = composeQueryUrl(searchString);
-    const DolphinQuery query = DolphinQuery::fromBalooSearchUrl(testUrl);
+    const DolphinQuery query = DolphinQuery::fromSearchUrl(searchUrl);

 
 

-    QStringList searchTerms = query.searchTerms();
-    searchTerms.sort();
+    // Checkt that the URL is supported
+    QVERIFY(DolphinQuery::supportsScheme(searchUrl.scheme()));

 
     // 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)
 
     // 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)

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

     QCOMPARE(searchTerms.count(), expectedTerms.count());
     for (int i = 0; i < expectedTerms.count(); i++) {
         QCOMPARE(searchTerms.at(i), expectedTerms.at(i));
     QCOMPARE(searchTerms.count(), expectedTerms.count());
     for (int i = 0; i < expectedTerms.count(); i++) {
         QCOMPARE(searchTerms.at(i), expectedTerms.at(i));