/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.functions;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import org.apache.commons.lang3.RandomStringUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.jmeter.engine.util.CompoundVariable;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.samplers.Sampler;
import org.apache.jmeter.threads.JMeterVariables;
import org.apache.jmeter.util.JMeterUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Provides a RandomString function which returns a random String of length (first argument)
* using characters (second argument)
* @since 2.6
*/
public class RandomString extends AbstractFunction {
private static final Logger log = LoggerFactory.getLogger(RandomString.class);
private static final List<String> desc = new LinkedList<>();
private static final String KEY = "__RandomString"; //$NON-NLS-1$
static {
desc.add(JMeterUtils.getResString("random_string_length")); //$NON-NLS-1$
desc.add(JMeterUtils.getResString("random_string_chars_to_use")); //$NON-NLS-1$
desc.add(JMeterUtils.getResString("function_name_paropt")); //$NON-NLS-1$
}
private CompoundVariable[] values;
private static final int MAX_PARAM_COUNT = 3;
private static final int MIN_PARAM_COUNT = 1;
private static final int CHARS = 2;
private static final int PARAM_NAME = 3;
/**
* No-arg constructor.
*/
public RandomString() {
super();
}
/** {@inheritDoc} */
@Override
public String execute(SampleResult previousResult, Sampler currentSampler)
throws InvalidVariableException {
int length = Integer.parseInt(values[0].execute());
String charsToUse = null;//means no restriction
if (values.length >= CHARS) {
charsToUse = (values[CHARS - 1]).execute().trim();
if (charsToUse.length() <= 0) { // empty chars, return to null
charsToUse = null;
}
}
String myName = "";//$NON-NLS-1$
if (values.length >= PARAM_NAME) {
myName = (values[PARAM_NAME - 1]).execute().trim();
}
String myValue = null;
if(StringUtils.isEmpty(charsToUse)) {
myValue = RandomStringUtils.random(length);
} else {
myValue = RandomStringUtils.random(length, charsToUse);
}
if (myName.length() > 0) {
JMeterVariables vars = getVariables();
if (vars != null) {// Can be null if called from Config item testEnded() method
vars.put(myName, myValue);
}
}
if (log.isDebugEnabled()) {
String tn = Thread.currentThread().getName();
log.debug(tn + " name:" //$NON-NLS-1$
+ myName + " value:" + myValue);//$NON-NLS-1$
}
return myValue;
}
/** {@inheritDoc} */
@Override
public void setParameters(Collection<CompoundVariable> parameters) throws InvalidVariableException {
checkParameterCount(parameters, MIN_PARAM_COUNT, MAX_PARAM_COUNT);
values = parameters.toArray(new CompoundVariable[parameters.size()]);
}
/** {@inheritDoc} */
@Override
public String getReferenceKey() {
return KEY;
}
/** {@inheritDoc} */
@Override
public List<String> getArgumentDesc() {
return desc;
}
}