1
0
Fork 0
flightgear/test_suite/fgCompilerOutputter.cxx
Edward d'Auvergne 3bd60e96c8 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.
2018-03-23 17:26:04 +01:00

143 lines
4.6 KiB
C++

/*
* 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"
#include "logging.hxx"
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.
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);
// 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.
fgCompilerOutputter::printIOStreamMessages("SG_LOG, SG_ALL class, SG_BULK priority", test_io.sg_bulk, true);
fgCompilerOutputter::printIOStreamMessages("SG_LOG, SG_ALL class, SG_BULK only priority", test_io.sg_bulk_only);
fgCompilerOutputter::printIOStreamMessages("SG_LOG, SG_ALL class, SG_DEBUG only priority", test_io.sg_debug_only);
fgCompilerOutputter::printIOStreamMessages("SG_LOG, SG_ALL class, SG_INFO only priority", test_io.sg_info_only);
fgCompilerOutputter::printIOStreamMessages("SG_LOG, SG_ALL class, SG_WARN only priority", test_io.sg_warn_only);
fgCompilerOutputter::printIOStreamMessages("SG_LOG, SG_ALL class, SG_ALERT only priority", test_io.sg_alert_only);
// Default IO streams.
fgCompilerOutputter::printIOStreamMessages("STDOUT and STDERR", test_io.stdio);
}
// Detailed printout after a failed run of the test suite.
void fgCompilerOutputter::printFailureReport()
{
// Custom printouts for each failed test.
printFailuresList();
// A summary with timing info.
printSuiteStats();
// Final summary.
fg_stream << endl << "[ FAILED ]" << endl << endl;
fg_stream.flush();
}
void fgCompilerOutputter::printIOStreamMessages(const char *heading, string messages, bool empty)
{
// 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;
}
// Printout of the test suite stats.
void fgCompilerOutputter::printSuiteStats()
{
// A divider.
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()
{
// A summary with timing info.
printSuiteStats();
// Final summary.
fg_stream << endl << "[ OK ]" << endl << endl;
fg_stream.flush();
}