/*
Copyright 2013 the original author or authors.
<p/>
Licensed under the Apache License, Version 2.0 the "License";
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
<p/>
http://www.apache.org/licenses/LICENSE-2.0
<p/>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package io.neba.core.resourcemodels.adaptation;
import io.neba.core.resourcemodels.caching.ResourceModelCaches;
import io.neba.core.resourcemodels.mapping.ResourceToModelMapper;
import io.neba.core.resourcemodels.registration.LookupResult;
import io.neba.core.resourcemodels.registration.ModelRegistry;
import io.neba.core.util.Key;
import io.neba.core.util.OsgiBeanSource;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import org.mockito.stubbing.Answer;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.eq;
import static org.mockito.Matchers.isA;
import static org.mockito.Mockito.*;
/**
* @author Olaf Otto
*/
@RunWith(MockitoJUnitRunner.class)
public class ResourceToModelAdapterTest {
/**
* @author Olaf Otto
*/
private static class TestModel {
}
/**
* @author Olaf Otto
*/
private static class TestModelDerived extends TestModel {
}
@Mock
private ModelRegistry registry;
@Mock
private ResourceToModelMapper mapper;
@Mock
private Resource resource;
@Mock
private ResourceResolver resourceResolver;
@Mock
private ResourceModelCaches caches;
private Map<Key, Object> testCache = new HashMap<>();
private Class<?> targetType;
private Object adapted;
private Object[] models;
private List<LookupResult> sources;
@InjectMocks
private ResourceToModelAdapter testee;
@Before
public void setUp() throws Exception {
Answer storeInCache = invocation -> {
testCache.put((Key) invocation.getArguments()[2], invocation.getArguments()[1]);
return null;
},
lookupFromCache = invocation -> {
Key key = (Key) invocation.getArguments()[0];
return testCache.get(key);
};
doAnswer(storeInCache).when(this.caches).store(isA(Resource.class), any(), isA(Key.class));
doAnswer(lookupFromCache).when(this.caches).lookup(isA(Key.class));
doReturn(this.resourceResolver).when(resource).getResourceResolver();
}
@Test
public void testAdaptationToExactModelType() throws Exception {
withTargetType(TestModel.class);
withAvailableModels(new TestModel());
adapt();
verifyAdapterObtainsSourceFromRegistrar();
verifyAdapterMapsResourceToModel();
assertResourceWasAdaptedToModel();
}
@Test
public void testAdaptationToDerivedModelType() throws Exception {
withTargetType(TestModel.class);
withAvailableModels(new TestModelDerived());
adapt();
verifyAdapterObtainsSourceFromRegistrar();
verifyAdapterMapsResourceToModel();
assertResourceWasAdaptedToModel();
}
@Test
public void testHandlingOfNullBeanSource() throws Exception {
withTargetType(TestModel.class);
withNullReturnedAsBeanSourceFromRegistrar();
adapt();
verifyAdapterObtainsSourceFromRegistrar();
assertResourceWasNotAdaptedToModel();
verifyAdapterDoesNotMapResourceToModel();
}
@Test(expected = AmbiguousModelAssociationException.class)
public void testAdaptationToTypeWithMultipleMappings() throws Exception {
withTargetType(TestModel.class);
withAvailableModels(new TestModel(), new TestModelDerived());
adapt();
}
@Test
public void testAdaptationOfSameResourceWithDifferentResourceTypeYieldsDifferentModel() throws Exception {
withResourceType("resource/type/one");
withResourcePath("/resource/path");
withTargetType(TestModel.class);
withAvailableModels(new TestModel());
adapt();
assertResourceWasAdaptedToModel();
withResourceType("resource/type/two");
withAvailableModels(new TestModelDerived());
adapt();
assertResourceWasAdaptedToModel();
}
@Test
public void testSubsequentAdaptationOfSameResourceWithSameResourceTypeIsServedFromCache() throws Exception {
withResourceType("resource/type/one");
withResourcePath("/resource/path");
withTargetType(TestModel.class);
withAvailableModels(new TestModel());
adapt();
verifyAdapterMapsResourceToModel();
assertResourceWasAdaptedToModel();
withResourceType("resource/type/one");
adapt();
verifyAdapterMapsResourceToModel();
assertResourceWasAdaptedToModel();
}
@Test
public void testAdapterUsesResourceResolverIdentityForCacheKey() throws Exception {
withResourceType("resource/type/one");
withResourcePath("/resource/path");
withTargetType(TestModel.class);
withAvailableModels(new TestModel());
adapt();
verifyModelIsMappedOnlyOnce();
withDifferentResourceResolverForSameResource();
adapt();
verifyModelIsMappedAgain();
}
private void verifyModelIsMappedAgain() {
verify(this.mapper, times(2)).map(eq(this.resource), isA(OsgiBeanSource.class));
}
private void withDifferentResourceResolverForSameResource() {
doReturn(mock(ResourceResolver.class)).when(this.resource).getResourceResolver();
}
private void verifyModelIsMappedOnlyOnce() {
verify(this.mapper, times(1)).map(eq(this.resource), isA(OsgiBeanSource.class));
}
@SuppressWarnings("unchecked")
private void verifyAdapterDoesNotMapResourceToModel() {
verify(this.mapper, never()).map(isA(Resource.class), isA(OsgiBeanSource.class));
}
private void withNullReturnedAsBeanSourceFromRegistrar() {
when(this.registry.lookupMostSpecificModels(eq(this.resource))).thenReturn(null);
when(this.registry.lookupMostSpecificModels(eq(this.resource), eq(this.targetType))).thenReturn(null);
}
private void assertResourceWasNotAdaptedToModel() {
assertThat(this.adapted).isNull();
}
private void assertResourceWasAdaptedToModel() {
assertResourceWasAdaptedToModel(0);
}
private void assertResourceWasAdaptedToModel(int i) {
assertThat(this.adapted).isSameAs(this.models[i]);
}
private void verifyAdapterObtainsSourceFromRegistrar() {
verify(this.registry, times(1)).lookupMostSpecificModels(eq(this.resource), eq(this.targetType));
}
private void verifyAdapterMapsResourceToModel() {
verifyAdapterMapsResourceToModel(0);
}
private void verifyAdapterMapsResourceToModel(int i) {
OsgiBeanSource<?> source = this.sources.get(i).getSource();
verify(this.mapper).map(eq(this.resource), eq(source));
}
@SuppressWarnings({"unchecked", "rawtypes"})
private void withAvailableModels(Object... models) {
this.models = models;
this.sources = new ArrayList<>();
when(this.registry.lookupMostSpecificModels(isA(Resource.class), isA(Class.class))).thenReturn(this.sources);
for (Object model : models) {
OsgiBeanSource source = mock(OsgiBeanSource.class);
LookupResult result = mock(LookupResult.class);
when(result.getSource()).thenReturn(source);
this.sources.add(result);
when(source.getBeanType()).thenReturn((Class) model.getClass());
when(source.getBean()).thenReturn(model);
when(this.mapper.map(eq(this.resource), eq(source))).thenReturn(model);
}
}
private void adapt() {
this.adapted = this.testee.getAdapter(this.resource, this.targetType);
}
private void withTargetType(Class<TestModel> targetType) {
this.targetType = targetType;
}
private void withResourcePath(String path) {
doReturn(path).when(resource).getPath();
}
private void withResourceType(String type) {
doReturn(type).when(this.resource).getResourceType();
}
}