Groovy is a dynamic scripting language for Java Virtual Machine (JVM). Ever since JMeter 3.0, it has been the default scripting language for standard JVM APIs. Scripting in Groovy simplifies Java programming because it automates recurring takes. Groovy also provides advanced language features.
However, Eclipse, which is a common IDE used by Java developers, does not natively support Groovy script. And that presents a challenge to many developers because they love Groovy, and Eclipse is one of the best IDEs out there. But there are plugins available that can be used for this purpose.
In this blog, we’ll show you how you can use Eclipse to develop Groovy scripts. We’ll also dwell into the benefits of Groovy, and what you can build with it.
Disclaimer
Before we begin, let be clarified that using an IDE is optional and we can always write the code directly into the Event Handler window and it will check for syntax and compile time errors for us. But this way, we won’t be able to make use of the features mentioned earlier.
A brief intro of Groovy
While Groovy is a scripting language, limiting it to just that masks away its many features. It can also pro-compile into Java bytecode using the JAR file in Groovy. That is why it is used in major projects like Jenkins.
Here are some of the prominent features of Groovy in a nutshell:
- Groovy runs on the JVM, so you get the same runtime ecosystem, tooling, and deployment model, while writing in a more flexible, scripting-friendly style.
- It works with Java code and libraries so you can use existing Java classes, frameworks, and dependencies without wrappers or special adapters.
- Groovy fits with Java’s object model. Everything in it is still an object in the Java sense, which keeps the mental model familiar.
- Abstracted classes, interfaces, and inheritance are the same concepts in Groovy as Java because the former understands the core Java structures.
These are just the surface-level features of Groovy. It is really like using Java on steroids with all the Java features, plus the vast set of Groovy libraries.
Running Groovy with Groovy-Eclipse plugin
Eclipse offers many add-ons to run additional Java-compatible products. The Groovy-Eclipse plugin is one such add-on to compile Groovy code in Eclipse. With this plugin, the IDE treats Groovy as a first-class language.
INSTALLING GROOVY-ECLIPSE PLUGIN
The plugin we are going to use for this is Groovy-Eclipse available at:
URLs for releases of specific Eclipse are on the wiki page:
Copy the URL for version of Eclipse you have. Then launch Eclipse, click on Help and select Install New Software.
For this case, we are going to install Groovy-Eclipse Feature and Groovy Compiler Feature.
Note: As of now Agile PLM supports Groovy 1.5.6 so any of the later compilers can work. The compiler feature for versions earlier than 1.8 is not available.
After making the selection, click next. Go through to the terms and conditions and hit finish to install.
Once installed, Eclipse will restart automatically.
On the New dialog, search for and select Groovy Project and then click Next.
Give the project a name and click finish.
Eclipse will create the Project for us. But before we can start writing code for our process extension, we have to include relevant libraries into our project.
The libraries we are going to need are the following. They come with the installation of Agile PLM.
- AgileAPI.jar
- agileclasses.jar
To do this, right click the Project and select Properties. In the Project Properties, select Java Build Path and go to Libraries tab. Click on Add External JARs and select AgileAPI.jar and agileclasses.jar. Click OK once done.
Now we are going to add a class for Groovy. To do that right click the src folder. Select New and Other.
In the New wizard search for and select Groovy Class and click Next.
In create new class window, enter a name for the package and class. Then click finish.
Eclipse will create the class. Edit it and add the following started code and import statement.
package com.xavor.groovyproject
import com.agile.agileDSL.ScriptObj.IBaseScriptObj
class GroovyClass {
void invokeScript(IBaseScriptObj obj) {
}
}
Once we do that we can go ahead and start implementing. Eclipse will help with the code completion.
Please note that since Groovy script is a dynamically type language and we can’t be certain of an object type at compile time, you might have to use variable declaration to make use of IntelliSense.
After the code is written, the last step is to copy it to the event handler in Java client.
RESOURCES
- Eclipse: https://www.eclipse.org/
- Groovy-Eclipse plugin: https://github.com/groovy/groovy-eclipse
- Agile PLM Documentation
- Agile SDK JavaDocs
FAQs
Groovy scripting is used to write quick, flexible automation and custom logic on the JVM, often embedded inside applications and tools. It’s commonly used to customize workflows, integrate systems, transform data, and extend platforms like Jenkins or Gradle.
Yes, Groovy is generally easy to learn, especially if you already know Java or any C-style language. Its syntax is simpler and more flexible than Java, so you can become productive quickly for scripting and automation tasks.
No, Groovy isn’t dying. While its popularity has dropped, it’s still actively maintained and released by the Apache Groovy project. Now, it’s more niche than it used to be, but it remains widely used in areas like Jenkins pipelines and Gradle/build tooling.