/**
    * Copyright (C) 2005-2009 Alfresco Software Limited.
    *
    * This file is part of the Spring Surf Extension project.
    *
    * 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.springframework.extensions.surf;
  
  import java.io.File;
  import java.net.URL;
  
  import javax.servlet.ServletContext;
  import javax.servlet.ServletException;
  
  import junit.framework.TestCase;
  
  import org.junit.Ignore;
  import org.springframework.context.ApplicationContext;
  import org.springframework.extensions.surf.exception.WebFrameworkServiceException;
  import org.springframework.extensions.surf.site.Model;
  import org.springframework.mock.web.MockServletConfig;
  import org.springframework.web.context.support.XmlWebApplicationContext;
  import org.springframework.web.servlet.DispatcherServlet;
  
  /**
   * Tests the Surf API directly using mock objects
   * 
   * @author muzquiano
   */
  @Ignore public abstract class AbstractSurfTestCase extends TestCase
  {
  	protected MockServletConfig servletConfig;
  	protected DispatcherServlet dispatcherServlet;
  	protected Model api;
  	
  	public void setUp() throws ServletException
  	{
  		initTestDataFolder();
  		
  		servletConfig = new MockServletConfig(new SurfServletContext(getTestDataFolder()), "root");
  		
  		MockServletConfig surfConfig = new MockServletConfig(servletConfig.getServletContext(), "surf");
  		surfConfig.addInitParameter("publishContext", "false");
  		surfConfig.addInitParameter("class", "notWritable");
  		surfConfig.addInitParameter("unknownParam", "someValue");
  		
  		dispatcherServlet = new DispatcherServlet();
  		dispatcherServlet.setContextClass(XmlWebApplicationContext.class);
  		dispatcherServlet.setContextConfigLocation(getConfigLocation().toString());
  		dispatcherServlet.init(surfConfig);
  	}
  	
  	public void tearDown() throws ServletException
  	{
  		destroyTestDataFolder();
  	}
  	
  	public StringBuilder getConfigLocation()
  	{
  		StringBuilder sb = new StringBuilder();
  		sb.append("classpath*:org/springframework/extensions/webscripts/*-context.xml");
  		sb.append(",");
  		sb.append("classpath*:org/springframework/extensions/surf/*-context.xml");
  		sb.append(",");
  		sb.append("classpath*:org/springframework/extensions/surf/surf-test-context.xml");
  		
  		return sb;		
  	}
  	
  	public ServletContext getServletContext() 
  	{
  		return servletConfig.getServletContext();
  	}
  	
  	public ApplicationContext getApplicationContext()
  	{
  		return dispatcherServlet.getWebApplicationContext();
  	}
  	
  	public WebFrameworkServiceRegistry getServiceRegistry()
  	{
  		return (WebFrameworkServiceRegistry) getApplicationContext().getBean("webframework.service.registry");
  	}
  	
  	public Model getModel() throws WebFrameworkServiceException
  	{
  		if (api == null)
 		{
 			ModelPersistenceContext mpc = new ModelPersistenceContext(null);
 			api = new Model(getServiceRegistry().getWebFrameworkManager().getObjectManager(mpc));
 		}
 		
 		return api;
 	}
 	
 	public static boolean deleteDirectory(File path) 
 	{
 		if( path.exists() )
 		{
 			File[] files = path.listFiles();
 			for(int i=0; i<files.length; i++) 
 			{
 				if(files[i].isDirectory()) 
 				{
 					deleteDirectory(files[i]);
 				}
 				else 
 				{
 					files[i].delete();
 				}
 			}
 		}
 
 		return( path.delete() );
 	}
 	
 	public static File getTestDataFolder() 
 	{
 		Class anyTestClass = AbstractSurfTestCase.class;
 		
 		final String clsUri = anyTestClass.getName().replace('.','/') + ".class";
 		final URL url = anyTestClass.getClassLoader().getResource(clsUri);
 		final String clsPath = url.getPath();
 		final File root = new File(clsPath.substring(0, clsPath.length() - clsUri.length()));
 		
 		return new File(root.getParentFile(), "test-data");		
 	}
 	
 	public static void initTestDataFolder() 
 	{		
 		File f = getTestDataFolder();		
 		deleteDirectory(f);
 		f.mkdirs();
 		
 		File site = new File(f, "site");
 		site.mkdirs();
 
 		// init model object directories
 		// TODO - autogenerate?
 		new File(site, "chrome").mkdirs();
 		new File(site, "components").mkdirs();
 		new File(site, "component-types").mkdirs();
 		new File(site, "configurations").mkdirs();
 		new File(site, "content-associations").mkdirs();
 		new File(site, "page-associations").mkdirs();
 		new File(site, "pages").mkdirs();
 		new File(site, "page-types").mkdirs();
 		new File(site, "template-instances").mkdirs();
 		new File(site, "template-types").mkdirs();
 		new File(site, "themes").mkdirs();
 		
 		File webscripts = new File(f, "webscripts");
 		webscripts.mkdirs();
 		
 		File templates = new File(f, "templates");
 		templates.mkdirs();
 	}
 
 	public static void destroyTestDataFolder() 
 	{		
 		File f = getTestDataFolder();		
 		deleteDirectory(f);
 	}
 	
 }