Create JMeter Test Plan using JSR223 Sampler

Question

I am new to Jmeter and my current requirement is to create a JMeter Test Plan using JSR223 Sampler in Java and then trigger it.

First step I tried is to run the jmx file(which is using JSR223 Sampler and java code snippet in script area) through Java but getting below error - javax.scripts.ScriptException: Cannot find engine named : ' java', ensure you set language field in JSR223 Test Element: JSR223 Sampler.

My Code:

File jmeterHome = new File(System.getProperty("jmeter.home")); String slash = System.getProperty("file.separator");

    if (jmeterHome.exists()) {
        File jmeterProperties = new File(jmeterHome.getPath() + slash + "bin" + slash + "jmeter.properties");
        if (jmeterProperties.exists()) {
            //JMeter Engine
            StandardJMeterEngine jmeter = new StandardJMeterEngine();

            //JMeter initialization (properties, log levels, locale, etc)
            JMeterUtils.setJMeterHome(jmeterHome.getPath());
            JMeterUtils.loadJMeterProperties(jmeterProperties.getPath());
            JMeterUtils.initLogging();// you can comment this line out to see extra log messages of i.e. DEBUG level
            JMeterUtils.initLocale();

            SaveService.loadProperties();

            // JMeter Test Plan, basically JOrphan HashTree
            HashTree testPlanTree = SaveService.loadTree(new File(JMX FILE PATH))   

            // Run Test Plan
            jmeter.configure(testPlanTree);
            jmeter.run();


        }
    }

Answer 1

If you want to "create" a test plan you're really supposed to "create" it and it sounds like you want to copy and paste a ready solution from online sources or ask someone to write the script for you.

I would expect you to show your code and highlight the problematic place rather than asking to implement a test plan.

---

Whatever.

Here is how you can instantiate a JSR223 Sampler using Java code:

JSR223Sampler jsr223Sampler = new JSR223Sampler();
jsr223Sampler.setName("JSR223 Sampler");
jsr223Sampler.setProperty("cacheKey", "true");
jsr223Sampler.setProperty("script", "println('Hello')");
jsr223Sampler.setProperty("scriptLanguage", "groovy");
jsr223Sampler.setProperty(TestElement.TEST_CLASS, JSR223Sampler.class.getName());
jsr223Sampler.setProperty(TestElement.GUI_CLASS, TestBeanGUI.class.getName());

Full class just in case:

import org.apache.jmeter.config.Arguments;
import org.apache.jmeter.config.gui.ArgumentsPanel;
import org.apache.jmeter.control.LoopController;
import org.apache.jmeter.control.gui.LoopControlPanel;
import org.apache.jmeter.control.gui.TestPlanGui;
import org.apache.jmeter.engine.StandardJMeterEngine;
import org.apache.jmeter.protocol.java.sampler.JSR223Sampler;
import org.apache.jmeter.reporters.ResultCollector;
import org.apache.jmeter.reporters.Summariser;
import org.apache.jmeter.save.SaveService;
import org.apache.jmeter.testbeans.gui.TestBeanGUI;
import org.apache.jmeter.testelement.TestElement;
import org.apache.jmeter.testelement.TestPlan;
import org.apache.jmeter.threads.ThreadGroup;
import org.apache.jmeter.threads.gui.ThreadGroupGui;
import org.apache.jmeter.util.JMeterUtils;
import org.apache.jorphan.collections.HashTree;

import java.io.File;
import java.io.FileOutputStream;


public class JMeterFromScratch {

    public static void main(String[] argv) throws Exception {

        File jmeterHome = new File(System.getProperty("jmeter.home"));
        String slash = System.getProperty("file.separator");

        if (jmeterHome.exists()) {
            File jmeterProperties = new File(jmeterHome.getPath() + slash + "bin" + slash + "jmeter.properties");
            if (jmeterProperties.exists()) {
                //JMeter Engine
                StandardJMeterEngine jmeter = new StandardJMeterEngine();

                //JMeter initialization (properties, log levels, locale, etc)
                JMeterUtils.setJMeterHome(jmeterHome.getPath());
                JMeterUtils.loadJMeterProperties(jmeterProperties.getPath());
                JMeterUtils.initLogging();// you can comment this line out to see extra log messages of i.e. DEBUG level
                JMeterUtils.initLocale();

                // JMeter Test Plan, basically JOrphan HashTree
                HashTree testPlanTree = new HashTree();

                // JSR223 Sampler

                JSR223Sampler jsr223Sampler = new JSR223Sampler();
                jsr223Sampler.setName("JSR223 Sampler");
                jsr223Sampler.setProperty("cacheKey", "true");
                jsr223Sampler.setProperty("script", "println('Hello')");
                jsr223Sampler.setProperty("scriptLanguage", "groovy");
                jsr223Sampler.setProperty(TestElement.TEST_CLASS, JSR223Sampler.class.getName());
                jsr223Sampler.setProperty(TestElement.GUI_CLASS, TestBeanGUI.class.getName());


                // Loop Controller
                LoopController loopController = new LoopController();
                loopController.setLoops(1);
                loopController.setFirst(true);
                loopController.setProperty(TestElement.TEST_CLASS, LoopController.class.getName());
                loopController.setProperty(TestElement.GUI_CLASS, LoopControlPanel.class.getName());
                loopController.initialize();

                // Thread Group
                ThreadGroup threadGroup = new ThreadGroup();
                threadGroup.setName("Example Thread Group");
                threadGroup.setNumThreads(1);
                threadGroup.setRampUp(1);
                threadGroup.setSamplerController(loopController);
                threadGroup.setProperty(TestElement.TEST_CLASS, ThreadGroup.class.getName());
                threadGroup.setProperty(TestElement.GUI_CLASS, ThreadGroupGui.class.getName());

                // Test Plan
                TestPlan testPlan = new TestPlan("Create JMeter Script From Java Code");
                testPlan.setProperty(TestElement.TEST_CLASS, TestPlan.class.getName());
                testPlan.setProperty(TestElement.GUI_CLASS, TestPlanGui.class.getName());
                testPlan.setUserDefinedVariables((Arguments) new ArgumentsPanel().createTestElement());

                // Construct Test Plan from previously initialized elements
                testPlanTree.add(testPlan);
                HashTree threadGroupHashTree = testPlanTree.add(testPlan, threadGroup);
                threadGroupHashTree.add(jsr223Sampler);


                // save generated test plan to JMeter's .jmx file format
                SaveService.saveTree(testPlanTree, new FileOutputStream(jmeterHome + slash + "example.jmx"));

                //add Summarizer output to get test progress in stdout like:
                // summary =      2 in   1.3s =    1.5/s Avg:   631 Min:   290 Max:   973 Err:     0 (0.00%)
                Summariser summer = null;
                String summariserName = JMeterUtils.getPropDefault("summariser.name", "summary");
                if (summariserName.length() > 0) {
                    summer = new Summariser(summariserName);
                }


                // Store execution results into a .jtl file
                String logFile = jmeterHome + slash + "example.jtl";
                ResultCollector logger = new ResultCollector(summer);
                logger.setFilename(logFile);
                testPlanTree.add(testPlanTree.getArray()[0], logger);

                // Run Test Plan
                jmeter.configure(testPlanTree);
                jmeter.run();

                System.out.println("Test completed. See " + jmeterHome + slash + "example.jtl file for results");
                System.out.println("JMeter .jmx script is available at " + jmeterHome + slash + "example.jmx");
                System.exit(0);

            }
        }

        System.err.println("jmeter.home property is not set or pointing to incorrect location");
        System.exit(1);


    }
}

References:

• Five Ways To Launch a JMeter Test without Using the JMeter GUI
• jmeter-from-code example repository
• JSR223Sampler JavaDoc