Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

INT-2491: Scripting: Variables Improvements

Browse Source 
JIRA: https://jira.springsource.org/browse/INT-2491

* Add support variables for 'inline' scripts
* Add convenient attribute `variables` for script tags
* Introduce `BeanFactoryFallbackBinding` for groovy scripts.

INT-2491: Polishing

* Add check for duplication of provided variables
* Tests and Docs

Polishing
This commit is contained in:
Artem Bilan
2013-11-18 17:28:29 +02:00
committed by Gary Russell
parent a7cabc53b0
commit 87798b055f
14 changed files with 327 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
spring-integration-groovy/src/main/java/org/springframework/integration/groovy/GroovyScriptExecutingMessageProcessor.java
View File

@@ -16,12 +16,21 @@
package org.springframework.integration.groovy;
import groovy.lang.Binding;
import groovy.lang.GString;
import groovy.lang.GroovyClassLoader;
import groovy.lang.GroovyObject;
import groovy.lang.MetaClass;
import groovy.lang.MissingPropertyException;
import groovy.lang.Script;
import java.util.Map;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.integration.Message;
import org.springframework.integration.scripting.AbstractScriptExecutingMessageProcessor;
@@ -32,13 +41,6 @@ import org.springframework.scripting.groovy.GroovyObjectCustomizer;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import groovy.lang.Binding;
import groovy.lang.GString;
import groovy.lang.GroovyClassLoader;
import groovy.lang.GroovyObject;
import groovy.lang.MetaClass;
import groovy.lang.Script;
/**
* The {@link org.springframework.integration.handler.MessageProcessor} implementation
* to evaluate Groovy scripts.
@@ -136,12 +138,9 @@ public class GroovyScriptExecutingMessageProcessor extends AbstractScriptExecuti
try {
GroovyObject goo = (GroovyObject) this.scriptClass.newInstance();
GroovyObjectCustomizer groovyObjectCustomizer = this.customizerDecorator;
if (variables != null) {
// Override empty Script.Binding with new one with 'variables'
groovyObjectCustomizer = new BindingOverwriteGroovyObjectCustomizerDecorator(new Binding(variables));
((VariableBindingGroovyObjectCustomizerDecorator) groovyObjectCustomizer).setCustomizer(this.customizerDecorator);
}
VariableBindingGroovyObjectCustomizerDecorator groovyObjectCustomizer =
new BindingOverwriteGroovyObjectCustomizerDecorator(new BeanFactoryFallbackBinding(variables));
groovyObjectCustomizer.setCustomizer(this.customizerDecorator);
if (goo instanceof Script) {
// Allow metaclass and other customization.
@@ -164,4 +163,34 @@ public class GroovyScriptExecutingMessageProcessor extends AbstractScriptExecuti
}
}
private class BeanFactoryFallbackBinding extends Binding {
private BeanFactoryFallbackBinding(Map<?, ?> variables) {
super(variables);
}
@Override
public Object getVariable(String name) {
try {
return super.getVariable(name);
}
catch (MissingPropertyException e) {
// Original {@link Binding} doesn't have 'variable' for the given 'name'.
// Try to resolve it as 'bean' from the given <code>beanFactory</code>.
}
if (GroovyScriptExecutingMessageProcessor.this.beanFactory == null) {
throw new MissingPropertyException(name, this.getClass());
}
try {
return GroovyScriptExecutingMessageProcessor.this.beanFactory.getBean(name);
}
catch (NoSuchBeanDefinitionException e) {
throw new MissingPropertyException(name, this.getClass(), e);
}
}
}
}

26
spring-integration-groovy/src/test/java/org/springframework/integration/groovy/config/GroovyServiceActivatorTests-context.xml
View File

@@ -10,30 +10,38 @@
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
<service-activator input-channel="referencedScriptInput">
<groovy:script location="org/springframework/integration/groovy/config/GroovyServiceActivatorTests.groovy"
<groovy:script location="org/springframework/integration/groovy/config/GroovyServiceActivatorTests.groovy"
customizer="groovyCustomizer">
<groovy:variable name="foo" value="foo"/>
<groovy:variable name="bar" value="bar"/>
<groovy:variable name="date" ref="date"/>
</groovy:script>
</service-activator>
<service-activator input-channel="withScriptVariableGenerator">
<groovy:script location="org/springframework/integration/groovy/config/GroovyServiceActivatorTests.groovy"
script-variable-generator="scriptVarSource" customizer="groovyCustomizer"/>
</service-activator>
<beans:bean id="groovyCustomizer"
<beans:bean id="groovyCustomizer"
class="org.springframework.integration.groovy.config.GroovyServiceActivatorTests.MyGroovyCustomizer"/>
<beans:bean id="scriptVarSource"
<beans:bean id="scriptVarSource"
class="org.springframework.integration.groovy.config.GroovyServiceActivatorTests.SampleScriptVariSource"/>
<service-activator input-channel="inlineScriptInput">
<groovy:script customizer="groovyCustomizer">
<groovy:script customizer="groovyCustomizer" variables="date-ref=date">
<![CDATA[
return "inline-$payload"
return "inline-$payload : ${date.format('dd.mm.yyyy')}"
]]>
</groovy:script>
</service-activator>
<service-activator input-channel="scriptWithoutVariablesInput">
<groovy:script>
<![CDATA[
return "withoutVariables-$payload : ${date.format('dd.mm.yyyy')}"
]]>
</groovy:script>
</service-activator>

20
spring-integration-groovy/src/test/java/org/springframework/integration/groovy/config/GroovyServiceActivatorTests-fail-context.xml
View File

@@ -1,20 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns="http://www.springframework.org/schema/integration"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:beans="http://www.springframework.org/schema/beans"
xmlns:groovy="http://www.springframework.org/schema/integration/groovy"
xsi:schemaLocation="http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration.xsd
http://www.springframework.org/schema/integration/groovy http://www.springframework.org/schema/integration/groovy/spring-integration-groovy.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
<service-activator input-channel="inlineScriptInput">
<groovy:script>
<![CDATA[
return "inline-$payload-" + "$foo" + " - " + bar + " - " + date
]]>
<groovy:variable name="foo" value="foo"/>
<groovy:variable name="bar" value="bar"/>
</groovy:script>
</service-activator>
</beans:beans>

42
spring-integration-groovy/src/test/java/org/springframework/integration/groovy/config/GroovyServiceActivatorTests.java
View File

@@ -23,6 +23,8 @@ import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
@@ -38,6 +40,7 @@ import org.springframework.integration.Message;
import org.springframework.integration.MessageChannel;
import org.springframework.integration.MessageHandlingException;
import org.springframework.integration.channel.QueueChannel;
import org.springframework.integration.core.PollableChannel;
import org.springframework.integration.handler.ReplyRequiredException;
import org.springframework.integration.message.ErrorMessage;
import org.springframework.integration.message.GenericMessage;
@@ -73,6 +76,9 @@ public class GroovyServiceActivatorTests {
@Autowired
private MessageChannel invalidInlineScript;
@Autowired
private MessageChannel scriptWithoutVariablesInput;
@Autowired
private MyGroovyCustomizer groovyCustomizer;
@@ -134,13 +140,38 @@ public class GroovyServiceActivatorTests {
Message<?> message = MessageBuilder.withPayload("test-" + i).setReplyChannel(replyChannel).build();
this.inlineScriptInput.send(message);
}
assertEquals("inline-test-1", replyChannel.receive(0).getPayload());
assertEquals("inline-test-2", replyChannel.receive(0).getPayload());
assertEquals("inline-test-3", replyChannel.receive(0).getPayload());
DateFormat format = new SimpleDateFormat("dd.mm.yyyy");
String now = format.format(new Date());
assertEquals("inline-test-1 : " + now, replyChannel.receive(0).getPayload());
assertEquals("inline-test-2 : " + now, replyChannel.receive(0).getPayload());
assertEquals("inline-test-3 : " + now, replyChannel.receive(0).getPayload());
assertNull(replyChannel.receive(0));
assertTrue(groovyCustomizer.executed);
}
@Test
public void testScriptWithoutVariables() throws Exception{
PollableChannel replyChannel = new QueueChannel();
for (int i = 1; i <= 3; i++) {
Message<?> message = MessageBuilder.withPayload("test-" + i).setReplyChannel(replyChannel).build();
this.scriptWithoutVariablesInput.send(message);
}
DateFormat format = new SimpleDateFormat("dd.mm.yyyy");
String now = format.format(new Date());
assertEquals("withoutVariables-test-1 : " + now, replyChannel.receive(0).getPayload());
assertEquals("withoutVariables-test-2 : " + now, replyChannel.receive(0).getPayload());
assertEquals("withoutVariables-test-3 : " + now, replyChannel.receive(0).getPayload());
assertNull(replyChannel.receive(0));
}
//INT-2399
@Test(expected = MessageHandlingException.class)
public void invalidInlineScript() throws Exception {
@@ -158,11 +189,6 @@ public class GroovyServiceActivatorTests {
}
@Test(expected=BeanDefinitionParsingException.class)
public void inlineScriptAndVariables() throws Exception{
new ClassPathXmlApplicationContext("GroovyServiceActivatorTests-fail-context.xml", this.getClass());
}
@Test(expected=BeanDefinitionParsingException.class)
public void variablesAndScriptVariableGenerator() throws Exception{
new ClassPathXmlApplicationContext("GroovyServiceActivatorTests-fail-withgenerator-context.xml", this.getClass());

100
spring-integration-scripting/src/main/java/org/springframework/integration/scripting/config/AbstractScriptParser.java
View File

@@ -16,14 +16,15 @@ import java.util.List;
import org.w3c.dom.Element;
import org.springframework.beans.BeanMetadataElement;
import org.springframework.beans.factory.config.RuntimeBeanReference;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
import org.springframework.beans.factory.support.ManagedMap;
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.beans.factory.xml.XmlReaderContext;
import org.springframework.integration.config.xml.IntegrationNamespaceUtils;
import org.springframework.integration.scripting.DefaultScriptVariableGenerator;
import org.springframework.integration.scripting.RefreshableResourceScriptSource;
import org.springframework.scripting.support.StaticScriptSource;
import org.springframework.util.CollectionUtils;
@@ -32,6 +33,7 @@ import org.springframework.util.xml.DomUtils;
/**
* @author David Turanski
* @author Artem Bilan
*
*/
public abstract class AbstractScriptParser extends AbstractSingleBeanDefinitionParser {
@@ -62,13 +64,6 @@ public abstract class AbstractScriptParser extends AbstractSingleBeanDefinitionP
List<Element> variableElements = DomUtils.getChildElementsByTagName(element, "variable");
String scriptVariableGeneratorName = element.getAttribute("script-variable-generator");
if (StringUtils.hasText(scriptText)
&& (variableElements.size() > 0 || StringUtils.hasText(scriptVariableGeneratorName))) {
parserContext.getReaderContext().error(
"Variable bindings or custom ScriptVariableGenerator are not allowed when using an inline groovy script. "
+ "Specify location of the script via 'location' attribute instead", element);
return;
}
if (StringUtils.hasText(scriptVariableGeneratorName) && variableElements.size() > 0) {
parserContext.getReaderContext().error(
@@ -88,33 +83,23 @@ public abstract class AbstractScriptParser extends AbstractSingleBeanDefinitionP
builder.addConstructorArgValue(new StaticScriptSource(scriptText));
}
}
BeanMetadataElement scriptVariableGeneratorDef = null;
if (!StringUtils.hasText(scriptVariableGeneratorName)) {
BeanDefinitionBuilder scriptVariableGeneratorBuilder = BeanDefinitionBuilder
.genericBeanDefinition("org.springframework.integration.scripting.DefaultScriptVariableGenerator");
ManagedMap<String, Object> variableMap = new ManagedMap<String, Object>();
for (Element childElement : variableElements) {
String variableName = childElement.getAttribute("name");
String variableValue = childElement.getAttribute("value");
String variableRef = childElement.getAttribute("ref");
if (!(StringUtils.hasText(variableValue) ^ StringUtils.hasText(variableRef))) {
parserContext.getReaderContext().error(
"Exactly one of the 'ref' attribute or 'value' attribute, " + " is required for element "
+ IntegrationNamespaceUtils.createElementDescription(element) + ".", element);
}
if (StringUtils.hasText(variableValue)) {
variableMap.put(variableName, variableValue);
}
else {
variableMap.put(variableName, new RuntimeBeanReference(variableRef));
}
}
.genericBeanDefinition(DefaultScriptVariableGenerator.class);
ManagedMap<String, Object> variableMap = buildVariablesMap(element, parserContext, variableElements);
if (!CollectionUtils.isEmpty(variableMap)) {
scriptVariableGeneratorBuilder.addConstructorArgValue(variableMap);
}
scriptVariableGeneratorName = BeanDefinitionReaderUtils.registerWithGeneratedName(
scriptVariableGeneratorBuilder.getBeanDefinition(), parserContext.getRegistry());
scriptVariableGeneratorDef = scriptVariableGeneratorBuilder.getBeanDefinition();
}
builder.addConstructorArgReference(scriptVariableGeneratorName);
else {
scriptVariableGeneratorDef = new RuntimeBeanReference(scriptVariableGeneratorName);
}
builder.addConstructorArgValue(scriptVariableGeneratorDef);
postProcess(builder, element, parserContext);
}
@@ -138,4 +123,61 @@ public abstract class AbstractScriptParser extends AbstractSingleBeanDefinitionP
return resourceScriptSourceBuilder.getBeanDefinition();
}
private ManagedMap<String, Object> buildVariablesMap(final Element element, final ParserContext parserContext,
List<Element> variableElements) {
@SuppressWarnings("serial")
ManagedMap<String, Object> variableMap = new ManagedMap<String, Object>() {
@Override
public Object put(String key, Object value) {
if (this.containsKey(key)) {
parserContext.getReaderContext().error("Duplicated variable: " + key, element);
}
return super.put(key, value);
}
};
for (Element childElement : variableElements) {
String variableName = childElement.getAttribute("name");
String variableValue = childElement.getAttribute("value");
String variableRef = childElement.getAttribute("ref");
if (!(StringUtils.hasText(variableValue) ^ StringUtils.hasText(variableRef))) {
parserContext.getReaderContext().error(
"Exactly one of the 'ref' attribute or 'value' attribute, " + " is required for element "
+ IntegrationNamespaceUtils.createElementDescription(element) + ".", element);
}
if (StringUtils.hasText(variableValue)) {
variableMap.put(variableName, variableValue);
}
else {
variableMap.put(variableName, new RuntimeBeanReference(variableRef));
}
}
String variables = element.getAttribute("variables");
if (StringUtils.hasText(variables)) {
String[] variablePairs = StringUtils.commaDelimitedListToStringArray(variables);
for (String variablePair : variablePairs) {
String[] variableValue = variablePair.split("=");
if (variableValue.length != 2) {
parserContext.getReaderContext().error(
"Variable declarations in the 'variable' attribute must have the "
+ "form 'var=value'; found : '" + variablePair + "'", element);
}
String variable = variableValue[0].trim();
String value = variableValue[1];
if (variable.endsWith("-ref")) {
variable = variable.substring(0, variable.indexOf("-ref"));
variableMap.put(variable, new RuntimeBeanReference(value));
}
else {
variableMap.put(variable, value);
}
}
}
return variableMap;
}
}

14
spring-integration-scripting/src/main/resources/org/springframework/integration/scripting/config/spring-integration-scripting-core-3.0.xsd
View File

@@ -61,7 +61,7 @@
<xsd:annotation>
<xsd:documentation>
Reference to the ScriptVariableGenerator bean. This attribute is mutually
exclusive with any 'variable' sub-elements.
exclusive with any 'variable' sub-elements and 'variables' attribute.
</xsd:documentation>
<xsd:appinfo>
<tool:expected-type
@@ -78,6 +78,18 @@
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="variables">
<xsd:annotation>
<xsd:documentation>
Comma-delimited pairs of variables and their values.
the variable name can applies '-ref' suffix, which mean to determine
a variable value as a bean reference.
This attribute isn't mutually exclusive with 'variable' sub-elements
and all variables will be merged to one Map.
This attribute is mutually exclusive with 'script-variable-generator' attribute.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:schema>

25
spring-integration-scripting/src/test/java/org/springframework/integration/scripting/config/jsr223/Jsr223ServiceActivatorTests-context.xml
View File

@@ -10,30 +10,31 @@
http://www.springframework.org/schema/integration/scripting http://www.springframework.org/schema/integration/scripting/spring-integration-scripting.xsd">
<service-activator input-channel="referencedScriptInput">
<script:script
<script:script
lang="python"
location="org/springframework/integration/scripting/config/jsr223/Jsr223ServiceActivatorTests.py">
location="org/springframework/integration/scripting/config/jsr223/Jsr223ServiceActivatorTests.py"
variables="foo2=#{'foo2'}, date2-ref=date">
<script:variable name="foo" value="foo"/>
<script:variable name="bar" value="bar"/>
<script:variable name="date" ref="date"/>
</script:script>
</service-activator>
<service-activator input-channel="withScriptVariableGenerator">
<script:script lang="ruby" location="org/springframework/integration/scripting/config/jsr223/Jsr223ServiceActivatorTests.rb"
script-variable-generator="scriptVarSource"/>
</service-activator>
<beans:bean id="scriptVarSource"
class="org.springframework.integration.scripting.config.jsr223.Jsr223ServiceActivatorTests.SampleScriptVariSource"/>
<beans:bean id="scriptVarSource"
class="org.springframework.integration.scripting.config.jsr223.Jsr223ServiceActivatorTests$SampleScriptVariSource"/>
<service-activator input-channel="inlineScriptInput">
<script:script lang="ruby">
<script:script lang="ruby" variables="foo=#{'FOO'}, date-ref=date">
<![CDATA[
"inline-#{payload}"
"inline-#{payload} - #{foo} :#{date}"
]]>
</script:script>
</service-activator>
@@ -41,5 +42,5 @@
<beans:bean id="date" class="java.util.Date" scope="prototype">
<aop:scoped-proxy/>
</beans:bean>
</beans:beans>

13
spring-integration-scripting/src/test/java/org/springframework/integration/scripting/config/jsr223/Jsr223ServiceActivatorTests-fail-context.xml → spring-integration-scripting/src/test/java/org/springframework/integration/scripting/config/jsr223/Jsr223ServiceActivatorTests-fail-duplicated-variable-context.xml
View File

@@ -7,14 +7,13 @@
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/integration/scripting http://www.springframework.org/schema/integration/scripting/spring-integration-scripting.xsd">
<service-activator input-channel="inlineScriptInput">
<script:script lang="ruby">
<![CDATA[
return "inline-#{payload}-" + "#{foo}" + " - " + bar + " - " + date
]]>
<service-activator input-channel="duplicateVariableInput">
<script:script lang="ruby" variables="foo=FOO">
<script:variable name="foo" value="foo"/>
<script:variable name="bar" value="bar"/>
<![CDATA[
payload
]]>
</script:script>
</service-activator>
</beans:beans>

67
spring-integration-scripting/src/test/java/org/springframework/integration/scripting/config/jsr223/Jsr223ServiceActivatorTests.java
View File

@@ -17,19 +17,21 @@
package org.springframework.integration.scripting.config.jsr223;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import org.hamcrest.Matchers;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.parsing.BeanDefinitionParsingException;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.integration.Message;
import org.springframework.integration.MessageChannel;
@@ -72,14 +74,24 @@ public class Jsr223ServiceActivatorTests {
String value1 = (String) replyChannel.receive(0).getPayload();
String value2 = (String) replyChannel.receive(0).getPayload();
String value3 = (String) replyChannel.receive(0).getPayload();
assertTrue(value1.startsWith("python-test-1-foo - bar"));
assertTrue(value2.startsWith("python-test-2-foo - bar"));
assertTrue(value3.startsWith("python-test-3-foo - bar"));
assertTrue(value1.startsWith("python-test-1-foo (foo2) - bar"));
assertTrue(value2.startsWith("python-test-2-foo (foo2) - bar"));
assertTrue(value3.startsWith("python-test-3-foo (foo2) - bar"));
// because we are using 'prototype bean the suffix date will be
// different
assertFalse(value1.substring(26).equals(value2.substring(26)));
assertFalse(value2.substring(26).equals(value3.substring(26)));
assertFalse(value1.substring(value1.indexOf(":") + 1, value1.lastIndexOf(":"))
.equals(value2.substring(value1.indexOf(":") + 1, value1.lastIndexOf(":"))));
assertFalse(value1.substring(value1.indexOf(":") +1, value1.lastIndexOf(":"))
.equals(value1.substring(value1.lastIndexOf(":"))));
assertFalse(value2.substring(value1.indexOf(":") + 1, value1.lastIndexOf(":"))
.equals(value3.substring(value1.indexOf(":") + 1, value1.lastIndexOf(":"))));
assertFalse(value1.substring(value1.lastIndexOf(":") + 1)
.equals(value2.substring(value1.lastIndexOf(":") + 1)));
assertFalse(value2.substring(value1.lastIndexOf(":") + 1)
.equals(value3.substring(value1.lastIndexOf(":") + 1)));
assertNull(replyChannel.receive(0));
}
@@ -118,22 +130,41 @@ public class Jsr223ServiceActivatorTests {
Message<?> message = MessageBuilder.withPayload("test-" + i).setReplyChannel(replyChannel).build();
this.inlineScriptInput.send(message);
}
assertEquals("inline-test-1", replyChannel.receive(0).getPayload());
assertEquals("inline-test-2", replyChannel.receive(0).getPayload());
assertEquals("inline-test-3", replyChannel.receive(0).getPayload());
String payload = (String) replyChannel.receive(0).getPayload();
assertThat(payload, Matchers.startsWith("inline-test-1 - FOO"));
payload = (String) replyChannel.receive(0).getPayload();
assertThat(payload, Matchers.startsWith("inline-test-2 - FOO"));
payload = (String) replyChannel.receive(0).getPayload();
assertThat(payload, Matchers.startsWith("inline-test-3 - FOO"));
assertTrue(payload.substring(payload.indexOf(":") + 1).matches(".+\\d{2}:\\d{2}:\\d{2}.+"));
assertNull(replyChannel.receive(0));
}
@Test(expected = BeanDefinitionParsingException.class)
public void inlineScriptAndVariables() throws Exception {
new ClassPathXmlApplicationContext("Jsr223ServiceActivatorTests-fail-context.xml", this.getClass());
@Test
public void variablesAndScriptVariableGenerator() throws Exception {
try {
new ClassPathXmlApplicationContext("Jsr223ServiceActivatorTests-fail-withgenerator-context.xml", this.getClass());
fail("BeansException expected.");
}
catch (BeansException e) {
assertThat(e.getMessage(), Matchers.containsString("'script-variable-generator' and 'variable' sub-elements are mutually exclusive."));
}
}
@Test(expected = BeanDefinitionParsingException.class)
public void variablesAndScriptVariableGenerator() throws Exception {
new ClassPathXmlApplicationContext("Jsr223ServiceActivatorTests-fail-withgenerator-context.xml",
this.getClass());
@Test
public void testDuplicateVariable() throws Exception {
try {
new ClassPathXmlApplicationContext("Jsr223ServiceActivatorTests-fail-duplicated-variable-context.xml", this.getClass());
fail("BeansException expected.");
}
catch (BeansException e) {
assertThat(e.getMessage(), Matchers.containsString("Duplicated variable: foo"));
}
}
public static class SampleScriptVariSource implements ScriptVariableGenerator {

2
spring-integration-scripting/src/test/java/org/springframework/integration/scripting/config/jsr223/Jsr223ServiceActivatorTests.py
View File

@@ -1 +1 @@
"python-%s-%s - %s - %s" %(payload,foo,bar,date)
"python-%s-%s (%s) - %s - :%s:%s" %(payload,foo,foo2,bar,date,date2)

44
spring-integration-scripting/src/test/java/org/springframework/integration/scripting/jsr223/Jsr223ScriptExecutingMessageProcessorTests.java
View File

@@ -1,11 +1,11 @@
/*
* Copyright 2002-2011 the original author or authors.
*
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
@@ -19,6 +19,9 @@ import java.util.Map;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mockito;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.core.io.ClassPathResource;
import org.springframework.integration.Message;
import org.springframework.integration.message.GenericMessage;
@@ -31,42 +34,45 @@ import org.springframework.scripting.support.ResourceScriptSource;
*
*/
public class Jsr223ScriptExecutingMessageProcessorTests {
ScriptExecutor executor;
@Before
public void setUp() {
executor = ScriptExecutorFactory.getScriptExecutor("jruby");
}
@Test
public void testExecuteWithVariables(){
Map<String,Object> vars = new HashMap<String,Object>();
vars.put("one",1);
vars.put("two","two");
vars.put("three", new Integer(3));
vars.put("three", 3);
ScriptSource scriptSource = new ResourceScriptSource(new ClassPathResource("/org/springframework/integration/scripting/jsr223/print_message.rb"));
ScriptExecutingMessageProcessor messageProcessor = new ScriptExecutingMessageProcessor(scriptSource,executor,vars);
ScriptExecutingMessageProcessor messageProcessor = new ScriptExecutingMessageProcessor(scriptSource, executor, vars);
messageProcessor.setBeanFactory(Mockito.mock(BeanFactory.class));
Message<?> message = new GenericMessage<String>("hello");
Object obj = messageProcessor.processMessage(message);
assertEquals("hello modified",obj.toString().substring(0,"hello modified".length()));
}
@Test
public void testWithNoVars(){
ScriptSource scriptSource = new ResourceScriptSource(new ClassPathResource("/org/springframework/integration/scripting/jsr223/print_message.rb"));
ScriptExecutingMessageProcessor messageProcessor = new ScriptExecutingMessageProcessor(scriptSource,executor);
ScriptExecutingMessageProcessor messageProcessor = new ScriptExecutingMessageProcessor(scriptSource, executor);
messageProcessor.setBeanFactory(Mockito.mock(BeanFactory.class));
Message<?> message = new GenericMessage<String>("hello");
Object obj = messageProcessor.processMessage(message);
assertEquals("hello modified",obj.toString().substring(0,"hello modified".length()));
}
}

23
src/reference/docbook/groovy.xml
View File

@@ -57,9 +57,26 @@
Setting a custom GroovyObjectCustomizer is not mutually exclusive with <code>&lt;variable&gt;</code> sub-elements or
the <code>script-variable-generator</code> attribute. It can also be provided when defining an inline script.
For more information regarding <code>&lt;variable&gt;</code> and <code>script-variable-generator</code>, see the
paragraph '<emphasis>Script variable bindings</emphasis>' of <xref linkend="scripting-config"/>.
</para>
</para>
<para>
With <emphasis>Spring Integration 3.0</emphasis>, in addition to the <code>variable</code> sub-element,
the <code>variables</code> attribute has been introduced. Also, groovy scripts have the ability to resolve a
variable to a bean in the
<interfacename>BeanFactory</interfacename>, if a binding variable was not provided with
the name:
<programlisting language="xml">&lt;int-groovy:script&gt;
&lt;![CDATA[
entityManager.persist(payload)
payload
]]&gt;
&lt;/int-groovy:script&gt;</programlisting>
where variable <code>entityManager</code> is an appropriate bean in the application context.
</para>
<para>
For more information regarding <code>&lt;variable&gt;</code>, <code>variables</code>,
and <code>script-variable-generator</code>, see the
paragraph '<emphasis>Script variable bindings</emphasis>' of <xref linkend="scripting-config"/>.
</para>
</section>
<section id="groovy-control-bus">

31
src/reference/docbook/scripting.xml
View File

@@ -98,7 +98,32 @@
</script:script>]]></programlisting>
As shown in the above example, you can bind a script variable either to a scalar value or a Spring bean reference. Note that
<code>payload</code> and <code>headers</code> will still be included as binding variables.
</para>
<para>
With <emphasis>Spring Integration 3.0</emphasis>, in addition to the <code>variable</code> sub-element,
the <code>variables</code> attribute has been introduced. This attribute and <code>variable</code> sub-elements
aren't mutually exclusive and you can combine them within one <code>script</code> component. However variables must
be unique, regardless of where they are defined. Also, since <emphasis>Spring Integration 3.0</emphasis>,
variable bindings are allowed for inline scripts too:
<programlisting language="xml">&lt;service-activator input-channel="input"&gt;
&lt;script:script lang="ruby" variables="foo=FOO, date-ref=dateBean"&gt;
&lt;script:variable name="bar" ref="barBean"/&gt;
&lt;script:variable name="baz" value="bar"/&gt;
&lt;![CDATA[
payload.foo = foo
payload.date = date
payload.bar = bar
payload.baz = baz
payload
]]&gt;
&lt;/script:script&gt;
&lt;/service-activator&gt;</programlisting>
The example above shows a combination of an inline script, a <code>variable</code> sub-element and a <code>variables</code> attribute.
The <code>variables</code> attribute is a comma-separated value, where each segment contains an '=' separated pair
of the variable and its value. The variable name can be suffixed with <code>-ref</code>, as in the
<code>date-ref</code> variable above. That means that the binding variable
will have the name <code>date</code>, but the value will be a reference to the <code>dateBean</code> bean from the application context.
This may be useful when using <emphasis>Property Placeholder Configuration</emphasis> or command line arguments.
</para>
<para>
If you need more control over how variables are generated, you can implement your own Java class
@@ -115,7 +140,7 @@
provide an implementation of <classname>ScriptVariableGenerator</classname> and reference it with the <code>script-variable-generator</code>
attribute:
<programlisting language="xml"><![CDATA[<int-script:script location="foo/bar/MyScript.groovy"
script-variable-generator="variableGenerator"/>
script-variable-generator="variableGenerator"/>
<bean id="variableGenerator" class="foo.bar.MyScriptVariableGenerator"/>]]></programlisting>
If a <code>script-variable-generator</code> is not provided, script components use
@@ -124,7 +149,7 @@
variables from the <code>Message</code> in its <code>generateScriptVariables(Message)</code> method.
<important>
You cannot provide both the <code>script-variable-generator</code> attribute and <code>&lt;variable&gt;</code> sub-element(s)
as they are mutually exclusive. Also, custom variable bindings cannot be used with an inline script.
as they are mutually exclusive.
</important>
</para>
</section>

8
src/reference/docbook/whats-new.xml
View File

@@ -667,5 +667,13 @@
<xref linkend="file-reading"/>, <xref linkend="ftp-inbound"/>, and <xref linkend="sftp-inbound"/> for more information.
</para>
</section>
<section id="3.0-scripting-variables">
<title>Scripting Support: Variables Changes</title>
<para>
A new <code>variables</code> attribute has been introduced for scripting components.
In addition, variable bindings are now allowed for inline scripts.
See <xref linkend="groovy"/> and <xref linkend="scripting"/> for more information.
</para>
</section>
</section>
</chapter>