Use Case: Writing tests for AEM application.
Current Issue: As your project and code base grows, it is really important to make sure that test coverage for code is there to maintain consistency and sanity of your code. Writing test cases for AEM is little bit different than writing conventional Java test cases, This makes it difficult for beginner to write test cases for AEM application.
Idea of this post to give different options available for writing unit test for AEM services.
Prerequisite:
Dependencies: It is recommended to have following dependencies in to your pom before start writing for tests for your application
Case 1: Writing test cases for Generic Helper class.
This is simplest use case where your generic helper class (For example StringUtils, DateUtils) is not using any AEM libraries. For this you can simply use Junit to write your unit test. https://www.tutorialspoint.com/junit
Here is very simple example:
Case 2: Writing test cases for AEM Helper class
This is second use case where you want to test AEM helper methods. For this you can use combination of Junit and Mockito. Use Mockito to Mock AEM services and methods and Junit for assertion.
Here is simple example
Case 3: Writing test cases for AEM services
Now it gets little bit tricky where you need to mock certain behavior of bundle and implicit object. That's why Sling has created Mock version of sling objects and wcm.io has created mock version of AEM objects. You can just use aem mock http://wcm.io/testing/aem-mock/ to achieve most of your use cases. (AEM mock extend Sling mock).
here are some of the common use cases you will come across while testing your service.
1) How can I mock content my service is running against ?
For this it is recommended to use contentLoader API http://wcm.io/testing/aem-mock/usage.html to either load existing json based resource (You can simply get it by creating resource in CRXDE and then using something like RESOURCEPATH.infinity.json to get json for that resource) or just create mock resource using ContentBuilder context.create().resource() or ResourceBuilder context.build().resource() http://wcm.io/testing/aem-mock/apidocs/
Note that if you are mocking Page object then you have to use aem mock using aemcontext.pageManager().create()
2) How Can I initialize properties in the bundle ?
You can use register and activate OSGI service with properties http://wcm.io/testing/aem-mock/usage.html#Registering_OSGi_service for that. Here is some example
3) How Can I inject other service for my service ?
You can either Mock service or use register service API for that http://wcm.io/testing/aem-mock/usage.html#Registering_OSGi_service
Note that when you inject a service to your service using Reference then you have to register this your injected service, otherwise your test will fail.
4) How Can I test sling model ?
You can use aemContext for that. http://wcm.io/testing/aem-mock/usage.html#Sling_Models
Case 4: Writing test cases for AEM servlets and filters
This is very similar to how you would do test cases for Service. For request and response you either have to mock request / response object using Mockito or Use Spy or use sling request and response mock. Since a lot of methods in filter and servlet do not return any result, Make Mockito verify your friend. Here is one example using simple mockito to test servlet
How can I measure my test coverage ?
You can use jococo test coverage plugin along with your build system to measure this coverage. You can have following plugin in to your parent pom
How Can I write Integration test in AEM ?
Very good example here https://github.com/sneakybeaky/AEM-Integration-Test-Example
It is based of sling test base https://sling.apache.org/documentation/development/sling-testing-tools.html
I know this information is not enough to have you set up for writing tests in AEM. Feel free to let me know if you have more question and I will add more stuff here.
Current Issue: As your project and code base grows, it is really important to make sure that test coverage for code is there to maintain consistency and sanity of your code. Writing test cases for AEM is little bit different than writing conventional Java test cases, This makes it difficult for beginner to write test cases for AEM application.
Idea of this post to give different options available for writing unit test for AEM services.
Prerequisite:
- Familiar with Java Junit test framework http://junit.org
- Familiar with Java Mockito test framework http://site.mockito.org/
- Optional: PowerMockito test framework http://powermock.github.io/
- Sling test framework (Mock and IT) https://sling.apache.org/documentation/development.html
- AEM Mock http://wcm.io/testing/aem-mock/ and http://wcm.io/testing/aem-mock/apidocs/
- WCMUse classes Mocking http://aempodcast.com/2015/testing/unit-testing-wcmuse-classes-using-mockito/#.WEmiUMMrJKc
Dependencies: It is recommended to have following dependencies in to your pom before start writing for tests for your application
Case 1: Writing test cases for Generic Helper class.
This is simplest use case where your generic helper class (For example StringUtils, DateUtils) is not using any AEM libraries. For this you can simply use Junit to write your unit test. https://www.tutorialspoint.com/junit
Here is very simple example:
Case 2: Writing test cases for AEM Helper class
This is second use case where you want to test AEM helper methods. For this you can use combination of Junit and Mockito. Use Mockito to Mock AEM services and methods and Junit for assertion.
Here is simple example
Case 3: Writing test cases for AEM services
Now it gets little bit tricky where you need to mock certain behavior of bundle and implicit object. That's why Sling has created Mock version of sling objects and wcm.io has created mock version of AEM objects. You can just use aem mock http://wcm.io/testing/aem-mock/ to achieve most of your use cases. (AEM mock extend Sling mock).
here are some of the common use cases you will come across while testing your service.
1) How can I mock content my service is running against ?
For this it is recommended to use contentLoader API http://wcm.io/testing/aem-mock/usage.html to either load existing json based resource (You can simply get it by creating resource in CRXDE and then using something like RESOURCEPATH.infinity.json to get json for that resource) or just create mock resource using ContentBuilder context.create().resource() or ResourceBuilder context.build().resource() http://wcm.io/testing/aem-mock/apidocs/
Note that if you are mocking Page object then you have to use aem mock using aemcontext.pageManager().create()
2) How Can I initialize properties in the bundle ?
You can use register and activate OSGI service with properties http://wcm.io/testing/aem-mock/usage.html#Registering_OSGi_service for that. Here is some example
3) How Can I inject other service for my service ?
You can either Mock service or use register service API for that http://wcm.io/testing/aem-mock/usage.html#Registering_OSGi_service
Note that when you inject a service to your service using Reference then you have to register this your injected service, otherwise your test will fail.
4) How Can I test sling model ?
You can use aemContext for that. http://wcm.io/testing/aem-mock/usage.html#Sling_Models
Case 4: Writing test cases for AEM servlets and filters
This is very similar to how you would do test cases for Service. For request and response you either have to mock request / response object using Mockito or Use Spy or use sling request and response mock. Since a lot of methods in filter and servlet do not return any result, Make Mockito verify your friend. Here is one example using simple mockito to test servlet
How can I measure my test coverage ?
You can use jococo test coverage plugin along with your build system to measure this coverage. You can have following plugin in to your parent pom
How Can I write Integration test in AEM ?
Very good example here https://github.com/sneakybeaky/AEM-Integration-Test-Example
It is based of sling test base https://sling.apache.org/documentation/development/sling-testing-tools.html
I know this information is not enough to have you set up for writing tests in AEM. Feel free to let me know if you have more question and I will add more stuff here.
