[asterisk-dev] [Code Review] Unit Test Framework

[Russell Bryant]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/447/#review1301
-----------------------------------------------------------


Here is a first pass on comments ... it's time for me to go home now.  :-)


/trunk/include/asterisk/test.h
<https://reviewboard.asterisk.org/r/447/#comment2989>

    just 2009



/trunk/include/asterisk/test.h
<https://reviewboard.asterisk.org/r/447/#comment2990>

    This header file needs defines to protect against multiple includes.  See other headers for something like ...
    
    #ifndef __AST_TEST_H__
    #define __AST_TEST_H__
    
    ...
    
    #endif /* __AST_TEST_H__ */



/trunk/include/asterisk/test.h
<https://reviewboard.asterisk.org/r/447/#comment2991>

    It would be awesome if you could doxygenify this comment block.



/trunk/include/asterisk/test.h
<https://reviewboard.asterisk.org/r/447/#comment2992>

    What is an example that you hit that broke it?



/trunk/include/asterisk/test.h
<https://reviewboard.asterisk.org/r/447/#comment2994>

    Put this in include/asterisk/_private.h



/trunk/include/asterisk/test.h
<https://reviewboard.asterisk.org/r/447/#comment2993>

    Use ...
    
    \retval 0 success
    \retval -1 failure



/trunk/include/asterisk/test.h
<https://reviewboard.asterisk.org/r/447/#comment2996>

    Do we expect these to be used anywhere else other than the CLI functions?  If not, there is no reason to make them public API calls.
    
    We can always make them public API calls later if needed.



/trunk/include/asterisk/test.h
<https://reviewboard.asterisk.org/r/447/#comment2995>

    Kill trailing whitespace



/trunk/main/test.c
<https://reviewboard.asterisk.org/r/447/#comment2997>

    2009



/trunk/main/test.c
<https://reviewboard.asterisk.org/r/447/#comment2998>

    Since ast_test_init() is outside of your ifdef block, Asterisk will fail to link if you disabled TEST_FRAMEWORK.



/trunk/tests/test_heap.c
<https://reviewboard.asterisk.org/r/447/#comment2999>

    Do you think it would be useful to pass the CLI fd down to test functions to give them the ability to provide status output as tests execute?


- Russell


On 2009-12-15 18:15:17, David Vossel wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviewboard.asterisk.org/r/447/
> -----------------------------------------------------------
> 
> (Updated 2009-12-15 18:15:17)
> 
> 
> Review request for Asterisk Developers and Russell Bryant.
> 
> 
> Summary
> -------
> 
> The Unit Test Framework is a new API that manages registration and execution of unit tests in Asterisk with the purpose of verifying the operation of C functions.
> 
> The Framework consists of a single test manager accompanied by a list of registered test functions defined within the code.  A test is defined, registered, and unregistered from the framework using a set of macros which allow the test code to only be compiled within asterisk when the TEST_FRAMEWORK flag is enabled in menuselect.  This allows the test code to exist in the same file as the C functions it intends to verify.  Registered tests may be viewed and executed via a set of new CLI commands.  CLI commands are also present for generating and exporting test results into xml and txt formats.
> 
> For more information and use cases please refer to the documentation provided at the beginning of the test.h file.
> 
> 
> Diffs
> -----
> 
>   /trunk/build_tools/cflags-devmode.xml 235225 
>   /trunk/include/asterisk/test.h PRE-CREATION 
>   /trunk/main/asterisk.c 235225 
>   /trunk/main/test.c PRE-CREATION 
>   /trunk/tests/test_heap.c 235225 
> 
> Diff: https://reviewboard.asterisk.org/r/447/diff
> 
> 
> Testing
> -------
> 
> test_heap.c has been modified to take advantage of the Test Framework.  I have executed and generated reports for these tests. 
> 
> 
> Thanks,
> 
> David
> 
>