BIND 10 #2350: Define a framework for unit-test documentation

[BIND 10 Development]

#2350: Define a framework for unit-test documentation
-------------------------------------+-------------------------------------
            Reporter:  tomek         |                        Owner:
                Type:  task          |                       Status:  new
            Priority:  medium        |                    Milestone:  DHCP
           Component:                |  2012
  documentation                      |                     Keywords:
           Sensitive:  0             |              Defect Severity:  N/A
         Sub-Project:  DHCP          |  Feature Depending on Ticket:
Estimated Difficulty:  0             |          Add Hours to Ticket:  0
         Total Hours:  0             |                    Internal?:  0
-------------------------------------+-------------------------------------
 Many unit-tests lack description of their scope and purpose. It would be
 useful to have a consistent way to document them.

 One simple approach to that problem is to define a macro that will call
 TEST and TEST_F macros from gtest, but will take additional parameter(s).

 Such additional parameter would be test description.
 Another parameter to consider would be the component the test is covering
 (auth, resolver, dhcp4, dhcp6 etc.)

 With such extension, it would be possible to write a script that will
 parse all unit-test code and generate test report. Together with
 GTEST_OUTPUT=xml:results.xml passed to unit-tests, it would allow us to
 generate a proper test report that could be further processed.

-- 
Ticket URL: <http://bind10.isc.org/ticket/2350>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development