tapestry/tapestry-framework/src/test/org/apache/tapestry/services/impl/TestApplicationSpecificationInitializer.java

// Copyright 2004, 2005 The Apache Software Foundation
//
// 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 org.apache.tapestry.services.impl;

import static org.easymock.EasyMock.*;

import java.net.URL;

import org.apache.commons.logging.Log;
import org.apache.hivemind.Registry;
import org.apache.hivemind.Resource;
import org.apache.hivemind.impl.DefaultClassResolver;
import org.apache.hivemind.impl.RegistryBuilder;
import org.apache.hivemind.util.ClasspathResource;
import org.apache.hivemind.util.ContextResource;
import org.apache.tapestry.BaseComponentTestCase;
import org.apache.tapestry.parse.ISpecificationParser;
import org.apache.tapestry.services.ApplicationGlobals;
import org.apache.tapestry.services.ApplicationInitializer;
import org.apache.tapestry.spec.ApplicationSpecification;
import org.apache.tapestry.spec.IApplicationSpecification;
import org.testng.annotations.Test;

import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServlet;

/**
 * Tests for the {@link org.apache.tapestry.services.impl.ApplicationSpecificationInitializer}.
 * 
 * @author Howard Lewis Ship
 * @since 4.0
 */
@Test
public class TestApplicationSpecificationInitializer extends BaseComponentTestCase
{   
    
    public void test_On_Classpath() throws Exception
    {
        DefaultClassResolver cr = new DefaultClassResolver();

        Resource appSpecResource = new ClasspathResource(cr, "/foo/OnClasspath.application");

        ApplicationSpecificationInitializer i = new ApplicationSpecificationInitializer();

        Log log = newMock(Log.class);

        i.setLog(log);

        ClasspathResourceFactoryImpl cf = new ClasspathResourceFactoryImpl();
        cf.setClassResolver(cr);

        i.setClasspathResourceFactory(cf);
        
        HttpServlet servlet = new ServletFixture();
        
        ServletConfig config = newMock(ServletConfig.class);
        
        IApplicationSpecification as = new ApplicationSpecification();
        
        ISpecificationParser parser = newMock(ISpecificationParser.class);
        
        i.setParser(parser);
        
        expect(config.getInitParameter(ApplicationSpecificationInitializer.APP_SPEC_PATH_PARAM))
        .andReturn(appSpecResource.getPath());
        
        expect(parser.parseApplicationSpecification(appSpecResource)).andReturn(as);
        
        ApplicationGlobals ag = new ApplicationGlobalsImpl();

        i.setGlobals(ag);

        replay();

        servlet.init(config);

        // The real ApplicationServlet will build a Registry and, indirectly, invoke this.

        i.initialize(servlet);

        assertNotNull(ag.getActivator());
        assertSame(as, ag.getSpecification());

        verify();
    }

    public void test_Default_On_Classpath() throws Exception
    {
        DefaultClassResolver cr = new DefaultClassResolver();
        Resource appSpecResource = new ClasspathResource(cr, "Fred.application");
        
        ApplicationSpecificationInitializer i = new ApplicationSpecificationInitializer();
        Log log = newMock(Log.class);
        i.setLog(log);
        
        ServletContext context = newMock(ServletContext.class);
        
        ClasspathResourceFactoryImpl cf = new ClasspathResourceFactoryImpl();
        cf.setClassResolver(cr);

        i.setClasspathResourceFactory(cf);
        
        HttpServlet servlet = new ServletFixture();
        
        ServletConfig config = newMock(ServletConfig.class);
        checkOrder(config, false);
        
        IApplicationSpecification as = new ApplicationSpecification();
        
        ISpecificationParser parser = newMock(ISpecificationParser.class);
        
        i.setParser(parser);
        
        expect(config.getInitParameter(ApplicationSpecificationInitializer.APP_SPEC_PATH_PARAM)).andReturn(null);
        
        expect(config.getServletContext()).andReturn(context);
        
        expect(config.getServletName()).andReturn("Fred").anyTimes();
        
        // begin testing finding spec
        
        expect(log.isDebugEnabled()).andReturn(true);
        
        Resource r = new ContextResource(context, "/WEB-INF/Fred/Fred.application");
        
        log.debug("Checking for existence of " + r);
        
        expect(context.getResource(r.getPath())).andReturn(null);
        
        expect(log.isDebugEnabled()).andReturn(true);
        
        r = new ContextResource(context, "/WEB-INF/Fred.application");
        
        log.debug("Checking for existence of " + r);
        
        expect(context.getResource(r.getPath())).andReturn(null);
        
        expect(parser.parseApplicationSpecification(appSpecResource)).andReturn(as);
        
        ApplicationGlobals ag = new ApplicationGlobalsImpl();

        i.setGlobals(ag);

        replay();
        
        servlet.init(config);
        
        // The real ApplicationServlet will build a Registry and, indirectly, invoke this.
        
        i.initialize(servlet);
        
        assertNotNull(ag.getActivator());
        assertSame(as, ag.getSpecification());

        verify();
    }
    
    public void test_In_App_Context_Folder() throws Exception
    {
        DefaultClassResolver cr = new DefaultClassResolver();

        ApplicationSpecificationInitializer i = new ApplicationSpecificationInitializer();
        
        ServletContext context = newMock(ServletContext.class);
        Log log = newLog();

        i.setLog(log);
        
        ClasspathResourceFactoryImpl cf = new ClasspathResourceFactoryImpl();
        cf.setClassResolver(cr);
        
        i.setClasspathResourceFactory(cf);
        
        HttpServlet servlet = new ServletFixture();
        
        ServletConfig config = newMock(ServletConfig.class);
        
        expect(config.getInitParameter(ApplicationSpecificationInitializer.APP_SPEC_PATH_PARAM))
        .andReturn(null);
        
        expect(config.getServletContext()).andReturn(context);

        expect(config.getServletName()).andReturn("fred");

        expect(log.isDebugEnabled()).andReturn(true);

        Resource r = new ContextResource(context, "/WEB-INF/fred/fred.application");

        log.debug("Checking for existence of " + r);

        expect(context.getResource(r.getPath()))
        .andReturn(new URL("file:/context" + r.getPath()));

        log.debug("Found " + r);

        IApplicationSpecification as = new ApplicationSpecification();
        
        ISpecificationParser parser = newMock(ISpecificationParser.class);

        i.setParser(parser);

        expect(parser.parseApplicationSpecification(r)).andReturn(as);

        ApplicationGlobals ag = new ApplicationGlobalsImpl();

        i.setGlobals(ag);

        replay();

        servlet.init(config);

        // The real ApplicationServlet will build a Registry and, indirectly, invoke this.

        i.initialize(servlet);

        verify();
    }

    public void test_In_Web_Inf_Folder() throws Exception
    {
        DefaultClassResolver cr = new DefaultClassResolver();

        ApplicationSpecificationInitializer i = new ApplicationSpecificationInitializer();

        ServletContext context = newMock(ServletContext.class);
        Log log = newLog();

        i.setLog(log);

        ClasspathResourceFactoryImpl cf = new ClasspathResourceFactoryImpl();
        cf.setClassResolver(cr);

        i.setClasspathResourceFactory(cf);

        HttpServlet servlet = new ServletFixture();

        ServletConfig config = newMock(ServletConfig.class);
        
        expect(config.getInitParameter(ApplicationSpecificationInitializer.APP_SPEC_PATH_PARAM))
        .andReturn(null);

        expect(config.getServletContext()).andReturn(context);

        expect(config.getServletName()).andReturn("barney");

        expect(log.isDebugEnabled()).andReturn(false);

        Resource r = new ContextResource(context, "/WEB-INF/barney.application");

        expect(context.getResource("/WEB-INF/barney/barney.application")).andReturn(null);

        expect(log.isDebugEnabled()).andReturn(false);

        expect(context.getResource(r.getPath()))
        .andReturn(new URL("file:/context" + r.getPath()));

        log.debug("Found " + r);

        IApplicationSpecification as = new ApplicationSpecification();
        
        ISpecificationParser parser = newMock(ISpecificationParser.class);

        i.setParser(parser);

        expect(parser.parseApplicationSpecification(r)).andReturn(as);

        ApplicationGlobals ag = new ApplicationGlobalsImpl();

        i.setGlobals(ag);

        replay();

        servlet.init(config);

        // The real ApplicationServlet will build a Registry and, indirectly, invoke this.

        i.initialize(servlet);

        verify();
    }

    public void test_No_App_Spec() throws Exception
    {
        DefaultClassResolver cr = new DefaultClassResolver();

        ApplicationSpecificationInitializer i = new ApplicationSpecificationInitializer();

        ServletContext context = newMock(ServletContext.class);
        Log log = newLog();

        i.setLog(log);

        ClasspathResourceFactoryImpl cf = new ClasspathResourceFactoryImpl();
        cf.setClassResolver(cr);

        i.setClasspathResourceFactory(cf);

        HttpServlet servlet = new ServletFixture();

        ServletConfig config = newMock(ServletConfig.class);

        expect(config.getInitParameter(ApplicationSpecificationInitializer.APP_SPEC_PATH_PARAM)).andReturn(null);

        expect(config.getServletContext()).andReturn(context);

        expect(config.getServletName()).andReturn("wilma");

        expect(log.isDebugEnabled()).andReturn(false);

        expect(context.getResource("/WEB-INF/wilma/wilma.application")).andReturn(null);

        expect(log.isDebugEnabled()).andReturn(false);

        expect(context.getResource("/WEB-INF/wilma.application")).andReturn(null);

        expect(config.getServletName()).andReturn("wilma");

        log.warn("Could not find an application specification for application servlet wilma.");

        expect(config.getServletName()).andReturn("wilma");

        expect(config.getServletContext()).andReturn(context);

        ApplicationGlobals ag = new ApplicationGlobalsImpl();

        i.setGlobals(ag);

        replay();

        servlet.init(config);

        // The real ApplicationServlet will build a Registry and, indirectly, invoke this.

        i.initialize(servlet);

        verify();

        IApplicationSpecification as = ag.getSpecification();

        assertEquals("wilma", as.getName());
        assertEquals(new ContextResource(context, "/WEB-INF/wilma.application"), as
                .getSpecificationLocation());
    }

    /**
     * Test within the Registry, to ensure the module deployment descriptor is well configured.
     */
    public void test_Integration() throws Exception
    {
        ServletContext context = newMock(ServletContext.class);

        HttpServlet servlet = new ServletFixture();
        
        ServletConfig config = newMock(ServletConfig.class);
        
        expect(config.getInitParameter(ApplicationSpecificationInitializer.APP_SPEC_PATH_PARAM))
        .andReturn(null);
        
        expect(config.getServletContext()).andReturn(context).anyTimes();
        
        expect(config.getServletName()).andReturn("dino").anyTimes();
        
        expect(context.getResource("/WEB-INF/dino/dino.application"))
        .andReturn(getClass().getResource("ParseApp.application")).times(2);
        
        replay();

        servlet.init(config);

        Registry registry = RegistryBuilder.constructDefaultRegistry();

        ApplicationInitializer ai = (ApplicationInitializer) registry.getService(
                "tapestry.init.ApplicationSpecificationInitializer",
                ApplicationInitializer.class);

        ai.initialize(servlet);

        ApplicationGlobals ag = (ApplicationGlobals) registry.getService(
                "tapestry.globals.ApplicationGlobals",
                ApplicationGlobals.class);

        assertEquals("ParseApp", ag.getSpecification().getName());

        verify();
        
        registry.shutdown();
    }
}