File indexing completed on 2024-05-05 04:55:40

0001 /**
0002  * \file testutils.h
0003  * Utility functions for tests.
0004  *
0005  * \b Project: Kid3
0006  * \author Urs Fleisch
0007  * \date 07 Oct 2012
0008  *
0009  * Copyright (C) 2012-2018  Urs Fleisch
0010  *
0011  * This file is part of Kid3.
0012  *
0013  * Kid3 is free software; you can redistribute it and/or modify
0014  * it under the terms of the GNU General Public License as published by
0015  * the Free Software Foundation; either version 2 of the License, or
0016  * (at your option) any later version.
0017  *
0018  * Kid3 is distributed in the hope that it will be useful,
0019  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0021  * GNU General Public License for more details.
0022  *
0023  * You should have received a copy of the GNU General Public License
0024  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
0025  */
0026 
0027 #pragma once
0028 
0029 #include <QStringList>
0030 
0031 class QObject;
0032 
0033 namespace TestUtils {
0034 
0035 /**
0036  * Run the tests of a test suite.
0037  *
0038  * Besides the standard QtTest options, this test runner also allows to select
0039  * the testcase with "-testcase" and list the testcases with "-testcases".
0040  * This function will exit the application for certain \a args parsed by QtTest.
0041  *
0042  * @param testSuite an object containing QtTest test cases as children
0043  * @param args command line arguments from QCoreApplication::arguments()
0044  *
0045  * @return 0 if OK, the number of failed tests if failed.
0046  */
0047 int runTestSuite(const QObject& testSuite, QStringList& args);
0048 
0049 }