You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2020/02/12 10:38:35 UTC
[isis] 01/19: ISIS-2285: adds new config property and uses
FixtureLifecycleService to run initialScript if present.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 8aa96e32001889fb54c839728e7a6b63d94f5d8d
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Tue Feb 11 20:48:42 2020 +0000
ISIS-2285: adds new config property and uses FixtureLifecycleService to run initialScript if present.
---
.../config/pages/configuration-properties.adoc | 15 +++++
.../apache/isis/core/config/IsisConfiguration.java | 76 +++++++++++++++++++++-
.../additional-spring-configuration-metadata.json | 9 +++
.../main/resources/ValidationMessages.properties | 1 +
scripts/generateConfigDocs.groovy | 9 ++-
.../applib/services/FixturesLifecycleService.java | 72 +++++++++++++++++++-
6 files changed, 178 insertions(+), 4 deletions(-)
diff --git a/core/config/src/main/adoc/modules/config/pages/configuration-properties.adoc b/core/config/src/main/adoc/modules/config/pages/configuration-properties.adoc
index f2e97a5..d13f167 100644
--- a/core/config/src/main/adoc/modules/config/pages/configuration-properties.adoc
+++ b/core/config/src/main/adoc/modules/config/pages/configuration-properties.adoc
@@ -179,6 +179,20 @@ include::refguide:config:example$generated/isis.viewer.wicket.adoc[]
|===
+== Testing
+
+[cols="2a,2a,3a", options="header"]
+|===
+|Property
+|Value +
+(default value)
+|Description
+
+include::refguide:config:example$generated/isis.testing.adoc[]
+
+|===
+
+
== Value Types
[cols="2a,2a,3a", options="header"]
@@ -236,6 +250,7 @@ include::refguide:config:example$generated/isis.extensions.adoc[]
|===
+
ifdef::env-this-stuff-is-currently-disabled[]
== Incubator
diff --git a/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java b/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java
index 839540d..785109a 100644
--- a/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java
+++ b/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java
@@ -18,6 +18,9 @@
*/
package org.apache.isis.core.config;
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
@@ -30,12 +33,21 @@ import java.util.Optional;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
+import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
import javax.inject.Inject;
import javax.inject.Named;
+import javax.validation.Constraint;
+import javax.validation.ConstraintValidator;
+import javax.validation.ConstraintValidatorContext;
+import javax.validation.Payload;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
-import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.validation.annotation.Validated;
@@ -49,6 +61,7 @@ import org.apache.isis.applib.services.command.CommandWithDto;
import org.apache.isis.applib.services.i18n.TranslationService;
import org.apache.isis.applib.services.iactn.Interaction;
import org.apache.isis.applib.services.publish.PublishedObjects;
+import org.apache.isis.core.commons.internal.context._Context;
import org.apache.isis.core.config.metamodel.facets.AuditObjectsConfiguration;
import org.apache.isis.core.config.metamodel.facets.CommandActionsConfiguration;
import org.apache.isis.core.config.metamodel.facets.CommandPropertiesConfiguration;
@@ -63,6 +76,7 @@ import org.apache.isis.core.config.viewer.wicket.DialogMode;
import lombok.Data;
import lombok.Value;
+import lombok.var;
/**
@@ -2893,6 +2907,25 @@ public class IsisConfiguration {
}
}
+ private final Testing testing = new Testing();
+ @Data
+ public static class Testing {
+ private final Fixtures fixtures = new Fixtures();
+ @Data
+ public static class Fixtures {
+ /**
+ * Indicates the fixture script class to run initially.
+ *
+ * <p>
+ * Intended for use when prototyping against an in-memory database (but will run in production mode
+ * as well if required).
+ * </p>
+ */
+ @AssignableFrom("org.apache.isis.testing.fixtures.applib.fixturescripts.FixtureScript")
+ private Class<?> initialScript = null;
+ }
+ }
+
private final Legacy legacy = new Legacy();
@Data
public static class Legacy {
@@ -3013,4 +3046,45 @@ public class IsisConfiguration {
}
+ @Target({ FIELD, METHOD, PARAMETER, ANNOTATION_TYPE })
+ @Retention(RUNTIME)
+ @Constraint(validatedBy = AssignableFromValidator.class)
+ @Documented
+ public @interface AssignableFrom {
+
+ String value();
+
+ String message()
+ default "{org.apache.isis.core.config.IsisConfiguration.AssignableFrom.message}";
+
+ Class<?>[] groups() default { };
+
+ Class<? extends Payload>[] payload() default { };
+ }
+
+
+ public static class AssignableFromValidator implements ConstraintValidator<AssignableFrom, Class<?>> {
+
+ private Class<?> superType;
+
+ @Override
+ public void initialize(final AssignableFrom assignableFrom) {
+ var className = assignableFrom.value();
+ try {
+ superType = _Context.loadClass(className);
+ } catch (ClassNotFoundException e) {
+ superType = null;
+ }
+ }
+
+ @Override
+ public boolean isValid(
+ final Class<?> candidateClass,
+ final ConstraintValidatorContext constraintContext) {
+ if (superType == null || candidateClass == null) {
+ return true;
+ }
+ return superType.isAssignableFrom(candidateClass);
+ }
+ }
}
diff --git a/core/config/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/core/config/src/main/resources/META-INF/additional-spring-configuration-metadata.json
index 9fd9532..c0bbadd 100644
--- a/core/config/src/main/resources/META-INF/additional-spring-configuration-metadata.json
+++ b/core/config/src/main/resources/META-INF/additional-spring-configuration-metadata.json
@@ -120,6 +120,15 @@
}]
},
{
+ "name": "isis.testing.fixtures.initial-script",
+ "providers": [{
+ "name": "class-reference",
+ "parameters": {
+ "target": "org.apache.isis.testing.fixtures.applib.fixturescripts.FixtureScript"
+ }
+ }]
+ },
+ {
"name": "isis.viewer.wicket.themes.provider",
"providers": [{
"name": "class-reference",
diff --git a/core/config/src/main/resources/ValidationMessages.properties b/core/config/src/main/resources/ValidationMessages.properties
new file mode 100644
index 0000000..e541c51
--- /dev/null
+++ b/core/config/src/main/resources/ValidationMessages.properties
@@ -0,0 +1 @@
+org.apache.isis.core.config.IsisConfiguration.AssignableFrom.message=Must be a subtype of '{value}'
\ No newline at end of file
diff --git a/scripts/generateConfigDocs.groovy b/scripts/generateConfigDocs.groovy
index 49a32f0..058e787 100644
--- a/scripts/generateConfigDocs.groovy
+++ b/scripts/generateConfigDocs.groovy
@@ -153,7 +153,14 @@ groups+= new PropertyGroup() {{
groups+= new PropertyGroup() {{
prefix = "isis.subdomains"
name = "Subdomains"
- description = "Configuration that applies to value type definitions"
+ description = "Configuration that applies to subdomain libraries"
+ searchOrder = 501
+}}
+
+groups+= new PropertyGroup() {{
+ prefix = "isis.testing"
+ name = "Testing"
+ description = "Configuration that applies to the testing libraries"
searchOrder = 501
}}
diff --git a/testing/fixtures/applib/src/main/java/org/apache/isis/testing/fixtures/applib/services/FixturesLifecycleService.java b/testing/fixtures/applib/src/main/java/org/apache/isis/testing/fixtures/applib/services/FixturesLifecycleService.java
index 49badf9..be77226 100644
--- a/testing/fixtures/applib/src/main/java/org/apache/isis/testing/fixtures/applib/services/FixturesLifecycleService.java
+++ b/testing/fixtures/applib/src/main/java/org/apache/isis/testing/fixtures/applib/services/FixturesLifecycleService.java
@@ -18,6 +18,8 @@
*/
package org.apache.isis.testing.fixtures.applib.services;
+import java.util.Collections;
+
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.inject.Inject;
@@ -25,25 +27,59 @@ import javax.inject.Named;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Primary;
+import org.springframework.context.event.ContextRefreshedEvent;
+import org.springframework.context.event.EventListener;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Service;
import org.apache.isis.applib.annotation.OrderPrecedence;
import org.apache.isis.applib.clock.Clock;
+import org.apache.isis.applib.services.inject.ServiceInjector;
import org.apache.isis.core.commons.internal.environment.IsisSystemEnvironment;
+import org.apache.isis.core.commons.internal.exceptions._Exceptions;
+import org.apache.isis.core.config.IsisConfiguration;
+import org.apache.isis.core.runtime.context.session.AppLifecycleEvent;
+import org.apache.isis.core.runtime.session.template.AbstractIsisSessionTemplate;
+import org.apache.isis.core.security.authentication.standard.SimpleSession;
import org.apache.isis.testing.fixtures.applib.clock.FixtureClock;
import org.apache.isis.core.runtime.session.IsisSessionFactory;
+import org.apache.isis.testing.fixtures.applib.fixturescripts.FixtureScript;
+import org.apache.isis.testing.fixtures.applib.fixturescripts.FixtureScripts;
+
+import lombok.val;
+import lombok.var;
+import lombok.extern.log4j.Log4j2;
@Service
@Named("isisTstFixtures.FixturesLifecycleService")
@Order(OrderPrecedence.MIDPOINT)
@Primary
@Qualifier("Default")
+@Log4j2
public class FixturesLifecycleService {
@SuppressWarnings("unused")
- @Inject private IsisSessionFactory isisSessionFactory; // depends on relationship
- @Inject private IsisSystemEnvironment isisSystemEnvironment;
+ private final IsisSessionFactory isisSessionFactory; // depends on relationship
+ private final IsisSystemEnvironment isisSystemEnvironment;
+ private final IsisConfiguration isisConfiguration;
+ private final ServiceInjector serviceInjector;
+ private final FixtureScripts fixtureScripts;
+
+ private FixtureScript initialFixtureScript;
+
+ @Inject
+ public FixturesLifecycleService(
+ final IsisSessionFactory isisSessionFactory,
+ final IsisSystemEnvironment isisSystemEnvironment,
+ final IsisConfiguration isisConfiguration,
+ final ServiceInjector serviceInjector,
+ final FixtureScripts fixtureScripts) {
+ this.isisSessionFactory = isisSessionFactory;
+ this.isisSystemEnvironment = isisSystemEnvironment;
+ this.isisConfiguration = isisConfiguration;
+ this.serviceInjector = serviceInjector;
+ this.fixtureScripts = fixtureScripts;
+ }
@PostConstruct
public void postConstruct() {
@@ -56,10 +92,42 @@ public class FixturesLifecycleService {
FixtureClock.initialize();
}
+ final Class<?> initialScript = isisConfiguration.getTesting().getFixtures().getInitialScript();
+ if (initialScript != null && FixtureScript.class.isAssignableFrom(initialScript)) {
+ try {
+ initialFixtureScript = (FixtureScript) initialScript.newInstance();
+ serviceInjector.injectServicesInto(initialFixtureScript);
+ } catch (InstantiationException | IllegalAccessException e) {
+ initialFixtureScript = null;
+ }
+ }
+ }
+
+ @EventListener(AppLifecycleEvent.class)
+ public void onAppLifecycleEvent(final AppLifecycleEvent event) {
+
+ val eventType = event.getEventType();
+
+ log.debug("received app lifecycle event {}", eventType);
+
+ switch (eventType) {
+ case appPreMetamodel:
+ break;
+ case appPostMetamodel:
+ log.info("SEED");
+ if(initialFixtureScript != null) {
+ fixtureScripts.run(initialFixtureScript);
+ }
+ break;
+
+ default:
+ throw _Exceptions.unmatchedCase(eventType);
+ }
}
+
@PreDestroy
public void preDestroy() {