AutoDetectTemplateParser.java

package fr.sii.ogham.core.template.parser;

import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import fr.sii.ogham.core.exception.template.EngineDetectionException;
import fr.sii.ogham.core.exception.template.NoEngineDetectionException;
import fr.sii.ogham.core.exception.template.ParseException;
import fr.sii.ogham.core.message.content.Content;
import fr.sii.ogham.core.resource.path.ResourcePath;
import fr.sii.ogham.core.template.context.Context;
import fr.sii.ogham.core.template.detector.TemplateEngineDetector;

/**
 * Decorator that automatically detects the template engine parser to use. The
 * auto-detection is based on pairs of engine detector and associated template
 * engine parser.
 * 
 * The detection mechanism loop through the engine detectors until one indicates
 * that the associated engine can parse the template.
 * 
 * @author Aurélien Baudet
 *
 */
public class AutoDetectTemplateParser implements TemplateParser {
	private static final Logger LOG = LoggerFactory.getLogger(AutoDetectTemplateParser.class);
	

	/**
	 * The pairs of engine detector and template engine parser
	 */
	private List<TemplateImplementation> implementations;

	public AutoDetectTemplateParser(List<TemplateImplementation> implementations) {
		super();
		this.implementations = implementations;
	}

	@Override
	public Content parse(ResourcePath templatePath, Context ctx) throws ParseException {
		try {
			LOG.debug("Start template engine automatic detection for {}", templatePath);
			TemplateParser parser = findParser(templatePath, ctx);
			LOG.info("Parse the template {} using template engine {}", templatePath, parser);
			return parser.parse(templatePath, ctx);
		} catch (EngineDetectionException e) {
			throw new ParseException("Failed to automatically detect parser due to detection error", templatePath, ctx, e);
		}
	}

	private TemplateParser findParser(ResourcePath templatePath, Context ctx) throws EngineDetectionException {
		for (TemplateImplementation impl : implementations) {
			if (impl.getDetector().canParse(templatePath, ctx)) {
				TemplateParser parser = impl.getParser();
				LOG.debug("Template engine {} is used for {}", parser, templatePath);
				return parser;
			} else {
				LOG.debug("Template engine {} can't be used for {}", impl.getParser(), templatePath);
			}
		}
		throw new NoEngineDetectionException("Auto detection couldn't find any parser able to handle the template " + templatePath.getOriginalPath() + ".\n"
				+ "Either the template uses a template engine that is not registered in Ogham or the path points to a non existing template.");
	}
	

	@Override
	public String toString() {
		return "AutoDetectTemplateParser (" + implementations + ")";
	}



	public static class TemplateImplementation {
		private final TemplateEngineDetector detector;
		private final TemplateParser parser;
		public TemplateImplementation(TemplateEngineDetector detector, TemplateParser parser) {
			super();
			this.detector = detector;
			this.parser = parser;
		}
		public TemplateEngineDetector getDetector() {
			return detector;
		}
		public TemplateParser getParser() {
			return parser;
		}
		@Override
		public String toString() {
			return "TemplateImplementation {detector:" + detector + ", parser:" + parser + "}";
		}
	}
}









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.template.parser;
2
3		import java.util.List;
4
5		import org.slf4j.Logger;
6		import org.slf4j.LoggerFactory;
7
8		import fr.sii.ogham.core.exception.template.EngineDetectionException;
9		import fr.sii.ogham.core.exception.template.NoEngineDetectionException;
10		import fr.sii.ogham.core.exception.template.ParseException;
11		import fr.sii.ogham.core.message.content.Content;
12		import fr.sii.ogham.core.resource.path.ResourcePath;
13		import fr.sii.ogham.core.template.context.Context;
14		import fr.sii.ogham.core.template.detector.TemplateEngineDetector;
15
16		/**
17		* Decorator that automatically detects the template engine parser to use. The
18		* auto-detection is based on pairs of engine detector and associated template
19		* engine parser.
20		*
21		* The detection mechanism loop through the engine detectors until one indicates
22		* that the associated engine can parse the template.
23		*
24		* @author Aurélien Baudet
25		*
26		*/
27		public class AutoDetectTemplateParser implements TemplateParser {
28		private static final Logger LOG = LoggerFactory.getLogger(AutoDetectTemplateParser.class);
29
30
31		/**
32		* The pairs of engine detector and template engine parser
33		*/
34		private List<TemplateImplementation> implementations;
35
36		public AutoDetectTemplateParser(List<TemplateImplementation> implementations) {
37		super();
38		this.implementations = implementations;
39		}
40
41		@Override
42		public Content parse(ResourcePath templatePath, Context ctx) throws ParseException {
43		try {
44		LOG.debug("Start template engine automatic detection for {}", templatePath);
45		TemplateParser parser = findParser(templatePath, ctx);
46		LOG.info("Parse the template {} using template engine {}", templatePath, parser);
47	4 1. parse : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::parse → NO_COVERAGE 2. parse : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::parse → SURVIVED 3. parse : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::parse → TIMED_OUT 4. parse : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::parse → KILLED	return parser.parse(templatePath, ctx);
48		} catch (EngineDetectionException e) {
49		throw new ParseException("Failed to automatically detect parser due to detection error", templatePath, ctx, e);
50		}
51		}
52
53		private TemplateParser findParser(ResourcePath templatePath, Context ctx) throws EngineDetectionException {
54		for (TemplateImplementation impl : implementations) {
55	4 1. findParser : negated conditional → NO_COVERAGE 2. findParser : negated conditional → TIMED_OUT 3. findParser : negated conditional → KILLED 4. findParser : negated conditional → KILLED	if (impl.getDetector().canParse(templatePath, ctx)) {
56		TemplateParser parser = impl.getParser();
57		LOG.debug("Template engine {} is used for {}", parser, templatePath);
58	4 1. findParser : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::findParser → NO_COVERAGE 2. findParser : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::findParser → TIMED_OUT 3. findParser : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::findParser → KILLED 4. findParser : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::findParser → KILLED	return parser;
59		} else {
60		LOG.debug("Template engine {} can't be used for {}", impl.getParser(), templatePath);
61		}
62		}
63		throw new NoEngineDetectionException("Auto detection couldn't find any parser able to handle the template " + templatePath.getOriginalPath() + ".\n"
64		+ "Either the template uses a template engine that is not registered in Ogham or the path points to a non existing template.");
65		}
66
67
68		@Override
69		public String toString() {
70	3 1. toString : replaced return value with "" for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::toString → SURVIVED 2. toString : replaced return value with "" for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::toString → NO_COVERAGE 3. toString : replaced return value with "" for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::toString → TIMED_OUT	return "AutoDetectTemplateParser (" + implementations + ")";
71		}
72
73
74
75		public static class TemplateImplementation {
76		private final TemplateEngineDetector detector;
77		private final TemplateParser parser;
78		public TemplateImplementation(TemplateEngineDetector detector, TemplateParser parser) {
79		super();
80		this.detector = detector;
81		this.parser = parser;
82		}
83		public TemplateEngineDetector getDetector() {
84	4 1. getDetector : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getDetector → NO_COVERAGE 2. getDetector : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getDetector → TIMED_OUT 3. getDetector : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getDetector → KILLED 4. getDetector : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getDetector → KILLED	return detector;
85		}
86		public TemplateParser getParser() {
87	4 1. getParser : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getParser → NO_COVERAGE 2. getParser : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getParser → TIMED_OUT 3. getParser : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getParser → KILLED 4. getParser : replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getParser → KILLED	return parser;
88		}
89		@Override
90		public String toString() {
91	3 1. toString : replaced return value with "" for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::toString → SURVIVED 2. toString : replaced return value with "" for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::toString → NO_COVERAGE 3. toString : replaced return value with "" for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::toString → TIMED_OUT	return "TemplateImplementation {detector:" + detector + ", parser:" + parser + "}";
92		}
93		}
94		}
		Mutations
47		1.1 Location : parse Killed by : none replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::parse → TIMED_OUT 2.2 Location : parse Killed by : none replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::parse → NO_COVERAGE 3.3 Location : parse Killed by : none replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::parse → SURVIVED 4.4 Location : parse Killed by : oghamall.it.email.EmailMultiTemplateTest.withThymeleafOneVariantWithInvalidResourcePath(oghamall.it.email.EmailMultiTemplateTest) replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::parse → KILLED
55		1.1 Location : findParser Killed by : none negated conditional → NO_COVERAGE 2.2 Location : findParser Killed by : oghamall.it.template.TemplateErrorTest.singleTemplateNotFound(oghamall.it.template.TemplateErrorTest) negated conditional → KILLED 3.3 Location : findParser Killed by : none negated conditional → TIMED_OUT 4.4 Location : findParser Killed by : oghamcore.it.core.builder.TemplatePrioritySpec negated conditional → KILLED
58		1.1 Location : findParser Killed by : none replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::findParser → TIMED_OUT 2.2 Location : findParser Killed by : none replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::findParser → NO_COVERAGE 3.3 Location : findParser Killed by : oghamcore.it.core.builder.TemplatePrioritySpec replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::findParser → KILLED 4.4 Location : findParser Killed by : oghamall.it.email.EmailSMTPDefaultsTest.invalidTemplate(oghamall.it.email.EmailSMTPDefaultsTest) replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::findParser → KILLED
70		1.1 Location : toString Killed by : none replaced return value with "" for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::toString → SURVIVED 2.2 Location : toString Killed by : none replaced return value with "" for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::toString → NO_COVERAGE 3.3 Location : toString Killed by : none replaced return value with "" for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser::toString → TIMED_OUT
84		1.1 Location : getDetector Killed by : none replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getDetector → TIMED_OUT 2.2 Location : getDetector Killed by : oghamall.it.template.TemplateErrorTest.singleTemplateNotFound(oghamall.it.template.TemplateErrorTest) replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getDetector → KILLED 3.3 Location : getDetector Killed by : none replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getDetector → NO_COVERAGE 4.4 Location : getDetector Killed by : oghamcore.it.core.builder.TemplatePrioritySpec replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getDetector → KILLED
87		1.1 Location : getParser Killed by : none replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getParser → NO_COVERAGE 2.2 Location : getParser Killed by : none replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getParser → TIMED_OUT 3.3 Location : getParser Killed by : oghamall.it.configuration.EmptyBuilderTest.emailSenderManuallyRegisteredAndFreemarkerOnlyRegisteredButResourceResolutionNotConfiguredCantHandleTemplateContent(oghamall.it.configuration.EmptyBuilderTest) replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getParser → KILLED 4.4 Location : getParser Killed by : oghamcore.it.core.builder.TemplatePrioritySpec replaced return value with null for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::getParser → KILLED
91		1.1 Location : toString Killed by : none replaced return value with "" for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::toString → SURVIVED 2.2 Location : toString Killed by : none replaced return value with "" for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::toString → TIMED_OUT 3.3 Location : toString Killed by : none replaced return value with "" for fr/sii/ogham/core/template/parser/AutoDetectTemplateParser$TemplateImplementation::toString → NO_COVERAGE

AutoDetectTemplateParser.java

Mutations

Active mutators

Tests examined