/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache", "Jakarta", "JAMES" and "Apache Software Foundation"
* must not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* Portions of this software are based upon public domain software
* originally written at the National Center for Supercomputing Applications,
* University of Illinois, Urbana-Champaign.
*/
package org.apache.james.test;
import org.apache.james.imapserver.ImapHandler;
import org.apache.james.imapserver.ImapHost;
import org.apache.james.imapserver.ImapRequestHandler;
import org.apache.james.imapserver.ImapSession;
import org.apache.james.imapserver.ImapSessionImpl;
import org.apache.james.imapserver.ImapTest;
import org.apache.james.imapserver.JamesImapHost;
import org.apache.james.imapserver.store.MailboxException;
import org.apache.james.services.User;
import org.apache.james.services.UsersRepository;
import org.apache.james.userrepository.AbstractUsersRepository;
import org.apache.james.userrepository.DefaultUser;
import junit.framework.TestCase;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.Socket;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
/**
* Abstract Protocol Test is the root of all of the James Imap Server test
* cases. It provides basic functionality for running a protocol session
* as a JUnit test, and failing if exceptions are thrown.
* To create a test which reads the entire protocol session from a single
* protocol definition file, use the {@link SimpleFileProtocolTest}.
*
* @author Darrell DeBoer
* @author Andrew C. Oliver
*/
public abstract class AbstractProtocolTest
extends TestCase implements ImapTest
{
/** The Protocol session which is run before the testElements */
protected ProtocolSession preElements = new ProtocolSession();
/** The Protocol session which contains the tests elements */
protected ProtocolSession testElements = new ProtocolSession();
/** The Protocol session which is run after the testElements. */
protected ProtocolSession postElements = new ProtocolSession();
/** The host name to connect to for socket-based testing. */
protected String host = HOST;
/** The host port to connect to for socket-based testing. */
protected int port = PORT;
/** The timeout to set on the socket for socket-based testing. */
protected int timeout = TIMEOUT;
/** A UsersRepository which all tests share. */
private UsersRepository users;
/** An ImapHost instance which all tests share. */
private ImapHost imapHost;
public AbstractProtocolTest( String s )
{
super( s );
}
protected void setUp() throws Exception
{
super.setUp();
setUpEnvironment();
}
/**
* Uses a system property to determine whether to run tests locally, or against
* a remote server.
*/
protected void runSessions() throws Exception
{
String runLocal = System.getProperty( "runTestsLocal", "true" );
boolean local = Boolean.valueOf( runLocal ).booleanValue();
if ( local ) {
runLocalProtocolSessions();
}
else {
runSocketProtocolSessions();
}
}
/**
* Runs the pre,test and post protocol sessions against a running instance of James,
* by communicating via a socket connection. After a request is sent, the server response
* is parsed to determine if the actual response matches that expected.
*/
private void runSocketProtocolSessions()
throws Exception
{
Socket socket = new Socket( host, port );
socket.setSoTimeout( timeout );
PrintWriter out = new PrintWriter( socket.getOutputStream(), true );
BufferedReader in = new BufferedReader( new InputStreamReader( socket.getInputStream() ) );
try {
preElements.runLiveSession( out, in );
testElements.runLiveSession( out, in );
postElements.runLiveSession( out, in );
}
catch ( ProtocolSession.InvalidServerResponseException e ) {
fail( e.getMessage() );
}
out.close();
in.close();
socket.close();
}
/**
* Runs the pre,test and post protocol sessions against a local copy of the ImapServer.
* This does not require that James be running, and is useful for rapid development and
* debugging.
*
* Instead of sending requests to a socket, requests are written to a CharArrayWriter,
* which then constructs a Reader which can be given to the ImapRequestHandler.
* Likewise, server responses are written to a CHarArrayWriter, and the associate reader
* is parsed to ensure that the responses match those expected.
*/
private void runLocalProtocolSessions() throws Exception
{
ByteArrayOutputStream clientRequestCollector = new ByteArrayOutputStream();
PrintWriter clientOut = new PrintWriter( clientRequestCollector );
preElements.writeClient( clientOut );
testElements.writeClient( clientOut );
postElements.writeClient( clientOut );
InputStream clientIn = new ByteArrayInputStream( clientRequestCollector.toByteArray() );
clientRequestCollector.close();
ByteArrayOutputStream serverResponseCollector = new ByteArrayOutputStream();
serverResponseCollector.write( "* OK IMAP4rev1 Server XXX ready".getBytes() );
serverResponseCollector.write( '\r' );
serverResponseCollector.write( '\n' );
ImapSession session = getImapSession();
ImapRequestHandler requestHandler = new ImapRequestHandler();
while( requestHandler.handleRequest( clientIn, serverResponseCollector, session ) ) {};
InputStream serverInstream = new ByteArrayInputStream( serverResponseCollector.toByteArray() );
BufferedReader serverIn = new BufferedReader( new InputStreamReader( serverInstream ) );
try {
preElements.testResponse( serverIn );
testElements.testResponse( serverIn );
postElements.testResponse( serverIn );
}
catch ( ProtocolSession.InvalidServerResponseException e ) {
fail( e.getMessage() );
}
}
/**
* Provides an ImapSession to use for this test. An ImapSession is accosiated
* with a single client connection.
*/
private ImapSession getImapSession() throws MailboxException
{
ImapSession session = new ImapSessionImpl( imapHost, users, new ImapHandler(), null, null );
return session;
}
/**
* Initialises the UsersRepository and ImapHost on first call.
* TODO enable logging, set up components properly.
*/
private void setUpEnvironment() throws MailboxException
{
if ( users == null || imapHost == null ) {
users = new InMemoryUsersRepository();
DefaultUser user = new DefaultUser( USER, "SHA" );
user.setPassword( PASSWORD );
users.addUser( user );
imapHost = new JamesImapHost();
imapHost.createPrivateMailAccount( user );
}
}
/**
* A simple, dummy implementation of UsersRepository to use for testing,
* which stored all users in memory.
*/
private class InMemoryUsersRepository extends AbstractUsersRepository
{
private Map users = new HashMap();
protected Iterator listAllUsers()
{
return users.values().iterator();
}
protected void doAddUser( User user )
{
users.put( user.getUserName(), user );
}
protected void doRemoveUser( User user )
{
users.remove( user.getUserName());
}
protected void doUpdateUser( User user )
{
users.put( user.getUserName(), user );
}
}
}