/*
* 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.util;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.Serializable;
import java.util.Collections;
import java.util.Map;
import java.util.Properties;
import javax.script.Bindings;
import javax.script.Compilable;
import javax.script.CompiledScript;
import javax.script.ScriptEngine;
import javax.script.ScriptEngineManager;
import javax.script.ScriptException;
import org.apache.commons.collections.map.LRUMap;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.samplers.Sampler;
import org.apache.jmeter.testelement.TestStateListener;
import org.apache.jmeter.threads.JMeterContext;
import org.apache.jmeter.threads.JMeterContextService;
import org.apache.jmeter.threads.JMeterVariables;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.jorphan.util.JOrphanUtils;
import org.apache.log.Logger;
public abstract class JSR223TestElement extends ScriptingTestElement
implements Serializable, TestStateListener
{
/**
* Initialization On Demand Holder pattern
*/
private static class LazyHolder {
public static final ScriptEngineManager INSTANCE = new ScriptEngineManager();
}
/**
* @return ScriptEngineManager singleton
*/
public static ScriptEngineManager getInstance() {
return LazyHolder.INSTANCE;
}
private static final long serialVersionUID = 233L;
private String cacheKey = ""; // If not empty then script in ScriptText will be compiled and cached
/**
* Cache of compiled scripts
*/
@SuppressWarnings("unchecked") // LRUMap does not support generics (yet)
private static final Map<String, CompiledScript> compiledScriptsCache =
Collections.synchronizedMap(
new LRUMap(JMeterUtils.getPropDefault("jsr223.compiled_scripts_cache_size", 100)));
public JSR223TestElement() {
super();
}
protected ScriptEngine getScriptEngine() throws ScriptException {
final String lang = getScriptLanguage();
ScriptEngine scriptEngine = getInstance().getEngineByName(lang);
if (scriptEngine == null) {
throw new ScriptException("Cannot find engine named: "+lang);
}
return scriptEngine;
}
/**
* Populate variables to be passed to scripts
* @param bindings Bindings
*/
protected void populateBindings(Bindings bindings) {
final String label = getName();
final String fileName = getFilename();
final String scriptParameters = getParameters();
// Use actual class name for log
final Logger logger = LoggingManager.getLoggerForShortName(getClass().getName());
bindings.put("log", logger);
bindings.put("Label", label);
bindings.put("FileName", fileName);
bindings.put("Parameters", scriptParameters);
String [] args=JOrphanUtils.split(scriptParameters, " ");//$NON-NLS-1$
bindings.put("args", args);
// Add variables for access to context and variables
JMeterContext jmctx = JMeterContextService.getContext();
bindings.put("ctx", jmctx);
JMeterVariables vars = jmctx.getVariables();
bindings.put("vars", vars);
Properties props = JMeterUtils.getJMeterProperties();
bindings.put("props", props);
// For use in debugging:
bindings.put("OUT", System.out);
// Most subclasses will need these:
Sampler sampler = jmctx.getCurrentSampler();
bindings.put("sampler", sampler);
SampleResult prev = jmctx.getPreviousResult();
bindings.put("prev", prev);
}
/**
* This method will run inline script or file script with special behaviour for file script:
* - If ScriptEngine implements Compilable script will be compiled and cached
* - If not if will be run
* @param scriptEngine ScriptEngine
* @param bindings {@link Bindings} might be null
* @return Object returned by script
* @throws IOException
* @throws ScriptException
*/
protected Object processFileOrScript(ScriptEngine scriptEngine, Bindings bindings) throws IOException, ScriptException {
if (bindings == null) {
bindings = scriptEngine.createBindings();
}
populateBindings(bindings);
File scriptFile = new File(getFilename());
// Hack as in bsh-2.0b5.jar BshScriptEngine implements Compilable but throws new Error
boolean supportsCompilable = scriptEngine instanceof Compilable
&& !(scriptEngine.getClass().getName().equals("bsh.engine.BshScriptEngine"));
if (!StringUtils.isEmpty(getFilename())) {
if (scriptFile.exists() && scriptFile.canRead()) {
BufferedReader fileReader = null;
try {
if (supportsCompilable) {
String cacheKey =
getScriptLanguage()+"#"+
scriptFile.getAbsolutePath()+"#"+
scriptFile.lastModified();
CompiledScript compiledScript =
compiledScriptsCache.get(cacheKey);
if (compiledScript==null) {
synchronized (compiledScriptsCache) {
compiledScript =
compiledScriptsCache.get(cacheKey);
if (compiledScript==null) {
// TODO Charset ?
fileReader = new BufferedReader(new FileReader(scriptFile),
(int)scriptFile.length());
compiledScript =
((Compilable) scriptEngine).compile(fileReader);
compiledScriptsCache.put(cacheKey, compiledScript);
}
}
}
return compiledScript.eval(bindings);
} else {
// TODO Charset ?
fileReader = new BufferedReader(new FileReader(scriptFile),
(int)scriptFile.length());
return scriptEngine.eval(fileReader, bindings);
}
} finally {
IOUtils.closeQuietly(fileReader);
}
} else {
throw new ScriptException("Script file '"+scriptFile.getAbsolutePath()+"' does not exist or is unreadable for element:"+getName());
}
} else if (!StringUtils.isEmpty(getScript())){
if (supportsCompilable && !StringUtils.isEmpty(cacheKey)) {
CompiledScript compiledScript =
compiledScriptsCache.get(cacheKey);
if (compiledScript==null) {
synchronized (compiledScriptsCache) {
compiledScript =
compiledScriptsCache.get(cacheKey);
if (compiledScript==null) {
compiledScript =
((Compilable) scriptEngine).compile(getScript());
compiledScriptsCache.put(cacheKey, compiledScript);
}
}
}
return compiledScript.eval(bindings);
} else {
return scriptEngine.eval(getScript(), bindings);
}
} else {
throw new ScriptException("Both script file and script text are empty for element:"+getName());
}
}
/**
* @return the cacheKey
*/
public String getCacheKey() {
return cacheKey;
}
/**
* @param cacheKey the cacheKey to set
*/
public void setCacheKey(String cacheKey) {
this.cacheKey = cacheKey;
}
/**
* @see org.apache.jmeter.testelement.TestStateListener#testStarted()
*/
@Override
public void testStarted() {
// NOOP
}
/**
* @see org.apache.jmeter.testelement.TestStateListener#testStarted(java.lang.String)
*/
@Override
public void testStarted(String host) {
// NOOP
}
/**
* @see org.apache.jmeter.testelement.TestStateListener#testEnded()
*/
@Override
public void testEnded() {
testEnded("");
}
/**
* @see org.apache.jmeter.testelement.TestStateListener#testEnded(java.lang.String)
*/
@Override
public void testEnded(String host) {
compiledScriptsCache.clear();
}
}