src/test/java/org/apache/sling/servlets/resolver/internal/helper/ResourceCollectorTest.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.servlets.resolver.internal.helper;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceUtil;
import org.apache.sling.commons.testing.sling.MockResource;

public class ResourceCollectorTest extends HelperTestBase {

    private String label;

    @Override
    protected void setUp() throws Exception {
        super.setUp();

        label = ResourceUtil.getName(resourceTypePath);
    }

    public void testGetServlets0() {
        String[] names = { "/" + label + ".esp", // 0
                "/GET.esp", // 1
                "/" + label + ".html.esp", // 2
                "/html.esp", // 3
                "/print.esp", // 4
                "/print/a4.esp", // 5
                "/print.html.esp", // 6
                "/print/a4.html.esp", // 7
                "/print", // resource to enable walking the tree
                "/print", // resource to enable walking the tree
        };

        int[] baseIdxs = { 0, 1, 1, 0, 0, 1, 0, 1, 0, 1 };
        int[] indices  = { 7, 5, 6, 4, 2, 3, 0, 1 };

        effectiveTest(names, baseIdxs, indices);
    }

    public void testGetServlets1() {
        String[] names = { "/" + label + ".esp", // 0
                "/GET.esp", // 1
                "/" + label + ".html.esp", // 2
                "/print.esp", // 3
                "/print.other.esp", // 4
                "/print/other.esp", // 5
                "/print.html.esp", // 6
                "/print/a4.html.esp", // 7
                "/print", // resource to enable walking the tree
                "/print", // resource to enable walking the tree
        };

        int[] baseIdxs = { 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1 };
        int[] indices = { 7, 6, 3, 2, 0, 1 };

        effectiveTest(names, baseIdxs, indices);
    }

    public void testGetServlets2() {
        String[] names = { "/" + label + ".esp", // 0
                "/GET.esp", // 1
                "/" + label + ".html.esp", // 2
                "/html.esp", // 3
                "/image.esp", // 4
                "/print/other.esp", // 5
                "/print.other.esp", // 6
                "/print.html.esp", // 7
                "/print/a4.html.esp", // 8
                "/print", // resource to enable walking the tree
                "/print", // resource to enable walking the tree
        };

        int[] baseIdxs = { 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1 };
        int[] indices = { 8, 7, 2, 3, 0, 1 };

        effectiveTest(names, baseIdxs, indices);
    }

    public void testGetServlets3() {
        String[] names = { ".servlet", // 0
                "/" + label + ".esp", // 1
                "/GET.esp", // 2
                "/" + label + ".html.esp", // 3
                "/html.esp", // 4
                "/image.esp", // 5
                "/print/other.esp", // 6
                "/print.other.esp", // 7
                "/print.html.esp", // 8
                "/print/a4.html.esp", // 9
                "/print", // resource to enable walking the tree
                "/print", // resource to enable walking the tree
        };

        int[] baseIdxs = { 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1 };
        int[] indices = { 9, 8, 3, 4, 1, 2, 0 };

        effectiveTest(names, baseIdxs, indices);
    }

    public void testGetServlets4() {
        String[] names = { ".servlet", // 0
                "/" + label + ".esp", // 1
                "/GET.esp", // 2
                "/" + label + ".html.esp", // 3
                "/html.esp", // 4
                ".esp", // 5
                "/image.esp", // 6
                "/print/other.esp", // 7
                "/print.other.esp", // 8
                "/print.html.esp", // 9
                "/print/a4.html.esp", // 10
                "/print", // resource to enable walking the tree
                "/print", // resource to enable walking the tree
        };

        int[] baseIdxs = { 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 0, 1 };
        int[] indices = { 10, 9, 3, 4, 1, 2, 0 };

        effectiveTest(names, baseIdxs, indices);
    }

    public void testScriptExtensionsPriority() {
        String[] names = {".servlet", // 0
                "/" + label + ".esp", // 1
                "/GET.esp", // 2
                "/" + label + ".html.esp", // 3
                "/html.esp", // 4
                ".esp", // 5
                "/image.esp", // 6
                "/print/other.esp", // 7
                "/print.other.esp", // 8
                "/print.html.esp", // 9
                "/print/a4.html.esp", // 10
                "/print/a4.html.js", // 11
                "/print/a4.html.html", // 12
                "/print/a4.html.jsp", // 13
                "/print", // resource to enable walking the tree
                "/print", // resource to enable walking the tree
        };

        int[] baseIdxs = { 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 0, 1 , 0 , 1, 0};
        int[] indices = {12, 13, 11, 10, 9, 3, 4, 1, 2, 0};

        effectiveTest(names, baseIdxs, indices, new ArrayList<String>(){{
            add("esp");
            add("js");
            add("jsp");
            add("html");
        }});
    }

    public void testAnyServlets0() {
        // use a request with another request method "ANY"
        request.setMethod("ANY");

        String[] names = { "/" + label + ".ANY.esp", // 0
                "/ANY.esp", // 1
                "/" + label + ".html.ANY.esp", // 2
                "/html.ANY.esp", // 3
                "/print.ANY.esp", // 4
                "/print/a4.ANY.esp", // 5
                "/print.html.ANY.esp", // 6
                "/print/a4.html.ANY.esp", // 7
                "/print", // resource to enable walking the tree
                "/print", // resource to enable walking the tree
        };

        int[] baseIdxs = { 0, 1, 1, 0, 0, 1, 0, 1, 0, 1 };
        int[] indices  = { 7, 5, 6, 4, 2, 3, 0, 1 };

        effectiveTest(names, baseIdxs, indices);
    }

    public void testAnyServlets1() {
        // use a request with another request method "ANY"
        request.setMethod("ANY");

        String[] names = { "/" + label + ".ANY.esp", // 0
                "/ANY.esp", // 1
                "/" + label + ".html.ANY.esp", // 2
                "/print.ANY.esp", // 3
                "/print.other.ANY.esp", // 4
                "/print/other.ANY.esp", // 5
                "/print.html.ANY.esp", // 6
                "/print/a4.html.ANY.esp", // 7
                "/print", // resource to enable walking the tree
                "/print", // resource to enable walking the tree
        };

        int[] baseIdxs = { 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1 };
        int[] indices = { 7, 6, 3, 2, 0, 1 };

        effectiveTest(names, baseIdxs, indices);
    }

    public void testAnyServlets2() {
        // use a request with another request method "ANY"
        request.setMethod("ANY");

        String[] names = { "/" + label + ".ANY.esp", // 0
                "/ANY.esp", // 1
                "/" + label + ".html.ANY.esp", // 2
                "/html.ANY.esp", // 3
                "/image.ANY.esp", // 4
                "/print/other.ANY.esp", // 5
                "/print.other.ANY.esp", // 6
                "/print.html.ANY.esp", // 7
                "/print/a4.html.ANY.esp", // 8
                "/print", // resource to enable walking the tree
                "/print", // resource to enable walking the tree
        };

        int[] baseIdxs = { 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1 };
        int[] indices = { 8, 7, 2, 3, 0, 1 };

        effectiveTest(names, baseIdxs, indices);
    }

    public void testAnyServlets3() {
        // use a request with another request method "ANY"
        request.setMethod("ANY");

        String[] names = { ".servlet", // 0
                "/" + label + ".ANY.esp", // 1
                "/ANY.esp", // 2
                "/" + label + ".html.ANY.esp", // 3
                "/html.ANY.esp", // 4
                "/image.ANY.esp", // 5
                "/print/other.ANY.esp", // 6
                "/print.other.ANY.esp", // 7
                "/print.html.ANY.esp", // 8
                "/print/a4.html.ANY.esp", // 9
                "/print", // resource to enable walking the tree
                "/print", // resource to enable walking the tree
        };

        int[] baseIdxs = { 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1 };
        int[] indices = { 9, 8, 3, 4, 1, 2, 0 };

        effectiveTest(names, baseIdxs, indices);
    }

    public void testAnyServlets4() {
        // use a request with another request method "ANY"
        request.setMethod("ANY");

        String[] names = { ".servlet", // 0
                "/" + label + ".ANY.esp", // 1
                "/ANY.esp", // 2
                "/" + label + ".html.ANY.esp", // 3
                "/html.ANY.esp", // 4
                ".ANY.esp", // 5
                "/image.ANY.esp", // 6
                "/print/other.ANY.esp", // 7
                "/print.other.ANY.esp", // 8
                "/print.html.ANY.esp", // 9
                "/print/a4.html.ANY.esp", // 10
                "/print", // resource to enable walking the tree
                "/print", // resource to enable walking the tree
        };

        int[] baseIdxs = { 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 0, 1 };
        int[] indices = { 10, 9, 3, 4, 1, 2, 0 };

        effectiveTest(names, baseIdxs, indices);
    }

    protected void effectiveTest(String[] names, int[] baseIdxs, int[] indices) {
        effectiveTest(names, baseIdxs, indices, null);
    }

    protected void effectiveTest(String[] names, int[] baseIdxs, int[] indices, List<String> scriptEngineExtensions) {

        String[] base = { "/apps/" + resourceTypePath,
            "/libs/" + resourceTypePath };

        Map<String, String> pathMap = new HashMap<String, String>();

        for (int i=0; i < names.length; i++) {
            String name = names[i];
            int baseIdx = baseIdxs[i];
            String path = base[baseIdx] + name;
            createScriptResource(path, "nt:file");
            pathMap.put(name, path);
        }

        ResourceCollector lu = ResourceCollector.create(request, null, new String[] {"html"});
        Collection<Resource> res;
        if (scriptEngineExtensions != null) {
            res = lu.getServlets(request.getResourceResolver(), scriptEngineExtensions);
        } else {
            res = lu.getServlets(request.getResourceResolver(), Collections.EMPTY_LIST);
        }
        Iterator<Resource> rIter = res.iterator();

        for (int index : indices) {
            assertTrue(rIter.hasNext());

            Resource lr = rIter.next();

            String name = names[index];
            String path = pathMap.get(name);

            assertEquals(path, lr.getPath());
        }

        assertFalse(rIter.hasNext());
    }

    protected MockResource createScriptResource(String path, String type) {
        MockResource res = new MockResource(resourceResolver, path, type);
        resourceResolver.addResource(res);
        return res;
    }
}