<\/code><\/code>Beanshell Sampler<\/a>.<\/li>\n<\/code><\/code>Beanshell PreProcessor<\/a>.<\/li>\n<\/code><\/code>Beanshell PostProcessor<\/a>.<\/li>\n<\/code><\/code>__BeanShell<\/a> function.<\/li>\n<\/code><\/code>Beanshell Assertion<\/a>.<\/li>\n<\/ol>\nBelow are the JMeter API classes exposed to Beanshell. If you look at the bottom of Beanshell, you\u2019ll see the list of variables defined for the script.<\/p>\n
![](\"https:\/\/d1u7j79bg1ays7.cloudfront.net\/blog\/wp-content\/uploads\/2018\/06\/word-image-4.png\")
<\/p>\n
SampleResult<\/strong><\/h2>\nYou can access the member variables and methods of the <\/code><\/code>SampleResult<\/a> Class in Beanshell.<\/p>\nFor example, you can set and get the thread name using setThreadName()<\/code> and getThreadName()<\/code> methods respectively.<\/p>\n![](\"https:\/\/d1u7j79bg1ays7.cloudfront.net\/blog\/wp-content\/uploads\/2018\/06\/word-image-5.png\")
<\/p>\n
ResponseCode<\/strong><\/h2>\nThis class allows you to set response code manually. In some situations, you may need to set the response code based on the response that you get from server.
\nHere is a sample use-case:<\/p>\n
if (condition) {\n ResponseCode = \"200\";\n}\nelse {\n ResponseCode = \"500\";\n}\n<\/pre>\nResponseMessage<\/strong><\/h2>\nThis class allows you to set the response message manually. The sample use case is the same as the one for ResponseCode<\/code>.<\/p>\nIsSuccess:<\/strong><\/h2>\nIsSuccess<\/code> is a Boolean<\/code> that reflects whether the sampler succeeded. If it\u2019s set to true, the sampler is considered to have \u201cpassed.\u201d Otherwise, it will be marked as \u201cfailed\u201d.<\/p>\nif (condition) {\n IsSuccess = true;\n}\nelse {\n IsSuccess = false;\n}\n<\/pre>\nctx<\/strong><\/h2>\nctx<\/code> is the most powerful variable exposed to BeanShell. It represents the <\/code><\/code>JMeterContext <\/a> class, which is virtually JMeter itself. It provides read\/write access to the underlying JMeter engine, samplers, and their results as well as variables\/properties.<\/p>\nThe following code demonstrates the usage of ctx variable:<\/p>\n
log.info(\"Current Sampler class is: \" + ctx.getCurrentSampler());\nlog.info(\"JMeter Engine class is: \" + ctx.getEngine());\n\nlog.info(\"Previous Response Message is: \" + ctx.getPreviousResult().getResponseMessage());\nlog.info(\"Previous Response Code is: \" + ctx.getPreviousResult().getResponseCode());\nlog.info(\"Previous Response URL is: \" + ctx.getPreviousResult().getURL());\nlog.info(\"Previous Response Time is: \" + ctx.getPreviousResult().getTime());\n\nlog.info(\"Previous Domain is: \" + ctx.getPreviousSampler().getDomain());\nlog.info(\"Previous Protocol is: \" + ctx.getPreviousSampler().getProtocol());\nlog.info(\"Previous Port is: \" + ctx.getPreviousSampler().getPort());\nlog.info(\"Previous Method is: \" + ctx.getPreviousSampler().getMethod());\n\nlog.info(\"Thread Name is: \" + ctx.getThread().getThreadName());\nlog.info(\"Thread Start Time is: \" + ctx.getThread().getStartTime());\nlog.info(\"Thread End Time is: \" + ctx.getThread().getEndTime());\nlog.info(\"Start Next Thread Loop on Error: \" + ctx.getThreadGroup().getOnErrorStartNextLoop());\nlog.info(\"Stop Test on Error: \" + ctx.getThreadGroup().getOnErrorStopTest());\n<\/pre>\n![](\"https:\/\/d1u7j79bg1ays7.cloudfront.net\/blog\/wp-content\/uploads\/2018\/06\/word-image-6.png\")
<\/p>\n
Another use case is if you want to write all Assertions error to an HTML file so you can see which assertion is not working. You can use ctx<\/code> variable in Beanshell assertion to iterate through all samplers in the current context and write the failures in an html file.<\/p>\nAdd a Beanshell assertion and copy the following code to write all the assertions to a html file:<\/p>\n
import org.apache.jmeter.services.FileServer;\nf = new FileOutputStream(\"C:\\\\apache-jmeter-4.0\\\\bin\\\\result.html\", true);\npt = new PrintStream(f);\npt.println(\"<html><body>\");\nfor (a: SampleResult.getAssertionResults()) {\n if (a.isError() || a.isFailure()) {\n log.error(\"URL :\"+ ctx.getCurrentSampler().toString());\n log.error(Thread.currentThread().getName()+\": \"+SampleLabel+\": Assertion failed for response: \" + new String((byte[]) ResponseData));\n pt.println(\"URL :\"+ ctx.getCurrentSampler().toString());\n pt.println(Thread.currentThread().getName()+\": \"+SampleLabel+\": Assertion failed for response: \" + new String((byte[]) ResponseData)); \/\/ update here what you want to write\n }\n pt.println(\"<\/body><\/html>\");\n pt.close();\n f.close();\n}\n<\/pre>\nvars<\/strong><\/h2>\nIt\u2019s an instance of the <\/code><\/code>JMeterVariables<\/a> class and provides read\/write access to current variables, is capable of enumerating\/changing existing variables, creating new variables, and obtaining nested properties. All JMeter variables are Java strings. If you need to put something else to a JMeter variable, you\u2019ll need to cast it to a string first. The following code snippet demonstrates how to save previous sampler response data into a JMeter variable:<\/p>\nvars.put(\"ResponceData\", prev.getResponseDataAsString());\nlog.info(vars.get(\"ResponceData\"));\n<\/pre>\n![](\"https:\/\/d1u7j79bg1ays7.cloudfront.net\/blog\/wp-content\/uploads\/2018\/06\/word-image-7.png\")
<\/p>\n
props<\/strong><\/h2>\nBasically, this is the same as vars<\/code>, but it exposes JMeter properties instead. See JavaDoc on java.util.Properties<\/code> and JMeter documentation on JMeter properties for more information. The primary distinction between props<\/code> and vars<\/code> is that props have a \u201cglobal\u201d scope, whereas the scope of vars<\/code> is limited to the current thread group.<\/p>\nlog<\/strong><\/h2>\nlog<\/code> represents the Logger<\/code> class and can be used to append a message into jmeter.log<\/code> file. The following is the sample use case:<\/p>\nlog.info(\"Test Message with INFO level\");\nlog.error(\"Test Message with ERROR level\");\n<\/pre>\nSome Common Use Cases of Beanshell<\/strong><\/h2>\nWriting custom requests in JMeter.<\/strong><\/h4>\nIn some cases, you might want to add parameters based on the response. You can do this using the Beanshell preprocessor.<\/p>\n
The sampler.addArgument()<\/code> method allows you to add arguments before hitting the server manually.<\/p>\nChanging JMeter Variables.<\/strong><\/h4>\nAs mentioned earlier, you can update JMeter variables on the fly using Beanshell. Assume that you have a user defined variable called \u201ccounter\u201d with the value of \u201c1\u201d. Let\u2019s say you want to increment this counter value by one every time it executes a sampler in while loop. The following code snippet increments the counter value by one and updates the same:<\/p>\n
int counter = Integer.parseInt(vars.get(\"counter\")) +1;\nvars.put(\"counter\",Integer.toString(counter));\n<\/pre>\nUsing a Custom Jar in the Beanshell Sampler.<\/strong><\/h4>\nAssume that you have a requirement to call one of the methods which is present in a user created class. You can call the methods present in user created JAR file using Beanshell.<\/p>\n
\n- Place your User created Jar file in
lib\/ext<\/code> folder of JMeter.<\/li>\n- Restart JMeter to pick the .jar.<\/li>\n
- Add a Beanshell sampler to your Test Plan and call the method from .jar file as you would do in Java.<\/li>\n<\/ol>\n
For Example :<\/p>\n
Given you have the following class:<\/p>\n
package timeStampPack;\nimport java.text.SimpleDateFormat;\nimport java.util.Calendar;\npublic class TimeStampConversion\n{\n public TimeStampConversion() {}\n public static String getTimeStamps(int count)\n {\n String dates = \"\";\n for (int i = 1; i <= count; i++)\n {\n try {\n Thread.sleep(1L);\n } catch (InterruptedException e) {\n e.printStackTrace();\n }\n dates = dates + \"TimeStamp\" + i + \"==>\" + getCurrentDateTime() + \"\\n\";\n }\n return dates;\n }\n}\n<\/pre>\nIn above class, getTimeStamps()<\/code> method returns timestamp, packages it as timeStamp.jar and copies the file to the lib\/ext<\/code> folder of your JMeter installation.<\/p>\nAdd Beanshell Sampler to your Test Plan and put the following code into the “Script” area.<\/p>\n
Import timeStampPack.*;\nvar time=TimeStampConversion.getTimeStamps(1);\nlog.info(time);\n<\/pre>\nThe above code will call getTimeStamps()<\/code> method and logs the value.<\/p>\n![](\"https:\/\/d1u7j79bg1ays7.cloudfront.net\/blog\/wp-content\/uploads\/2018\/06\/word-image-8.png\")
<\/p>\n
You can also use Beanshell to parameterize test data using CSV file. Check this article<\/a> to see details.<\/p>\nHow RedLine13 Enhances JMeter Load Testing<\/strong><\/h2>\nJMeter is an excellent open source load testing tool used by thousands of developers. If you\u2019re one of them, you may want to load test. JMeter can be used for load testing. With RedLine13, you can run a JMeter Load Test<\/a> with your JMX script of any mobile application, web application, or API in 10 minutes.<\/p>\n","protected":false},"excerpt":{"rendered":"