tapestry/tapestry-framework/src/test/org/apache/tapestry/html/ScriptTest.java

// Copyright 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.html;

import org.apache.hivemind.ApplicationRuntimeException;
import org.apache.hivemind.Location;
import org.apache.hivemind.Resource;
import org.apache.tapestry.*;
import org.apache.tapestry.asset.AssetSource;
import org.apache.tapestry.engine.IScriptSource;
import org.apache.tapestry.spec.ComponentSpecification;
import org.apache.tapestry.spec.IComponentSpecification;
import static org.easymock.EasyMock.*;
import org.testng.annotations.Test;

import java.util.HashMap;
import java.util.Locale;
import java.util.Map;

/**
 * Tests for the {@link Script} component.
 * 
 * @author Howard M. Lewis Ship
 * @since 4.0
 */
@Test
public class ScriptTest extends BaseComponentTestCase
{
    private static class MockScript implements IScript
    {
        Map _symbols;

        public void execute(IRequestCycle cycle, IScriptProcessor processor, Map symbols)
        {
            _symbols = symbols;
        }

        public void execute(IComponent target, IRequestCycle cycle, IScriptProcessor processor, Map symbols)
        {
            _symbols = symbols;
        }
        
        public Resource getScriptResource()
        {
            // TODO Auto-generated method stub
            return null;
        }

    }

    /**
     * No input symbols, no informal parameters.
     */
    public void test_Minimal_Render()
    {
        IScriptSource source = newScriptSource();
        IScript script = newScript();

        IMarkupWriter writer = newWriter();
        
        PageRenderSupport support = newPageRenderSupport();
        
        IRequestCycle cycle = newCycle(false, null);
        AssetSource assetSource = newMock(AssetSource.class);
        IPage page = newMock(IPage.class);
        expect(page.getLocale()).andReturn(Locale.getDefault());
        
        trainGetPageRenderSupport(cycle, support);
        
        Resource scriptLocation = newResource();
        IRender body = newRender();
        
        IComponent container = newComponent();

        String scriptPath = "MyScript.script";

        Script component = newInstance(Script.class,
                "specification", new ComponentSpecification(),
                "container", container,
                "scriptSource", source,
                "scriptPath", scriptPath,
                "assetSource", assetSource,
                "page", page
        );
        
        trainGetScriptLocation(container, scriptPath, scriptLocation, assetSource);
        
        trainGetScript(source, scriptLocation, script);

        script.execute(component, cycle, support, new HashMap());

        trainResponseBuilder(cycle, writer);
        
        body.render(writer, cycle);
        
        replay();

        component.addBody(body);

        component.renderComponent(writer, cycle);

        verify();
    }

    public void test_With_Symbols_Map()
    {
        IScriptSource source = newScriptSource();
        MockScript script = new MockScript();

        PageRenderSupport support = newPageRenderSupport();
        IMarkupWriter writer = newWriter();
        IRequestCycle cycle = newCycle(false, null);
        AssetSource assetSource = newMock(AssetSource.class);

        IPage page = newMock(IPage.class);
        expect(page.getLocale()).andReturn(Locale.getDefault());

        trainGetPageRenderSupport(cycle, support);
        
        Resource scriptLocation = newResource();
        IRender body = newRender();

        IComponent container = newComponent();

        Map baseSymbols = new HashMap();
        baseSymbols.put("fred", "barney");

        String scriptPath = "MyScript.script";

        Script component = newInstance(Script.class,
                "specification", new ComponentSpecification(),
                "container", container,
                "scriptSource", source,
                "scriptPath", scriptPath,
                "baseSymbols", baseSymbols,
                "assetSource", assetSource,
                "page", page
        );

        trainGetScriptLocation(container, scriptPath, scriptLocation, assetSource);

        trainGetScript(source, scriptLocation, script);

        trainResponseBuilder(cycle, writer);
        
        body.render(writer, cycle);
        
        replay();

        component.addBody(body);

        component.renderComponent(writer, cycle);

        verify();

        assertEquals(baseSymbols, script._symbols);
        assertSame(script._symbols, component.getSymbols());
        assertNotSame(baseSymbols, script._symbols);
    }

    public void test_With_Symbols_Map_And_Informal_Parameters()
    {
        IScriptSource source = newScriptSource();
        MockScript script = new MockScript();

        PageRenderSupport support = newPageRenderSupport();
        IRequestCycle cycle = newCycle(false, null);
        AssetSource assetSource = newMock(AssetSource.class);
        
        IPage page = newMock(IPage.class);
        expect(page.getLocale()).andReturn(Locale.getDefault());

        trainGetPageRenderSupport(cycle, support);
        
        IMarkupWriter writer = newWriter();
        Resource scriptLocation = newResource();
        IRender body = newRender();

        IComponent container = newComponent();

        Map baseSymbols = new HashMap();
        baseSymbols.put("fred", "flintstone");
        baseSymbols.put("flash", "gordon");

        IBinding informal = newBinding("mercury");

        String scriptPath = "MyScript.script";

        Script component = newInstance(Script.class,
                "specification", new ComponentSpecification(),
                "container", container,
                "scriptSource", source,
                "scriptPath", scriptPath,
                "baseSymbols", baseSymbols,
                "assetSource", assetSource,
                "page", page
        );
        component.setBinding("fred", informal);

        trainGetScriptLocation(container, scriptPath, scriptLocation, assetSource);

        trainGetScript(source, scriptLocation, script);

        trainResponseBuilder(cycle, writer);
        
        body.render(writer, cycle);
        
        replay();

        component.addBody(body);

        component.renderComponent(writer, cycle);

        verify();

        Map expectedSymbols = new HashMap(baseSymbols);
        expectedSymbols.put("fred", "mercury");

        assertEquals(expectedSymbols, script._symbols);
        assertSame(script._symbols, component.getSymbols());
    }

    public void test_Rewinding()
    {
        IMarkupWriter writer = newWriter();
        IRequestCycle cycle = newCycle(true, writer);
        IRender body = newRender();

        body.render(writer, cycle);
        
        replay();

        Script component = (Script) newInstance(Script.class);

        component.addBody(body);

        component.renderComponent(writer, cycle);

        verify();
    }

    public void test_MultiParam_Exception() 
    {
    	IScriptSource source = newScriptSource();
        
        PageRenderSupport support = newPageRenderSupport();
        IRequestCycle cycle = newCycle(false, false);
        IMarkupWriter writer = newWriter();
        IRender body = newRender();
        
        IComponent container = newComponent();

        String scriptPath = "MyScript.script";
        
        IAsset scriptAsset = newAsset();

        Script component = newInstance(Script.class,
                "specification", new ComponentSpecification(),
                "container", container,
                "scriptSource", source,
                "scriptPath", scriptPath,
                "scriptAsset", scriptAsset
        );

        trainGetPageRenderSupport(cycle, support);
        
        replay();
        
        component.addBody(body);
        
        try {
        	component.renderComponent(writer, cycle);
        } catch (ApplicationRuntimeException ex) {
        	assertExceptionSubstring(ex, "Script component has both script IAsset");
        }
        
        verify();
    }
    
    public void test_NoParam_Exception() 
    {
    	IScriptSource source = newScriptSource();
        
        PageRenderSupport support = newPageRenderSupport();
        IRequestCycle cycle = newCycle(false, false);
        IMarkupWriter writer = newWriter();
        IRender body = newRender();
        
        IComponent container = newComponent();

        String scriptPath = "MyScript.script";
        
        IAsset scriptAsset = newAsset();

        Script component = newInstance(Script.class,
                "specification", new ComponentSpecification(),
                "container", container,
                "scriptSource", source
        );

        trainGetPageRenderSupport(cycle, support);
        
        replay();
        
        component.addBody(body);
        
        try {
        	component.renderComponent(writer, cycle);
        } catch (ApplicationRuntimeException ex) {
        	assertExceptionSubstring(ex, "neither parameter was set");
        }
        
        verify();
    }    
    
    public void test_IAsset_NotFound_Exception() 
    {
        IScriptSource source = newScriptSource();
        IScript script = newScript();
        
        PageRenderSupport support = newPageRenderSupport();
        
        IRequestCycle cycle = newCycle(false, null);
        
        trainGetPageRenderSupport(cycle, support);
        
        IMarkupWriter writer = newWriter();
        Resource scriptLocation = newResource();
        IRender body = newRender();
        
        IComponent container = newComponent();
        
        IAsset scriptAsset = newAsset();
        
        expect(scriptAsset.getResourceLocation()).andReturn(scriptLocation);

        Script component = newInstance(Script.class,
                "specification", new ComponentSpecification(),
                "container", container,
                "scriptSource", source,
                "scriptAsset", scriptAsset
        );
        
        expect(source.getScript(scriptLocation)).andThrow(new RuntimeException());
        
        replay();
        
        component.addBody(body);
        
        try {
        	component.renderComponent(writer, cycle);
                unreachable();
        } catch (ApplicationRuntimeException ex) {
        }        
        
        verify();
    }      
    
    public void test_IAsset_Param_Render()
    {
        IScriptSource source = newScriptSource();
        IScript script = newScript();
        
        PageRenderSupport support = newPageRenderSupport();
        
        IRequestCycle cycle = newCycle(false, null);
        
        trainGetPageRenderSupport(cycle, support);
        
        IMarkupWriter writer = newWriter();
        Resource scriptLocation = newResource();
        IRender body = newRender();
        
        IComponent container = newComponent();
        
        IAsset scriptAsset = newAsset();
        
        expect(scriptAsset.getResourceLocation()).andReturn(scriptLocation);

        Script component = newInstance(Script.class,
                "specification", new ComponentSpecification(),
                "container", container,
                "scriptSource", source,
                "scriptAsset", scriptAsset
        );

        trainGetScript(source, scriptLocation, script);
        
        script.execute(component, cycle, support, new HashMap());
        
        trainResponseBuilder(cycle, writer);
        
        body.render(writer, cycle);
        
        replay();
        
        component.addBody(body);
        
        component.renderComponent(writer, cycle);
        
        verify();
    }
    
    protected IScript newScript()
    {
        return newMock(IScript.class);
    }

    protected void trainGetScript(IScriptSource source, Resource scriptLocation, IScript script)
    {
        expect(source.getScript(scriptLocation)).andReturn(script);
    }

    protected IScriptSource newScriptSource()
    {
        return newMock(IScriptSource.class);
    }

    protected void trainGetScriptLocation(IComponent component, String scriptPath,
            Resource scriptLocation, AssetSource assetSource)
    {
        IComponentSpecification spec = newSpec();
        Resource resource = newResource();
        IAsset asset = newMock(IAsset.class);

        expect(component.getSpecification()).andReturn(spec).anyTimes();
        
        expect(spec.getSpecificationLocation()).andReturn(resource);

        expect(assetSource.findAsset(eq(resource), eq(spec), eq(scriptPath), isA(Locale.class), (Location)isNull())).andReturn(asset);
        expect(asset.getResourceLocation()).andReturn(scriptLocation);        
    }
}