On Thu, Apr 29, 2010 at 8:04 PM, Steve Huston <shus...@riverace.com> wrote: > (This goes for all the tests, not just Java.
Totally agreed ! I thought I'd start with Java and see how the reaction is :) Rajith >> -----Original Message----- >> From: Rajith Attapattu [mailto:rajit...@gmail.com] >> Sent: Thursday, April 29, 2010 6:03 PM >> To: dev@qpid.apache.org >> Subject: Understanding Java Tests >> >> >> Hi All, >> >> Sometimes it's very difficult to understand the intent of a >> test case by just reading the code, especially if the test >> itself is wrong or has bugs. >> >> Therefore may I kindly ask anybody who writes a new test case >> or debugs/works on an existing test case to document the following . >> >> 1. Goal : What the test is trying to achieve. >> 2. Strategy : How the test is constructed to achieve the above goal. >> >> Obviously we don't need to document every test out there, as >> some tests are very simple and where you can easily >> understand by just reading the code. But we do have a hell of >> a lot of tests that are not trivial. For these test cases >> it's important we document the above. It makes peoples life >> easy as they don't have to pull their hair & curse while >> trying to guess what the original intent was. Also it helps >> to identify if the test is wrong or if it's buggy. >> >> So if you are working on an existing or new test case, please >> be considerate and try to document it if it's not trivial. >> >> Regards, >> >> Rajith Attapattu >> Red Hat >> http://rajith.2rlabs.com/ >> >> --------------------------------------------------------------------- >> Apache Qpid - AMQP Messaging Implementation >> Project: http://qpid.apache.org >> Use/Interact: mailto:dev-subscr...@qpid.apache.org >> >> > > > --------------------------------------------------------------------- > Apache Qpid - AMQP Messaging Implementation > Project: http://qpid.apache.org > Use/Interact: mailto:dev-subscr...@qpid.apache.org > > -- Regards, Rajith Attapattu Red Hat http://rajith.2rlabs.com/ --------------------------------------------------------------------- Apache Qpid - AMQP Messaging Implementation Project: http://qpid.apache.org Use/Interact: mailto:dev-subscr...@qpid.apache.org
