KaneAI - World’s First E2E Software Testing Agent.Signup for Private Beta Join TestMu Conference

How to use VariableUtils method of com.consol.citrus.variable.VariableUtils class

Best Citrus code snippet using com.consol.citrus.variable.VariableUtils.VariableUtils

Source:TestContext.java

...29import com.consol.citrus.validation.MessageValidatorRegistry;30import com.consol.citrus.validation.interceptor.GlobalMessageConstructionInterceptors;31import com.consol.citrus.validation.matcher.ValidationMatcherRegistry;32import com.consol.citrus.variable.GlobalVariables;33import com.consol.citrus.variable.VariableUtils;34import com.consol.citrus.xml.namespace.NamespaceContextBuilder;35import org.slf4j.Logger;36import org.slf4j.LoggerFactory;37import org.springframework.context.ApplicationContext;38import org.springframework.util.*;39import java.lang.reflect.Field;40import java.util.*;41import java.util.Map.Entry;42import java.util.concurrent.ConcurrentHashMap;43/**44 * Class holding and managing test variables. The test context also provides utility methods45 * for replacing dynamic content(variables and functions) in message payloads and headers.46 * 47 * @author Christoph Deppisch48 */49public class TestContext {50    /**51     * Logger52     */53    private static Logger log = LoggerFactory.getLogger(TestContext.class);54    55    /** Local variables */56    protected Map<String, Object> variables;57    58    /** Global variables */59    private GlobalVariables globalVariables;60    /** Message store */61    private MessageStore messageStore = new DefaultMessageStore();62    63    /** Function registry holding all available functions */64    private FunctionRegistry functionRegistry = new FunctionRegistry();65    /** Endpoint factory creates endpoint instances */66    private EndpointFactory endpointFactory;67    /** Bean reference resolver */68    private ReferenceResolver referenceResolver;69    70    /** Registered message validators */71    private MessageValidatorRegistry messageValidatorRegistry = new MessageValidatorRegistry();72    73    /** Registered validation matchers */74    private ValidationMatcherRegistry validationMatcherRegistry = new ValidationMatcherRegistry();75    /** List of test listeners to be informed on test events */76    private TestListeners testListeners = new TestListeners();77    /** List of message listeners to be informed on inbound and outbound message exchange */78    private MessageListeners messageListeners = new MessageListeners();79    /** List of global message construction interceptors */80    private GlobalMessageConstructionInterceptors globalMessageConstructionInterceptors = new GlobalMessageConstructionInterceptors();81    /** Central namespace context builder */82    private NamespaceContextBuilder namespaceContextBuilder = new NamespaceContextBuilder();83    /** Spring bean application context */84    private ApplicationContext applicationContext;85    /** Timers registered in test context, that can be stopped */86    protected Map<String, StopTimer> timers = new ConcurrentHashMap<>();87    /** List of exceptions that actions raised during execution of forked operations */88    private List<CitrusRuntimeException> exceptions = new ArrayList<>();89    /**90     * Default constructor91     */92    public TestContext() {93        variables = new ConcurrentHashMap<>();94    }95    96    /**97     * Gets the value for the given variable expression. Expression usually is the 98     * simple variable name, with optional expression prefix/suffix.99     * 100     * In case variable is not known to the context throw runtime exception.101     * 102     * @param variableExpression expression to search for.103     * @throws CitrusRuntimeException104     * @return value of the variable105     */106    public String getVariable(final String variableExpression) {107        return getVariable(variableExpression, String.class);108    }109    /**110     * Gets typed variable value.111     * @param variableExpression112     * @param type113     * @param <T>114     * @return115     */116    public <T> T getVariable(String variableExpression, Class<T> type) {117        return TypeConversionUtils.convertIfNecessary(getVariableObject(variableExpression), type);118    }119    /**120     * Gets the value for the given variable as object representation.121     * Use this method if you seek for test objects stored in the context.122     * 123     * @param variableExpression expression to search for.124     * @throws CitrusRuntimeException125     * @return value of the variable as object126     */127    public Object getVariableObject(final String variableExpression) {128        String variableName = VariableUtils.cutOffVariablesPrefix(variableExpression);129        if (variableName.startsWith(Citrus.VARIABLE_ESCAPE) && variableName.endsWith(Citrus.VARIABLE_ESCAPE)) {130            return Citrus.VARIABLE_PREFIX + VariableUtils.cutOffVariablesEscaping(variableName) + Citrus.VARIABLE_SUFFIX;131        } else if (variables.containsKey(variableName)) {132            return variables.get(variableName);133        } else if (variableName.contains(".")) {134            String objectName = variableName.substring(0, variableName.indexOf("."));135            if (variables.containsKey(objectName)) {136                return getVariable(variables.get(objectName), variableName.substring(variableName.indexOf(".") + 1));137            }138        }139        throw new CitrusRuntimeException("Unknown variable '" + variableName + "'");140    }141    /**142     * Gets variable from path expression. Variable paths are translated to reflection fields on object instances.143     * Path separators are '.'. Each separator is handled as object hierarchy.144     * @param instance145     * @param pathExpression146     */147    private Object getVariable(Object instance, String pathExpression) {148        String leftOver = null;149        String fieldName;150        if (pathExpression.contains(".")) {151            fieldName = pathExpression.substring(0, pathExpression.indexOf("."));152            leftOver = pathExpression.substring(pathExpression.indexOf(".") + 1);153        } else {154            fieldName = pathExpression;155        }156        Field field = ReflectionUtils.findField(instance.getClass(), fieldName);157        if (field == null) {158            throw new CitrusRuntimeException(String.format("Failed to get variable - unknown field '%s' on type %s", fieldName, instance.getClass().getName()));159        }160        ReflectionUtils.makeAccessible(field);161        Object fieldValue = ReflectionUtils.getField(field, instance);162        if (StringUtils.hasText(leftOver)) {163            return getVariable(fieldValue, leftOver);164        }165        return fieldValue;166    }167    /**168     * Creates a new variable in this test context with the respective value. In case variable already exists 169     * variable is overwritten.170     * 171     * @param variableName the name of the new variable172     * @param value the new variable value173     * @throws CitrusRuntimeException174     * @return175     */176    public void setVariable(final String variableName, Object value) {177        if (!StringUtils.hasText(variableName) || VariableUtils.cutOffVariablesPrefix(variableName).length() == 0) {178            throw new CitrusRuntimeException("Can not create variable '"+ variableName + "', please define proper variable name");179        }180        if (value == null) {181            throw new VariableNullValueException("Trying to set variable: " + VariableUtils.cutOffVariablesPrefix(variableName) + ", but variable value is null");182        }183        if (log.isDebugEnabled()) {184            log.debug("Setting variable: " + VariableUtils.cutOffVariablesPrefix(variableName) + " with value: '" + value + "'");185        }186        variables.put(VariableUtils.cutOffVariablesPrefix(variableName), value);187    }188    /**189     * Add variables to context.190     * @param variableNames the variable names to set191     * @param variableValues the variable values to set192     */193    public void addVariables(String[] variableNames, Object[] variableValues) {194        if (variableNames.length != variableValues.length) {195            throw new CitrusRuntimeException(String.format(196                    "Invalid context variable usage - received '%s' variables with '%s' values",197                    variableNames.length,198                    variableValues.length));199        }200        for (int i = 0; i < variableNames.length; i++) {201            if (variableValues[i] != null) {202                setVariable(variableNames[i], variableValues[i]);203            }204        }205    }206    207    /**208     * Add several new variables to test context. Existing variables will be 209     * overwritten.210     * 211     * @param variablesToSet the list of variables to set.212     */213    public void addVariables(Map<String, Object> variablesToSet) {214        for (Entry<String, Object> entry : variablesToSet.entrySet()) {215            if (entry.getValue() != null) {216                setVariable(entry.getKey(), entry.getValue());217            } else {218                setVariable(entry.getKey(), "");219            }220        }221    }222    /**223     * Replaces variables and functions inside a map with respective values and returns a new224     * map representation.225     *226     * @param map optionally having variable entries.227     * @return the constructed map without variable entries.228     */229    public <T> Map<String, T> resolveDynamicValuesInMap(final Map<String, T> map) {230        Map<String, T> target = new LinkedHashMap<>(map.size());231        for (Entry<String, T> entry : map.entrySet()) {232            String key = replaceDynamicContentInString(entry.getKey());233            T value = entry.getValue();234            if (value instanceof String) {235                //put value into target map, but check if value is variable or function first236                target.put(key, (T) replaceDynamicContentInString((String) value));237            } else {238                target.put(key, value);239            }240        }241        return target;242    }243    /**244     * Replaces variables and functions in a list with respective values and245     * returns the new list representation.246     *247     * @param list having optional variable entries.248     * @return the constructed list without variable entries.249     */250    public <T> List<T> resolveDynamicValuesInList(final List<T> list) {251        List<T> variableFreeList = new ArrayList<>(list.size());252        for (T value : list) {253            if (value instanceof String) {254                //add new value after check if it is variable or function255                variableFreeList.add((T) replaceDynamicContentInString((String) value));256            }257        }258        return variableFreeList;259    }260    /**261     * Replaces variables and functions in array with respective values and262     * returns the new array representation.263     *264     * @param array having optional variable entries.265     * @return the constructed list without variable entries.266     */267    public <T> T[] resolveDynamicValuesInArray(final T[] array) {268        return resolveDynamicValuesInList(Arrays.asList(array)).toArray(Arrays.copyOf(array, array.length));269    }270    271    /**272     * Clears variables in this test context. Initially adds all global variables.273     */274    public void clear() {275        variables.clear();276        variables.putAll(globalVariables.getVariables());277    }278    279    /**280     * Checks if variables are present right now.281     * @return boolean flag to mark existence282     */283    public boolean hasVariables() {284        return !CollectionUtils.isEmpty(variables);285    }286    287    /**288     * Method replacing variable declarations and place holders as well as 289     * function expressions in a string290     * 291     * @param str the string to parse.292     * @return resulting string without any variable place holders.293     */294    public String replaceDynamicContentInString(String str) {295        return replaceDynamicContentInString(str, false);296    }297    /**298     * Method replacing variable declarations and functions in a string, optionally 299     * the variable values get surrounded with single quotes.300     * 301     * @param str the string to parse for variable place holders.302     * @param enableQuoting flag marking surrounding quotes should be added or not.303     * @return resulting string without any variable place holders.304     */305    public String replaceDynamicContentInString(final String str, boolean enableQuoting) {306        String result = null;307        if (str != null) {308            result = VariableUtils.replaceVariablesInString(str, this, enableQuoting);309            result = FunctionUtils.replaceFunctionsInString(result, this, enableQuoting);310        }311        return result;312    }313    314    /**315     * Checks weather the given expression is a variable or function and resolves the value316     * accordingly317     * @param expression the expression to resolve318     * @return the resolved expression value319     */320    public String resolveDynamicValue(String expression) {321        if (VariableUtils.isVariableName(expression)) {322            return getVariable(expression);323        } else if (functionRegistry.isFunction(expression)) {324            return FunctionUtils.resolveFunction(expression, this);325        }326        return expression;327    }328    /**329     * Handles error creating a new CitrusRuntimeException and330     * informs test listeners.331     * @param testName332     * @param packageName333     * @param message334     * @param cause335     * @return...

Source:VariableUtilsTest.java

...15 */16package com.consol.citrus.util;17import com.consol.citrus.exceptions.CitrusRuntimeException;18import com.consol.citrus.testng.AbstractTestNGUnitTest;19import com.consol.citrus.variable.VariableUtils;20import org.testng.Assert;21import org.testng.annotations.Test;22import javax.script.ScriptException;23/**24 * @author Jan Lipphaus25 */26public class VariableUtilsTest extends AbstractTestNGUnitTest {27    private String validGroovyScript = "a = 1";28    private String groovyScriptResult = "1";29    private String invalidGroovyScript = "a";30    private String validScriptEngine = "groovy";31    private String invalidScriptEngine = "invalidScriptEngine";32    /**33     * Test for correct return with valid script34     */35    @Test36    public void testValidScript() {37        String result = VariableUtils.getValueFromScript(validScriptEngine, validGroovyScript);38        Assert.assertEquals(result, groovyScriptResult);39    }40    /**41     * Test for correct exception with invalid script42     */43    @Test44    public void testInvalidScript() {45        try {46            VariableUtils.getValueFromScript(validScriptEngine, invalidGroovyScript);47        } catch (CitrusRuntimeException e) {48            Assert.assertTrue(e.getCause() instanceof ScriptException);49            return;50        }51        Assert.fail("Missing CitrusRuntimeException because of invalid groovy script");52    }53    /**54     * Test for correct exception with invalid script engine55     */56    @Test57    public void testInvalidScriptEngine() {58        try {59            VariableUtils.getValueFromScript(invalidScriptEngine, validGroovyScript);60        } catch (CitrusRuntimeException e) {61            Assert.assertTrue(e.getMessage().contains(invalidScriptEngine));62            return;63        }64        Assert.fail("Missing CitrusRuntimeException because of invalid script engine");65    }66    67    @Test68    public void testCutOffVariablesPrefixSuffix() {69        Assert.assertEquals(VariableUtils.cutOffVariablesPrefix(""), "");70        Assert.assertEquals(VariableUtils.cutOffVariablesPrefix("something_else"), "something_else");71        Assert.assertEquals(VariableUtils.cutOffVariablesPrefix("${}"), "");72        Assert.assertEquals(VariableUtils.cutOffVariablesPrefix("${variable}"), "variable");73        Assert.assertEquals(VariableUtils.cutOffVariablesPrefix("${incomplete"), "${incomplete");74        Assert.assertEquals(VariableUtils.cutOffVariablesPrefix("{incomplete}"), "{incomplete}");75    }76    @Test77    public void testCutOffSingleQuotes() {78        Assert.assertEquals(VariableUtils.cutOffSingleQuotes(""), "");79        Assert.assertEquals(VariableUtils.cutOffSingleQuotes("something_else"), "something_else");80        Assert.assertEquals(VariableUtils.cutOffSingleQuotes("'"), "'");81        Assert.assertEquals(VariableUtils.cutOffSingleQuotes("''"), "");82        Assert.assertEquals(VariableUtils.cutOffSingleQuotes("'variable'"), "variable");83        Assert.assertEquals(VariableUtils.cutOffSingleQuotes("'incomplete"), "'incomplete");84        Assert.assertEquals(VariableUtils.cutOffSingleQuotes("incomplete'"), "incomplete'");85    }86    @Test87    public void testCutOffDoubleQuotes() {88        Assert.assertEquals(VariableUtils.cutOffDoubleQuotes(""), "");89        Assert.assertEquals(VariableUtils.cutOffDoubleQuotes("something_else"), "something_else");90        Assert.assertEquals(VariableUtils.cutOffDoubleQuotes("\""), "\"");91        Assert.assertEquals(VariableUtils.cutOffDoubleQuotes("\"\""), "");92        Assert.assertEquals(VariableUtils.cutOffDoubleQuotes("\"variable\""), "variable");93        Assert.assertEquals(VariableUtils.cutOffDoubleQuotes("\"incomplete"), "\"incomplete");94        Assert.assertEquals(VariableUtils.cutOffDoubleQuotes("incomplete\""), "incomplete\"");95    }96    @Test97    public void testCutOffVariablesEscaping() {98        Assert.assertEquals(VariableUtils.cutOffVariablesEscaping(""), "");99        Assert.assertEquals(VariableUtils.cutOffVariablesEscaping("something_else"), "something_else");100        Assert.assertEquals(VariableUtils.cutOffVariablesEscaping("////"), "");101        Assert.assertEquals(VariableUtils.cutOffVariablesEscaping("//variable//"), "variable");102        Assert.assertEquals(VariableUtils.cutOffDoubleQuotes("//incomplete"), "//incomplete");103        Assert.assertEquals(VariableUtils.cutOffDoubleQuotes("incomplete//"), "incomplete//");104    }105}...

VariableUtils

Using AI Code Generation

1package com.consol.citrus;2import java.util.HashMap;3import java.util.Map;4import org.testng.Assert;5import org.testng.annotations.Test;6import com.consol.citrus.variable.VariableUtils;7public class VariableUtilsTest {8    public void testVariableUtils() {9        Map<String, Object> variables = new HashMap<String, Object>();10        variables.put("test", "testValue");11        variables.put("test2", "testValue2");12        variables.put("test3", "testValue3");13        String result = VariableUtils.replaceVariablesInString("${test} ${test2} ${test3}", variables);14        Assert.assertEquals(result, "testValue testValue2 testValue3");15        result = VariableUtils.replaceVariablesInString("${test} ${test2} ${test3} ${test4}", variables);16        Assert.assertEquals(result, "testValue testValue2 testValue3 ${test4}");17        result = VariableUtils.replaceVariablesInString("${test} ${test2} ${test3} ${test4}", variables, true);18        Assert.assertEquals(result, "testValue testValue2 testValue3 ");19        result = VariableUtils.replaceVariablesInString("${test} ${test2} ${test3} ${test4}", variables, false);20        Assert.assertEquals(result, "testValue testValue2 testValue3 ${test4}");21    }22}23package com.consol.citrus;24import java.util.HashMap;25import java.util.Map;26import org.testng.Assert;27import org.testng.annotations.Test;28public class VariableUtilsTest {29    public void testVariableUtils() {30        Map<String, Object> variables = new HashMap<String, Object>();31        variables.put("test", "testValue");32        variables.put("test2", "testValue2");33        variables.put("test3", "testValue3");34        String result = VariableUtils.replaceVariablesInString("${test} ${test2} ${test3}", variables);35        Assert.assertEquals(result, "testValue testValue2 testValue3");36        result = VariableUtils.replaceVariablesInString("${test} ${test2} ${test3} ${test4}", variables);37        Assert.assertEquals(result, "testValue testValue2 testValue3 ${test4}");38        result = VariableUtils.replaceVariablesInString("${test} ${test2} ${test3} ${test4}", variables, true);39        Assert.assertEquals(result, "

VariableUtils

Using AI Code Generation

1package com.consol.citrus;2import com.consol.citrus.variable.VariableUtils;3import org.testng.annotations.Test;4public class VariableUtilsTest {5    public void testVariableUtils() {6        String variable = "variable";7        String value = "value";8        VariableUtils.setVariable(variable, value);9        String variableValue = VariableUtils.getVariable(variable);10        System.out.println("variableValue = " + variableValue);11    }12}13package com.consol.citrus;14import org.testng.annotations.Test;15public class CitrusTest {16    public void testCitrus() {17        String variable = "variable";18        String value = "value";19        Citrus.setVariable(variable, value);20        String variableValue = Citrus.getVariable(variable);21        System.out.println("variableValue = " + variableValue);22    }23}24package com.consol.citrus;25import org.testng.annotations.Test;26public class CitrusTest {27    public void testCitrus() {28        String variable = "variable";29        String value = "value";30        Citrus.setVariable(variable, value);31        String variableValue = Citrus.getVariable(variable);32        System.out.println("variableValue = " + variableValue);33    }34}35package com.consol.citrus;36import org.testng.annotations.Test;37public class CitrusTest {38    public void testCitrus() {39        String variable = "variable";40        String value = "value";41        Citrus.setVariable(variable, value);42        String variableValue = Citrus.getVariable(variable);43        System.out.println("variableValue = " + variableValue);44    }45}46package com.consol.citrus;47import org.testng.annotations.Test;48public class CitrusTest {49    public void testCitrus() {50        String variable = "variable";51        String value = "value";52        Citrus.setVariable(variable, value);53        String variableValue = Citrus.getVariable(variable);54        System.out.println("variableValue = " + variableValue);55    }56}57package com.consol.citrus;58import org.testng.annotations.Test;59public class CitrusTest {60    public void testCitrus() {61        String variable = "variable";

VariableUtils

Using AI Code Generation

1import com.consol.citrus.variable.VariableUtils;2import com.consol.citrus.exceptions.CitrusRuntimeException;3import java.util.Map;4import java.util.HashMap;5import java.util.Properties;6import java.util.Map.Entry;7import java.util.Set;8import java.util.HashSet;9import java.util.Iterator;10import java.util.List;11import java.util.ArrayList;12public class Test {13    public static void main(String[] args) {14        Map<String, Object> variables = new HashMap<String, Object>();15        variables.put("var1", "value1");16        variables.put("var2", "value2");17        variables.put("var3", "value3");18        variables.put("var4", "value4");19        variables.put("var5", "value5");20        variables.put("var6", "value6");21        variables.put("var7", "value7");22        variables.put("var8", "value8");23        variables.put("var9", "value9");24        variables.put("var10", "value10");25        variables.put("var11", "value11");26        variables.put("var12", "value12");27        variables.put("var13", "value13");28        variables.put("var14", "value14");29        variables.put("var15", "value15");30        variables.put("var16", "value16");31        variables.put("var17", "value17");32        variables.put("var18", "value18");33        variables.put("var19", "value19");34        variables.put("var20", "value20");35        variables.put("var21", "value21");36        variables.put("var22", "value22");37        variables.put("var23", "value23");38        variables.put("var24", "value24");39        variables.put("var25", "value25");40        variables.put("var26", "value26");41        variables.put("var27", "value27");42        variables.put("var28", "value28");43        variables.put("var29", "value29");44        variables.put("var30", "value30");45        variables.put("var31", "value31");46        variables.put("var32", "value32");47        variables.put("var33", "value33");48        variables.put("var34", "value34");49        variables.put("var35", "value35");50        variables.put("var36", "value36");51        variables.put("

VariableUtils

Using AI Code Generation

1import com.consol.citrus.variable.VariableUtils;2import java.util.HashMap;3import java.util.Map;4public class VariableUtilsExample {5public static void main(String[] args) {6    Map<String, Object> variables = new HashMap<String, Object>();7    variables.put("name", "John");8    variables.put("age", "32");9    String name = VariableUtils.resolveDynamicValue("${name}", variables);10    System.out.println("Name: " + name);11    String age = VariableUtils.resolveDynamicValue("${age}", variables);12    System.out.println("Age: " + age);13}14}

VariableUtils

Using AI Code Generation

1public class 4 {2    public static void main(String[] args) {3        VariableUtils variableUtils = new VariableUtils();4        Map<String, Object> variables = new HashMap<String, Object>();5        variables.put("var1", "Hello");6        variables.put("var2", "World");7        String result = variableUtils.doInterpolate("${var1} ${var2}", variables);8        System.out.println(result);9    }10}

VariableUtils

Using AI Code Generation

1public class 4 {2public static void main(String[] args) {3String str = "Hello";4VariableUtils obj = new VariableUtils();5obj.setVariable(str);6}7}

VariableUtils

Using AI Code Generation

1import com.consol.citrus.variable.VariableUtils;2import com.consol.citrus.context.TestContext;3import com.consol.citrus.context.TestContextFactory;4import java.util.Map;5import java.util.HashMap;6import java.util.Iterator;7import java.util.Set;8import java.util.Map.Entry;9public class 4{10	public static void main(String[] args){11		TestContext context = TestContextFactory.newInstance().getObject();12		Map<String,String> map = new HashMap<String,String>();13		map.put("key1","value1");14		map.put("key2","value2");15		map.put("key3","value3");16		VariableUtils.setVariables(map,context);17		Set<Entry<String,String>> set = map.entrySet();18		Iterator<Entry<String,String>> itr = set.iterator();19		while(itr.hasNext()){20			Map.Entry<String,String> me = (Map.Entry<String,String>)itr.next();21			System.out.println(me.getKey()+": "+context.getVariable(me.getKey()));22		}23	}24}25import com.consol.citrus.variable.VariableUtils;26import com.consol.citrus.context.TestContext;27import com.consol.citrus.context.TestContextFactory;28import java.util.Map;29import java.util.HashMap;30import java.util.Iterator;31import java.util.Set;32import java.util.Map.Entry;33public class 5{34	public static void main(String[] args){35		TestContext context = TestContextFactory.newInstance().getObject();36		Map<String,String> map = new HashMap<String,String>();37		map.put("key1","value1");38		map.put("key2","value2");39		map.put("key3","value3");40		VariableUtils.setVariables(map,context);

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.