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

168 lines
5.2 KiB
C++
Raw Normal View History

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
/*
* Copyright (C) 2016 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 <algorithm>
#include <iomanip>
#include <cppunit/SourceLine.h>
#include <cppunit/TestResultCollector.h>
#include "fgCompilerOutputter.hxx"
#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;
// Create a new class instance.
fgCompilerOutputter * fgCompilerOutputter::defaultOutputter(CppUnit::TestResultCollector *result, vector<TestIOCapt> *capt, const clock_t *clock, CppUnit::OStream &stream)
{
return new fgCompilerOutputter(result, capt, clock, stream);
}
// Printout for each failed test.
void fgCompilerOutputter::printFailureDetail(CppUnit::TestFailure *failure)
{
// Declarations.
TestIOCapt test_io;
vector<TestIOCapt>::iterator test_iter;
// Initial separator.
TestSuite: Improved output formatting on MS Windows. For some reason, this OS needs a few more newlines output than other OSes.
2019-09-26 10:28:31 +00:00
#ifdef _WIN32
fg_stream << endl;
#endif
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
fg_stream << string(WIDTH_DIVIDER, '=') << endl;
// Test info.
fg_stream << (failure->isError() ? "ERROR: " : "FAIL: ") << failure->failedTestName() << endl;
fg_stream << string(WIDTH_DIVIDER, '-') << endl;
fg_stream << (failure->isError() ? "Error" : "Assertion") << ": ";
printFailureLocation(failure->sourceLine());
printFailureMessage(failure);
TestSuite: Added a debugging command line option. This is to enable full output from passing tests to help with debugging.
2018-03-12 15:43:24 +00:00
fg_stream.flush();
if (debug)
return;
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
// The captured IO for this test.
test_iter = find_if(io_capt->begin(), io_capt->end(), matchTestName(failure->failedTestName()));
if (test_iter != io_capt->end())
test_io = *test_iter;
// SG_LOG IO streams.
TestSuite: Implementation of the --log-split command line option.
2019-07-30 12:54:45 +00:00
if (!test_io.sg_interleaved.empty())
TestSuite: Addition of the --log-class option for selecting SG_LOG classes. This option mimics the fgfs option of the same name but additionally supports the "particles", "headless", "osg", "undefined", and "all" classes.
2019-07-31 08:35:23 +00:00
fgCompilerOutputter::printIOStreamMessages("SG_LOG, "+test_io.log_class+" class, "+test_io.log_priority+" priority", test_io.sg_interleaved, true);
TestSuite: Implementation of the --log-split command line option.
2019-07-30 12:54:45 +00:00
if (!test_io.sg_bulk_only.empty())
TestSuite: Addition of the --log-class option for selecting SG_LOG classes. This option mimics the fgfs option of the same name but additionally supports the "particles", "headless", "osg", "undefined", and "all" classes.
2019-07-31 08:35:23 +00:00
fgCompilerOutputter::printIOStreamMessages("SG_LOG, "+test_io.log_class+" class, SG_BULK only priority", test_io.sg_bulk_only);
TestSuite: Implementation of the --log-split command line option.
2019-07-30 12:54:45 +00:00
if (!test_io.sg_debug_only.empty())
TestSuite: Addition of the --log-class option for selecting SG_LOG classes. This option mimics the fgfs option of the same name but additionally supports the "particles", "headless", "osg", "undefined", and "all" classes.
2019-07-31 08:35:23 +00:00
fgCompilerOutputter::printIOStreamMessages("SG_LOG, "+test_io.log_class+" class, SG_DEBUG only priority", test_io.sg_debug_only);
TestSuite: Implementation of the --log-split command line option.
2019-07-30 12:54:45 +00:00
if (!test_io.sg_info_only.empty())
TestSuite: Addition of the --log-class option for selecting SG_LOG classes. This option mimics the fgfs option of the same name but additionally supports the "particles", "headless", "osg", "undefined", and "all" classes.
2019-07-31 08:35:23 +00:00
fgCompilerOutputter::printIOStreamMessages("SG_LOG, "+test_io.log_class+" class, SG_INFO only priority", test_io.sg_info_only);
TestSuite: Implementation of the --log-split command line option.
2019-07-30 12:54:45 +00:00
if (!test_io.sg_warn_only.empty())
TestSuite: Addition of the --log-class option for selecting SG_LOG classes. This option mimics the fgfs option of the same name but additionally supports the "particles", "headless", "osg", "undefined", and "all" classes.
2019-07-31 08:35:23 +00:00
fgCompilerOutputter::printIOStreamMessages("SG_LOG, "+test_io.log_class+" class, SG_WARN only priority", test_io.sg_warn_only);
TestSuite: Implementation of the --log-split command line option.
2019-07-30 12:54:45 +00:00
if (!test_io.sg_alert_only.empty())
TestSuite: Addition of the --log-class option for selecting SG_LOG classes. This option mimics the fgfs option of the same name but additionally supports the "particles", "headless", "osg", "undefined", and "all" classes.
2019-07-31 08:35:23 +00:00
fgCompilerOutputter::printIOStreamMessages("SG_LOG, "+test_io.log_class+" class, SG_ALERT only priority", test_io.sg_alert_only);
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
// Default IO streams.
fgCompilerOutputter::printIOStreamMessages("STDOUT and STDERR", test_io.stdio);
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
}
// Detailed printout after a failed run of the test suite.
void fgCompilerOutputter::printFailureReport()
{
// Custom printouts for each failed test.
printFailuresList();
TestSuite: CTest support for running each test suite as a separate ctest. The --ctest command line option has also been added to allow for a simplified output from the test suite more suitable for the ctest verbose output.
2018-03-12 10:43:24 +00:00
// CTest output (nothing).
if (ctest_output)
return;
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
// A summary with timing info.
printSuiteStats();
// Final summary.
fg_stream << endl << "[ FAILED ]" << endl << endl;
fg_stream.flush();
}
TestSuite: Addition of the --log-level option for setting the logging priority. This option mimics the fgfs option of the same name. However for the test suite option, additionally the SG_POPUP, SG_DEV_WARN and SG_DEV_ALERT priorities are supported. The default test suite output has been modified to only show the interleaved log with the logging priority set to the command line supplied value or defaulting to SG_INFO.
2019-07-30 11:19:23 +00:00
void fgCompilerOutputter::printIOStreamMessages(string heading, string messages, bool empty)
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
{
// Silence.
if (!empty && messages.size() == 0)
return;
// Divider.
fg_stream << string(WIDTH_DIVIDER, '-') << endl;
// Heading.
fg_stream << "# " << heading << endl << endl;
// Nothing to do
if (messages.size() == 0)
fg_stream << "(empty)" << endl << endl;
// The IO stream contents.
else
fg_stream << messages << endl;
}
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
// Printout of the test suite stats.
void fgCompilerOutputter::printSuiteStats()
{
// A divider.
TestSuite: Improved output formatting on MS Windows. For some reason, this OS needs a few more newlines output than other OSes.
2019-09-26 10:28:31 +00:00
#ifdef _WIN32
fg_stream << endl;
#endif
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
fg_stream << string(WIDTH_DIVIDER, '-') << endl;
// Timing and test count line.
fg_stream << "Ran " << fg_result->runTests() << " tests";
streamsize prec = fg_stream.precision();
fg_stream << setprecision(3);
fg_stream << " in " << ((double)*suite_timer)/CLOCKS_PER_SEC << " seconds." << endl;
fg_stream << setprecision(prec);
// Failure line.
if (!fg_result->wasSuccessful()) {
fg_stream << endl << "Failures = " << fg_result->testFailures() << endl;
fg_stream << "Errors = " << fg_result->testErrors() << endl;
}
}
// Print a summary after a successful run of the test suite.
void fgCompilerOutputter::printSuccess()
{
TestSuite: CTest support for running each test suite as a separate ctest. The --ctest command line option has also been added to allow for a simplified output from the test suite more suitable for the ctest verbose output.
2018-03-12 10:43:24 +00:00
// CTest output (nothing).
if (ctest_output)
return;
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
// A summary with timing info.
printSuiteStats();
// Final summary.
fg_stream << endl << "[ OK ]" << endl << endl;
fg_stream.flush();
}
Copy permalink