// $Header: /home/cvs/jakarta-jmeter/src/core/org/apache/jmeter/engine/util/ValueReplacer.java,v 1.17.2.1 2005/08/18 20:38:48 mstover1 Exp $
/*
* Copyright 2003-2004 The Apache Software Foundation.
*
* 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.
*
*/
package org.apache.jmeter.engine.util;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import junit.framework.TestCase;
import org.apache.jmeter.config.ConfigTestElement;
import org.apache.jmeter.functions.InvalidVariableException;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jmeter.testelement.TestPlan;
import org.apache.jmeter.testelement.property.CollectionProperty;
import org.apache.jmeter.testelement.property.JMeterProperty;
import org.apache.jmeter.testelement.property.MultiProperty;
import org.apache.jmeter.testelement.property.PropertyIterator;
import org.apache.jmeter.testelement.property.StringProperty;
import org.apache.jmeter.threads.JMeterContextService;
import org.apache.jmeter.threads.JMeterVariables;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.log.Logger;
/**
* @author Michael Stover
* @author <a href="mailto:jsalvata@apache.org">Jordi Salvat i Alabart</a>
* @version $Revision: 1.17.2.1 $ updated on $Date: 2005/08/18 20:38:48 $
*/
public class ValueReplacer {
transient private static Logger log = LoggingManager.getLoggerForClass();
CompoundVariable masterFunction = new CompoundVariable();
Map variables = new HashMap();
public ValueReplacer() {
}
public ValueReplacer(TestPlan tp) {
setUserDefinedVariables(tp.getUserDefinedVariables());
}
public void setUserDefinedVariables(Map variables) {
this.variables = variables;
}
public void replaceValues(TestElement el) throws InvalidVariableException {
Collection newProps = replaceValues(el.propertyIterator(), new ReplaceStringWithFunctions(masterFunction,
variables));
setProperties(el, newProps);
}
private void setProperties(TestElement el, Collection newProps) {
Iterator iter = newProps.iterator();
el.clear();
while (iter.hasNext()) {
el.setProperty((JMeterProperty) iter.next());
}
}
public void reverseReplace(TestElement el) throws InvalidVariableException {
Collection newProps = replaceValues(el.propertyIterator(), new ReplaceFunctionsWithStrings(masterFunction,
variables));
setProperties(el, newProps);
}
public void reverseReplace(TestElement el, boolean regexMatch) throws InvalidVariableException {
Collection newProps = replaceValues(el.propertyIterator(), new ReplaceFunctionsWithStrings(masterFunction,
variables, regexMatch));
setProperties(el, newProps);
}
public void undoReverseReplace(TestElement el) throws InvalidVariableException {
Collection newProps = replaceValues(el.propertyIterator(), new UndoVariableReplacement(masterFunction,
variables));
setProperties(el, newProps);
}
public void addVariable(String name, String value) {
variables.put(name, value);
}
/**
* Add all the given variables to this replacer's variables map.
*
* @param vars
* A map of variable name-value pairs (String-to-String).
*/
public void addVariables(Map vars) {
variables.putAll(vars);
}
private Collection replaceValues(PropertyIterator iter, ValueTransformer transform) throws InvalidVariableException {
List props = new LinkedList();
while (iter.hasNext()) {
JMeterProperty val = iter.next();
if (log.isDebugEnabled()) {
log.debug("About to replace in property of type: " + val.getClass() + ": " + val);
}
if (val instanceof StringProperty) {
// Must not convert TestElement.gui_class etc
if (!val.getName().equals(TestElement.GUI_CLASS) &&
!val.getName().equals(TestElement.TEST_CLASS)) {
val = transform.transformValue(val);
if (log.isDebugEnabled()) {
log.debug("Replacement result: " + val);
}
}
} else if (val instanceof MultiProperty) {
MultiProperty multiVal = (MultiProperty) val;
Collection newValues = replaceValues(multiVal.iterator(), transform);
multiVal.clear();
Iterator propIter = newValues.iterator();
while (propIter.hasNext()) {
multiVal.addProperty((JMeterProperty) propIter.next());
}
if (log.isDebugEnabled()) {
log.debug("Replacement result: " + multiVal);
}
} else {
if (log.isDebugEnabled()) {
log.debug("Won't replace " + val);
}
}
props.add(val);
}
return props;
}
public static class Test extends TestCase {
TestPlan variables;
public Test(String name) {
super(name);
}
public void setUp() {
variables = new TestPlan();
variables.addParameter("server", "jakarta.apache.org");
variables.addParameter("username", "jack");
variables.addParameter("password", "jacks_password");
variables.addParameter("regex", ".*");
JMeterVariables vars = new JMeterVariables();
vars.put("server", "jakarta.apache.org");
JMeterContextService.getContext().setVariables(vars);
JMeterContextService.getContext().setSamplingStarted(true);
}
public void testReverseReplacement() throws Exception {
ValueReplacer replacer = new ValueReplacer(variables);
assertTrue(variables.getUserDefinedVariables().containsKey("server"));
assertTrue(replacer.variables.containsKey("server"));
TestElement element = new TestPlan();
element.setProperty(new StringProperty("domain", "jakarta.apache.org"));
List args = new ArrayList();
args.add("username is jack");
args.add("jacks_password");
element.setProperty(new CollectionProperty("args", args));
replacer.reverseReplace(element);
assertEquals("${server}", element.getPropertyAsString("domain"));
args = (List) element.getProperty("args").getObjectValue();
assertEquals("${password}", ((JMeterProperty) args.get(1)).getStringValue());
}
public void testReplace() throws Exception {
ValueReplacer replacer = new ValueReplacer();
replacer.setUserDefinedVariables(variables.getUserDefinedVariables());
TestElement element = new ConfigTestElement();
element.setProperty(new StringProperty("domain", "${server}"));
replacer.replaceValues(element);
log.debug("domain property = " + element.getProperty("domain"));
element.setRunningVersion(true);
assertEquals("jakarta.apache.org", element.getPropertyAsString("domain"));
}
/*
* (non-Javadoc)
*
* @see junit.framework.TestCase#tearDown()
*/
protected void tearDown() throws Exception {
JMeterContextService.getContext().setSamplingStarted(false);
}
}
}