src/functions/org/apache/jmeter/functions/JavaScript.java

/*
 * 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 javax.script.Bindings;
import javax.script.ScriptContext;
import javax.script.ScriptEngine;
import javax.script.ScriptEngineManager;
import javax.script.SimpleScriptContext;

import org.apache.jmeter.engine.util.CompoundVariable;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.samplers.Sampler;
import org.apache.jmeter.threads.JMeterContext;
import org.apache.jmeter.threads.JMeterContextService;
import org.apache.jmeter.threads.JMeterVariables;
import org.apache.jmeter.util.JMeterUtils;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.log.Logger;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.RhinoException;
import org.mozilla.javascript.Scriptable;

/**
 * javaScript function implementation that executes a piece of JavaScript (not Java!) code and returns its value
 * @since 1.9
 */
public class JavaScript extends AbstractFunction {
    private static final String NASHORN_ENGINE_NAME = "nashorn"; //$NON-NLS-1$

    private static final String USE_RHINO_ENGINE_PROPERTY = "javascript.use_rhino"; //$NON-NLS-1$

    /**
     * Initialization On Demand Holder pattern
     */
    private static class LazyHolder {
        public static final ScriptEngineManager INSTANCE = new ScriptEngineManager();
    }
 
    private static final boolean USE_RHINO_ENGINE = 
            JMeterUtils.getPropDefault(USE_RHINO_ENGINE_PROPERTY, true) || 
            (getInstance().getEngineByName(JavaScript.NASHORN_ENGINE_NAME) == null);

    /**
     * @return ScriptEngineManager singleton
     */
    private static ScriptEngineManager getInstance() {
            return LazyHolder.INSTANCE;
    }
    private static final List<String> desc = new LinkedList<>();

    private static final String KEY = "__javaScript"; //$NON-NLS-1$

    private static final Logger log = LoggingManager.getLoggerForClass();

    static {
        desc.add(JMeterUtils.getResString("javascript_expression"));//$NON-NLS-1$
        desc.add(JMeterUtils.getResString("function_name_paropt")); //$NON-NLS-1$
    }

    private Object[] values;

    public JavaScript() {
    }

    /** {@inheritDoc} */
    @Override
    public String execute(SampleResult previousResult, Sampler currentSampler)
            throws InvalidVariableException {

        JMeterContext jmctx = JMeterContextService.getContext();
        JMeterVariables vars = jmctx.getVariables();

        String script = ((CompoundVariable) values[0]).execute();
        // Allow variable to be omitted
        String varName = values.length < 2 ? null : ((CompoundVariable) values[1]).execute().trim();
        String resultStr = "";

        if(USE_RHINO_ENGINE) {
            resultStr = executeWithRhino(previousResult, currentSampler, jmctx,
                vars, script, varName);
        } else {
            resultStr = executeWithNashorn(previousResult, currentSampler, jmctx,
                    vars, script, varName);
        }

        return resultStr;

    }

    /**
     * 
     * @param previousResult {@link SampleResult}
     * @param currentSampler {@link Sampler}
     * @param jmctx {@link JMeterContext}
     * @param vars {@link JMeterVariables}
     * @param script Javascript code
     * @param varName variable name
     * @return result as String
     * @throws InvalidVariableException
     */
    private String executeWithNashorn(SampleResult previousResult,
            Sampler currentSampler, JMeterContext jmctx, JMeterVariables vars,
            String script, String varName)
            throws InvalidVariableException {
        String resultStr = null;
        try {
            ScriptContext newContext = new SimpleScriptContext();
            ScriptEngine engine = getInstance().getEngineByName(JavaScript.NASHORN_ENGINE_NAME);
            Bindings bindings = engine.createBindings();

            // Set up some objects for the script to play with
            bindings.put("log", log); //$NON-NLS-1$
            bindings.put("ctx", jmctx); //$NON-NLS-1$
            bindings.put("vars", vars); //$NON-NLS-1$
            bindings.put("props", JMeterUtils.getJMeterProperties()); //$NON-NLS-1$

            bindings.put("threadName", Thread.currentThread().getName()); //$NON-NLS-1$
            bindings.put("sampler", currentSampler); //$NON-NLS-1$
            bindings.put("sampleResult", previousResult); //$NON-NLS-1$
            newContext.setBindings(bindings, ScriptContext.ENGINE_SCOPE);
            Object result = engine.eval(script, newContext);
            resultStr = result.toString();
            if (varName != null && vars != null) {// vars can be null if run from TestPlan
                vars.put(varName, resultStr);
            }
        } catch (Exception e) {
            log.error("Error processing Javascript: [" + script + "]\n", e);
            throw new InvalidVariableException("Error processing Javascript: [" + script + "]", e);
        } 
        return resultStr;
    }
    
    /**
     * @param previousResult {@link SampleResult}
     * @param currentSampler {@link Sampler}
     * @param jmctx {@link JMeterContext}
     * @param vars {@link JMeterVariables}
     * @param script Javascript code
     * @param varName variable name
     * @return result as String
     * @throws InvalidVariableException
     */
    private String executeWithRhino(SampleResult previousResult,
            Sampler currentSampler, JMeterContext jmctx, JMeterVariables vars,
            String script, String varName)
            throws InvalidVariableException {
        Context cx = Context.enter();
        String resultStr = null;
        try {

            Scriptable scope = cx.initStandardObjects(null);

            // Set up some objects for the script to play with
            scope.put("log", scope, log); //$NON-NLS-1$
            scope.put("ctx", scope, jmctx); //$NON-NLS-1$
            scope.put("vars", scope, vars); //$NON-NLS-1$
            scope.put("props", scope, JMeterUtils.getJMeterProperties()); //$NON-NLS-1$
            // Previously mis-spelt as theadName
            scope.put("threadName", scope, Thread.currentThread().getName()); //$NON-NLS-1$
            scope.put("sampler", scope, currentSampler); //$NON-NLS-1$
            scope.put("sampleResult", scope, previousResult); //$NON-NLS-1$

            Object result = cx.evaluateString(scope, script, "<cmd>", 1, null); //$NON-NLS-1$

            resultStr = Context.toString(result);
            if (varName != null && vars != null) {// vars can be null if run from TestPlan
                vars.put(varName, resultStr);
            }
        } catch (RhinoException e) {
            log.error("Error processing Javascript: [" + script + "]\n", e);
            throw new InvalidVariableException("Error processing Javascript: [" + script + "]", e);
        } finally {
            Context.exit();
        }
        return resultStr;
    }

    /** {@inheritDoc} */
    @Override
    public void setParameters(Collection<CompoundVariable> parameters) throws InvalidVariableException {
        checkParameterCount(parameters, 1, 2);
        values = parameters.toArray();
    }

    /** {@inheritDoc} */
    @Override
    public String getReferenceKey() {
        return KEY;
    }

    /** {@inheritDoc} */
    @Override
    public List<String> getArgumentDesc() {
        return desc;
    }

}