com.github.mjeanroy.junit.servers.tomcat.EmbeddedTomcatFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of junit-servers-tomcat Show documentation
Add Tomcat Embedded Server to your junit tests case.
There is a newer version: 3.3.0
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2019 
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.github.mjeanroy.junit.servers.tomcat;

import com.github.mjeanroy.junit.servers.loggers.Logger;
import com.github.mjeanroy.junit.servers.loggers.LoggerFactory;
import com.github.mjeanroy.junit.servers.servers.AbstractConfiguration;
import com.github.mjeanroy.junit.servers.tomcat.exceptions.IllegalTomcatConfigurationException;

import static com.github.mjeanroy.junit.servers.commons.reflect.Annotations.findAnnotation;
import static com.github.mjeanroy.junit.servers.commons.reflect.Classes.instantiate;
import static com.github.mjeanroy.junit.servers.engine.Servers.findConfiguration;

/**
 * Static factories for {@link EmbeddedTomcat} that can be used in JUnit 4 Runner implementation
 * or JUnit Jupiter Extension.
 */
public final class EmbeddedTomcatFactory {

	/**
	 * Class Logger.
	 */
	private static final Logger log = LoggerFactory.getLogger(EmbeddedTomcatFactory.class);

	// Ensure non instantiation.
	private EmbeddedTomcatFactory() {
	}

	/**
	 * Instantiate embedded tomcat from given test class.
	 *
	 * @param testClass The test class.
	 * @return Created embedded tomcat instance.
	 */
	public static EmbeddedTomcat createFrom(Class testClass) {
		return createFrom(testClass, null);
	}

	/**
	 * Instantiate embedded tomcat from given test class, with given provided configuration (may be {@code null}).
	 *
	 * @param testClass The test class.
	 * @param configuration The configuration to use, may be {@code null}.
	 * @return Created embedded tomcat instance.
	 */
	public static EmbeddedTomcat createFrom(Class testClass, AbstractConfiguration configuration) {
		log.debug("Instantiating embedded tomcat for test class: {}", testClass);
		final EmbeddedTomcatConfiguration tomcatConfiguration = extractConfiguration(testClass, configuration);
		return tomcatConfiguration == null ? new EmbeddedTomcat() : new EmbeddedTomcat(tomcatConfiguration);
	}

	/**
	 * Try to extract {@link EmbeddedTomcat} configuration from:
	 * 
	 *   The given {@code configuration} if it is not {@code null}.
	 *   A class field/method annotated with {@link com.github.mjeanroy.junit.servers.annotations.TestServerConfiguration} on given {@code testClass} otherwise.
	 * 
	 *
	 * @param testClass The test class to analyze.
	 * @param configuration The configuration to use if not {@code null}.
	 * @return The {@link EmbeddedTomcat} configuration.
	 * @throws IllegalTomcatConfigurationException If extracted {@code configuration} is not an instance of {@link EmbeddedTomcatConfiguration}.
	 */
	private static EmbeddedTomcatConfiguration extractConfiguration(Class testClass, AbstractConfiguration configuration) {
		if (configuration != null) {
			log.debug("Returning provided configuration instance: {}", configuration);
			return checkConfiguration(configuration);
		}

		TomcatConfiguration configurationAnnotation = findAnnotation(testClass, TomcatConfiguration.class);
		if (configurationAnnotation != null) {
			return buildEmbeddedTomcatConfiguration(testClass, configurationAnnotation);
		}

		log.debug("Extracting configuration from given test class: {}", testClass);
		return checkConfiguration(findConfiguration(testClass));
	}

	/**
	 * Create configuration using {@link TomcatConfiguration} annotation.
	 *
	 * @param testClass The annotation.
	 * @param configurationAnnotation The test class.
	 * @return The configuration.
	 */
	private static EmbeddedTomcatConfiguration buildEmbeddedTomcatConfiguration(Class testClass, TomcatConfiguration configurationAnnotation) {
		log.debug("Returning configuration provided by @TomcatConfiguration annotation");
		Class providerClass = configurationAnnotation.providedBy();
		EmbeddedTomcatConfigurationProvider provider = instantiate(providerClass);
		return provider.build(testClass);
	}

	/**
	 * Ensure that given {@code configuration} parameter is an instance of {@link EmbeddedTomcatConfiguration} and returns it,
	 * or fail with {@link IllegalTomcatConfigurationException} otherwise.
	 *
	 * @param configuration The configuration.
	 * @return The configuration.
	 */
	private static EmbeddedTomcatConfiguration checkConfiguration(AbstractConfiguration configuration) {
		if (configuration == null) {
			return null;
		}

		if (!(configuration instanceof EmbeddedTomcatConfiguration)) {
			log.error("Cannot instantiate embedded tomcat using configuration {} because it does not extends EmbeddedTomcatConfiguration class", configuration);
			throw new IllegalTomcatConfigurationException();
		}

		return (EmbeddedTomcatConfiguration) configuration;
	}
}