Runtime Test Services - Revision history

Ryanh at 19:54, 7 July 2015

2015-07-07T19:54:07Z

← Older revision		Revision as of 19:54, 7 July 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	The Runtime Test Services (declared in '''srtest.h''') are a set of APIs in the ~~STRIDE~~ Runtime that facilitate the writing of target based test code. These APIs make up an optional portion of the Stride Runtime and can be used to communicate additional information about tests to the host based reporting mechanism. These APIs also allow target test code to create additional test suites and test cases dynamically at runtime.		The Runtime Test Services (declared in '''srtest.h''') are a set of APIs in the Stride Runtime that facilitate the writing of target based test code. These APIs make up an optional portion of the Stride Runtime and can be used to communicate additional information about tests to the host based reporting mechanism. These APIs also allow target test code to create additional test suites and test cases dynamically at runtime.

	There are two ways of accessing these APIs: through C-based functions, or through a C++ base class from which you may derive your C++ test class. These are discussed below in [[#C Test Functions\|C Test Functions]], and [[#C++ Test Classes\|C++ Test Classes]] sections below.		There are two ways of accessing these APIs: through C-based functions, or through a C++ base class from which you may derive your C++ test class. These are discussed below in [[#C Test Functions\|C Test Functions]], and [[#C++ Test Classes\|C++ Test Classes]] sections below.
Line 365:		Line 365:
	\| dwDuration		\| dwDuration
	\| Input		\| Input
	\| The duration of the test in clock ticks. Using "0" allows the ~~STRIDE~~ Runtime (Intercept Module) to set the time automatically.		\| The duration of the test in clock ticks. Using "0" allows the Stride Runtime (Intercept Module) to set the time automatically.
	\|}		\|}
	<br>		<br>
Line 413:		Line 413:
	\| dwDuration		\| dwDuration
	\| Input		\| Input
	\| The duration of the test in clock ticks. Using "0" allows the ~~STRIDE~~ Runtime (Intercept Module) to set the time automatically.		\| The duration of the test in clock ticks. Using "0" allows the Stride Runtime (Intercept Module) to set the time automatically.
	\|-		\|-
	\| lExtendedFailureCode		\| lExtendedFailureCode

Ryanh at 19:49, 7 July 2015

2015-07-07T19:49:08Z

← Older revision		Revision as of 19:49, 7 July 2015
Line 789:		Line 789:

	=== method AddCase ===		=== method AddCase ===
	The AddCase method is used to new test case to the test suite.		The AddCase method is used to add a new test case to the test suite.
	<source lang=cpp>		<source lang=cpp>
	srTestCase AddCase(const srCHAR * name, const srCHAR * descr = srNULL)		srTestCase AddCase(const srCHAR * name, const srCHAR * descr = srNULL)

Marku at 03:06, 7 July 2015

2015-07-07T03:06:16Z

Show changes

Marku: /* srTestGetParam */

2015-07-07T02:56:36Z

srTestGetParam

← Older revision		Revision as of 02:56, 7 July 2015
Line 26:		Line 26:
	srWORD srTestGetParam(const srCHAR * szName, srCHAR * szValue, srDWORD dwSize, const srCHAR * szDefValue);		srWORD srTestGetParam(const srCHAR * szName, srCHAR * szValue, srDWORD dwSize, const srCHAR * szDefValue);
	</source>		</source>


	{\| border="1" cellspacing="0" cellpadding="10" style="align:left;"		{\| border="1" cellspacing="0" cellpadding="10" style="align:left;"
Line 62:		Line 63:
	\| The named parameter is not found and <i>szDefValue</i> is set to srNULL.		\| The named parameter is not found and <i>szDefValue</i> is set to srNULL.
	\|}		\|}


	<source lang=c>		<source lang=c>
Line 78:		Line 80:
	#endif		#endif
	</source>		</source>


	== srTestGetParamLong ==		== srTestGetParamLong ==

Marku at 02:55, 7 July 2015

2015-07-07T02:55:57Z

← Older revision		Revision as of 02:55, 7 July 2015
Line 121:		Line 121:
	</source>		</source>

	=== srTestGetParamDouble ===
			== srTestGetParamDouble ==
	The srTestGetParamDouble() function is used to get the value of a named parameter as a double.		The srTestGetParamDouble() function is used to get the value of a named parameter as a double.
	<source lang=c>		<source lang=c>
Line 162:		Line 163:
	</source>		</source>

	=== srTestSuiteAddCase ===
			== srTestSuiteAddCase ==
	The srTestSuiteAddCase() routine is used to add a new test case to the specified test suite.		The srTestSuiteAddCase() routine is used to add a new test case to the specified test suite.
	<source lang=c>		<source lang=c>
Line 209:		Line 211:
	#endif		#endif
	</source>		</source>


	== srTestSuiteAddAnnotation ==		== srTestSuiteAddAnnotation ==
Line 321:		Line 324:
	#endif		#endif
	</source>		</source>


	== srTestCaseSetStatus ==		== srTestCaseSetStatus ==
Line 371:		Line 375:
	#endif		#endif
	</source>		</source>


	== srTestCaseSetStatusEx ==		== srTestCaseSetStatusEx ==
Line 420:		Line 425:
	#endif		#endif
	</source>		</source>


	== srTestCaseAddAnnotation ==		== srTestCaseAddAnnotation ==
Line 489:		Line 495:
	#endif		#endif
	</source>		</source>


	== srTestCaseSetData ==		== srTestCaseSetData ==
Line 538:		Line 545:
	#endif		#endif
	</source>		</source>


	== srTestAnnotationAddComment ==		== srTestAnnotationAddComment ==
Line 593:		Line 601:
	#endif		#endif
	</source>		</source>


	= C++ Test Classes =		= C++ Test Classes =
Line 601:		Line 610:
	* '''[[#class srTestCase\|class srTestCase]]''' - represents a test case		* '''[[#class srTestCase\|class srTestCase]]''' - represents a test case
	* '''[[#class srTestAnnotation\|class srTestAnnotation]]''' - represents a test annotation		* '''[[#class srTestAnnotation\|class srTestAnnotation]]''' - represents a test annotation


	== class srTest ==		== class srTest ==
	The srTest class provides one member object ''testCase'' of [[#class srTestCase\|class srTestCase]] and the folowing methods:		The srTest class provides one member object ''testCase'' of [[#class srTestCase\|class srTestCase]] and the folowing methods:


	=== method GetParam ===		=== method GetParam ===
Line 657:		Line 668:
	#endif		#endif
	</source>		</source>


	=== method GetParam ===		=== method GetParam ===
Line 701:		Line 713:
	#pragma scl_test_class(srtest_class)		#pragma scl_test_class(srtest_class)
	#endif</source>		#endif</source>


	=== method GetParam ===		=== method GetParam ===
Line 745:		Line 758:
	#pragma scl_test_class(srtest_class)		#pragma scl_test_class(srtest_class)
	#endif</source>		#endif</source>


	=== method AddCase ===		=== method AddCase ===
Line 799:		Line 813:
	#endif		#endif
	</source>		</source>


	=== method AddAnnotation ===		=== method AddAnnotation ===
Line 865:		Line 880:
	#endif		#endif
	</source>		</source>


	=== method SetData ===		=== method SetData ===
Line 912:		Line 928:
	#endif		#endif
	</source>		</source>


	== class srTestCase ==		== class srTestCase ==
Line 965:		Line 982:
	#endif		#endif
	</source>		</source>


	=== method AddAnnotation ===		=== method AddAnnotation ===
Line 1,032:		Line 1,050:
	#endif		#endif
	</source>		</source>


	=== method SetData ===		=== method SetData ===
Line 1,077:		Line 1,096:
	#endif		#endif
	</source>		</source>


	== class srTestAnnotation ==		== class srTestAnnotation ==
	The srTestAnnotation class provides the following methods:		The srTestAnnotation class provides the following methods:


	=== method AddComment ===		=== method AddComment ===

Marku at 23:07, 2 July 2015

2015-07-02T23:07:27Z

Show changes

Ivailop: /* srTestCaseSetData */

2014-11-27T00:50:54Z

srTestCaseSetData

← Older revision		Revision as of 00:50, 27 November 2014
Line 534:		Line 534:
	void tfcase_setData(void)		void tfcase_setData(void)
	{		{
	srTestCaseSetData(srTEST_CASE_DEFAULT, "MyName", "my value);		srTestCaseSetData(srTEST_CASE_DEFAULT, "MyName", "my value");
	}		}

Marku at 15:03, 6 August 2014

2014-08-06T15:03:34Z

Show changes

Ivailop: /* method AddComment */

2014-08-02T00:41:24Z

method AddComment

← Older revision		Revision as of 00:41, 2 August 2014
Line 1,104:		Line 1,104:
	\| Input		\| Input
	\| Pointer to null-terminated string representing the new comment. Cannot be empty.		\| Pointer to null-terminated string representing the new comment. Cannot be empty.
	\|-
	~~\| ...~~
	~~\| Input (Optional)~~
	~~\| Variable argument list to format comment.~~
	\|}		\|}
	<br>		<br>

Ivailop: /* method AddAnnotation */

2014-08-02T00:39:36Z

method AddAnnotation

← Older revision		Revision as of 00:39, 2 August 2014
Line 994:		Line 994:
	\|-		\|-
	\| name		\| name
	\| Input ~~(Optional)~~		\| Input
	\| Pointer to null-terminated string that represents the name of the new annotation. If null, the default host naming scheme will be used.		\| Pointer to null-terminated string that represents the name of the new annotation. If null, the default host naming scheme will be used.
	\|-		\|-
	\| descr		\| descr
	\| Input ~~(Optional)~~		\| Input
	\| Pointer to null-terminated string representing the description of the new annotation. Cannot be null.		\| Pointer to null-terminated string representing the description of the new annotation. Cannot be null.
	\|}		\|}