/**
* 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 <http://www.gnu.org/licenses/>.
*/
package ch.powerunit;
import java.util.concurrent.Callable;
import java.util.function.BiFunction;
import java.util.function.Function;
import ch.powerunit.exception.AssumptionError;
import ch.powerunit.impl.AssertThatExceptionImpl;
import ch.powerunit.impl.AssertThatIterableImpl;
import ch.powerunit.impl.AssertThatObjectImpl;
import ch.powerunit.impl.AssertThatStringImpl;
/**
* This is the assume features.
*
* @author borettim
*
*/
interface Assume {
/**
* Assume the value of an object. This is used to skipped the test if the
* assumption fail.
* <p>
* For instance
*
* <pre>
* assumeThat(myObject).is(myOtherObject);
* </pre>
*
* This will check that <code>myObject</code> is <code>myOtherObject</code>
* (using the <code>equalTo</code> Hamcrest matcher). <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param <T>
* the object type.
* @param obj
* the object
* @return {@link AssertThatCastableObject the assert DSL on this object}
*/
default <T> AssertThatCastableObject<T> assumeThat(T obj) {
return assumeThat(null, obj);
}
/**
* Assume the value of an object. This is used to skipped the test if the
* assumption fail.
* <p>
* For instance
*
* <pre>
* assumeThat("msg", myObject).is(myOtherObject);
* </pre>
*
* This will check that <code>myObject</code> is <code>myOtherObject</code>
* (using the <code>equalTo</code> Hamcrest matcher). <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param <T>
* the object type.
* @param msg
* a message
* @param obj
* the object
* @return {@link AssertThatCastableObject the assert DSL on this object}
*/
default <T> AssertThatCastableObject<T> assumeThat(String msg, T obj) {
return new AssertThatObjectImpl<T>(this, false, msg, () -> obj);
}
/**
* Assume the value of a String.
* <p>
* For instance
*
* <pre>
* assumeThat(myString).is("");
* </pre>
*
* This will check that <code>myString</code> is <code>""</code> (using the
* <code>equalTo</code> Hamcrest matcher). <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param obj
* the String
* @return {@link AssertThatString the assert DSL on this object}
*/
default AssertThatString assumeThat(String obj) {
return assumeThat(null, obj);
}
/**
* Assume the value of a String.
* <p>
* For instance
*
* <pre>
* assumeThat("msg", myString).is("");
* </pre>
*
* This will check that <code>myString</code> is <code>""</code> (using the
* <code>equalTo</code> Hamcrest matcher). <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param msg
* a message
* @param obj
* the String
* @return {@link AssertThatString the assert DSL on this object}
*/
default AssertThatString assumeThat(String msg, String obj) {
return new AssertThatStringImpl(this, true, msg, () -> obj);
}
/**
* Assume on an iterable object. This is used to skipped the test if the
* assumption fail.
* <p>
* For instance
*
* <pre>
* assumeThatIterable(myIterable).hasSize(0);
* </pre>
*
* This will check that <code>myIterable</code> has a size of 0. <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param <T>
* the element type.
* @param obj
* the object (Iterable)
* @return {@link AssertThatIterable the assert DSL on this iterable}
*/
default <T> AssertThatIterable<T> assumeThatIterable(Iterable<T> obj) {
return assumeThatIterable(null, obj);
}
/**
* Assume on an iterable object. This is used to skipped the test if the
* assumption fail.
* <p>
* For instance
*
* <pre>
* assumeThatIterable("msg", myIterable).hasSize(0);
* </pre>
*
* This will check that <code>myIterable</code> has a size of 0. <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param <T>
* the element type.
* @param msg
* a message
* @param obj
* the object (Iterable)
* @return {@link AssertThatIterable the assert DSL on this iterable}
*/
default <T> AssertThatIterable<T> assumeThatIterable(String msg,
Iterable<T> obj) {
return new AssertThatIterableImpl<T>(this, false, msg, () -> obj);
}
/**
* Assume on a function. This is used to skipped the test if the assumption
* fail.
* <p>
* The purpose of this variant of <i>assumeThat</i> provides a way to apply
* a function on some input and to check the result.
* <p>
* For instance
*
* <pre>
* assumeThatFunction((a) -> a + "x", "b").is("bx")
* </pre>
*
* This will pass the <code>b</code> string to the passed function (which
* add a <code>x</code> add the end of the string and then it will check
* that this string is <code>bx</code> (which is the case). <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param <T>
* the object type of the input of the function
* @param <R>
* the object type of the result
* @param function
* the function
* @param input
* the input to the function
* @return {@link AssertThatCastableObject then assert DSL on the result of
* the function}
*/
default <T, R> AssertThatCastableObject<R> assumeThatFunction(
Function<T, R> function, T input) {
return new AssertThatObjectImpl<R>(this, false, null,
() -> function.apply(input));
}
/**
* Assume on a function. This is used to skipped the test if the assumption
* fail.
* <p>
* The purpose of this variant of <i>assertThat</i> provides a way to apply
* a function on some input and to check the result.
* <p>
* For instance
*
* <pre>
* assumeThatFunction("msg", (a) -> a + "x", "b").is("bx")
* </pre>
*
* This will pass the <code>b</code> string to the passed function (which
* add a <code>x</code> add the end of the string and then it will check
* that this string is <code>bx</code> (which is the case). <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param <T>
* the object type of the input of the function
* @param <R>
* the object type of the result
* @param msg
* a message
* @param function
* the function
* @param input
* the input to the function
* @return {@link AssertThatCastableObject then assert DSL on the result of
* the function}
*/
default <T, R> AssertThatCastableObject<R> assumeThatFunction(String msg,
Function<T, R> function, T input) {
return new AssertThatObjectImpl<R>(this, false, msg,
() -> function.apply(input));
}
/**
* Assume on a bifunction.
* <p>
* The purpose of this variant of <i>assumeThat</i> provides a way to apply
* a bifunction on some input and to check the result.
* <p>
* For instance
*
* <pre>
* assumeThatBiFunction((a, b) -> a + b, "a", "b").is("ab")
* </pre>
*
* This will pass the <code>b</code> string to the passed function (which
* add a <code>x</code> add the end of the string and then it will check
* that this string is <code>bx</code> (which is the case). <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param <T>
* the object type of the first input of the function
* @param <U>
* the object type fo the second input of the function
* @param <R>
* the object type of the result
* @param function
* the function
* @param input1
* the first input to the function
* @param input2
* the second input to the function
* @return {@link AssertThatCastableObject then assert DSL on the result of
* the bifunction}
*/
default <T, U, R> AssertThatCastableObject<R> assumeThatBiFunction(
BiFunction<T, U, R> function, T input1, U input2) {
return new AssertThatObjectImpl<R>(this, false, null,
() -> function.apply(input1, input2));
}
/**
* Assume on a bifunction.
* <p>
* The purpose of this variant of <i>assumeThat</i> provides a way to apply
* a bifunction on some input and to check the result.
* <p>
* For instance
*
* <pre>
* assumeThatBiFunction((a, b) -> a + b, "a", "b").is("ab")
* </pre>
*
* This will pass the <code>b</code> string to the passed function (which
* add a <code>x</code> add the end of the string and then it will check
* that this string is <code>bx</code> (which is the case). <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param <T>
* the object type of the first input of the function
* @param <U>
* the object type fo the second input of the function
* @param <R>
* the object type of the result
* @param msg
* a message
* @param function
* the function
* @param input1
* the first input to the function
* @param input2
* the second input to the function
* @return {@link AssertThatCastableObject then assert DSL on the result of
* the bifunction}
*/
default <T, U, R> AssertThatCastableObject<R> assumeThatBiFunction(
String msg, BiFunction<T, U, R> function, T input1, U input2) {
return new AssertThatObjectImpl<R>(this, false, msg,
() -> function.apply(input1, input2));
}
/**
* Assume that a statement (a piece of code) throw an exception. This is
* used to skipped the test if the assumption fail.
* <p>
* The goal of <code>assumeWhen</code> is to provide a way to validate that
* an exception is thrown.
* <p>
* For instance
*
* <pre>
* assumeWhen((p) -> {
* throw new Throwable("test");
* }).throwException(exceptionMessage("test"));
* </pre>
*
* Will run a piece of code that always thrown an exception and then
* validate that the message of the exception is <code>test</code>. <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param underTest
* the {@link Statement} <code>(p)->{}</code>
* @return {@link AssertThatException the assert DSL on the exception}
* @param <T>
* the exception type
*/
default <T extends Throwable> AssertThatException<T> assumeWhen(
Statement<?, T> underTest) {
return assumeWhen(null, underTest, null);
}
/**
* Assume that a statement (a piece of code) throw an exception. This is
* used to skipped the test if the assumption fail.
* <p>
* The goal of <code>assumeWhen</code> is to provide a way to validate that
* an exception is thrown. <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param underTest
* the {@link Callable}
* @return {@link AssertThatException the assert DSL on the exception}
* @param <T>
* the exception type
* @since 0.4.0
*/
default <T extends Exception> AssertThatException<T> assumeWhen(
Callable<?> underTest) {
return assumeWhen(null, (p) -> {
underTest.call();
}, null);
}
/**
* Assume that a statement (a piece of code) throw an exception. This is
* used to skipped the test if the assumption fail.
* <p>
* The goal of <code>assumeWhen</code> is to provide a way to validate that
* an exception is thrown.
* <p>
* For instance
*
* <pre>
* assumeWhen((p) -> {
* throw new Throwable("test");
* }, null).throwException(exceptionMessage("test"));
* </pre>
*
* Will run a piece of code, passing null as parameter, that always thrown
* an exception and then validate that the message of the exception is
* <code>test</code>. <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param underTest
* the {@link Statement} <code>(p)->{}</code>
* @param param
* the parameter for the statement underTest
* @param <P>
* the type of the parameter
* @param <T>
* the exception type
* @return {@link AssertThatException the assert DSL on the exception}
*
*/
default <P, T extends Throwable> AssertThatException<T> assumeWhen(
Statement<P, T> underTest, P param) {
return assumeWhen(null, underTest, param);
}
/**
* Assume that a statement (a piece of code) throw an exception. This is
* used to skipped the test if the assumption fail.
* <p>
* The goal of <code>assumeWhen</code> is to provide a way to validate that
* an exception is thrown.
* <p>
* For instance
*
* <pre>
* assumeWhen("msg", (p) -> {
* throw new Throwable("test");
* }).throwException(exceptionMessage("test"));
* </pre>
*
* Will run a piece of code that always thrown an exception and then
* validate that the message of the exception is <code>test</code>. <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param msg
* a message
* @param underTest
* the statement <code>(p)->{}</code>
* @return {@link AssertThatException the assert DSL on the exception}
* @param <T>
* the exception type
*/
default <T extends Throwable> AssertThatException<T> assumeWhen(String msg,
Statement<?, T> underTest) {
return assumeWhen(msg, underTest, null);
}
/**
* Assume that a statement (a piece of code) throw an exception. This is
* used to skipped the test if the assumption fail.
* <p>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param msg
* a message
* @param underTest
* the callable
* @return {@link AssertThatException the assert DSL on the exception}
* @param <T>
* the exception type
*/
default <T extends Exception> AssertThatException<T> assumeWhen(String msg,
Callable<?> underTest) {
return assumeWhen(msg, (p) -> {
underTest.call();
}, null);
}
/**
* Assume that a statement (a piece of code) throw an exception. This is
* used to skipped the test if the assumption fail.
* <p>
* The goal of <code>assumeWhen</code> is to provide a way to validate that
* an exception is thrown.
* <p>
* For instance
*
* <pre>
* assumeWhen("msg", (p) -> {
* throw new Throwable("test");
* }, null).throwException(exceptionMessage("test"));
* </pre>
*
* Will run a piece of code, passing null as parameter, that always thrown
* an exception and then validate that the message of the exception is
* <code>test</code>. <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param msg
* a message
* @param underTest
* the statement <code>(p)->{}</code>
* @param param
* the parameter for the statement underTest
* @param <P>
* the type of the parameter
* @param <T>
* the exception type
* @return {@link AssertThatException the assert DSL on the exception}
*
*
*/
default <P, T extends Throwable> AssertThatException<T> assumeWhen(
String msg, Statement<P, T> underTest, P param) {
return new AssertThatExceptionImpl<P, T>(this, false, underTest, param,
msg);
}
/**
* Assume that a function throw an exception. As {@link Function} signature
* doesn't throws exception, it should be a RuntimeException. <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param msg
* a message
* @param function
* the function to be executed and that should return an
* exception
* @param param
* the parameter to be passed to the function.
* @param <P>
* the type of the parameter
* @param <T>
* the exception type
* @return {@link AssertThatException the assert DSL on the exception}
*
* @since 0.3.0
*/
default <P, T extends RuntimeException> AssertThatException<T> assumeWhenFunction(
String msg, Function<P, ?> function, P param) {
return assumeWhen(msg, (p) -> function.apply(p), param);
}
/**
* Assume that a function throw an exception. As {@link Function} signature
* doesn't throws exception, it should be a RuntimeException. <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param function
* the function to be executed and that should return an
* exception
* @param param
* the parameter to be passed to the function.
* @param <P>
* the type of the parameter
* @param <T>
* the exception type
* @return {@link AssertThatException the assert DSL on the exception}
*
* @since 0.3.0
*/
default <P, T extends RuntimeException> AssertThatException<T> assumeWhenFunction(
Function<P, ?> function, P param) {
return assumeWhen((p) -> function.apply(p), param);
}
/**
* Assume that a bifunction throw an exception. As {@link BiFunction}
* signature doesn't throws exception, it should be a RuntimeException. <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param msg
* a message
* @param bifunction
* the bifunction to be executed and that should return an
* exception
* @param param1
* the first parameter to be used.
* @param param2
* the second parameter to be used.
* @return {@link AssertThatException the assert DSL on the exception}
* @param <P1>
* the type of the first parameter
* @param <P2>
* the type of the second parameter
* @param <T>
* the exception type
* @since 0.3.0
*/
default <P1, P2, T extends RuntimeException> AssertThatException<T> assumeWhenBiFunction(
String msg, BiFunction<P1, P2, ?> bifunction, P1 param1, P2 param2) {
return assumeWhen(msg, (p) -> bifunction.apply(param1, param2));
}
/**
* Assume that a bifunction throw an exception. As {@link BiFunction}
* signature doesn't throws exception, it should be a RuntimeException. <br>
* <br>
* <i>By default, assumeThat can only be used from the main thread of the
* test ; When used from another thread, the assumption will be lost.</i>
*
* @param bifunction
* the bifunction to be executed and that should return an
* exception
* @param param1
* the first parameter to be used.
* @param param2
* the second parameter to be used.
* @return {@link AssertThatException the assert DSL on the exception}
* @param <P1>
* the type of the first parameter
* @param <P2>
* the type of the second parameter
* @param <T>
* the exception type
* @since 0.3.0
*/
default <P1, P2, T extends RuntimeException> AssertThatException<T> assumeWhenBiFunction(
BiFunction<P1, P2, ?> bifunction, P1 param1, P2 param2) {
return assumeWhen((p) -> bifunction.apply(param1, param2));
}
/**
* Always produce a skip.
* <p>
* For instance :
*
* <pre>
* skip();
* </pre>
*
* will immediately skip the current test. <br>
* <br>
* <i>By default, skip can only be used from the main thread of the test ;
* When used from another thread, the assumption will be lost.</i>
*/
default void skip() {
skip("Manual skip");
}
/**
* Always produce a skip.
* <p>
* For instance :
*
* <pre>
* skip("my message");
* </pre>
*
* will immediately skip the current test. <br>
* <br>
* <i>By default, skip can only be used from the main thread of the test ;
* When used from another thread, the assumption will be lost.</i>
*
* @param msg
* a message
*/
default void skip(String msg) {
throw new AssumptionError(msg);
}
}