SendMessageRetryablePredicates.java

package fr.sii.ogham.core.builder.configurer;

import static fr.sii.ogham.core.util.ExceptionUtils.fatalJvmError;
import static fr.sii.ogham.core.util.ExceptionUtils.hasAnyCause;

import java.util.function.Predicate;

import fr.sii.ogham.core.exception.InvalidMessageException;
import fr.sii.ogham.core.exception.filler.FillMessageException;
import fr.sii.ogham.core.exception.handler.NoContentException;
import fr.sii.ogham.core.exception.handler.TemplateNotFoundException;
import fr.sii.ogham.core.exception.handler.TemplateParsingFailedException;
import fr.sii.ogham.core.exception.mimetype.MimeTypeDetectionException;
import fr.sii.ogham.core.exception.resource.ResourceResolutionException;
import fr.sii.ogham.core.exception.template.ContextException;
import fr.sii.ogham.core.exception.template.EngineDetectionException;
import fr.sii.ogham.core.exception.template.ParseException;
import fr.sii.ogham.core.exception.util.BeanException;
import fr.sii.ogham.core.util.ExceptionUtils;

/**
 * Predicate that skip retry if one of theses condition is met:
 * 
 * <ul>
 * <li>The error is a JVM error that should not be ignored</li>
 * <li>If the error is due to a preparation error (not sending). In this case,
 * retrying will result in the same behavior so it will fail again:
 * <ul>
 * <li>It is a parsing error</li>
 * <li>The message in not valid</li>
 * <li>A resource associated to the message can't be resolved</li>
 * <li>The mimetype of a resource couldn't be determined</li>
 * </ul>
 * </li>
 * </ul>
 * 
 * <p>
 * In other situations, the message may be sent again.
 * 
 * 
 * @author Aurélien Baudet
 *
 */
public final class SendMessageRetryablePredicates {

	private SendMessageRetryablePredicates() {
		super();
	}

	/**
	 * Predicate that skip retry if one of theses condition is met:
	 * 
	 * <ul>
	 * <li>The error is a JVM error that should not be ignored</li>
	 * <li>If the error is due to a preparation error (not sending). In this
	 * case, retrying will result in the same behavior so it will fail again:
	 * <ul>
	 * <li>It is a parsing error</li>
	 * <li>The message in not valid</li>
	 * <li>A resource associated to the message can't be resolved</li>
	 * <li>The mimetype of a resource couldn't be determined</li>
	 * </ul>
	 * </li>
	 * </ul>
	 * 
	 * <p>
	 * In other situations, the message may be sent again.
	 * 
	 * @param error
	 *            the error to analyze
	 * @return true if the message can be sent again
	 */
	@SuppressWarnings("squid:S1126")
	public static boolean canResendMessage(Throwable error) {
		if (fatalJvmError(error) || isMessagePreparationError(error)) {
			return false;
		}
		if (hasAnyCause(error, ExceptionUtils::fatalJvmError) || hasAnyCause(error, SendMessageRetryablePredicates::isMessagePreparationError)) {
			return false;
		}
		return true;
	}

	/**
	 * Checks is raised during preparation of the message.
	 * 
	 * <p>
	 * The error may be due to:
	 * <ul>
	 * <li>Either a parsing error</li>
	 * <li>Or the message in not valid</li>
	 * <li>Or a resource can't be resolved</li>
	 * <li>Or the mimetype of a resource couldn't be determined</li>
	 * </ul>
	 * 
	 * <p>
	 * In these cases, retrying will always give the same result so there is no
	 * point in retrying.
	 * 
	 * @param error
	 *            the error to analyze
	 * @return true if the error is raised during preparation of the message
	 */
	public static boolean isMessagePreparationError(Throwable error) {
		// @formatter:off
		return parsingFailed(error) 
				|| messageIsInvalid(error) 
				|| resourceIsUnresolved(error) 
				|| mimetypeIsUndetectable(error)
				|| developerError(error);
		// @formatter:on
	}

	/**
	 * Indicates if the error is raised during template parsing.
	 * 
	 * @param error
	 *            the error to analyze
	 * @return true if it is a parsing error
	 */
	public static boolean parsingFailed(Throwable error) {
		// @formatter:off
		return error instanceof ParseException 
				|| error instanceof BeanException 
				|| error instanceof EngineDetectionException 
				|| error instanceof ContextException
				|| error instanceof TemplateParsingFailedException 
				|| error instanceof TemplateNotFoundException
				|| error instanceof NoContentException;
		// @formatter:on
	}

	/**
	 * Indicates if the error is raised because the message is invalid.
	 * 
	 * @param error
	 *            the error to analyze
	 * @return true if the message is invalid
	 */
	public static boolean messageIsInvalid(Throwable error) {
		// @formatter:off
		return error instanceof InvalidMessageException 
				|| error instanceof FillMessageException;
		// @formatter:on
	}

	/**
	 * Indicates if the error is raised because a resource can't be resolved.
	 * 
	 * @param error
	 *            the error to analyze
	 * @return true if a resource can't be resolved
	 */
	public static boolean resourceIsUnresolved(Throwable error) {
		return error instanceof ResourceResolutionException;
	}

	/**
	 * Indicates if the error is raised because a resource mimetype can't be
	 * determined.
	 * 
	 * @param error
	 *            the error to analyze
	 * @return true if a resource mimetype can't be determined
	 */
	public static boolean mimetypeIsUndetectable(Throwable error) {
		return error instanceof MimeTypeDetectionException;
	}

	/**
	 * Indicates if the error is raised because the developer has misconfigured
	 * or has used an illegal value ( {@link IllegalArgumentException},
	 * {@link NullPointerException}, ...).
	 * 
	 * @param error
	 *            the error to analyze
	 * @return true if developer has used an illegal value
	 */
	public static boolean developerError(Throwable error) {
		// @formatter:off
		return error instanceof IllegalArgumentException
				|| error instanceof NullPointerException;
		// @formatter:on
	}

	/**
	 * Predicate that skip retry if one of theses condition is met:
	 * 
	 * <ul>
	 * <li>The error is a JVM error that should not be ignored</li>
	 * <li>If the error is due to a preparation error (not sending). In this
	 * case, retrying will result in the same behavior so it will fail again:
	 * <ul>
	 * <li>It is a parsing error</li>
	 * <li>The message in not valid</li>
	 * <li>A resource associated to the message can't be resolved</li>
	 * <li>The mimetype of a resource couldn't be determined</li>
	 * </ul>
	 * </li>
	 * </ul>
	 * 
	 * <p>
	 * In other situations, the message may be sent again.
	 * 
	 * @return the predicate
	 */
	public static Predicate<Throwable> canResendMessage() {
		return SendMessageRetryablePredicates::canResendMessage;
	}
}


















Active mutators

org.pitest.mutationtest.engine.gregor.mutators.BooleanFalseReturnValsMutator
org.pitest.mutationtest.engine.gregor.mutators.BooleanTrueReturnValsMutator
org.pitest.mutationtest.engine.gregor.mutators.ConditionalsBoundaryMutator
org.pitest.mutationtest.engine.gregor.mutators.EmptyObjectReturnValsMutator
org.pitest.mutationtest.engine.gregor.mutators.IncrementsMutator
org.pitest.mutationtest.engine.gregor.mutators.InvertNegsMutator
org.pitest.mutationtest.engine.gregor.mutators.MathMutator
org.pitest.mutationtest.engine.gregor.mutators.NegateConditionalsMutator
org.pitest.mutationtest.engine.gregor.mutators.NullReturnValsMutator
org.pitest.mutationtest.engine.gregor.mutators.PrimitiveReturnsMutator
org.pitest.mutationtest.engine.gregor.mutators.VoidMethodCallMutator

Tests examined

Report generated by PIT OGHAM

1		package fr.sii.ogham.core.builder.configurer;
2
3		import static fr.sii.ogham.core.util.ExceptionUtils.fatalJvmError;
4		import static fr.sii.ogham.core.util.ExceptionUtils.hasAnyCause;
5
6		import java.util.function.Predicate;
7
8		import fr.sii.ogham.core.exception.InvalidMessageException;
9		import fr.sii.ogham.core.exception.filler.FillMessageException;
10		import fr.sii.ogham.core.exception.handler.NoContentException;
11		import fr.sii.ogham.core.exception.handler.TemplateNotFoundException;
12		import fr.sii.ogham.core.exception.handler.TemplateParsingFailedException;
13		import fr.sii.ogham.core.exception.mimetype.MimeTypeDetectionException;
14		import fr.sii.ogham.core.exception.resource.ResourceResolutionException;
15		import fr.sii.ogham.core.exception.template.ContextException;
16		import fr.sii.ogham.core.exception.template.EngineDetectionException;
17		import fr.sii.ogham.core.exception.template.ParseException;
18		import fr.sii.ogham.core.exception.util.BeanException;
19		import fr.sii.ogham.core.util.ExceptionUtils;
20
21		/**
22		* Predicate that skip retry if one of theses condition is met:
23		*
24		* <ul>
25		* <li>The error is a JVM error that should not be ignored</li>
26		* <li>If the error is due to a preparation error (not sending). In this case,
27		* retrying will result in the same behavior so it will fail again:
28		* <ul>
29		* <li>It is a parsing error</li>
30		* <li>The message in not valid</li>
31		* <li>A resource associated to the message can't be resolved</li>
32		* <li>The mimetype of a resource couldn't be determined</li>
33		* </ul>
34		* </li>
35		* </ul>
36		*
37		* <p>
38		* In other situations, the message may be sent again.
39		*
40		*

SendMessageRetryablePredicates.java

Mutations

Active mutators

Tests examined