[HBASE-15919] Document @Rule vs @ClassRule. Also clarify timeout limits are on TestCase.

• Type: Sub-task
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.0.0
• Hadoop Flags: Reviewed
• Assignee: Apekshit Sharma
• Reporter: Apekshit Sharma
• Created: 31/May/16 04:39
• Updated: 31/May/16 20:03
• Resolved: 31/May/16 17:13

Description

Our timeout for tests is not clear in the refguide. Our @Rule based CategoryBased timeout is for each individual test when the timeout it seems is for the whole testcase... all the tests that make up the test class. This issue is about cleaning up any abiguity and promoting the new change added over in HBASE-15915 by @appy for a @ClassRule

Cleanup refguide on what timeout applys to.

Add section on how to add timeouts to tests.

See HBASE-15915 tail for some notes on what to add to doc.

Issue Links

• links to: Review Board (master)