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
Rewriting files in Google Cloud Storage
Rewriting Files in GCP Note: even though this code is in Python, this should be the same idea in JavaScript, Go, etc. I wrote the following to copy a file from one Google Cloud Storage […]
Interpreting Spatial Data in the Age of COVID-19
As 2020 has come to an end, many are eager to leave the mess of COVID-19 behind with the new year and gain a fresh start. Unfortunately, new cases are still soaring across the United […]
Building a Better Mousetrap
Recently, my daughter (age 6) was into building “mousetraps” out of shoe boxes. These were more or less comfortable cardboard mouse houses complete with beds, rooms, everything a mouse could want or need and not […]
ARM Wrestling Its Way Into Mainstream Software Development
Nearly all smart phones have been running ARM-based processors for years. They provide superior power for the amount of power consumed, and thus extend battery life. With Apple’s recent release of the Apple Silicon M1 […]