4 Multi-Tenancy Unit Testing

Testing controller logic that uses Multi-Tenancy requires special considerations.

Luckily GORM 6.1 makes it relatively simple to write unit tests.

To write a unit test for the VehicleController class create a new src/test/groovy/example/VehicleControllerSpec.groovy Spock specification:

As you can see above the test extends HibernateSpec.

To make testing simpler override the tenantResolverClass by overriding the getConfiguration() method of HibernateSpec:

This will allow you to use SystemPropertyTenantResolver for changing the tenant id within the test.

Next step is to provide a setup method that configures the VehicleService for the controller:

To ensure proper cleanup you should also clear the tenant id in a cleanup method:

With that done it is trivial to test the controller logic, for example to test the index action with no data:

You can also write tests to test the case where no tenant id is present by clearing the tenant id:

Testing more complex interactions like saving data is possible too:

Note that within the assertions of the above test we use the vehicleService which makes sure the correct database connection is used when making the assertion.