I would have to agree with adrianh that the test suite is maybe not the place to do this. His suggestion about using the SCM comments is a good one, but I would take that a step further as well, and enter the information about the bug, how it was fixed, and where it is tested in some RT-like bug-tracking application.

... given a specific bug-ID, could you tell me: a) if it is being tested by the regression test suite; and b) which bit of unit test code actually tests that bug.

All this could then be accomplished by just viewing the comments about the bug. And since what you are asking to look at is really best viewed from the POV of the bug, the bug-tracking application seems to me the logical place for it.

As for how to accomplish this with your test-cases and test-plans, I would reccommend the same approach (assuming you have an application or document that keeps track of these things, and you can add information to said document).

Another thought might be to place specific bug-fix test code into seperate files, which are then included with do or some kind of pre-processing into the larger test suite. This would allow you to still retain the larger structure of the tests, while being able to keep the bug-fix tests in their own seperate files. This would allow you to reference that single file in your bug-tracking application, and put more in depth comments in the file. Of course you still need to worry about the tendency of comments and code to fall out of sync, but being that the whole file will be specific to this one bug-fix, it is possible this may not happen (at least not as easily).

---

---

• Are you posting in the right place? Check out Where do I post X? to know for sure.
• Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:

  <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>

• Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
• Want more info? How to link or How to display code and escape characters are good places to start.