Fork me on GitHub

12 Aug 2010

Auto-generate Spock specs for Grails artifacts

When creating artifacts such as domain classes, controllers and tag libs Grails generates a JUnit test case. If, like me, you're digging writing specifications with Spock you'd probably rather have Grails generate one of those. The last thing I want is to manually transform every generated test case into a specification for every artifact I create.

It's very simple to create a CreateUnitSpec or CreateIntegrationSpec script with a template specification. Hooking in to the other types of artifact creation turned out to be fiddlier. Each create-* command calls a Closure called createUnitTest. Reassigning that Closure should be the solution. The trick is in figuring out where that can be done.

Any time one of its Gant targets is invoked the Grails build system fires an event. You can respond to those events by declaring a closure called event<target name>Start in scripts/_Events.groovy. The only Gant target directly invoked when an artifact is created is called 'default'. It is possible to intercept that although that means the event handler will be invoked any time any Gant target called 'default' runs. For this purpose that's no problem since we're just overriding a closure in the build binding.

The other factor is that the superclass for the unit test is specified by the individual create-* scripts (or defaulted to GrailsUnitTestCase). Rather than having to override those scripts as well, I've just mapped the non-standard unit test superclasses to the Spock equivalents.

Here's the code for your _Events.groovy script:
The template specification should be placed in src/templates/artifacts/Spec.groovy and is simply:
It goes without saying that this is a slightly hairy and it would be great if Grails provided a proper hook for overriding the test generation. I can live with some fun-size evil in _Events.groovy for the sake of the convenience of getting template specs for all my artifacts, though.


Peter Niederwieser said...

This has been a long-standing feature request for spock-grails. In other words, it's a great opportunity to become an official Spock contributor/committer. :-)

Rob said...

Cool, I'll send Luke a patch

Marco Vermeulen said...
This comment has been removed by the author.
Marco Vermeulen said...

I've also added a hook that generates integration specs:
By adding the following below the createUnitTest closure it should all work:

createIntegrationTest = { Map args = [:] ->
createArtifact name: args["name"], suffix: "${args['suffix']}Spec", type: "Spec", path: "test/integration", superClass: "IntegrationSpec"

It would be nice if this was included into the grails spock plugin by default ;-)

Rick Jensen said...

These two enhancements are currently included in the Spock plugin by default.

Ramachandran Srinivasan said...

I am getting this error:
Groovy:unable to resolve class

I created a unit test for my DomainClass Employees and it produced

import spock.lang.*
import grails.plugin.spock.*

class EmployeesSpec extends UnitSpec {
def "feature method"() {


I changed to UnitTest to Specification, and the class looks good without errors.

Did I miss something?

Rokki Winchester said...

Thanks for posting
I wish it was able to be translated, but for some reason Google toolbar isn't working. I copy pasted it into another application and read the post. 

Unknown said...

Thanks for your sharing! The information your share is very useful to me and many people are looking for them just like me! thank you! I hope you have many useful articles to share with everyone!