Skip to content

[6.x.x] New annotation for configuring XSuite #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop-6.x.x
Choose a base branch
from
Open

[6.x.x] New annotation for configuring XSuite #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 74 additions & 4 deletions exist-core/src/main/java/org/exist/test/runner/XSuite.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
package org.exist.test.runner;

import org.exist.test.ExistEmbeddedServer;
import org.exist.util.StringUtil;
import org.exist.util.XMLFilenameFilter;
import org.exist.util.XQueryFilenameFilter;
import org.junit.AfterClass;
Expand All @@ -65,6 +66,7 @@
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Properties;
import java.util.stream.Collectors;
import java.util.stream.Stream;

Expand All @@ -83,6 +85,9 @@
*/
public class XSuite extends ParentRunner<Runner> {

private static boolean DEFAULT_DISABLE_EXPATH_AUTO_DEPLOY = true;
private static boolean DEFAULT_DATABASE_USE_TEMPORARY_STORAGE = true;

/**
* Returns an empty suite.
*
Expand Down Expand Up @@ -120,6 +125,18 @@ public static Runner emptySuite() {
public @interface XSuiteParallel {
}

/**
* The <code>XSuiteConfig</code> annotation specifies any config for XSuite.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Inherited
public @interface XSuiteConfig {
boolean disableExpathAutoDeploy() default true;
boolean databaseUseTemporaryStorage() default true;
String databaseDataDirPath() default "";
}

private static String[] getAnnotatedDirectories(final Class<?> klass) throws InitializationError {
final XSuite.XSuiteFiles annotation = klass.getAnnotation(XSuite.XSuiteFiles.class);
if (annotation == null) {
Expand All @@ -136,6 +153,24 @@ private static boolean hasParallelAnnotation(@Nullable final Class<?> klass) {
return annotation != null;
}

private static Config getConfig(final Class<?> klass) throws InitializationError {
final XSuite.XSuiteConfig annotation = klass.getAnnotation(XSuite.XSuiteConfig.class);
final boolean disableExpathAutoDeploy;
final boolean databaseUseTemporaryStorage;
final String databaseDataDirPath;
if (annotation != null) {
disableExpathAutoDeploy = annotation.disableExpathAutoDeploy();
databaseUseTemporaryStorage = annotation.databaseUseTemporaryStorage();
databaseDataDirPath = annotation.databaseDataDirPath();
} else {
disableExpathAutoDeploy = DEFAULT_DISABLE_EXPATH_AUTO_DEPLOY;
databaseUseTemporaryStorage = DEFAULT_DATABASE_USE_TEMPORARY_STORAGE;
databaseDataDirPath = null;
}
return new Config(disableExpathAutoDeploy, databaseUseTemporaryStorage, databaseDataDirPath);
}

private final Config config;
private final List<Runner> runners;

/**
Expand Down Expand Up @@ -198,6 +233,7 @@ protected XSuite(final RunnerBuilder builder, final Class<?> klass, final String
*/
protected XSuite(final Class<?> klass, final List<Runner> runners) throws InitializationError {
super(klass);
this.config = getConfig(klass);
this.runners = Collections.unmodifiableList(runners);
}

Expand Down Expand Up @@ -280,7 +316,7 @@ protected Statement withBeforeClasses(final Statement statement) {
final List<FrameworkMethod> befores = getTestClass().getAnnotatedMethods(BeforeClass.class);

// inject a Server startup as though it were an @BeforeClass
final Statement startExistDb = new StartExistDbStatement();
final Statement startExistDb = new StartExistDbStatement(config);

return new RunXSuiteBefores(statement, startExistDb, befores, null);
}
Expand All @@ -296,6 +332,26 @@ protected Statement withAfterClasses(final Statement statement) {
return new RunXSuiteAfters(statement, stopExist, afters, null);
}

private static class Config {
final boolean disableExpathAutoDeploy;
final boolean databaseUseTemporaryStorage;
final String databaseDataDirPath;


private Config(final boolean disableExpathAutoDeploy, final boolean databaseUseTemporaryStorage, final String databaseDataDirPath) {
if (databaseUseTemporaryStorage && databaseDataDirPath != null) {
throw new IllegalArgumentException("You cannot specify databaseUseTemporaryStorage=true and a databaseDataDirPath");
}
this.disableExpathAutoDeploy = disableExpathAutoDeploy;
this.databaseUseTemporaryStorage = databaseUseTemporaryStorage;
if (StringUtil.notNullOrEmpty(databaseDataDirPath)) {
this.databaseDataDirPath = databaseDataDirPath;
} else {
this.databaseDataDirPath = null;
}
}
}

private static class RunXSuiteBefores extends Statement {
private final Statement next;
private final Object target;
Expand Down Expand Up @@ -358,12 +414,18 @@ public void evaluate() throws Throwable {
}

private static class StartExistDbStatement extends Statement {
final Config config;

public StartExistDbStatement(final Config config) {
this.config = config;
}

@Override
public void evaluate() throws Throwable {
if (EXIST_EMBEDDED_SERVER_CLASS_INSTANCE != null) {
throw new IllegalStateException("EXIST_EMBEDDED_SERVER_CLASS_INSTANCE already instantiated");
}
EXIST_EMBEDDED_SERVER_CLASS_INSTANCE = newExistDbServer();
EXIST_EMBEDDED_SERVER_CLASS_INSTANCE = newExistDbServer(config);
EXIST_EMBEDDED_SERVER_CLASS_INSTANCE.startDb();
}
}
Expand All @@ -381,7 +443,15 @@ public void evaluate() {

static ExistEmbeddedServer EXIST_EMBEDDED_SERVER_CLASS_INSTANCE = null;

static ExistEmbeddedServer newExistDbServer() {
return new ExistEmbeddedServer(true, true);
static ExistEmbeddedServer newExistDbServer(final Config config) {
if (config.databaseDataDirPath == null) {
return new ExistEmbeddedServer(config.disableExpathAutoDeploy, config.databaseUseTemporaryStorage);

} else {
final Properties properties = new Properties();
properties.setProperty("org.exist.db-connection.files", config.databaseDataDirPath);
properties.setProperty("org.exist.db-connection.recovery.journal-dir", config.databaseDataDirPath);
return new ExistEmbeddedServer(properties, config.disableExpathAutoDeploy, false);
}
}
}