src/test/java/org/apache/sling/engine/impl/request/SlingRequestPathInfoTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.sling.engine.impl.request;

import org.apache.sling.api.request.RequestDispatcherOptions;
import org.apache.sling.api.request.RequestPathInfo;
import org.apache.sling.api.resource.AbstractResource;
import org.apache.sling.api.resource.ResourceMetadata;
import org.apache.sling.api.resource.ResourceResolver;
import org.junit.Test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.fail;

/** Test the SlingRequestPathInfo class */
public class SlingRequestPathInfoTest {

    @Test
    public void testNullResource() {
        try {
            new SlingRequestPathInfo(null);
            fail("Expected NullPointerException");
        } catch (NullPointerException npe) {
            // required for a null resource
        }
    }

    @Test
    public void testTrailingDot() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path", "."));
        assertEquals("/some/path", p.getResourcePath());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals(0, p.getSelectors().length);
        assertNull("Extension is null", p.getExtension());
        assertNull("Suffix is null", p.getSuffix());
    }

    @Test
    public void testTrailingDotWithSuffix() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path", "./suffix"));
        assertEquals("/some/path", p.getResourcePath());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals(0, p.getSelectors().length);
        assertNull("Extension is null", p.getExtension());
        assertEquals("/suffix", p.getSuffix());
    }

    @Test
    public void testTrailingDotDot() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path", ".."));
        assertEquals("/some/path", p.getResourcePath());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals(0, p.getSelectors().length);
        assertNull("Extension is null", p.getExtension());
        assertNull("Suffix is null", p.getSuffix());
    }

    @Test
    public void testTrailingDotDotWithSuffix() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path", "../suffix"));
        assertEquals("/some/path", p.getResourcePath());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals(0, p.getSelectors().length);
        assertNull("Extension is null", p.getExtension());
        assertEquals("/suffix", p.getSuffix());
    }

    @Test
    public void testTrailingDotDotDot() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path", "..."));
        assertEquals("/some/path", p.getResourcePath());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals(0, p.getSelectors().length);
        assertNull("Extension is null", p.getExtension());
        assertNull("Suffix is null", p.getSuffix());
    }

    @Test
    public void testTrailingDotDotDotWithSuffix() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path", ".../suffix"));
        assertEquals("/some/path", p.getResourcePath());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals(0, p.getSelectors().length);
        assertNull("Extension is null", p.getExtension());
        assertEquals("/suffix", p.getSuffix());
    }

    @Test
    public void testAllOptions() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path", ".print.a4.html/some/suffix"));
        assertEquals("/some/path", p.getResourcePath());
        assertEquals("print.a4", p.getSelectorString());
        assertEquals(2, p.getSelectors().length);
        assertEquals("print", p.getSelectors()[0]);
        assertEquals("a4", p.getSelectors()[1]);
        assertEquals("html", p.getExtension());
        assertEquals("/some/suffix", p.getSuffix());
    }

    @Test
    public void testAllEmpty() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/", null));
        assertEquals("/", p.getResourcePath());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals(0, p.getSelectors().length);
        assertNull("Extension is null", p.getExtension());
        assertNull("Suffix is null", p.getSuffix());
    }

    @Test
    public void testPathOnly() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path/here", ""));
        assertEquals("/some/path/here", p.getResourcePath());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals(0, p.getSelectors().length);
        assertNull("Extension is null", p.getExtension());
        assertNull("Suffix is null", p.getSuffix());
    }

    @Test
    public void testPathWithExtensionOnly() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path/here.html", ""));
        assertEquals("/some/path/here.html", p.getResourcePath());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals(0, p.getSelectors().length);
        assertNull("Extension is null", p.getExtension());
        assertNull("Suffix is null", p.getSuffix());
    }

    @Test
    public void testPathAndExtensionOnly() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path/here", ".html"));
        assertEquals("/some/path/here", p.getResourcePath());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals(0, p.getSelectors().length);
        assertEquals("html", p.getExtension());
        assertNull("Suffix is null", p.getSuffix());
    }

    @Test
    public void testPathAndOneSelectorOnly() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path/here", ".print.html"));
        assertEquals("/some/path/here", p.getResourcePath());
        assertEquals("print", p.getSelectorString());
        assertEquals(1, p.getSelectors().length);
        assertEquals("print", p.getSelectors()[0]);
        assertEquals("html", p.getExtension());
        assertNull("Suffix is null", p.getSuffix());
    }

    @Test
    public void testPathExtAndSuffix() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path/here", ".html/something"));
        assertEquals("/some/path/here", p.getResourcePath());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals(0, p.getSelectors().length);
        assertEquals("html", p.getExtension());
        assertEquals("/something", p.getSuffix());
    }

    @Test
    public void testSelectorsSplit() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path", ".print.a4.html/some/suffix"));
        assertEquals("/some/path", p.getResourcePath());
        assertEquals(2, p.getSelectors().length);
        assertEquals("print", p.getSelectors()[0]);
        assertEquals("a4", p.getSelectors()[1]);
        assertEquals("html", p.getExtension());
        assertEquals("/some/suffix", p.getSuffix());
    }

    @Test
    public void testPartialResolutionB() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path", ".print.a4.html/some/suffix"));
        assertEquals("/some/path", p.getResourcePath());
        assertEquals("print.a4", p.getSelectorString());
        assertEquals(2, p.getSelectors().length);
        assertEquals("print", p.getSelectors()[0]);
        assertEquals("a4", p.getSelectors()[1]);
        assertEquals("html", p.getExtension());
        assertEquals("/some/suffix", p.getSuffix());
    }

    @Test
    public void testPartialResolutionC() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path.print", ".a4.html/some/suffix"));
        assertEquals("/some/path.print", p.getResourcePath());
        assertEquals("a4", p.getSelectorString());
        assertEquals(1, p.getSelectors().length);
        assertEquals("a4", p.getSelectors()[0]);
        assertEquals("html", p.getExtension());
        assertEquals("/some/suffix", p.getSuffix());
    }

    @Test
    public void testPartialResolutionD() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path.print.a4", ".html/some/suffix"));
        assertEquals("/some/path.print.a4", p.getResourcePath());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals(0, p.getSelectors().length);
        assertEquals("html", p.getExtension());
        assertEquals("/some/suffix", p.getSuffix());
    }

    @Test
    public void testDotsAroundSuffix() {
        RequestPathInfo p = new SlingRequestPathInfo(
                new MockResource("/libs/foo/content/something/formitems", ".json/image/vnd/xnd/knd.xml"));
        assertEquals("/libs/foo/content/something/formitems", p.getResourcePath());
        assertEquals("json", p.getExtension());
        assertNull("Selectors are null", p.getSelectorString());
        assertEquals("/image/vnd/xnd/knd.xml", p.getSuffix());
    }

    @Test
    public void testJIRA_250_a() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/bunkai", ".1.json"));
        assertEquals("/bunkai", p.getResourcePath());
        assertEquals("json", p.getExtension());
        assertEquals("1", p.getSelectorString());
    }

    @Test
    public void testJIRA_250_b() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/", ".1.json"));
        assertEquals("/", p.getResourcePath());
        assertEquals("json", p.getExtension());
        assertNull("Suffix is null", p.getSuffix());
        assertEquals("Selector string must not be null", "1", p.getSelectorString());
    }

    @Test
    public void testJIRA_250_c() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/", ".1.json/my/suffix"));
        assertEquals("/", p.getResourcePath());
        assertEquals("json", p.getExtension());
        assertEquals("/my/suffix", p.getSuffix());
        assertEquals("Selector string must not be null", "1", p.getSelectorString());
    }

    @Test
    public void testJIRA_250_d() {
        RequestPathInfo p = new SlingRequestPathInfo(new MockResource("/", ".json"));
        assertEquals("/", p.getResourcePath());
        assertEquals("json", p.getExtension());
        assertNull("Suffix is null", p.getSuffix());
        assertNull("Selectors are null", p.getSelectorString());
    }

    @Test
    public void testMerge() {
        SlingRequestPathInfo p = new SlingRequestPathInfo(new MockResource("/some/path", ".s1.s2.ext"));
        assertEquals("s1.s2", p.getSelectorString());
        assertEquals("ext", p.getExtension());
        assertNull(p.getSuffix());

        // test to replace selectors with a new one
        RequestDispatcherOptions o = new RequestDispatcherOptions();
        o.setReplaceSelectors("a");
        RequestPathInfo result = p.merge(o);
        assertEquals("a", result.getSelectorString());
        assertEquals("ext", result.getExtension());
        assertNull(result.getSuffix());

        // test to replace selector with the empty string
        o.setReplaceSelectors("");
        result = p.merge(o);
        assertEquals(null, result.getSelectorString());
        assertEquals("ext", result.getExtension());
        assertNull(result.getSuffix());

        // now add a selector
        o.setAddSelectors("b");
        result = p.merge(o);
        assertEquals("b", result.getSelectorString());
        assertEquals("ext", result.getExtension());
        assertNull(result.getSuffix());

        // replace suffix
        o.setReplaceSuffix("html");
        result = p.merge(o);
        assertEquals("b", result.getSelectorString());
        assertEquals("html", result.getSuffix());
        assertEquals("ext", result.getExtension());

        // remove extension
        o.setReplaceExtension("");
        result = p.merge(o);
        assertEquals("b", result.getSelectorString());
        assertEquals("html", result.getSuffix());
        assertNull(result.getExtension());

        // replace extension
        o.setReplaceExtension("foo");
        result = p.merge(o);
        assertEquals("b", result.getSelectorString());
        assertEquals("html", result.getSuffix());
        assertEquals("foo", result.getExtension());
    }

    static class MockResource extends AbstractResource {

        private final ResourceMetadata metadata;

        MockResource(String resolutionPath, String resolutionPathInfo) {
            metadata = new ResourceMetadata();
            metadata.setResolutionPath(resolutionPath);
            metadata.setResolutionPathInfo(resolutionPathInfo);
        }

        public String getResourceType() {
            throw new Error("MockResource does not implement this method");
        }

        public String getResourceSuperType() {
            throw new Error("MockResource does not implement this method");
        }

        public String getPath() {
            throw new Error("MockResource does not implement this method");
        }

        public ResourceMetadata getResourceMetadata() {
            return metadata;
        }

        public ResourceResolver getResourceResolver() {
            return null;
        }

        public <Type> Type adaptTo(Class<Type> type) {
            return null;
        }
    }
}