src/test/java/org/apache/sling/startupfilter/impl/StartupFilterImplTest.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.startupfilter.impl;

import static org.junit.Assert.assertEquals;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Dictionary;
import java.util.concurrent.atomic.AtomicInteger;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.sling.startupfilter.StartupInfoProvider;
import org.apache.sling.startupfilter.impl.StartupFilterImpl.Config;
import org.hamcrest.Description;
import org.jmock.Expectations;
import org.jmock.Mockery;
import org.jmock.api.Action;
import org.jmock.api.Invocation;
import org.jmock.lib.action.DoAllAction;
import org.junit.Before;
import org.junit.Test;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceListener;
import org.osgi.framework.ServiceReference;
import org.osgi.framework.ServiceRegistration;

/** Test the StartupFilterImpl */
public class StartupFilterImplTest {
    static private class TestProvider implements StartupInfoProvider, ServiceReference {
        private final String info;

        TestProvider(String s) {
            info = s;
        }

        @Override
        public String getProgressInfo() {
            return info;
        }

        @Override
        public Object getProperty(String key) {
            return null;
        }

        @Override
        public String[] getPropertyKeys() {
            return null;
        }

        @Override
        public Bundle getBundle() {
            return null;
        }

        @Override
        public Bundle[] getUsingBundles() {
            return null;
        }

        @Override
        public boolean isAssignableTo(Bundle bundle, String className) {
            return false;
        }

        @Override
        public int compareTo(Object reference) {
            return 0;
        }
    }
    static private class TestFilterImpl extends StartupFilterImpl {
        void setup(BundleContext ctx, StartupFilterImpl.Config config) throws Exception {
            activate(ctx, config);
        }
    };

    static private class ChangeInteger implements Action {
        private final boolean increment;
        private final AtomicInteger value;

        ChangeInteger(AtomicInteger value, boolean increment) {
            this.increment = increment;
            this.value = value;
        }
        @Override
        public void describeTo(Description d) {
            d.appendText(increment ? "increment" : "decrement");
            d.appendText(" an integer");
        }
        @Override
        public Object invoke(Invocation invocation) throws Throwable {
            if(increment) {
                value.incrementAndGet();
            } else {
                value.decrementAndGet();
            }
            return null;
        }
    };

    private TestFilterImpl filter;
    private Mockery mockery;
    private HttpServletRequest request;
    private HttpServletResponse response;
    private FilterChain chain;
    private int lastReturnedStatus;
    private StringWriter messageWriter;
    private AtomicInteger activeFilterCount;
    private ServiceRegistration serviceRegistration;
    private String requestPath;
    private String pathInfo;
    private static final String CONSOLE_ROOT = "/test/system/console";

    @Before
    public void setup() {
        activeFilterCount = new AtomicInteger();
        mockery = new Mockery();
        request = mockery.mock(HttpServletRequest.class);
        response = mockery.mock(HttpServletResponse.class);
        chain = mockery.mock(FilterChain.class);
        serviceRegistration = mockery.mock(ServiceRegistration.class);
        filter = new TestFilterImpl();
        requestPath = "/NO_PATH_YET";
    }

    private void setProvider(final TestProvider provider) throws Exception {
        final BundleContext bundleContext = mockery.mock(BundleContext.class);

        final Action storeStatus = new Action() {
            @Override
            public void describeTo(Description d) {
                d.appendText("Store HTTP response values");
            }

            @Override
            public Object invoke(Invocation invocation) throws Throwable {
                lastReturnedStatus = (Integer)invocation.getParameter(0);
                return null;
            }
        };

        messageWriter = new StringWriter();
        final PrintWriter responseWriter = new PrintWriter(messageWriter);

        final Config cfg = mockery.mock(StartupFilterImpl.Config.class);
        final ServiceReference [] providerRefs = provider == null ? null : new ServiceReference[] { provider };
        mockery.checking(new Expectations() {{
            allowing(cfg).active_by_default();
            will(returnValue(true));
            allowing(cfg).default_message();
            will(returnValue(StartupFilterImpl.DEFAULT_MESSAGE));
            allowing(bundleContext).createFilter(with(any(String.class)));
            allowing(bundleContext).addServiceListener(with(any(ServiceListener.class)));
            allowing(bundleContext).addServiceListener(with(any(ServiceListener.class)), with(any(String.class)));

            allowing(bundleContext).getServiceReferences(StartupInfoProvider.class.getName(), null);
            will(returnValue(providerRefs));
            allowing(bundleContext).getService(with(any(ServiceReference.class)));
            will(returnValue(provider));

            allowing(bundleContext).getProperty(with("felix.webconsole.manager.root"));
            will(returnValue(CONSOLE_ROOT));

            allowing(bundleContext).registerService(with(equal(Filter.class)), with(any(Filter.class)), with(any(Dictionary.class)));
            will(new DoAllAction(
                    new ChangeInteger(activeFilterCount, true),
                    returnValue(serviceRegistration)
                    ));

            allowing(response).setStatus((with(any(Integer.class))));
            will(storeStatus);

            allowing(response).setContentType("text/plain");

            allowing(response).getWriter();
            will(returnValue(responseWriter));
            allowing(response).setCharacterEncoding(with(any(String.class)));

            allowing(serviceRegistration).unregister();
            will(new ChangeInteger(activeFilterCount, false));

            allowing(request).getServletPath();
            will(returnValue(""));

            allowing(request).getPathInfo();
            will(returnValue(getPathInfo()));

            allowing(chain).doFilter(with(any(ServletRequest.class)), with(any(ServletResponse.class)));
        }});

        filter.setup(bundleContext, cfg);
    }

    private String getPathInfo() {
        return pathInfo;
    }

    private void assertRequest(final int expectedStatus, final String expectedMessage) throws Exception {
        lastReturnedStatus = -1;

        filter.doFilter(request, response, chain);

        final String responseText = messageWriter.toString();

        // status 0 means we expect the request to go through
        assertEquals("Expecting status to match",
                expectedStatus, lastReturnedStatus);
        assertEquals("Expecting message to match",
                expectedMessage, responseText);
    }

    @Test
    public void testInitialState() throws Exception {
        setProvider(null);
        assertEquals("Initially expecting the default status message", 1, activeFilterCount.get());
        assertRequest(503, StartupFilterImpl.DEFAULT_MESSAGE);
    }

    @Test
    public void testBypassRoot() throws Exception {
        requestPath = pathInfo = CONSOLE_ROOT;
        setProvider(null);
        assertRequest(-1, "");
    }

    @Test
    public void testNullPathInfo() throws Exception {
        requestPath = pathInfo = CONSOLE_ROOT;
        pathInfo = null;
        setProvider(null);
        assertRequest(503, "Startup in progress");
    }

    @Test
    public void testBypassSubpath() throws Exception {
        requestPath = pathInfo = CONSOLE_ROOT + "/something";
        setProvider(null);
        assertRequest(-1, "");
    }

    @Test
    public void testDisabling() throws Exception {
        setProvider(null);
        assertEquals("Initially expecting one filter service", 1, activeFilterCount.get());
        filter.disable();
        assertEquals("Expecting filter service to be gone", 0, activeFilterCount.get());
    }

    @Test
    public void testProviders() throws Exception {
        final TestProvider p = new TestProvider("TEST");

        setProvider(p);
        assertEquals("Initially expecting one filter service", 1, activeFilterCount.get());

        final String expectedMessage = StartupFilterImpl.DEFAULT_MESSAGE + "\nTEST";
        assertRequest(503, expectedMessage);

        filter.disable();
        assertEquals("Expecting filter service to be gone", 0, activeFilterCount.get());
    }
}