Mar 1, 2016

Unit Testing URI-Based Grails Filters

This week while implementing a simplified version of Spring MVC in a Grails 2.x project, I ran into an interesting Grails bug (OK, more than one; it’s been a rough week).  Specifically, “GRAILS-8702: Unit Testing of URI based Filters seems not to work“. There’s even a discussion about it, but the answers there do not seem to work consistently, or may simply be incomplete for my purposes. While playing around with this issue, I believe I’ve found a workaround.

To begin with, let’s say we have three classes: a simple controller, our filter, and the currently-broken unit test for our filter (in this case using Spock). For the sake of simplicity, our filter will simply set two non-functional headers on the response to the controllerName and actionName.



If you run the test, you’ll see that it fails with the errors that the response headers are not equal to the values we’ve put in. We had expected this syntax to work because it’s similar to how we would specify tests for a filter using the “controller:” and “action:” notation. So how can we resolve this?

First we need to set the request’s requestURI field so that the filter actually intercepts our request. The specific value doesn’t matter, as long as it matches the URI:

This alone, however, is not sufficient to make the tests pass, as the values we need (the controllerName and actionName) are still not set, and an exception may be thrown (depending on how they’re used). For this, we simply change our invocation of the filter, and move away from the uri: call. Thus the complete, passing test will look like:

That’s it! Not the most complicated of solutions, but certainly befuddling the first time you run into it.

Igor Shults

About the Author

Object Partners profile.

One thought on “Unit Testing URI-Based Grails Filters

Leave a Reply

Your email address will not be published. Required fields are marked *

Related Blog Posts
Google Professional Machine Learning Engineer Exam 2021
Exam Description A Professional Machine Learning Engineer designs, builds, and productionizes ML models to solve business challenges using Google Cloud technologies and knowledge of proven ML models and techniques. The ML Engineer is proficient in all aspects […]
Designing Kubernetes Controllers
There has been some excellent online discussion lately around Kubernetes controllers, highlighted by an excellent Speakerdeck presentation assembled by Tim Hockin. What I’d like to do in this post is explore some of the implications […]
React Server Components
The React Team recently announced new work they are doing on React Server Components, a new way of rendering React components. The goal is to create smaller bundle sizes, speed up render time, and prevent […]
Jolt custom java transform
Jolt is a JSON to JSON transformation library where the transform is defined in JSON. It’s really good at reorganizing the json data and massaging it into the output JSON you need. Sometimes, you just […]