/*

  * 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.myfaces.mc.test.core;

 import org.apache.myfaces.mc.test.core.mock.MockMyFacesClient;

 import org.apache.myfaces.mc.test.core.mock.ServletMockContainer;

 import java.io.IOException;

 import javax.faces.application.Application;

 import javax.faces.context.ExternalContext;

 import javax.faces.context.FacesContext;

 import javax.servlet.ServletRequestEvent;

 import org.apache.myfaces.test.mock.MockHttpServletRequest;

 import org.apache.myfaces.test.mock.MockHttpServletResponse;

 import org.apache.myfaces.test.mock.MockHttpSession;

 import org.apache.myfaces.test.mock.MockHttpSessionProxy;

 /**

  * <p>Abstract JUnit test case base class, with method to setup/teardown a request.

  * It helps to create tests that involve multiple requests like client submits, or

  * tests that involve more control over the lifecycle.</p>

  * 

  * 

  * @author Leonardo Uribe

  *

  */

 public abstract class AbstractMyFacesRequestTestCase extends AbstractMyFacesTestCase

     implements ServletMockContainer

 {

     @Override

     public void setUp() throws Exception

     {

         super.setUp();

     }

     @Override

     public void tearDown() throws Exception

     {

         endRequest();

         session = null;

         lastSession = null;

         if (client != null)

         {

             client.setTestCase(null);

         }

         client = null;

         super.tearDown();

     }

     protected void setupRequest()

     {

         setupRequest(null);

     }

     protected void setupRequest(String pathInfo)

     {

         if (pathInfo == null)

         {

             setupRequest(null, null);

         }

         else

         {

             int queryIndex = pathInfo.indexOf("?");

             if (queryIndex >= 0) 

             {

                 setupRequest(pathInfo.substring(0,queryIndex), pathInfo.substring(queryIndex+1));

             }

             else

             {

                 setupRequest(pathInfo, null);

             }

         }

     }

     protected void setupRequest(String pathInfo, String query)

     {

         if (request != null)

         {

             //tear down previous request

             endRequest();

         }

         request = lastSession == null ? 

             new MockHttpServletRequest() : new MockHttpServletRequest(lastSession);

         request.setServletContext(servletContext);

         requestInitializedCalled = false;

         if (session == null)

         {

             session = new MockHttpSessionProxy(servletContext, request);

         }

         else

         {

             session.setRequest(request);

         }

         session.setServletContext(servletContext);

         response = new MockHttpServletResponse();

         //TODO check if this is correct

         request.setPathElements(getContextPath(), getServletPath(), pathInfo, query);

         facesContext = facesContextFactory.getFacesContext(

             servletContext, request, response, lifecycle);

         externalContext = facesContext.getExternalContext();

         application = facesContext.getApplication();

         if (client != null)

         {

             client.apply(request);

             client.reset(facesContext);

         }

         else

         {

             client = createClient();

         }

     }

     protected MockMyFacesClient createClient()

     {

         return new MockMyFacesClient(facesContext, this);

     }

     /**

      * This method call startViewRequest(viewId) and doRequestInitialized()

      */

     public final void startViewRequest(String viewId)

     {

         setupRequest(viewId);

         doRequestInitialized();

     }

     /**

      * This method call startViewRequest(null) and doRequestInitialized()

      */

     public final void startRequest()

     {

         startViewRequest(null);

         doRequestInitialized();

     }

     public void doRequestInitialized()

     {

         if (!requestInitializedCalled)

         {

             webContainer.requestInitialized(new ServletRequestEvent(servletContext, request));

             requestInitializedCalled = true;

         }

     }

     /**

      * This method call doRequestDestroyed() and then tearDownRequest(). 

      */

     public final void endRequest()

     {

         doRequestDestroyed();

         tearDownRequest();

     }

     public void doRequestDestroyed()

     {

         if (request != null)

         {

             lastSession = (MockHttpSession) request.getSession(false);

             webContainer.requestDestroyed(new ServletRequestEvent(servletContext, request));

         }

     }

     protected void tearDownRequest()

     {

         if (facesContext != null)

         {

             facesContext.release();

         }

         facesContext = null;

         externalContext = null;

         application = null;

         response = null;

         request = null;

         //session = null;

     }

     protected String getContextPath()

     {

         return "/test";

     }

     protected String getServletPath()

     {

         return "/faces";

     }

     public void processLifecycleExecute()

     {

         processLifecycleExecute(facesContext);

     }

     public void processLifecycleRender()

     {

         processLifecycleRender(facesContext);

     }

     public void processLifecycleExecuteAndRender()

     {

         processLifecycleExecute();

         renderResponse();

     }

     public void restoreView()

     {

         restoreView(facesContext);

     }

     public void applyRequestValues()

     {

         applyRequestValues(facesContext);

     }

     public void processValidations()

     {

         processValidations(facesContext);

     }

     public void updateModelValues()

     {

         updateModelValues(facesContext);

     }

     public void invokeApplication()

     {

         invokeApplication(facesContext);

     }

     public void renderResponse()

     {

         renderResponse(facesContext);

     }

     public void processRemainingExecutePhases()

     {

         processRemainingExecutePhases(facesContext);

     }

     public void processRemainingPhases()

     {

         processRemainingPhases(facesContext);

     }

     public void executeBeforeRender()

     {

         executeBeforeRender(facesContext);

     }

     public void executeViewHandlerRender()

     {

         executeViewHandlerRender(facesContext);

     }

     public void executeBuildViewCycle()

     {

         executeBuildViewCycle(facesContext);

     }

     public void executeAfterRender()

     {

         executeAfterRender(facesContext);

     }

     public String getRenderedContent() throws IOException

     {

         return getRenderedContent(facesContext);

     }

     protected MockMyFacesClient client = null;

     // Servlet objects 

     protected MockHttpServletRequest request = null;

     protected boolean requestInitializedCalled = false;

     protected MockHttpServletResponse response = null;

     protected MockHttpSessionProxy session = null;

     protected MockHttpSession lastSession = null;

     protected Application application = null;

     protected ExternalContext externalContext = null;

     protected FacesContext facesContext = null;

     @Override

     public MockHttpServletRequest getRequest()

     {

         return request;

     }

     @Override

     public MockHttpServletResponse getResponse()

     {

         return response;

     }

     @Override

     public FacesContext getFacesContext()

     {

         return facesContext;

     }

 }