fly/flightgear
1
0
Fork 0
Code Activity
flightgear/test_suite/testSuite.cxx

100 lines
2.6 KiB
C++
Raw Normal View History

TestSuite: Initial support for a FlightGear test suite based on CppUnit. This includes the basic CMake infrastructure for building and executing the test suite. Four test categories have been added - unit, system/functional, GUI, and simgear unit tests. The test suite is run by typing 'make test_suite'. All of the fgfs sources are included in the new run_test_suite executable, excluding the bootstrap routine and its main() function. The test suite currently consists of a single dummy unit test for the NasalSys subsystem, and a single demonstration simgear/props unit test.
2016-01-28 15:56:10 +00:00
/*
* Copyright (C) 2016-2018 Edward d'Auvergne
*
* This file is part of the program FlightGear.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <iostream>
#include "fgTestRunner.hxx"
TestSuite: Custom output formatting. A large number of improvements have been made by subclassing the CppUnit classes and overriding the base functions, including CompilerOutputter, TestListener, and TextTestRunner. All IO has also been captured by the test runner. The result is that during the test suite run, only the characters '.', 'F', and 'E' are output for a pass, failure and error state. At the end of each test suite category, all failures and errors are reported in full detail, including the different captured IO streams. A final synopsis is printed out, improving the overview in the case of too many tests failing. For the fgCompilerOutputter class, the printSuccess(), printFailureReport(), printFailureDetail(), and printSuiteStats() functions have been replaced to implement the above printout design. The class also stores the std::vector of TestIOCapt structures for the final printouts. The fgTestListener class handles the events from the running of the test suite. The startTest() and endTest() functions are used for IO capture. The IO is placed into a TestIOCapt data structure, with one std::string for holding the combined STDOUT and STDERR IO, and another for the SG_LOG IO. If failures occur, the TestIOCapt structure is appended to the fgCompilerOutputter vector. The startTest() and endTest() functions are also used for starting and stopping a timer to allow the full test suite to be timed. And the addFailure() function simply registers test failures or errors. The fgTestRunner class overrides the CppUnit::TextTestRunner::run() function, simply to prevent the base method from spawning a second test listener, causing the test output to be duplicated. Some auxiliary formatting functions have been added to print out titles, sections, and synopsis summary lines.
2016-02-09 16:34:56 +00:00
#include "formatting.hxx"
TestSuite: Capture and reporting of all simgear logstream priorities. Each of the global logstream priorities are captured into its own std::ostringstream stream, all held together in the test suite global _iostreams class instance. This object can be obtained by calling getIOstreams(). The streams are captured using the StreamLogCallback class, which is a simple modification of the simgear FileLogCallback class, registered with the global logstream's addCallback() function. When tests fail, all of contents the different simgear logstreams are now reported. The failure report consists of the following sections: - Failure information. - SG_BULK simgear logstream (all messages). - SG_BULK only simgear logstream. - SG_DEBUG only simgear logstream. - SG_INFO only simgear logstream. - SG_WARN only simgear logstream. - SG_ALERT only simgear logstream. - Combined STDOUT and STDERR streams. Any empty sections, except for SG_BULK, will not be shown.
2016-02-12 18:42:20 +00:00
#include "logging.hxx"
TestSuite: Custom output formatting. A large number of improvements have been made by subclassing the CppUnit classes and overriding the base functions, including CompilerOutputter, TestListener, and TextTestRunner. All IO has also been captured by the test runner. The result is that during the test suite run, only the characters '.', 'F', and 'E' are output for a pass, failure and error state. At the end of each test suite category, all failures and errors are reported in full detail, including the different captured IO streams. A final synopsis is printed out, improving the overview in the case of too many tests failing. For the fgCompilerOutputter class, the printSuccess(), printFailureReport(), printFailureDetail(), and printSuiteStats() functions have been replaced to implement the above printout design. The class also stores the std::vector of TestIOCapt structures for the final printouts. The fgTestListener class handles the events from the running of the test suite. The startTest() and endTest() functions are used for IO capture. The IO is placed into a TestIOCapt data structure, with one std::string for holding the combined STDOUT and STDERR IO, and another for the SG_LOG IO. If failures occur, the TestIOCapt structure is appended to the fgCompilerOutputter vector. The startTest() and endTest() functions are also used for starting and stopping a timer to allow the full test suite to be timed. And the addFailure() function simply registers test failures or errors. The fgTestRunner class overrides the CppUnit::TextTestRunner::run() function, simply to prevent the base method from spawning a second test listener, causing the test output to be duplicated. Some auxiliary formatting functions have been added to print out titles, sections, and synopsis summary lines.
2016-02-09 16:34:56 +00:00
using namespace std;
// Print out a summary of the relax test suite.
void summary(CppUnit::OStream &stream, int system_result, int unit_result, int gui_result, int simgear_result)
{
// Title.
string text = "Summary of the FlightGear test suite";
printTitle(stream, text);
// Subtitle.
text = "Synopsis";
printSection(stream, text);
// System/functional test summary.
text = "System/functional tests";
printSummaryLine(stream, text, system_result);
// Unit test summary.
text = "Unit tests";
printSummaryLine(stream, text, unit_result);
// GUI test summary.
text = "GUI tests";
printSummaryLine(stream, text, gui_result);
// Simgear unit test summary.
text = "Simgear unit tests";
printSummaryLine(stream, text, simgear_result);
// Synopsis.
text ="Synopsis";
int synopsis = system_result + unit_result + gui_result + simgear_result;
printSummaryLine(stream, text, synopsis);
// End.
stream << endl << endl;
}
TestSuite: Initial support for a FlightGear test suite based on CppUnit. This includes the basic CMake infrastructure for building and executing the test suite. Four test categories have been added - unit, system/functional, GUI, and simgear unit tests. The test suite is run by typing 'make test_suite'. All of the fgfs sources are included in the new run_test_suite executable, excluding the bootstrap routine and its main() function. The test suite currently consists of a single dummy unit test for the NasalSys subsystem, and a single demonstration simgear/props unit test.
2016-01-28 15:56:10 +00:00
int main(void)
{
// Declarations.
int status_gui, status_simgear, status_system, status_unit;
TestSuite: Capture and reporting of all simgear logstream priorities. Each of the global logstream priorities are captured into its own std::ostringstream stream, all held together in the test suite global _iostreams class instance. This object can be obtained by calling getIOstreams(). The streams are captured using the StreamLogCallback class, which is a simple modification of the simgear FileLogCallback class, registered with the global logstream's addCallback() function. When tests fail, all of contents the different simgear logstreams are now reported. The failure report consists of the following sections: - Failure information. - SG_BULK simgear logstream (all messages). - SG_BULK only simgear logstream. - SG_DEBUG only simgear logstream. - SG_INFO only simgear logstream. - SG_WARN only simgear logstream. - SG_ALERT only simgear logstream. - Combined STDOUT and STDERR streams. Any empty sections, except for SG_BULK, will not be shown.
2016-02-12 18:42:20 +00:00
// Set up logging.
sglog().setDeveloperMode(true);
setupLogging();
TestSuite: Initial support for a FlightGear test suite based on CppUnit. This includes the basic CMake infrastructure for building and executing the test suite. Four test categories have been added - unit, system/functional, GUI, and simgear unit tests. The test suite is run by typing 'make test_suite'. All of the fgfs sources are included in the new run_test_suite executable, excluding the bootstrap routine and its main() function. The test suite currently consists of a single dummy unit test for the NasalSys subsystem, and a single demonstration simgear/props unit test.
2016-01-28 15:56:10 +00:00
// Execute each of the test suite categories.
status_system = testRunner("System tests");
status_unit = testRunner("Unit tests");
status_gui = testRunner("GUI tests");
status_simgear = testRunner("Simgear unit tests");
TestSuite: Custom output formatting. A large number of improvements have been made by subclassing the CppUnit classes and overriding the base functions, including CompilerOutputter, TestListener, and TextTestRunner. All IO has also been captured by the test runner. The result is that during the test suite run, only the characters '.', 'F', and 'E' are output for a pass, failure and error state. At the end of each test suite category, all failures and errors are reported in full detail, including the different captured IO streams. A final synopsis is printed out, improving the overview in the case of too many tests failing. For the fgCompilerOutputter class, the printSuccess(), printFailureReport(), printFailureDetail(), and printSuiteStats() functions have been replaced to implement the above printout design. The class also stores the std::vector of TestIOCapt structures for the final printouts. The fgTestListener class handles the events from the running of the test suite. The startTest() and endTest() functions are used for IO capture. The IO is placed into a TestIOCapt data structure, with one std::string for holding the combined STDOUT and STDERR IO, and another for the SG_LOG IO. If failures occur, the TestIOCapt structure is appended to the fgCompilerOutputter vector. The startTest() and endTest() functions are also used for starting and stopping a timer to allow the full test suite to be timed. And the addFailure() function simply registers test failures or errors. The fgTestRunner class overrides the CppUnit::TextTestRunner::run() function, simply to prevent the base method from spawning a second test listener, causing the test output to be duplicated. Some auxiliary formatting functions have been added to print out titles, sections, and synopsis summary lines.
2016-02-09 16:34:56 +00:00
// Summary printout.
summary(cerr, status_system, status_unit, status_gui, status_simgear);
TestSuite: Capture and reporting of all simgear logstream priorities. Each of the global logstream priorities are captured into its own std::ostringstream stream, all held together in the test suite global _iostreams class instance. This object can be obtained by calling getIOstreams(). The streams are captured using the StreamLogCallback class, which is a simple modification of the simgear FileLogCallback class, registered with the global logstream's addCallback() function. When tests fail, all of contents the different simgear logstreams are now reported. The failure report consists of the following sections: - Failure information. - SG_BULK simgear logstream (all messages). - SG_BULK only simgear logstream. - SG_DEBUG only simgear logstream. - SG_INFO only simgear logstream. - SG_WARN only simgear logstream. - SG_ALERT only simgear logstream. - Combined STDOUT and STDERR streams. Any empty sections, except for SG_BULK, will not be shown.
2016-02-12 18:42:20 +00:00
// Deactivate the logging.
stopLogging();
TestSuite: Initial support for a FlightGear test suite based on CppUnit. This includes the basic CMake infrastructure for building and executing the test suite. Four test categories have been added - unit, system/functional, GUI, and simgear unit tests. The test suite is run by typing 'make test_suite'. All of the fgfs sources are included in the new run_test_suite executable, excluding the bootstrap routine and its main() function. The test suite currently consists of a single dummy unit test for the NasalSys subsystem, and a single demonstration simgear/props unit test.
2016-01-28 15:56:10 +00:00
// Failure.
if (status_system > 0)
return 1;
if (status_unit > 0)
return 1;
if (status_gui > 0)
return 1;
if (status_simgear > 0)
return 1;
// Success.
return 0;
}
Copy permalink