This class stores results of test case run. More...

#include <CTestResult.h>

Public Types
enum	ETestResultSection { E_SECTION_RESULT_COMMENT , E_SECTION_DEFAULT_DOWNLOAD_FILE , E_SECTION_STUB_RESULTS , E_SECTION_TEST_POINT_RESULTS , E_SECTION_STACK_USAGE_RESULTS , E_SECTION_TARGET_EXCEPTION , E_SECTION_PRE_CONDITION , E_SECTION_ASSERT , E_SECTION_LOG , E_SECTION_DRY_RUN_ASSIGNMENTS , E_SECTION_DIAGRAMS , E_SECTION_SCRIPT_ERRORS , E_SECTION_SCRIPT_OUTPUT }
	Test result sections. More...

Public Member Functions
void	addDiagram (const std::string &imageFileName)
void	addDryRunAssignment (const std::string &varName, const std::string &value)
void	addExprResult (CTestResult::ETestResultSection section, CTestExprResultSPtr &result)
	Adds result of evaluated test expression.
void	addStubResult (CTestPointResultSPtr &result)
	Adds stub result.
void	addTestPointResult (CTestPointResultSPtr &result)
	Adds test point result.
void	appendScriptError (const std::string &scriptFunctionType, const std::string &errorDesc) override
	Appends error message of script function.
void	appendScriptOutput (const std::string &scriptFunctionType, const std::string &outStr) override
	Appends stdout of script function.
CTestBaseSPtr	createInstance (const CTestBaseSPtr &parent) const override
	CTestResult (const isys::CTestSpecificationSPtr &testSpecification)
std::string	diffsToUIString (CTestResult::ETestResultSection section)
std::string	getAnalyzerFileName ()
	The following methods are reserved for iSYSTEM internal use.
CTestBaseListSPtr	getAssertResults (bool isConst)
	Returns list of CTestExprResult -s, one item per assert expression.
void	getCoverageResults (isys::StrCoverageTestResultsMap &resultMap) const
	Returns all coverage results.
void	getCoverageResultsWithError (isys::StrCoverageTestResultsMap &resultMap) const
	Returns only those coverage results, which do match expected values.
std::string	getDefaultDownloadFile ()
	Returns default download file name.
std::string	getExceptionString () override
	If `isException()` returns true, this method returns the message of the exception.
std::string	getFunction () const
	Returns the name of the function under test.
CLogResultSPtr	getLogResult (bool isConst)
	Returns object containing logged values.
CTestBaseListSPtr	getPreConditionResults (bool isConst)
	Returns list of precondition evaluations.
isys::CProfilerTestResultSPtr	getProfilerCodeResult (const std::string areaName)
	Returns profiler code result if exists, NULL otherwise.
void	getProfilerCodeResults (isys::StrProfilerTestResultsMap &resultMap)
	Returns all profiler code results.
isys::CProfilerTestResultSPtr	getProfilerDataResult (const std::string areaName)
	Returns profiler data result without value set if exists, NULL otherwise.
void	getProfilerDataResults (isys::StrProfilerTestResultsMap &resultMap)
	Returns all profiler data results.
std::string	getProfilerExportFileName ()
	Returns name of the file, where profiler data was exported - this is real file name, without host variables (they were replaced with values before test execution and saved in this class).
std::string	getResultComment () override
	Returns comment, which describes specific test run.
std::string	getScriptError (const std::string &scriptFunctionType) override
	Returns string returned by the given script function.
std::string	getScriptOutput (const std::string &scriptFunctionType) override
	Returns everything printed to std out by script function.
CStackUsageResultSPtr	getStackUsageResult (bool isConst)
CTestBaseListSPtr	getStubResults (bool isConst)
std::string	getTestId () const
	Returns the testId.
CTestBaseListSPtr	getTestPointResults (bool isConst)
isys::CTestSpecificationSPtr	getTestSpecification ()
	Returns test specification, which produced this result.
bool	isCodeCoverageError ()
	Returns true, if coverage results don't match the test specification requirements.
bool	isError () override
	Returns true if any of possible errors occurred - expressions, profiler, coverage, exception, ...
bool	isException () override
	Returns true, if an exception was thrown.
bool	isExpressionError ()
	Returns true, if target values after test run don't match expected values given in test specification (section 'expected').
bool	isPreConditionError ()
	Returns true, if conditions verified before test failed.
bool	isProfilerCodeError ()
	Returns true, if profiler code results don't match the test specification requirements.
bool	isProfilerDataError ()
	Returns true, if profiler data results don't match the test specification requirements.
bool	isScriptError () override
	Returns true, if there was error when executing script functions.
bool	isScriptError (const std::string &scriptFunctionType) override
	Returns true, if there was error when executing the given script function.
bool	isStackUsageError () override
	Returns true, if there was error in stack usage.
bool	isStubError ()
	Returns true, if there was error in stub.
bool	isTargetException ()
	Returns true, if exception was thrown by function on the target.
bool	isTargetExceptionError ()
	Returns true, if exception was thrown on target, but it is not expected as test result, or it is expected as test result, but it was not thrown on the target.
bool	isTestPointError ()
	Returns true, if there was error in test points.
virtual void	serialize (const isys::IEmitterSPtr &emitter)
	Sends contents of this class to emitter.
void	serialize (const isys::IEmitterSPtr &emitter, const isys::CTestReportConfigSPtr &reportConfig)
	Writes result to destination stream, which is usually associated with file.
void	serializeErrorsOnly (const isys::IEmitterSPtr &emitter, const isys::CTestReportConfigSPtr &reportConfig)
	Writes errors to destination stream, which is usually associated with file.
void	setDefaultDownloadFile (const std::string &defaultDlFileName)
void	setLogResult (const CLogResultSPtr &logResult)
	Sets log result.
void	setResultComment (const std::string &resultComment)
	Set arbitrary text to appear in test report, for example test description or purpose.
void	setStackUsageResult (CStackUsageResultSPtr stackUsageResult)
	Sets Stack usage result.
void	setTargetException (bool isTargetException)
	Set to true, if exception on target occurred during test.
void	setTargetExceptionStr (const std::string &targetException)
	Sets description of target exception.
void	setTestSpecification (isys::CTestSpecificationSPtr &testSpec)
std::string	toString () override
	Returns object's data as YAML string.
std::string	toUIString ()
	Returns string readable also as pure text, only errors are included.

Detailed Description

This class stores results of test case run.

Normally it is not intended to be instantiated by clients - call isys::CTestCase::getTestResult() or similar method in the scripting language wrapper to get test results. However, if you'd like to create testIDE-like reports with custom scripts, feel free to use it.

For result analysis the simple method used in itest_sample.py is enough in most cases:

def verify_result(results):
    while results.hasNextTestResult():
        result = results.nextTestResult()
        if result.isError():
            out = ic.CStringStream()
            emitter = ic.EmitterFactory.createYamlEmitter(out)
            emitter.startStream()
            emitter.startDocument(False)
            result.serializeErrorsOnly(emitter, None)
            emitter.endDocument(False)
            emitter.endStream()
            print(out.getString())
        else:
            print("OK")
    verify_result(test_case.getTestResultsContainer())

Python example: create_test_report.py

Member Enumeration Documentation

◆ ETestResultSection

enum isys::CTestResult::ETestResultSection

Test result sections.

Enumerator

E_SECTION_RESULT_COMMENT

comment user enters in tesIDEA to be saved to report.

It should describe conditions for particular test run.

Constructor & Destructor Documentation

◆ CTestResult()

isys::CTestResult::CTestResult ( const isys::CTestSpecificationSPtr & testSpecification )

Since: 9.12.288

Member Function Documentation

◆ addDiagram()

void isys::CTestResult::addDiagram ( const std::string & imageFileName )

Since: 9.12.288

◆ addDryRunAssignment()

void isys::CTestResult::addDryRunAssignment	(	const std::string &	varName,
		const std::string &	value )

Since: 9.12.288

◆ addExprResult()

void isys::CTestResult::addExprResult	(	CTestResult::ETestResultSection	section,
		CTestExprResultSPtr &	result )

Adds result of evaluated test expression.

Parameters

section	should be CTestResult::E_SECTION_PRE_CONDITION, or CTestResult::E_SECTION_ASSERT, if expression is evaluated before or after test respectively.
result	result to be added.

Since: 9.12.288

◆ addStubResult()

void isys::CTestResult::addStubResult ( CTestPointResultSPtr & result )

Adds stub result.

Since: 9.12.288

◆ addTestPointResult()

void isys::CTestResult::addTestPointResult ( CTestPointResultSPtr & result )

Adds test point result.

Since: 9.12.288

◆ appendScriptError()

void isys::CTestResult::appendScriptError	(	const std::string &	scriptFunctionType,
		const std::string &	errorDesc )

override

Appends error message of script function.

Since: 9.12.288

◆ appendScriptOutput()

void isys::CTestResult::appendScriptOutput	(	const std::string &	scriptFunctionType,
		const std::string &	outStr )

override

Appends stdout of script function.

Since: 9.12.288

◆ createInstance()

CTestBaseSPtr isys::CTestResult::createInstance ( const CTestBaseSPtr & parent ) const

override

Since: 9.12.288

◆ diffsToUIString()

std::string isys::CTestResult::diffsToUIString ( CTestResult::ETestResultSection section )

Since: 9.12.288

◆ getAnalyzerFileName()

std::string isys::CTestResult::getAnalyzerFileName ( )

The following methods are reserved for iSYSTEM internal use.

Since: 9.12.288

◆ getAssertResults()

CTestBaseListSPtr isys::CTestResult::getAssertResults ( bool isConst )

Returns list of CTestExprResult -s, one item per assert expression.

Since: 9.12.288

◆ getCoverageResults()

void isys::CTestResult::getCoverageResults ( isys::StrCoverageTestResultsMap & resultMap ) const

Returns all coverage results.

Since: 9.12.288

◆ getCoverageResultsWithError()

void isys::CTestResult::getCoverageResultsWithError ( isys::StrCoverageTestResultsMap & resultMap ) const

Returns only those coverage results, which do match expected values.

Since: 9.12.288

◆ getDefaultDownloadFile()

std::string isys::CTestResult::getDefaultDownloadFile ( )

Returns default download file name.

It is set only when profiler was run during test.

Since: 9.12.288

◆ getExceptionString()

std::string isys::CTestResult::getExceptionString ( )

override

If isException() returns true, this method returns the message of the exception.

Since: 9.12.288

◆ getFunction()

std::string isys::CTestResult::getFunction ( ) const

Returns the name of the function under test.

Since: 9.12.288

◆ getLogResult()

CLogResultSPtr isys::CTestResult::getLogResult ( bool isConst )

Returns object containing logged values.

Since: 9.12.288

◆ getPreConditionResults()

CTestBaseListSPtr isys::CTestResult::getPreConditionResults ( bool isConst )

Returns list of precondition evaluations.

Since: 9.12.288

◆ getProfilerCodeResult()

isys::CProfilerTestResultSPtr isys::CTestResult::getProfilerCodeResult ( const std::string areaName )

Returns profiler code result if exists, NULL otherwise.

Since: 9.12.288

◆ getProfilerCodeResults()

void isys::CTestResult::getProfilerCodeResults ( isys::StrProfilerTestResultsMap & resultMap )

Returns all profiler code results.

Since: 9.12.288

◆ getProfilerDataResult()

isys::CProfilerTestResultSPtr isys::CTestResult::getProfilerDataResult ( const std::string areaName )

Returns profiler data result without value set if exists, NULL otherwise.

Since: 9.12.288

◆ getProfilerDataResults()

void isys::CTestResult::getProfilerDataResults ( isys::StrProfilerTestResultsMap & resultMap )

Returns all profiler data results.

Since: 9.12.288

◆ getProfilerExportFileName()

std::string isys::CTestResult::getProfilerExportFileName ( )

Returns name of the file, where profiler data was exported - this is real file name, without host variables (they were replaced with values before test execution and saved in this class).

Since: 9.12.288

◆ getResultComment()

std::string isys::CTestResult::getResultComment ( )

override

Returns comment, which describes specific test run.

This value is typically entered by user after test run and before saving test report.

Since: 9.12.288

◆ getScriptError()

std::string isys::CTestResult::getScriptError ( const std::string & scriptFunctionType )

override

Returns string returned by the given script function.

If there was no error, an empty string is returned.

Since: 9.12.288

◆ getScriptOutput()

std::string isys::CTestResult::getScriptOutput ( const std::string & scriptFunctionType )

override

Returns everything printed to std out by script function.

Since: 9.12.288

◆ getStackUsageResult()

CStackUsageResultSPtr isys::CTestResult::getStackUsageResult ( bool isConst )

Since: 9.12.288

◆ getStubResults()

CTestBaseListSPtr isys::CTestResult::getStubResults ( bool isConst )

Since: 9.12.288

◆ getTestId()

std::string isys::CTestResult::getTestId ( ) const

Returns the testId.

Since: 9.12.288

◆ getTestPointResults()

CTestBaseListSPtr isys::CTestResult::getTestPointResults ( bool isConst )

Since: 9.12.288

◆ getTestSpecification()

isys::CTestSpecificationSPtr isys::CTestResult::getTestSpecification ( )

Returns test specification, which produced this result.

Usually this is the merged test specification.

Since: 9.12.288

◆ isCodeCoverageError()

bool isys::CTestResult::isCodeCoverageError ( )

Returns true, if coverage results don't match the test specification requirements.

Since: 9.12.288

◆ isError()

bool isys::CTestResult::isError ( )

override

Returns true if any of possible errors occurred - expressions, profiler, coverage, exception, ...

Since: 9.12.288

◆ isException()

bool isys::CTestResult::isException ( )

override

Returns true, if an exception was thrown.

Since: 9.12.288

◆ isExpressionError()

bool isys::CTestResult::isExpressionError ( )

Returns true, if target values after test run don't match expected values given in test specification (section 'expected').

Since: 9.12.288

◆ isPreConditionError()

bool isys::CTestResult::isPreConditionError ( )

Returns true, if conditions verified before test failed.

Since: 9.12.288

◆ isProfilerCodeError()

bool isys::CTestResult::isProfilerCodeError ( )

Returns true, if profiler code results don't match the test specification requirements.

Since: 9.12.288

◆ isProfilerDataError()

bool isys::CTestResult::isProfilerDataError ( )

Returns true, if profiler data results don't match the test specification requirements.

Since: 9.12.288

◆ isScriptError() [1/2]

bool isys::CTestResult::isScriptError ( )

override

Returns true, if there was error when executing script functions.

Since: 9.12.288

◆ isScriptError() [2/2]

bool isys::CTestResult::isScriptError ( const std::string & scriptFunctionType )

override

Returns true, if there was error when executing the given script function.

Since: 9.12.288

◆ isStackUsageError()

bool isys::CTestResult::isStackUsageError ( )

override

Returns true, if there was error in stack usage.

Since: 9.12.288

◆ isStubError()

bool isys::CTestResult::isStubError ( )

Returns true, if there was error in stub.

Since: 9.12.288

◆ isTargetException()

bool isys::CTestResult::isTargetException ( )

Returns true, if exception was thrown by function on the target.

Since: 9.12.288

◆ isTargetExceptionError()

bool isys::CTestResult::isTargetExceptionError ( )

Returns true, if exception was thrown on target, but it is not expected as test result, or it is expected as test result, but it was not thrown on the target.

Since: 9.12.288

◆ isTestPointError()

bool isys::CTestResult::isTestPointError ( )

Returns true, if there was error in test points.

Since: 9.12.288

◆ serialize() [1/2]

virtual void isys::CTestBase::serialize ( const isys::IEmitterSPtr & emitter )

Sends contents of this class to emitter.

Since: 9.12.288

◆ serialize() [2/2]

void isys::CTestResult::serialize	(	const isys::IEmitterSPtr &	emitter,
		const isys::CTestReportConfigSPtr &	reportConfig )

Writes result to destination stream, which is usually associated with file.

Parameters

emitter	destination object for serialized data
reportConfig	report configuration. If set to NULL, default configuration is used. If `CTestReportConfig::setReportContents(RCONFIG_ERRORS_ONLY)` is called, this call is identical to call serializeErrorsOnly() below.

Since: 9.12.288

◆ serializeErrorsOnly()

void isys::CTestResult::serializeErrorsOnly	(	const isys::IEmitterSPtr &	emitter,
		const isys::CTestReportConfigSPtr &	reportConfig )

Writes errors to destination stream, which is usually associated with file.

Parameters

emitter	destination object for serialized data
reportConfig	report configuration. If set to NULL, default configuration is used.

Since: 9.12.288

◆ setDefaultDownloadFile()

void isys::CTestResult::setDefaultDownloadFile ( const std::string & defaultDlFileName )

Since: 9.12.288

◆ setLogResult()

void isys::CTestResult::setLogResult ( const CLogResultSPtr & logResult )

Sets log result.

Since: 9.12.288

◆ setResultComment()

void isys::CTestResult::setResultComment ( const std::string & resultComment )

Set arbitrary text to appear in test report, for example test description or purpose.

Since: 9.12.288

◆ setStackUsageResult()

void isys::CTestResult::setStackUsageResult ( CStackUsageResultSPtr stackUsageResult )

Sets Stack usage result.

Since: 9.12.288

◆ setTargetException()

void isys::CTestResult::setTargetException ( bool isTargetException )

Set to true, if exception on target occurred during test.

See also: setTargetExceptionStr

Since: 9.12.288

◆ setTargetExceptionStr()

void isys::CTestResult::setTargetExceptionStr ( const std::string & targetException )

Sets description of target exception.

See also: setTargetException

Since: 9.12.288

◆ setTestSpecification()

void isys::CTestResult::setTestSpecification ( isys::CTestSpecificationSPtr & testSpec )

Since: 9.12.288

◆ toString()

std::string isys::CTestResult::toString ( )

override

Returns object's data as YAML string.

This method is intended for debugging purposes only, do not parse the returned data!

Since: 9.12.288

◆ toUIString()

std::string isys::CTestResult::toUIString ( )

Returns string readable also as pure text, only errors are included.

Since: 9.12.288

winIDEA SDK

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ETestResultSection

Constructor & Destructor Documentation

◆ CTestResult()

Member Function Documentation

◆ addDiagram()

◆ addDryRunAssignment()

◆ addExprResult()

◆ addStubResult()

◆ addTestPointResult()

◆ appendScriptError()

◆ appendScriptOutput()

◆ createInstance()

◆ diffsToUIString()

◆ getAnalyzerFileName()

◆ getAssertResults()

◆ getCoverageResults()

◆ getCoverageResultsWithError()

◆ getDefaultDownloadFile()

◆ getExceptionString()

◆ getFunction()

◆ getLogResult()

◆ getPreConditionResults()

◆ getProfilerCodeResult()

◆ getProfilerCodeResults()

◆ getProfilerDataResult()

◆ getProfilerDataResults()

◆ getProfilerExportFileName()

◆ getResultComment()

◆ getScriptError()

◆ getScriptOutput()

◆ getStackUsageResult()

◆ getStubResults()

◆ getTestId()

◆ getTestPointResults()

◆ getTestSpecification()

◆ isCodeCoverageError()

◆ isError()

◆ isException()

◆ isExpressionError()

◆ isPreConditionError()

◆ isProfilerCodeError()

◆ isProfilerDataError()

◆ isScriptError() [1/2]

◆ isScriptError() [2/2]

◆ isStackUsageError()

◆ isStubError()

◆ isTargetException()

◆ isTargetExceptionError()

◆ isTestPointError()

◆ serialize() [1/2]

◆ serialize() [2/2]

◆ serializeErrorsOnly()

◆ setDefaultDownloadFile()

◆ setLogResult()

◆ setResultComment()

◆ setStackUsageResult()

◆ setTargetException()

◆ setTargetExceptionStr()

◆ setTestSpecification()

◆ toString()

◆ toUIString()