TestStatus

TestStatus Enumeration

Inconclusive

Indicates that a condition can not be resolved as explicitly passing or failing. The discipline of "anything not explicitly passing should fail" is strongly discouraged. Something going wrong with a test because it was not properly configured makes it inconclusive. Only a genuine problem with the candidate code should explicitly fail the test. Inconclusive is also the default status if no results are found in a test. When evaluating overall status, Inconclusive takes precedence over Fail.

Fail

Indicates the explicit failure of a condition. This should only be used when improper behavior of the candidate code is the only likely cause.

Pass

Indicates that a condition passes. Coarse Grind treats a test as passing when it has at least one [TestResult] and no results are failing or inconclusive.

Member Methods

isPassing() - Returns true if the status is Pass.
isFailing() - Returns true if the status is Fail.
isInconclusive() - Returns true if the status is Inconclusive.
toString(String message) - This produces the boxed "Pass", "Fail" and "Stop" notices in Coarse Grind log files. The message parameter will be displayed next to it indicating what caused the status. (See also Text Effects)
toLogSystemLevel() - Unless the status is Pass returns LogSystem.Level.Critical. If the status is passing it returns LogSystem.Level.Standard instead. (See also the Level Enumeration of the LogSystem)
log(String message) - Uses the Global LogSystem instance to immediately log this status. This status will be logged using the toString() method above, passing along the message parameter. The logging priority level will be determined by toLogSystemLevel() above.
log(String message, LogSystem.Level requestedLevel) - Uses the Global LogSystem instance to immediately log this status at the specified level. This status will be logged using the toString() method above, passing along the message parameter.