fi.jumi.api.drivers.TestNotifier Maven / Gradle / Ivy
// Copyright © 2011-2013, Esko Luontola
// This software is released under the Apache License 2.0.
// The license text is at http://www.apache.org/licenses/LICENSE-2.0
package fi.jumi.api.drivers;
public interface TestNotifier {
/**
* Notifies about a test failure.
*
* The test will fail if this method is called at least once,[1] otherwise the test will
* pass.[2]
*
* May be called multiple times.[3] Must be called on the current test,[4][5] i.e. the latest
* {@code TestNotifier} which is not yet finished.
*
* @reference [1]:
* failing_tests_are_tests_with_failures
* @reference
[2]:
* passing_tests_are_tests_without_failures
* @reference
[3]:
* a_test_with_multiple_failures_counts_as_just_one_failing_test
* @reference
[4]:
* fireFailure_must_be_called_on_the_current_test
* @reference
[5]:
* fireFailure_cannot_be_called_after_the_test_is_finished
*/
void fireFailure(Throwable cause);
/**
* Notifies about the end of a test execution.
*
* Must be called last, exactly once.[1] Must be called on the current test,[2] i.e. the
* latest {@code TestNotifier} which is not yet finished.
*
* @reference [1]:
* fireTestFinished_cannot_be_called_after_the_test_is_finished
* @reference
[2]:
* fireTestFinished_must_be_called_on_the_current_test
*/
/* TODO: add javadoc after implemented:
If the test started any threads, will wait for them to finish (except the AWT event thread and maybe some others).
It is an error (or at least a warning) for a test to start threads without stopping them.
*/
void fireTestFinished();
}