src/common/expressionmatchtests.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   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                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #pragma once
  22
  23 #include <QString>
  24 #include <QStringList>
  25
  26 /**
  27  * Expression matcher test runner (temporary measure until switching to a real test framework)
  28  */
  29 class ExpressionMatchTests
  30 {
  31
  32 public:
  33     /**
  34      * Runs the ExpressionMatch tests
  35      *
  36      * Q_ASSERT will deliberately halt execution if an issue is found.  This should not be called
  37      * outside of a development environment.
  38      *
  39      * Recommended development usage until a testing framework exists:
  40      * 1.  Include "expressionmatchtests.h" in quassel.cpp
  41      * 2.  Call this function near the end of Quassel::init()
  42      */
  43     static void runTests();
  44
  45 private:
  46     // Disallow creating an instance of this static object
  47     /**
  48      * Construct a ExpressionMatchTests instance
  49      */
  50     ExpressionMatchTests() {}
  51
  52     /**
  53      * Tests ExpressionMatch empty pattern handling
  54      */
  55     static void runTestsEmptyPattern();
  56
  57     /**
  58      * Tests ExpressionMatch MatchMode::Phrase
  59      */
  60     static void runTestsMatchPhrase();
  61
  62     /**
  63      * Tests ExpressionMatch MatchMode::MultiPhrase
  64      */
  65     static void runTestsMatchMultiPhrase();
  66
  67     /**
  68      * Tests ExpressionMatch MatchMode::Wildcard
  69      */
  70     static void runTestsMatchWildcard();
  71
  72     /**
  73      * Tests ExpressionMatch MatchMode::MultiWildcard
  74      */
  75     static void runTestsMatchMultiWildcard();
  76
  77     /**
  78      * Tests ExpressionMatch MatchMode::RegEx
  79      */
  80     static void runTestsMatchRegEx();
  81
  82     /**
  83      * Tests ExpressionMatch MultiWildcard whitespace trimming
  84      */
  85     static void runTestsTrimMultiWildcardWhitespace();
  86
  87 };