QTestLogger Class Reference

#include <qtestlogger_p.h>

Inheritance diagram for QTestLogger:

Public Types
enum	TestLoggerFormat { TLF_XML = 0, TLF_LightXml = 1, TLF_XunitXml = 2 }
Public Types inherited from QAbstractTestLogger
enum	IncidentTypes { Pass, XFail, Fail, XPass }
enum	MessageTypes {   Warn, QWarning, QDebug, QSystem,   QFatal, Skip, Info }

Public Functions
void	addBenchmarkResult (const QBenchmarkResult &result)
void	addIncident (IncidentTypes type, const char *description, const char *file=0, int line=0)
void	addMessage (MessageTypes type, const char *message, const char *file=0, int line=0)
void	addTag (QTestElement *element)
void	enterTestFunction (const char *function)
int	errorCount () const
int	failureCount () const
bool	hasRandomSeed () const
int	infoCount () const
void	leaveTestFunction ()
TestLoggerFormat	logFormat ()
int	passCount () const
int	qdebugCount () const
int	qfatalCount () const
	QTestLogger (int fm=0)
int	qwarnCount () const
unsigned int	randomSeed () const
void	registerRandomSeed (unsigned int seed)
void	setLogFormat (TestLoggerFormat fm)
int	skipCount () const
void	startLogging ()
void	stopLogging ()
int	systemCount () const
int	warningCount () const
	~QTestLogger ()
Public Functions inherited from QAbstractTestLogger
	QAbstractTestLogger ()
virtual	~QAbstractTestLogger ()

Properties
QTestElement *	currentLogElement
int	errorCounter
QTestElement *	errorLogElement
int	failureCounter
QTestFileLogger *	filelogger
TestLoggerFormat	format
bool	hasRandomSeed_
int	infoCounter
QTestElement *	listOfTestcases
QTestBasicStreamer *	logFormatter
int	passCounter
int	qdebugCounter
int	qfatalCounter
int	qwarnCounter
unsigned int	randomSeed_
int	skipCounter
int	systemCounter
int	testCounter
int	warningCounter

Additional Inherited Members
Static Public Functions inherited from QAbstractTestLogger
static bool	isTtyOutput ()
static void	outputString (const char *msg)

Detailed Description

Definition at line 64 of file qtestlogger_p.h.

Enumerations

TestLoggerFormat

enum QTestLogger::TestLoggerFormat

Enumerator
TLF_XML
TLF_LightXml
TLF_XunitXml

Definition at line 70 of file qtestlogger_p.h.

        {
            TLF_XML = 0,
            TLF_LightXml = 1,
            TLF_XunitXml = 2
        };

Constructors and Destructors

QTestLogger()

QTestLogger::QTestLogger

(

int

fm = 0

)

Definition at line 57 of file qtestlogger.cpp.

    :listOfTestcases(0), currentLogElement(0), errorLogElement(0),
    logFormatter(0), format( (TestLoggerFormat)fm ), filelogger(new QTestFileLogger),
    testCounter(0), passCounter(0),
    failureCounter(0), errorCounter(0),
    warningCounter(0), skipCounter(0),
    systemCounter(0), qdebugCounter(0),
    qwarnCounter(0), qfatalCounter(0),
    infoCounter(0), randomSeed_(0),
    hasRandomSeed_(false)
{
}

~QTestLogger()

QTestLogger::~QTestLogger

(

)

Definition at line 70 of file qtestlogger.cpp.

{
    if(format == TLF_XunitXml)
        delete currentLogElement;
    else
        delete listOfTestcases;

    delete logFormatter;
    delete filelogger;
}

Functions

addBenchmarkResult()

void QTestLogger::addBenchmarkResult ( const QBenchmarkResult &  result )

virtual

Implements QAbstractTestLogger.

Definition at line 271 of file qtestlogger.cpp.

{
    QTestElement *benchmarkElement = new QTestElement(QTest::LET_Benchmark);
//    printf("element %i", benchmarkElement->elementType());

    benchmarkElement->addAttribute(
        QTest::AI_Metric,
        QTest::benchmarkMetricName(QBenchmarkTestMethodData::current->result.metric));
    benchmarkElement->addAttribute(QTest::AI_Tag, result.context.tag.toAscii().data());
    benchmarkElement->addAttribute(QTest::AI_Value, QByteArray::number(result.value).constData());

    char buf[100];
    QTest::qt_snprintf(buf, sizeof(buf), "%i", result.iterations);
    benchmarkElement->addAttribute(QTest::AI_Iterations, buf);
    currentLogElement->addLogElement(benchmarkElement);
}

addIncident()

void QTestLogger::addIncident ( IncidentTypes  type, const char *  description, const char *  file = 0, int  line = 0  )

virtual

Implements QAbstractTestLogger.

Definition at line 184 of file qtestlogger.cpp.

{
    const char *typeBuf = 0;
    char buf[100];

    switch (type) {
    case QAbstractTestLogger::XPass:
        ++failureCounter;
        typeBuf = "xpass";
        break;
    case QAbstractTestLogger::Pass:
        ++passCounter;
        typeBuf = "pass";
        break;
    case QAbstractTestLogger::XFail:
        ++passCounter;
        typeBuf = "xfail";
        break;
    case QAbstractTestLogger::Fail:
        ++failureCounter;
        typeBuf = "fail";
        break;
    default:
        typeBuf = "??????";
        break;
    }

    if (type == QAbstractTestLogger::Fail || type == QAbstractTestLogger::XPass
            || ((format != TLF_XunitXml) && (type == QAbstractTestLogger::XFail))) {
        QTestElement *failureElement = new QTestElement(QTest::LET_Failure);
        failureElement->addAttribute(QTest::AI_Result, typeBuf);
        if(file)
            failureElement->addAttribute(QTest::AI_File, file);
        else
            failureElement->addAttribute(QTest::AI_File, "");
        QTest::qt_snprintf(buf, sizeof(buf), "%i", line);
        failureElement->addAttribute(QTest::AI_Line, buf);
        failureElement->addAttribute(QTest::AI_Description, description);
        addTag(failureElement);
        currentLogElement->addLogElement(failureElement);
    }

    /*
        Only one result can be shown for the whole testfunction.
        Check if we currently have a result, and if so, overwrite it
        iff the new result is worse.
    */
    QTestElementAttribute* resultAttr =
        const_cast<QTestElementAttribute*>(currentLogElement->attribute(QTest::AI_Result));
    if (resultAttr) {
        const char* oldResult = resultAttr->value();
        bool overwrite = false;
        if (!strcmp(oldResult, "pass")) {
            overwrite = true;
        }
        else if (!strcmp(oldResult, "xfail")) {
            overwrite = (type == QAbstractTestLogger::XPass || type == QAbstractTestLogger::Fail);
        }
        else if (!strcmp(oldResult, "xpass")) {
            overwrite = (type == QAbstractTestLogger::Fail);
        }
        if (overwrite) {
            resultAttr->setPair(QTest::AI_Result, typeBuf);
        }
    }
    else {
        currentLogElement->addAttribute(QTest::AI_Result, typeBuf);
    }

    if(file)
        currentLogElement->addAttribute(QTest::AI_File, file);
    else
        currentLogElement->addAttribute(QTest::AI_File, "");

    QTest::qt_snprintf(buf, sizeof(buf), "%i", line);
    currentLogElement->addAttribute(QTest::AI_Line, buf);

    /*
        Since XFAIL does not add a failure to the testlog in xunitxml, add a message, so we still
        have some information about the expected failure.
    */
    if (format == TLF_XunitXml && type == QAbstractTestLogger::XFail) {
        QTestLogger::addMessage(QAbstractTestLogger::Info, description, file, line);
    }
}

addMessage()

void QTestLogger::addMessage ( MessageTypes  type, const char *  message, const char *  file = 0, int  line = 0  )

virtual

Implements QAbstractTestLogger.

Definition at line 309 of file qtestlogger.cpp.

Referenced by addIncident().

{
    QTestElement *errorElement = new QTestElement(QTest::LET_Error);
    const char *typeBuf = 0;

    switch (type) {
    case QAbstractTestLogger::Warn:
        ++warningCounter;
        typeBuf = "warn";
        break;
    case QAbstractTestLogger::QSystem:
        ++systemCounter;
        typeBuf = "system";
        break;
    case QAbstractTestLogger::QDebug:
        ++qdebugCounter;
        typeBuf = "qdebug";
        break;
    case QAbstractTestLogger::QWarning:
        ++qwarnCounter;
        typeBuf = "qwarn";
        break;
    case QAbstractTestLogger::QFatal:
        ++qfatalCounter;
        typeBuf = "qfatal";
        break;
    case QAbstractTestLogger::Skip:
        ++skipCounter;
        typeBuf = "skip";
        break;
    case QAbstractTestLogger::Info:
        ++infoCounter;
        typeBuf = "info";
        break;
    default:
        typeBuf = "??????";
        break;
    }

    errorElement->addAttribute(QTest::AI_Type, typeBuf);
    errorElement->addAttribute(QTest::AI_Description, message);
    addTag(errorElement);

    if(file)
        errorElement->addAttribute(QTest::AI_File, file);
    else
        errorElement->addAttribute(QTest::AI_File, "");

    char buf[100];
    QTest::qt_snprintf(buf, sizeof(buf), "%i", line);
    errorElement->addAttribute(QTest::AI_Line, buf);

    currentLogElement->addLogElement(errorElement);
    ++errorCounter;

    // Also add the message to the system error log (i.e. stderr), if one exists
    if (errorLogElement) {
        QTestElement *systemErrorElement = new QTestElement(QTest::LET_Error);
        systemErrorElement->addAttribute(QTest::AI_Description, message);
        errorLogElement->addLogElement(systemErrorElement);
    }
}

addTag()

void QTestLogger::addTag

(

QTestElement *

element

)

Definition at line 288 of file qtestlogger.cpp.

Referenced by addIncident(), and addMessage().

{
    const char *tag = QTestResult::currentDataTag();
    const char *gtag = QTestResult::currentGlobalDataTag();
    const char *filler = (tag && gtag) ? ":" : "";
    if ((!tag || !tag[0]) && (!gtag || !gtag[0])) {
        return;
    }

    if (!tag) {
        tag = "";
    }
    if (!gtag) {
        gtag = "";
    }

    QTestCharBuffer buf;
    QTest::qt_asprintf(&buf, "%s%s%s", gtag, filler, tag);
    element->addAttribute(QTest::AI_Tag, buf.constData());
}

enterTestFunction()

void QTestLogger::enterTestFunction ( const char *  function )

virtual

Implements QAbstractTestLogger.

Definition at line 167 of file qtestlogger.cpp.

{
    char buf[1024];
    QTest::qt_snprintf(buf, sizeof(buf), "Entered test-function: %s\n", function);
    filelogger->flush(buf);

    currentLogElement = new QTestElement(QTest::LET_TestCase);
    currentLogElement->addAttribute(QTest::AI_Name, function);
    currentLogElement->addToList(&listOfTestcases);

    ++testCounter;
}

errorCount()

int QTestLogger::errorCount

(

)

const

Definition at line 392 of file qtestlogger.cpp.

{
    return errorCounter;
}

failureCount()

int QTestLogger::failureCount

(

)

const

Definition at line 387 of file qtestlogger.cpp.

{
    return failureCounter;
}

hasRandomSeed()

bool QTestLogger::hasRandomSeed

(

)

const

Definition at line 443 of file qtestlogger.cpp.

Referenced by QTestXmlStreamer::output(), and stopLogging().

{
    return hasRandomSeed_;
}

infoCount()

int QTestLogger::infoCount

(

)

const

Definition at line 427 of file qtestlogger.cpp.

{
    return infoCounter;
}

leaveTestFunction()

void QTestLogger::leaveTestFunction ( )

virtual

Implements QAbstractTestLogger.

Definition at line 180 of file qtestlogger.cpp.

{
}

logFormat()

QTestLogger::TestLoggerFormat QTestLogger::logFormat

(

)

Definition at line 377 of file qtestlogger.cpp.

{
    return format;
}

passCount()

int QTestLogger::passCount

(

)

const

Definition at line 382 of file qtestlogger.cpp.

{
    return passCounter;
}

qdebugCount()

int QTestLogger::qdebugCount

(

)

const

Definition at line 412 of file qtestlogger.cpp.

{
    return qdebugCounter;
}

qfatalCount()

int QTestLogger::qfatalCount

(

)

const

Definition at line 422 of file qtestlogger.cpp.

{
    return qfatalCounter;
}

qwarnCount()

int QTestLogger::qwarnCount

(

)

const

Definition at line 417 of file qtestlogger.cpp.

{
    return qwarnCounter;
}

randomSeed()

unsigned int QTestLogger::randomSeed

(

)

const

Definition at line 438 of file qtestlogger.cpp.

Referenced by stopLogging().

{
    return randomSeed_;
}

registerRandomSeed()

void QTestLogger::registerRandomSeed ( unsigned int  seed )

virtual

Implements QAbstractTestLogger.

Definition at line 432 of file qtestlogger.cpp.

{
    randomSeed_ = seed;
    hasRandomSeed_ = true;
}

setLogFormat()

void QTestLogger::setLogFormat

(

TestLoggerFormat

fm

)

Definition at line 372 of file qtestlogger.cpp.

{
    format = fm;
}

skipCount()

int QTestLogger::skipCount

(

)

const

Definition at line 402 of file qtestlogger.cpp.

{
    return skipCounter;
}

startLogging()

void QTestLogger::startLogging ( )

virtual

Reimplemented from QAbstractTestLogger.

Definition at line 81 of file qtestlogger.cpp.

{
    switch(format){
    case TLF_LightXml:{
        logFormatter = new QTestLightXmlStreamer;
        filelogger->init();
        break;
    }case TLF_XML:{
        logFormatter = new QTestXmlStreamer;
        filelogger->init();
        break;
    }case TLF_XunitXml:{
        logFormatter = new QTestXunitStreamer;
        delete errorLogElement;
        errorLogElement = new QTestElement(QTest::LET_SystemError);
        filelogger->init();
        break;
    }
    }

    logFormatter->setLogger(this);
    logFormatter->startStreaming();
}

stopLogging()

void QTestLogger::stopLogging ( )

virtual

Reimplemented from QAbstractTestLogger.

Definition at line 105 of file qtestlogger.cpp.

{
    QTestElement *iterator = listOfTestcases;

    if(format == TLF_XunitXml ){
        char buf[10];

        currentLogElement = new QTestElement(QTest::LET_TestSuite);
        currentLogElement->addAttribute(QTest::AI_Name, QTestResult::currentTestObjectName());

        QTest::qt_snprintf(buf, sizeof(buf), "%i", testCounter);
        currentLogElement->addAttribute(QTest::AI_Tests, buf);

        QTest::qt_snprintf(buf, sizeof(buf), "%i", failureCounter);
        currentLogElement->addAttribute(QTest::AI_Failures, buf);

        QTest::qt_snprintf(buf, sizeof(buf), "%i", errorCounter);
        currentLogElement->addAttribute(QTest::AI_Errors, buf);

        QTestElement *property;
        QTestElement *properties = new QTestElement(QTest::LET_Properties);

        property = new QTestElement(QTest::LET_Property);
        property->addAttribute(QTest::AI_Name, "QTestVersion");
        property->addAttribute(QTest::AI_PropertyValue, QTEST_VERSION_STR);
        properties->addLogElement(property);

        property = new QTestElement(QTest::LET_Property);
        property->addAttribute(QTest::AI_Name, "QtVersion");
        property->addAttribute(QTest::AI_PropertyValue, qVersion());
        properties->addLogElement(property);

        if (hasRandomSeed()) {
            property = new QTestElement(QTest::LET_Property);
            property->addAttribute(QTest::AI_Name, "RandomSeed");
            QTest::qt_snprintf(buf, sizeof(buf), "%i", randomSeed());
            property->addAttribute(QTest::AI_PropertyValue, buf);
            properties->addLogElement(property);
        }

        currentLogElement->addLogElement(properties);

        currentLogElement->addLogElement(iterator);

        /* For correct indenting, make sure every testcase knows its parent */
        QTestElement* testcase = iterator;
        while (testcase) {
            testcase->setParent(currentLogElement);
            testcase = testcase->nextElement();
        }

        currentLogElement->addLogElement(errorLogElement);

        QTestElement *it = currentLogElement;
        logFormatter->output(it);
    }else{
        logFormatter->output(iterator);
    }

    logFormatter->stopStreaming();
}

systemCount()

int QTestLogger::systemCount

(

)

const

Definition at line 407 of file qtestlogger.cpp.

{
    return systemCounter;
}

warningCount()

int QTestLogger::warningCount

(

)

const

Definition at line 397 of file qtestlogger.cpp.

{
    return warningCounter;
}

Properties

currentLogElement

QTestElement* QTestLogger::currentLogElement

private

Definition at line 110 of file qtestlogger_p.h.

Referenced by addBenchmarkResult(), addIncident(), addMessage(), enterTestFunction(), stopLogging(), and ~QTestLogger().

errorCounter

int QTestLogger::errorCounter

private

Definition at line 119 of file qtestlogger_p.h.

Referenced by addMessage(), errorCount(), and stopLogging().

errorLogElement

QTestElement* QTestLogger::errorLogElement

private

Definition at line 111 of file qtestlogger_p.h.

Referenced by addMessage(), startLogging(), and stopLogging().

failureCounter

int QTestLogger::failureCounter

private

Definition at line 118 of file qtestlogger_p.h.

Referenced by addIncident(), failureCount(), and stopLogging().

filelogger

QTestFileLogger* QTestLogger::filelogger

private

Definition at line 114 of file qtestlogger_p.h.

Referenced by enterTestFunction(), startLogging(), and ~QTestLogger().

format

TestLoggerFormat QTestLogger::format

private

Definition at line 113 of file qtestlogger_p.h.

Referenced by logFormat().

hasRandomSeed_

bool QTestLogger::hasRandomSeed_

private

Definition at line 128 of file qtestlogger_p.h.

Referenced by hasRandomSeed(), and registerRandomSeed().

infoCounter

int QTestLogger::infoCounter

private

Definition at line 126 of file qtestlogger_p.h.

Referenced by addMessage(), and infoCount().

listOfTestcases

QTestElement* QTestLogger::listOfTestcases

private

Definition at line 109 of file qtestlogger_p.h.

Referenced by enterTestFunction(), stopLogging(), and ~QTestLogger().

logFormatter

QTestBasicStreamer* QTestLogger::logFormatter

private

Definition at line 112 of file qtestlogger_p.h.

Referenced by startLogging(), stopLogging(), and ~QTestLogger().

passCounter

int QTestLogger::passCounter

private

Definition at line 117 of file qtestlogger_p.h.

Referenced by addIncident(), and passCount().

qdebugCounter

int QTestLogger::qdebugCounter

private

Definition at line 123 of file qtestlogger_p.h.

Referenced by addMessage(), and qdebugCount().

qfatalCounter

int QTestLogger::qfatalCounter

private

Definition at line 125 of file qtestlogger_p.h.

Referenced by addMessage(), and qfatalCount().

qwarnCounter

int QTestLogger::qwarnCounter

private

Definition at line 124 of file qtestlogger_p.h.

Referenced by addMessage(), and qwarnCount().

randomSeed_

unsigned int QTestLogger::randomSeed_

private

Definition at line 127 of file qtestlogger_p.h.

Referenced by randomSeed(), and registerRandomSeed().

skipCounter

int QTestLogger::skipCounter

private

Definition at line 121 of file qtestlogger_p.h.

Referenced by addMessage(), and skipCount().

systemCounter

int QTestLogger::systemCounter

private

Definition at line 122 of file qtestlogger_p.h.

Referenced by addMessage(), and systemCount().

testCounter

int QTestLogger::testCounter

private

Definition at line 116 of file qtestlogger_p.h.

Referenced by enterTestFunction(), and stopLogging().

warningCounter

int QTestLogger::warningCounter

private

Definition at line 120 of file qtestlogger_p.h.

Referenced by addMessage(), and warningCount().

---

The documentation for this class was generated from the following files:

• /src/testlib/qtestlogger_p.h
• /src/testlib/qtestlogger.cpp