JUnit Test Cases for Sling Models based on Delegation Pattern

[amirk63597623]

I am trying to write jUnit test cases for custom teaser component which extends the core Teaser component using the Delegation Pattern for Sling Models using "@Self @Via(type=ResourceSuperType.class)" as specified here: https://github.com/adobe/aem-core-wcm-components/wiki/Delegation-Pattern-for-Sling-Models
When I try to set the context (io.wcm.testing.mock.aem.junit5.AemContext) and adapt the context's request (I've tried resource as well) to the model I have created (like the "PageHeadline" from the example), I am getting a NullPointerException.

I am using AEM 6.5.2.0 and trying to run test cases in JUnit 5

[amirk63597623]

Hello! Have you resolved the issue? I mean the case when we use one of the core component Teaser's methods? I also have a NullPointer.

[Rick_Holdsworth]

Is there any way you can UN-accept the solution ?

[leo47089]

For what it's worth... Do make sure your JSON content includes the sling:resourceSuperType property and value (project/customcomponent). I had extended the Core Text component and had problems because the "coreText" was null, thus could not call getText(), getId(), isRichText(); but once the sling:resourceSuperType was added to the JSON, the tests worked fine and passed.

[Arun_Patidar · Accepted solution]

I've managed to find a solution.

Basically instead of relying on injection during the Unit test I've used Mockito and FieldSetter.setField

The only change to the source code would be to ensure the defaultInjectionStrategy was Optional. Not ideal but minimal

First we need to adapt the request to core Teaser.class

Teaser coreTeaser = request.adaptTo(Teaser.class);

Then we adapt the request to our custom teaser

CustomTeaser underTest = request.adaptTo(CustomTeaser.class);

Then we set the field that's not injecting

try {
    FieldSetter.setField(underTest, underTest.getClass().getDeclaredField("teaser"), coreTeaser);
} catch (NoSuchFieldException e) {
    e.printStackTrace();
}

Specific to Teaser I also had to set some SlingBindings so that @ScriptVariables were set when adapting the request to Teaser.class

@BeforeEach

request = context.request();

Component component = mock(Component.class);
Style style = mock(Style.class);
SlingBindings slingBindings = (SlingBindings) request.getAttribute(SlingBindings.class.getName());
slingBindings.put(WCMBindingsConstants.NAME_COMPONENT, component);
slingBindings.put(WCMBindingsConstants.NAME_CURRENT_STYLE, style);
request.setAttribute(SlingBindings.class.getName(), slingBindings);

Following may only be specific to our POM setup but thought I'd add for completeness 

I also had to bump aem mock junit5 dependency to

<artifactId>io.wcm.testing.aem-mock.junit5</artifactId>
<version>4.0.0</version>

[Arun_Patidar · Accepted solution]

Thanks for sharing

[aderler · Accepted solution]

Thanks for the information, unfortunately, this does not work when the core model needs to be accessed in a @PostConstruct method, since at that time (that is, when adapting to the CustomModel) the core model member is null. Still searching for a solution for this problem.

[gomatis80521865]

Hi,

You need to use one more adaptable to adapt Teaser Component 

e.g.

@Model(adaptables = SlingHttpServletRequest.class, adapters = {Teaser.class, CustomTeaser.class}, resourceType = TeaserImpl.RESOURCE_TYPE)

Use CustomeTaeser to adapt to Junit test cases.

It will not cover 100% coverage but you will be able to write test cases for custom functionality.

[gomatis80521865]

I tried adding that additional adapter class and I'm still getting null when I try to adapt the context request to my CustomTeaser

[Arun_Patidar]

Please check demo code:

https://github.com/arunpatidar02/aem63app-repo/blob/master/java/CustomTeaser.java

https://github.com/arunpatidar02/aem63app-repo/blob/master/java/CustomTeaserTest.java

There might be issue with init function inside your model class.

[gomatis80521865]

Thank you Arun! I resolved the issue with the help of your sample code. I had missed out the "defaultInjectionStrategy=DefaultInjectionStrategy.OPTIONAL" option in my custom model which in turn caused an error during init when being initialised through the test case.

[thienm92844762]

Thank you so much! You saved my life.

[gomatis80521865]

Hi Arun. Is it possible to create JUnit test cases even if we use one of the core component Teaser's methods (say like isActionsEnabled or getActions) inside our CustomTeaser's @PostConstruct method? Because when I try to do that I am not able adapt the context without encountering a NullPointer inside the method annotated with @PostConstruct in CustomTeaser.

[pjcalvo]

Hi.

[pjcalvo]

Hi. I am having the same problem here. The core component property is always null in the custom implementation. And making it Optional just skips the instantiation of it.

[GonzaloCalandria]

Have you fixed the null Teaser object in your test when you did adaptTo? I'm trying to do the same with an extesion of the Image core component but I'm still having my image field (the one with the @Self) null.

[Arun_Patidar]

Hi,I am also not able to get all the properties of Teaser in junit test class, I was able to manage to write test cases only for custom properties using CustomTeaser class adapter. If you will adapt model to Teaser, you will see NPE.

[chris-parr]

I don't see the accepted solution as a solution. The model fails to adapt.

Making the field in the model optional hides the issue, but this too is not a solution (it just masks the problem).

[Rick_Holdsworth]

I also do not see this as an acceptable answer. My Teaser via the ResourceSuperType is always null

[#20]

Anyway, next to the working solution this seems to be a short-coming of the mocking libraries. Can you create a minimal testcase (at best without any AEM dependency) and post it to the sling-developer list?

[#21]

I have the same issue. I needed to declare the delegate proxy core component (Page in my case) as optional in my sling model as it is not resolved in the unit test (should not be optional in the real use case). Is a pity because my custom logic is simply a fallback of the core component one. I would like to have the object not null in my unit test so I will drop the Optional annotation for the field.

[#22]

Thank you so much!

[gomatis80521865]

have you registered the Sling model for the core teaser component as well to the context?

Jörg

[gomatis80521865]

Yes. I have included it in the context as follows: context.addModelsForClasses(com.adobe.cq.wcm.core.components.models.Teaser.class);

[gomatis80521865]

Yes. I have included it in the context as follows:context.addModelsForClasses(com.adobe.cq.wcm.core.components.models.Teaser.class);