May 5, 2014

Groovy Goodness: BaseScript with Abstract Run Script Method

In a previous blog post we have seen how we can use a BaseScript AST transformation to set a base script class for running scripts. Since Groovy 2.3 we can apply the @BaseScript annotation on package and import statements. Also we can implement a run method in our Script class in which we call an abstract method. The abstract method will actually run the script, so we can execute code before and after the script code runs by implementing logic in the run method.

In the following sample we create a Script class CustomScript. We implement the run method and add the abstract method runCode:

// File: CustomScript.groovy

abstract class CustomScript extends Script {

    def run() {
        try {

            // Run actually script code.
            final result = runCode()

            println "Script says $result"
        } finally {
            println 'Script ended'

    private void before() {
        println 'Script starts'

    // Abstract method as placeholder for
    // the actual script code to run.
    abstract def runCode()

Next we create a Groovy script where we use our new CustomScript class.

// File: Sample.groovy
// Since Groovy 2.3 we can apply the
// @BaseScript annotation on package
// and import statement.

// Script code:
final String value = 'Groovy rules'
assert value.size() == 12

// Return value

When we run our script we see the following output:

Before script runs
Script says Groovy rules
Script ended

Code written with Groovy 2.3.