Skip to content

Commit

Permalink
refactor: remove duplicated jetty factory
Browse files Browse the repository at this point in the history
  • Loading branch information
@mjeanroy
mjeanroy committed Nov 28, 2023
1 parent 405dcec commit 5a6e1e6
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 169 deletions.
44 changes: 14 additions & 30 deletions ...e/src/main/java/com/github/mjeanroy/junit/servers/jetty/AbstractEmbeddedJettyFactory.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* or JUnit Jupiter Extension.
*/
public abstract class AbstractEmbeddedJettyFactory<
EMBEDDED_JETTY extends AbstractEmbeddedJetty<EmbeddedJettyConfiguration>
EMBEDDED_JETTY extends AbstractBaseEmbeddedJetty<?, EmbeddedJettyConfiguration>
> {

/**
Expand All @@ -50,7 +50,7 @@ public abstract class AbstractEmbeddedJettyFactory<
* @param testClass The test class.
* @return Created embedded jetty instance.
*/
public EMBEDDED_JETTY instantiateFrom(Class<?> testClass) {
public final EMBEDDED_JETTY instantiateFrom(Class<?> testClass) {
return instantiateFrom(testClass, null);
}

Expand All @@ -61,28 +61,26 @@ public EMBEDDED_JETTY instantiateFrom(Class<?> testClass) {
* @param configuration The configuration to use, may be {@code null}.
* @return Created embedded jetty instance.
*/
public EMBEDDED_JETTY instantiateFrom(Class<?> testClass, EmbeddedJettyConfiguration configuration) {
public final EMBEDDED_JETTY instantiateFrom(Class<?> testClass, EmbeddedJettyConfiguration configuration) {
log.debug("Instantiating embedded jetty for test class: {}", testClass);
EmbeddedJettyConfiguration configurationToUse = extractConfiguration(testClass, configuration);
return configurationToUse == null ? instantiateFrom() : instantiateFrom(configurationToUse);
}

/**
* Instantiate embedded Jetty using default configuration.
*
* @return Embedded jetty.
*/
protected abstract EMBEDDED_JETTY instantiateFrom();

protected abstract EMBEDDED_JETTY instantiateFrom(EmbeddedJettyConfiguration config);

/**
* Try to extract Jetty configuration from:
* <ul>
* <li>The given {@code configuration} if it is not {@code null}.</li>
* <li>A class field/method annotated with {@link com.github.mjeanroy.junit.servers.annotations.TestServerConfiguration} on given {@code testClass} otherwise.</li>
* </ul>
* Instantiate embedded Jetty using given configuration.
*
* @param testClass The test class to analyze.
* @param configuration The configuration to use if not {@code null}.
* @return The Jetty configuration.
* @throws IllegalJettyConfigurationException If extracted {@code configuration} is not an instance of required configuration type.
* @return Embedded jetty.
*/
protected abstract EMBEDDED_JETTY instantiateFrom(EmbeddedJettyConfiguration config);

private EmbeddedJettyConfiguration extractConfiguration(Class<?> testClass, EmbeddedJettyConfiguration configuration) {
if (configuration != null) {
log.debug("Returning provided configuration instance: {}", configuration);
Expand All @@ -105,29 +103,15 @@ private Class<? extends EmbeddedJettyConfigurationProvider> findEmbeddedJettyCon
return configurationAnnotation == null ? null : configurationAnnotation.providedBy();
}

/**
* Create configuration using custom annotation, dedicated to Jetty.
*
* @param testClass The tested class.
* @param providerClass The provider class.
* @return The configuration.
*/
private EmbeddedJettyConfiguration buildEmbeddedJettyConfiguration(
Class<?> testClass,
Class<? extends EmbeddedJettyConfigurationProvider> providerClass
Class<?> testClass,
Class<? extends EmbeddedJettyConfigurationProvider> providerClass
) {
log.debug("Returning configuration provided by test class");
EmbeddedJettyConfigurationProvider provider = instantiate(providerClass);
return provider.build(testClass);
}

/**
* Ensure that given {@code configuration} parameter is an instance of compatible class and returns it,
* or fail with {@link IllegalJettyConfigurationException} otherwise.
*
* @param configuration The configuration.
* @return The configuration.
*/
private EmbeddedJettyConfiguration checkConfiguration(Object configuration) {
if (configuration == null) {
return null;
Expand Down
42 changes: 13 additions & 29 deletions ...src/main/java/com/github/mjeanroy/junit/servers/tomcat/AbstractEmbeddedTomcatFactory.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public abstract class AbstractEmbeddedTomcatFactory<
* @param testClass The test class.
* @return Created embedded tomcat instance.
*/
public EMBEDDED_TOMCAT instantiateFrom(Class<?> testClass) {
public final EMBEDDED_TOMCAT instantiateFrom(Class<?> testClass) {
return instantiateFrom(testClass, null);
}

Expand All @@ -61,28 +61,26 @@ public EMBEDDED_TOMCAT instantiateFrom(Class<?> testClass) {
* @param configuration The configuration to use, may be {@code null}.
* @return Created embedded tomcat instance.
*/
public EMBEDDED_TOMCAT instantiateFrom(Class<?> testClass, EmbeddedTomcatConfiguration configuration) {
public final EMBEDDED_TOMCAT instantiateFrom(Class<?> testClass, EmbeddedTomcatConfiguration configuration) {
log.debug("Instantiating embedded tomcat for test class: {}", testClass);
EmbeddedTomcatConfiguration configurationToUse = extractConfiguration(testClass, configuration);
return configurationToUse == null ? instantiateFrom() : instantiateFrom(configurationToUse);
}

/**
* Instantiate embedded Tomcat using default configuration.
*
* @return Embedded tomcat.
*/
protected abstract EMBEDDED_TOMCAT instantiateFrom();

protected abstract EMBEDDED_TOMCAT instantiateFrom(EmbeddedTomcatConfiguration config);

/**
* Try to extract Jetty configuration from:
* <ul>
* <li>The given {@code configuration} if it is not {@code null}.</li>
* <li>A class field/method annotated with {@link com.github.mjeanroy.junit.servers.annotations.TestServerConfiguration} on given {@code testClass} otherwise.</li>
* </ul>
* Instantiate embedded Tomcat using given configuration.
*
* @param testClass The test class to analyze.
* @param configuration The configuration to use if not {@code null}.
* @return The Jetty configuration.
* @throws IllegalTomcatConfigurationException If extracted {@code configuration} is not an instance of required configuration type.
* @return Embedded tomcat.
*/
protected abstract EMBEDDED_TOMCAT instantiateFrom(EmbeddedTomcatConfiguration config);

private EmbeddedTomcatConfiguration extractConfiguration(Class<?> testClass, EmbeddedTomcatConfiguration configuration) {
if (configuration != null) {
log.debug("Returning provided configuration instance: {}", configuration);
Expand All @@ -105,29 +103,15 @@ private Class<? extends EmbeddedTomcatConfigurationProvider> findEmbeddedTomcatC
return configurationAnnotation == null ? null : configurationAnnotation.providedBy();
}

/**
* Create configuration using custom annotation, dedicated to Tomcat.
*
* @param testClass The tested class.
* @param providerClass The provider class.
* @return The configuration.
*/
private EmbeddedTomcatConfiguration buildEmbeddedTomcatConfiguration(
Class<?> testClass,
Class<? extends EmbeddedTomcatConfigurationProvider> providerClass
Class<?> testClass,
Class<? extends EmbeddedTomcatConfigurationProvider> providerClass
) {
log.debug("Returning configuration provided by test class");
EmbeddedTomcatConfigurationProvider provider = instantiate(providerClass);
return provider.build(testClass);
}

/**
* Ensure that given {@code configuration} parameter is an instance of compatible class and returns it,
* or fail with {@link IllegalTomcatConfigurationException} otherwise.
*
* @param configuration The configuration.
* @return The configuration.
*/
private EmbeddedTomcatConfiguration checkConfiguration(Object configuration) {
if (configuration == null) {
return null;
Expand Down
116 changes: 6 additions & 110 deletions ...etty-12/src/main/java/com/github/mjeanroy/junit/servers/jetty12/EmbeddedJettyFactory.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,27 +26,14 @@

import com.github.mjeanroy.junit.servers.jetty.AbstractEmbeddedJettyFactory;
import com.github.mjeanroy.junit.servers.jetty.EmbeddedJettyConfiguration;
import com.github.mjeanroy.junit.servers.jetty.EmbeddedJettyConfigurationProvider;
import com.github.mjeanroy.junit.servers.jetty.IllegalJettyConfigurationException;
import com.github.mjeanroy.junit.servers.jetty.JettyConfiguration;
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 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 EmbeddedJetty} that can be used in JUnit 4 Runner implementation
* or JUnit Jupiter Extension.
*/
public final class EmbeddedJettyFactory {

/**
* Class Logger.
*/
private static final Logger log = LoggerFactory.getLogger(AbstractEmbeddedJettyFactory.class);
public final class EmbeddedJettyFactory extends AbstractEmbeddedJettyFactory<EmbeddedJetty> {

private static final EmbeddedJettyFactory INSTANCE = new EmbeddedJettyFactory();

Expand Down Expand Up @@ -83,104 +70,13 @@ public static EmbeddedJetty createFrom(Class<?> testClass, AbstractConfiguration
private EmbeddedJettyFactory() {
}

/**
* Instantiate embedded jetty from given test class.
*
* @param testClass The test class.
* @return Created embedded jetty instance.
*/
private EmbeddedJetty instantiateFrom(Class<?> testClass) {
return instantiateFrom(testClass, null);
}

/**
* Instantiate embedded jetty 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 jetty instance.
*/
private EmbeddedJetty instantiateFrom(Class<?> testClass, EmbeddedJettyConfiguration configuration) {
log.debug("Instantiating embedded jetty for test class: {}", testClass);
EmbeddedJettyConfiguration configurationToUse = extractConfiguration(testClass, configuration);
return configurationToUse == null ? instantiateFrom() : instantiateFrom(configurationToUse);
}

private EmbeddedJetty instantiateFrom() {
@Override
protected EmbeddedJetty instantiateFrom() {
return new EmbeddedJetty();
}

private EmbeddedJetty instantiateFrom(EmbeddedJettyConfiguration config) {
return new EmbeddedJetty(config);
}

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

Class<? extends EmbeddedJettyConfigurationProvider> providerClass = findEmbeddedJettyConfigurationProvider(testClass);
if (providerClass != null) {
return buildEmbeddedJettyConfiguration(testClass, providerClass);
}

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

private Class<? extends EmbeddedJettyConfigurationProvider> findEmbeddedJettyConfigurationProvider(Class<?> testClass) {
JettyConfiguration configurationAnnotation = findAnnotation(testClass, JettyConfiguration.class);
return configurationAnnotation == null ? null : configurationAnnotation.providedBy();
}

/**
* Create configuration using custom annotation, dedicated to Jetty.
*
* @param testClass The tested class.
* @param providerClass The provider class.
* @return The configuration.
*/
private EmbeddedJettyConfiguration buildEmbeddedJettyConfiguration(
Class<?> testClass,
Class<? extends EmbeddedJettyConfigurationProvider> providerClass
) {
log.debug("Returning configuration provided by test class");
EmbeddedJettyConfigurationProvider provider = instantiate(providerClass);
return provider.build(testClass);
}

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

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

return (EmbeddedJettyConfiguration) configuration;
@Override
protected EmbeddedJetty instantiateFrom(EmbeddedJettyConfiguration embeddedJettyConfiguration) {
return new EmbeddedJetty(embeddedJettyConfiguration);
}
}

0 comments on commit 5a6e1e6

Please sign in to comment.