Re: [Oorexx-devel] Revised TestUnit for array~makestring

[Rony G. F. <Ron...@wu...>]

Ad the header of your testunit program:

--------------- cut here -------------
#!/usr/bin/rexx
/*
   name:             array_makestring.testUnit
   author:           Lee Peedin
   date:             2007-10-05
   version:          0.1
   changed:

   languageLevel:    3.2 Rev 872 (Windows)
   purpose:          Test the makeString method of the array class

   remark:           First written to test patch "[ 1807755 ] Patch For RFE 1138618"
                     Added additional tests for normal operation

   license:          CPL 1.0 (Common Public License v1.0, see below)
   link:

   category1:        ooRexx
   category2:        ?
   category3:        ?

*/
--------------- cut here -------------


Just a suggestion, you should use in this case the following categorizations:

   category1:        ooRexx
   category2:        base
   category3:        class
   category4:        array
   category5:        makeString

Explanation: the header file of a standard formatted testunit program gets parsed such, that each word at the beginning of a line which is followed by a colon is taken as an index and the text following thereafter and all subsequent lines until one with a word followed immediately by a colon are hit. (This happens only within the very first comment block.)

So with other words: the framework will extract the top part and enter the information in a directory object and store it withe test unit class object, such that interested programs can get at those values (e.g. author, version, change history etc.) easily and use that e.g. for reports, statistics etc.

The value of this kind of "meta" information may become important sometimes in an unforeseeable future, if for one reason or another such an analysis is needed. But to do that one would *always* really need to supply these values while creating/changing a testcase.

---

Ad suggested values above: "category1" should name the domain for which the test unit got created, "category2" should indicate a subcategory (belongs to the "base" of the language), "category3" indicates it tests an ooRexx "class", "category4" hints it is for the Array class, category5 in your case would indicate that the tests are specifically for the "makeString" method.

This is just a suggested convention, you may choose whatever categorizations may make sense in the context of the application you test.

---rony