alfresco-community-repo/source/java/org/alfresco/repo/web/scripts/BaseWebScriptTest.java

/*
 * Copyright (C) 2005-2007 Alfresco Software Limited.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in Alfresco's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.alfresco.com/legal/licensing"
 */
package org.alfresco.repo.web.scripts;

import java.io.IOException;
import java.util.HashMap;

import org.alfresco.web.scripts.TestWebScriptServer;
import org.springframework.mock.web.MockHttpServletResponse;

import junit.framework.TestCase;

/**
 * Base unit test class for web scripts.
 * 
 * @author Roy Wetherall
 */
public abstract class BaseWebScriptTest extends TestCase
{
    /** Standard HTTP method names */
    protected static final String METHOD_POST = "post";
    protected static final String METHOD_GET = "get";
    protected static final String METHOD_PUT = "put";
    protected static final String METHOD_DELETE = "delete";
    
    /** Test web script server */
    private static TestWebScriptServer server = null;
    
    protected static TestWebScriptServer getServer()
    {
        if (BaseWebScriptTest.server == null)
        {
            BaseWebScriptTest.server = TestWebScriptRepoServer.getTestServer();
        }
        return BaseWebScriptTest.server;
    }
    
    /**
     * "GET" the url and check for the expected status code 
     * 
     * @param url
     * @param expectedStatus
     * @return
     * @throws IOException
     */
    protected MockHttpServletResponse getRequest(String url, int expectedStatus)
        throws IOException
    {
        return sendRequest(METHOD_GET, url, expectedStatus, null, null);
    }
    
    /**
     * "DELETE" the url and check for the expected status code
     * 
     * @param url
     * @param expectedStatus
     * @return
     * @throws IOException
     */
    protected MockHttpServletResponse deleteRequest(String url, int expectedStatus)
        throws IOException
    {
        return sendRequest(METHOD_DELETE, url, expectedStatus, null, null);
    }
    
    /**
     * "POST" the url and check for the expected status code
     * 
     * @param url
     * @param expectedStatus
     * @param body
     * @param contentType
     * @return
     * @throws IOException
     */
    protected MockHttpServletResponse postRequest(String url, int expectedStatus, String body, String contentType)
        throws IOException
    {
        return sendRequest(METHOD_POST, url, expectedStatus, body, contentType);
    }
    
    /**
     * "PUT" the url and check for the expected status code
     * 
     * @param url
     * @param expectedStatus
     * @param body
     * @param contentType
     * @return
     * @throws IOException
     */
    protected MockHttpServletResponse putRequest(String url, int expectedStatus, String body, String contentType)
        throws IOException
    {
        return sendRequest(METHOD_PUT, url, expectedStatus, body, contentType);
    }
    
    /**
     * 
     * @param method
     * @param url
     * @param expectedStatus
     * @return
     * @throws IOException
     */
    private MockHttpServletResponse sendRequest(String method, String url, int expectedStatus, String body, String contentType)
        throws IOException
    {
        MockHttpServletResponse response = BaseWebScriptTest.getServer().submitRequest(method, url, new HashMap<String, String>(), body, contentType);
        if (expectedStatus > 0 && expectedStatus != response.getStatus())
        {
            //if (response.getStatus() == 500)
            //{
                System.out.println(response.getContentAsString());
            //}
                        
            fail("Expected status code " + expectedStatus + " , " + response.getStatus() + " was returned");
        }
        return response;
    }

}