[GROOVY-7474] Difference between junit3 and junit 4 shouldFail {...} not described in docs

• Type: Bug
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Fix Version/s: 2.4.4
• Component/s: Documentation
• Labels: contributers-welcome
• Assignee: Paul King
• Reporter: Dmitry Andreychuk
• Created: 22/Jun/15 14:57
• Updated: 21/Jul/15 10:30
• Resolved: 07/Jul/15 10:16

Description

Groovy language documentation chapter on junit4 (http://docs.groovy-lang.org/latest/html/documentation/#_junit_4) states that "shouldFail can be used the same way it can be used in a GroovyTestCase". In fact junit4 version returns exception while junit3 returns message.

I've spent quite a lot of time trying to figure out why shouldFail in my code returns an exception while documentation and tests say that it returns message. It turned out that I was reading documentation for a wrong shouldFail. But I've never thought that methods in GroovyTestCase and GroovyAssert may have different signature or semantic. A small notice in documentation might help others avoid this confusion. An example for junit 4 version would be nice too.