ch.powerunit.Test Maven / Gradle / Ivy
Show all versions of powerunit Show documentation
/**
* Powerunit - A JDK1.8 test framework
* Copyright (C) 2014 Mathieu Boretti.
*
* This file is part of Powerunit
*
* Powerunit is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Powerunit is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Powerunit. If not, see
* This method must be public, non static, 0-arg, void return.
*
* @author borettim
*
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Test {
/**
* Define an alternative name for the test.
*
* If not used, the test name will be based on the method name. In case of
* parameterized test, the name will be formatted in the same way that the
* {@link Parameters @Parameters} annotation will be.
*
* @return the name
* @see Parameters#value() For the exact syntax of the name model.
* @see java.text.MessageFormat#format(String, Object...) The formatter used
* for parameterized test. For version before 0.4.0.
* @see java.lang.String#format(String, Object...) The formatter used for
* parameterized test, since version 0.4.0.
*/
String name() default "";
/**
* Define if the test must fail at the first assertion/failure in error
* (default) or only at the end (and accumulate all expected error).
*
* The goal is here to change the fail assertion and failure work ; When set
* to false. Assertion/failure will not stop the test, but
* return false. It is up to the test itself to define what to be done based
* on this return value (continue, return, etc). At the end of the test, if
* any failure happened, a general failure will be produced, with detail
* regarding all failures.
* For example, a test may look like :
*
*
* public class LaterFailureTest implements TestSuite {
* @Test(fastFail = false)
* public void test() {
* assertThat(true).is(false);
* assertWhen((p) -> {
* }).throwException(any(Throwable.class));
* fail("demo");
* }
* }
*
*
* And the result like:
*
*
* Multiple failures :
* Error : expecting <false> but was <true>
* Error : An exception was expected, but none was thrown
* Error : demo
*
* Original Stack Traces
* expecting <false> but was <true>
* ch.powerunit.impl.AssertThatObjectImpl.is(AssertThatObjectImpl.java:63)
* ...
* An exception was expected, but none was thrown
* ch.powerunit.impl.AssertThatExceptionImpl.throwException(AssertThatExceptionImpl.java:64)
* ...
* demo
* ch.powerunit.Assert.fail(Assert.java:578)
* ...
*
* ch.powerunit.impl.TestContextImpl.fail(TestContextImpl.java:115)
* ch.powerunit.impl.DefaultPowerUnitRunnerImpl.lambda$null$104(DefaultPowerUnitRunnerImpl.java:505)
* ch.powerunit.impl.DefaultPowerUnitRunnerImpl$$Lambda$38/665188480.run(Unknown Source)
* ch.powerunit.impl.DefaultPowerUnitRunnerImpl.lambda$runOne$73(DefaultPowerUnitRunnerImpl.java:226)
* ch.powerunit.impl.DefaultPowerUnitRunnerImpl$$Lambda$42/520022247.accept(Unknown Source)
* java.util.HashMap$EntrySet.forEach(HashMap.java:1035)
* ch.powerunit.impl.DefaultPowerUnitRunnerImpl.runOne(DefaultPowerUnitRunnerImpl.java:210)
* ch.powerunit.impl.DefaultPowerUnitRunnerImpl.run(DefaultPowerUnitRunnerImpl.java:144)
* ch.powerunit.PowerUnitMainRunner.main(PowerUnitMainRunner.java:82)
* ch.powerunit.suite.Suites.main(Suites.java:73)
*
*
*
* This function will only function in the following case :
*
* - The assertion method is used from the same thread that the test
* itself (it is the standard case).
* - The assertion method is used directement from the object test, and
* this class implements {@link TestSuite}.
*
*
* Examples
* Using two threads without fastFail
* Let's assume the following test class :
*
*
* import ch.powerunit.Rule;
* import ch.powerunit.Test;
* import ch.powerunit.TestRule;
* import ch.powerunit.TestSuite;
*
* public class MyBean4Test implements TestSuite {
* @Rule
* public final TestRule rule = before(this::prepare);
*
* private MyBean bean;
*
* private void prepare() {
* bean = new MyBean();
* }
*
* @Test()
* public void testSimple() throws Exception {
* Thread t = new Thread(() -> {
* bean.setField1("y");
* assertThat(bean.getField1()).is("x");
* });
* t.start();
* t.join();
* }
* }
*
*
* This test will not fail!. Why ? because simply the assertion
* failure happend in another thread, so this thread receive an assertion
* failure, not the once supporting the test.
*
* Using two threads inside the same class, with fastFail
* Let's assume the following test class
*
*
* import ch.powerunit.Rule;
* import ch.powerunit.Test;
* import ch.powerunit.TestRule;
* import ch.powerunit.TestSuite;
*
* public class MyBean3Test implements TestSuite {
* @Rule
* public final TestRule rule = before(this::prepare);
*
* private MyBean bean;
*
* private void prepare() {
* bean = new MyBean();
* }
*
* @Test(fastFail = false)
* public void testSimple() throws Exception {
* Thread t = new Thread(() -> {
* bean.setField1("y");
* assertThat(bean.getField1()).is("x");
* });
* t.start();
* t.join();
* }
* }
*
*
* This test will fail!. Why ? because the fastFail mode will make
* the assertThat method only register the failure, and produce
* an error in the test thread. the link between the two threads is found
* because the assertThat method used is the one from the test
* class itself.
*
* @return true by default.
* @since 0.4.0
*/
boolean fastFail() default true;
}