test/testutilscompare.cpp

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2022  Mike Tzou (Chocobo1)
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  * In addition, as a special exception, the copyright holders give permission to
  20  * link this program with the OpenSSL project's "OpenSSL" library (or with
  21  * modified versions of it that use the same license as the "OpenSSL" library),
  22  * and distribute the linked executables. You must obey the GNU General Public
  23  * License in all respects for all of the code used other than "OpenSSL".  If you
  24  * modify file(s), you may extend this exception to your version of the file(s),
  25  * but you are not obligated to do so. If you do not wish to do so, delete this
  26  * exception statement from your version.
  27  */
  28
  29 #include <QLocale>
  30 #include <QObject>
  31 #include <QTest>
  32
  33 #include "base/global.h"
  34
  35 // only test qbt own implementation, not QCollator
  36 #define QBT_USE_QCOLLATOR 0
  37 #include "base/utils/compare.h"
  38
  39 namespace
  40 {
  41     enum class CompareResult
  42     {
  43         Equal,
  44         Greater,
  45         Less
  46     };
  47
  48     struct TestData
  49     {
  50         QString lhs;
  51         QString rhs;
  52         CompareResult caseInsensitiveResult = CompareResult::Equal;
  53         CompareResult caseSensitiveResult = CompareResult::Equal;
  54     };
  55
  56     const TestData testData[] =
  57     {
  58         {u""_s, u""_s, CompareResult::Equal, CompareResult::Equal},
  59         {u""_s, u"a"_s, CompareResult::Less, CompareResult::Less},
  60         {u"a"_s, u""_s, CompareResult::Greater, CompareResult::Greater},
  61
  62         {u"a"_s, u"a"_s, CompareResult::Equal, CompareResult::Equal},
  63         {u"A"_s, u"a"_s, CompareResult::Equal, CompareResult::Greater},
  64         {u"a"_s, u"A"_s, CompareResult::Equal, CompareResult::Less},
  65
  66         {u"0"_s, u"0"_s, CompareResult::Equal, CompareResult::Equal},
  67         {u"1"_s, u"0"_s, CompareResult::Greater, CompareResult::Greater},
  68         {u"0"_s, u"1"_s, CompareResult::Less, CompareResult::Less},
  69
  70         {u"😀"_s, u"😀"_s, CompareResult::Equal, CompareResult::Equal},
  71         {u"😀"_s, u"😁"_s, CompareResult::Less, CompareResult::Less},
  72         {u"😁"_s, u"😀"_s, CompareResult::Greater, CompareResult::Greater},
  73
  74         {u"a1"_s, u"a1"_s, CompareResult::Equal, CompareResult::Equal},
  75         {u"A1"_s, u"a1"_s, CompareResult::Equal, CompareResult::Greater},
  76         {u"a1"_s, u"A1"_s, CompareResult::Equal, CompareResult::Less},
  77
  78         {u"a1"_s, u"a2"_s, CompareResult::Less, CompareResult::Less},
  79         {u"A1"_s, u"a2"_s, CompareResult::Less, CompareResult::Greater},
  80         {u"a1"_s, u"A2"_s, CompareResult::Less, CompareResult::Less},
  81         {u"A1"_s, u"A2"_s, CompareResult::Less, CompareResult::Less},
  82
  83         {u"abc100"_s, u"abc99"_s, CompareResult::Greater, CompareResult::Greater},
  84         {u"ABC100"_s, u"abc99"_s, CompareResult::Greater, CompareResult::Greater},
  85         {u"abc100"_s, u"ABC99"_s, CompareResult::Greater, CompareResult::Less},
  86         {u"ABC100"_s, u"ABC99"_s, CompareResult::Greater, CompareResult::Greater},
  87
  88         {u"100abc"_s, u"99abc"_s, CompareResult::Greater, CompareResult::Greater},
  89         {u"100ABC"_s, u"99abc"_s, CompareResult::Greater, CompareResult::Greater},
  90         {u"100abc"_s, u"99ABC"_s, CompareResult::Greater, CompareResult::Greater},
  91         {u"100ABC"_s, u"99ABC"_s, CompareResult::Greater, CompareResult::Greater},
  92
  93         {u"😀😀😀99"_s, u"😀😀😀100"_s, CompareResult::Less, CompareResult::Less},
  94         {u"😀😀😀100"_s, u"😀😀😀99"_s, CompareResult::Greater, CompareResult::Greater}
  95     };
  96
  97     void testCompare(const TestData &data, const int actual, const CompareResult expected)
  98     {
  99         const auto errorMessage = u"Wrong result. LHS: \"%1\". RHS: \"%2\". Result: %3"_s
 100             .arg(data.lhs, data.rhs, QString::number(actual));
 101
 102         switch (expected)
 103         {
 104         case CompareResult::Equal:
 105             QVERIFY2((actual == 0), qPrintable(errorMessage));
 106             break;
 107         case CompareResult::Greater:
 108             QVERIFY2((actual > 0), qPrintable(errorMessage));
 109             break;
 110         case CompareResult::Less:
 111             QVERIFY2((actual < 0), qPrintable(errorMessage));
 112             break;
 113         default:
 114             QFAIL("Unhandled case");
 115             break;
 116         }
 117     }
 118
 119     void testLessThan(const TestData &data, const bool actual, const CompareResult expected)
 120     {
 121         const auto errorMessage = u"Wrong result. LHS: \"%1\". RHS: \"%2\". Result: %3"_s
 122             .arg(data.lhs, data.rhs, QString::number(actual));
 123
 124         switch (expected)
 125         {
 126         case CompareResult::Equal:
 127         case CompareResult::Greater:
 128             QVERIFY2(!actual, qPrintable(errorMessage));
 129             break;
 130         case CompareResult::Less:
 131             QVERIFY2(actual, qPrintable(errorMessage));
 132             break;
 133         default:
 134             QFAIL("Unhandled case");
 135             break;
 136         }
 137     }
 138 }
 139
 140 class TestUtilsCompare final : public QObject
 141 {
 142     Q_OBJECT
 143     Q_DISABLE_COPY_MOVE(TestUtilsCompare)
 144
 145 public:
 146     TestUtilsCompare() = default;
 147
 148 private slots:
 149     void initTestCase() const
 150     {
 151         // Test will fail if ran with `C` locale. This is because `C` locale compare chars by code points
 152         // and doesn't take account of human expectations
 153         QLocale::setDefault(QLocale::English);
 154     }
 155
 156     void cleanupTestCase() const
 157     {
 158         // restore global state
 159         QLocale::setDefault(QLocale::system());
 160     }
 161
 162     void testNaturalCompareCaseInsensitive() const
 163     {
 164         const Utils::Compare::NaturalCompare<Qt::CaseInsensitive> cmp;
 165
 166         for (const TestData &data : testData)
 167             testCompare(data, cmp(data.lhs, data.rhs), data.caseInsensitiveResult);
 168     }
 169
 170     void testNaturalCompareCaseSensitive() const
 171     {
 172         const Utils::Compare::NaturalCompare<Qt::CaseSensitive> cmp;
 173
 174         for (const TestData &data : testData)
 175             testCompare(data, cmp(data.lhs, data.rhs), data.caseSensitiveResult);
 176     }
 177
 178     void testNaturalLessThanCaseInsensitive() const
 179     {
 180         const Utils::Compare::NaturalLessThan<Qt::CaseInsensitive> cmp {};
 181
 182         for (const TestData &data : testData)
 183             testLessThan(data, cmp(data.lhs, data.rhs), data.caseInsensitiveResult);
 184     }
 185
 186     void testNaturalLessThanCaseSensitive() const
 187     {
 188         const Utils::Compare::NaturalLessThan<Qt::CaseSensitive> cmp {};
 189
 190         for (const TestData &data : testData)
 191             testLessThan(data, cmp(data.lhs, data.rhs), data.caseSensitiveResult);
 192     }
 193 };
 194
 195 QTEST_APPLESS_MAIN(TestUtilsCompare)
 196 #include "testutilscompare.moc"