/*
  Copyright 2013 the original author or authors.

  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 io.neba.core.mvc;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.request.RequestPathInfo;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.verify;
import static org.springframework.web.util.WebUtils.INCLUDE_REQUEST_URI_ATTRIBUTE;
import static org.springframework.web.util.WebUtils.INCLUDE_SERVLET_PATH_ATTRIBUTE;

/**
 * @author Olaf Otto
 */
@RunWith(MockitoJUnitRunner.class)
public class SlingMvcServletRequestTest {
    @Mock
    private SlingHttpServletRequest request;
    @Mock
    private RequestPathInfo requestPathInfo;

    private SlingMvcServletRequest testee;

    @Before
    public void setUp() throws Exception {
        doReturn(this.requestPathInfo).when(this.request).getRequestPathInfo();
        doReturn("/bin/mvc").when(this.requestPathInfo).getResourcePath();
        doReturn("do").when(this.requestPathInfo).getExtension();
        doReturn("/controllerPath").when(this.requestPathInfo).getSuffix();

        this.testee = new SlingMvcServletRequest(this.request);
    }

    @Test
    public void testMvcRequestProvidesServletResourcePathAndExtensionAsServletPath() throws Exception {
        assertThat(this.testee.getServletPath()).isEqualTo("/bin/mvc.do");
    }

    /**
     * By default, sling provides the original request's servlet path, even if
     * a completely different path was included. For instance, a request to
     * "/test.html" with a subsequent <sling:include path="/other/path"> will
     * yield the include path "".
     *
     * Test that the {@link SlingMvcServletRequest} overrides this behavior, providing
     * the actually included servlet path. This allows including MVC resources, e.g.
     * <sling:include path="/bin/mvc.do/controller">
     */
    @Test
    public void testIncludeServletPathIsSameAsServletPath() throws Exception {
        assertThat(this.testee.getAttribute(INCLUDE_SERVLET_PATH_ATTRIBUTE))
                .isEqualTo("/bin/mvc.do");
    }

    /**
     * By default, sling provides the original request's URI, even if
     * a completely different URI was included. For instance, a request to
     * "/test.html" with a subsequent <sling:include path="/servlet/path"> will
     * yield the include URI path "/test.html".
     *
     * Test that the {@link SlingMvcServletRequest} overrides this behavior, providing
     * the actually included URI. This allows including MVC resources, e.g.
     * <sling:include path="/bin/mvc.do/controller">
     */
    @Test
    public void testIncludeContextPathIsSameAsServletPath() throws Exception {
        assertThat(this.testee.getAttribute(INCLUDE_REQUEST_URI_ATTRIBUTE))
                .isEqualTo("/bin/mvc.do/controllerPath");
    }

    @Test
    public void testOtherAttributesAreFetchedFromTheOriginalRequest() throws Exception {
        this.testee.getAttribute("other.attribute");
        verify(this.request).getAttribute("other.attribute");
    }
}