Adobe-Consulting-Services/acs-aem-commons

/*
 * ACS AEM Commons
 *
 * Copyright (C) 2013 - 2023 Adobe
 *
 * 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
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 com.adobe.acs.commons.util;

import com.adobe.acs.commons.util.impl.ActivatorHelper;
import com.adobe.cq.sightly.WCMBindings;
import com.day.cq.wcm.api.Page;
import io.wcm.testing.mock.aem.junit.AemContext;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.NonExistingResource;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ValueMap;
import org.apache.sling.api.scripting.SlingBindings;
import org.apache.sling.scripting.api.BindingsValuesProvider;
import org.apache.sling.scripting.api.BindingsValuesProvidersByContext;
import org.apache.sling.testing.mock.sling.ResourceResolverType;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;

import javax.script.Bindings;
import javax.script.ScriptEngineFactory;
import java.util.Arrays;
import java.util.Collection;
import java.util.Map;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

public class OverridePathSlingRequestWrapperTest {
    private static final String RESOURCE_PATH = "/content/child";
    private static final String PAGE_PATH = "/content/childPage";
    private static final String PAGE_CHILD_RESOURCE_PATH = "/content/childPage/jcr:content/some/child";

    private TestAdaptable testAdaptableInstance = new TestAdaptable();

    private ActivatorHelper activatorHelper = new ActivatorHelper();

    private BindingsValuesProvidersByContext bindingsValuesProvidersByContext;

    @Rule
    public final AemContext context = new AemContext(activatorHelper.afterSetup(), activatorHelper.beforeTeardown(), ResourceResolverType.JCR_MOCK);

    @Before
    public void setup() throws Exception {
        BindingsValuesProvider providerA = mock(BindingsValuesProvider.class);
        doAnswer(new Answer<Object>() {
            @Override
            public Object answer(InvocationOnMock invocationOnMock) throws Throwable {
                ((Bindings) invocationOnMock.getArgument(0)).put("bindingA", "valueA");
                return null;
            }
        }).when(providerA).addBindings(any(Bindings.class));
        BindingsValuesProvider providerB = mock(BindingsValuesProvider.class);
        doAnswer(new Answer<Object>() {
            @Override
            public Object answer(InvocationOnMock invocationOnMock) throws Throwable {
                ((Bindings) invocationOnMock.getArgument(0)).put("bindingB", "valueB");
                return null;
            }
        }).when(providerB).addBindings(any(Bindings.class));
        Collection<BindingsValuesProvider> bindingsValuesProviders = Arrays.asList(providerA, providerB);

        bindingsValuesProvidersByContext = mock(BindingsValuesProvidersByContext.class);
        when(bindingsValuesProvidersByContext.getBindingsValuesProviders(any(ScriptEngineFactory.class), eq("request"))).thenReturn(bindingsValuesProviders);

        this.context.create().resource(RESOURCE_PATH, "prop", "resourceval");
        this.context.create().page(PAGE_PATH, "prop", "pageval");
        this.context.create().resource(PAGE_CHILD_RESOURCE_PATH, "prop", "childval");
        this.context.registerAdapter(SlingHttpServletRequest.class, TestAdaptable.class, testAdaptableInstance);
    }

    @Test
    public void testGetAttributes() {
        this.context.currentResource(RESOURCE_PATH);

        this.context.request().setAttribute("testattr", "testval");
        OverridePathSlingRequestWrapper wrapper = new OverridePathSlingRequestWrapper(this.context.request(), PAGE_CHILD_RESOURCE_PATH);

        assertEquals("testval", wrapper.getAttribute("testattr"));

        Map<String, Object> originalBindings = (Map<String, Object>) this.context.request().getAttribute(SlingBindings.class.getName());
        Map<String, Object> wrappedBindings = (Map<String, Object>) wrapper.getAttribute(SlingBindings.class.getName());

        assertNotNull(originalBindings);
        assertNotNull(wrappedBindings);
        assertNotEquals(originalBindings, wrappedBindings);
        assertEquals(RESOURCE_PATH, ((Resource) originalBindings.get(SlingBindings.RESOURCE)).getPath());
        assertEquals(PAGE_CHILD_RESOURCE_PATH, ((Resource) wrappedBindings.get(SlingBindings.RESOURCE)).getPath());
    }

    @Test
    public void testBindingsForPage() {
        this.context.currentResource(RESOURCE_PATH);

        OverridePathSlingRequestWrapper pageResourceWrapper = new OverridePathSlingRequestWrapper(this.context.request(), PAGE_CHILD_RESOURCE_PATH);
        Map<String, Object> pageResourceBindings = (Map<String, Object>) pageResourceWrapper.getAttribute(SlingBindings.class.getName());
        assertNotNull(pageResourceBindings.get(WCMBindings.CURRENT_PAGE));
        assertEquals(PAGE_PATH, ((Page) pageResourceBindings.get(WCMBindings.CURRENT_PAGE)).getPath());

        OverridePathSlingRequestWrapper pageWrapper = new OverridePathSlingRequestWrapper(this.context.request(), PAGE_PATH);
        Map<String, Object> pageBindings = (Map<String, Object>) pageWrapper.getAttribute(SlingBindings.class.getName());
        assertNotNull(pageBindings.get(WCMBindings.CURRENT_PAGE));
        assertEquals(PAGE_PATH, ((Page) pageBindings.get(WCMBindings.CURRENT_PAGE)).getPath());

        OverridePathSlingRequestWrapper resourceWrapper = new OverridePathSlingRequestWrapper(this.context.request(), RESOURCE_PATH);
        Map<String, Object> resourceWrapperBindings = (Map<String, Object>) resourceWrapper.getAttribute(SlingBindings.class.getName());
        assertNull(resourceWrapperBindings.get(WCMBindings.CURRENT_PAGE));
    }

    @Test
    public void testBindingsForResource() {
        this.context.currentResource(RESOURCE_PATH);

        OverridePathSlingRequestWrapper pageResourceWrapper = new OverridePathSlingRequestWrapper(this.context.request(), PAGE_CHILD_RESOURCE_PATH);
        Map<String, Object> pageResourceBindings = (Map<String, Object>) pageResourceWrapper.getAttribute(SlingBindings.class.getName());
        assertNotNull(pageResourceBindings.get(SlingBindings.RESOURCE));
        assertEquals(PAGE_CHILD_RESOURCE_PATH, ((Resource) pageResourceBindings.get(SlingBindings.RESOURCE)).getPath());
        assertNotNull(pageResourceBindings.get(WCMBindings.PROPERTIES));
        assertEquals("childval", ((ValueMap) pageResourceBindings.get(WCMBindings.PROPERTIES)).get("prop"));
        assertEquals(pageResourceWrapper.getResourceResolver(), pageResourceBindings.get(SlingBindings.RESOLVER));

        OverridePathSlingRequestWrapper resourceWrapper = new OverridePathSlingRequestWrapper(this.context.request(), RESOURCE_PATH);
        Map<String, Object> resourceWrapperBindings = (Map<String, Object>) resourceWrapper.getAttribute(SlingBindings.class.getName());
        assertNotNull(resourceWrapperBindings.get(SlingBindings.RESOURCE));
        assertEquals(RESOURCE_PATH, ((Resource) resourceWrapperBindings.get(SlingBindings.RESOURCE)).getPath());
        assertNotNull(resourceWrapperBindings.get(WCMBindings.PROPERTIES));
        assertEquals("resourceval", ((ValueMap) resourceWrapperBindings.get(WCMBindings.PROPERTIES)).get("prop"));
        assertEquals(resourceWrapper.getResourceResolver(), resourceWrapperBindings.get(SlingBindings.RESOLVER));
    }

    @Test
    public void testBindingsFromAdditiontalProviders() {
        this.context.currentResource(RESOURCE_PATH);

        OverridePathSlingRequestWrapper wrapper = new OverridePathSlingRequestWrapper(this.context.request(), PAGE_CHILD_RESOURCE_PATH, bindingsValuesProvidersByContext);
        Map<String, Object> bindings = (Map<String, Object>) wrapper.getAttribute(SlingBindings.class.getName());
        assertEquals("valueA", bindings.get("bindingA"));
        assertEquals("valueB", bindings.get("bindingB"));
    }

    @Test
    public void testResource() {
        this.context.currentResource(RESOURCE_PATH);

        OverridePathSlingRequestWrapper pageResourceWrapper = new OverridePathSlingRequestWrapper(this.context.request(), PAGE_CHILD_RESOURCE_PATH, bindingsValuesProvidersByContext);
        assertEquals(PAGE_CHILD_RESOURCE_PATH, pageResourceWrapper.getResource().getPath());

        OverridePathSlingRequestWrapper resourceWrapper = new OverridePathSlingRequestWrapper(this.context.request(), RESOURCE_PATH, bindingsValuesProvidersByContext);
        assertEquals(RESOURCE_PATH, resourceWrapper.getResource().getPath());
    }

    @Test
    public void testSupportForNonExistingResource() {
        this.context.currentResource(new NonExistingResource(this.context.resourceResolver(), "/content/bogus1"));

        OverridePathSlingRequestWrapper bogusResourceWrapper = new OverridePathSlingRequestWrapper(this.context.request(), "/content/bogus2", bindingsValuesProvidersByContext);
        assertEquals("/content/bogus2", bogusResourceWrapper.getResource().getPath());
        assertEquals(Resource.RESOURCE_TYPE_NON_EXISTING, bogusResourceWrapper.getResource().getResourceType());
    }

    @Test
    public void testCreationWithoutBindings() {
        // AEM mocks always creates the bindings attribute so we need to manually remove it
        this.context.request().setAttribute(SlingBindings.class.getName(), null);
        this.context.currentResource(RESOURCE_PATH);

        OverridePathSlingRequestWrapper pageResourceWrapper = new OverridePathSlingRequestWrapper(this.context.request(), PAGE_CHILD_RESOURCE_PATH, bindingsValuesProvidersByContext);
        Map<String, Object> pageResourceBindings = (Map<String, Object>) pageResourceWrapper.getAttribute(SlingBindings.class.getName());
        assertNotNull(pageResourceBindings.get(SlingBindings.RESOURCE));
    }

    @Test
    public void testAdaptTo() {
        this.context.currentResource(RESOURCE_PATH);

        OverridePathSlingRequestWrapper pageResourceWrapper = new OverridePathSlingRequestWrapper(this.context.request(), PAGE_CHILD_RESOURCE_PATH, bindingsValuesProvidersByContext);

        TestAdaptable adapted = pageResourceWrapper.adaptTo(TestAdaptable.class);
        assertNotNull(adapted);
    }

    @Test
    public void testAdaptToWithNoBindings() {
        // AEM mocks always creates the bindings attribute so we need to manually remove it
        this.context.request().setAttribute(SlingBindings.class.getName(), null);
        this.context.currentResource(RESOURCE_PATH);

        OverridePathSlingRequestWrapper pageResourceWrapper = new OverridePathSlingRequestWrapper(this.context.request(), PAGE_CHILD_RESOURCE_PATH, bindingsValuesProvidersByContext);

        TestAdaptable adapted = pageResourceWrapper.adaptTo(TestAdaptable.class);
        assertNotNull(adapted);
    }

    private static class TestAdaptable {

    }
}