lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2026-01-06 11:41:12 +03:00
Code Activity

Add documentation and minor style changes

Browse Source 
Add doxygen style documentation to `mbedtls_test_fail`, `mbedtls_test_skip`,
`mbedtls_test_set_step` and `mbedtls_test_info_reset`. This should make it
easier to understand how the test infrastructure is used.

Also make some minor style changes to meet the coding standards and make it
more obvious that `mbedtls_test_info.step` was being incremented.

Signed-off-by: Chris Jones <christopher.jones@arm.com>
This commit is contained in:
Chris Jones
2021-02-03 12:07:01 +00:00
parent a5ab765832
commit 567e0ad8f1
4 changed files with 33 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
tests/include/test/helpers.h
View File

@@ -70,19 +70,42 @@ extern mbedtls_test_info_t mbedtls_test_info;
int mbedtls_test_platform_setup( void );
void mbedtls_test_platform_teardown( void );
/**
* \brief Record the given, usually current, test as a failure.
*
* \param test Name of the test to fail.
* \param line_no Line number where the failure originated.
* \param filename Filename where the failure originated.
*/
void mbedtls_test_fail( const char *test, int line_no, const char* filename );
/**
* \brief Record the given, usually current, test as skipped.
*
* \param test Name of the test to skip.
* \param line_no Line number where the test skipped.
* \param filename Filename where the test skipped.
*/
void mbedtls_test_skip( const char *test, int line_no, const char* filename );
/** Set the test step number for failure reports.
/**
* \brief Set the test step number for failure reports.
*
* Call this function to display "step NNN" in addition to the line number
* and file name if a test fails. Typically the "step number" is the index
* of a for loop but it can be whatever you want.
* \note Call this function to display "step NNN" in addition to the
* line number and file name if a test fails. Typically the "step
* number" is the index of a for loop but it can be whatever you
* want.
*
* \param step The step number to report.
*/
void mbedtls_test_set_step( unsigned long step );
/**
* \brief Reset mbedtls_test_info to a ready/starting state.
*
* \note Clears the test, line_no, filename, step and result from any
* previously stored values and initialises them ready to be used.
*/
void mbedtls_test_info_reset( void );
/**