Smack/test/org/jivesoftware/smackx/XHTMLManagerTest.java

/**
 * $RCSfile$
 * $Revision$
 * $Date$
 *
 * Copyright (C) 2002-2003 Jive Software. All rights reserved.
 * ====================================================================
 * The Jive Software License (based on Apache Software License, Version 1.1)
 *
 * 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
 *        Jive Software (http://www.jivesoftware.com)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Smack" and "Jive Software" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please
 *    contact webmaster@jivesoftware.com.
 *
 * 5. Products derived from this software may not be called "Smack",
 *    nor may "Smack" appear in their name, without prior written
 *    permission of Jive Software.
 *
 * 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 JIVE SOFTWARE 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.
 * ====================================================================
 */

package org.jivesoftware.smackx;

import java.util.Iterator;

import org.jivesoftware.smack.*;
import org.jivesoftware.smack.packet.*;

import junit.framework.TestCase;

/**
 * Test the XHTML extension using the high level API
 *
 * @author Gaston Dombiak
 */
public class XHTMLManagerTest extends TestCase {

    private int bodiesSent;
    private int bodiesReceived;

    /**
     * Constructor for XHTMLManagerTest.
     * @param name
     */
    public XHTMLManagerTest(String name) {
        super(name);
    }

    /**
     * High level API test.
     * This is a simple test to use with a XMPP client and check if the client receives the message
     * 1. User_1 will send a message with formatted text (XHTML) to user_2
     */
    public void testSendSimpleXHTMLMessage() {
        String host = "localhost";
        String server_user1 = "gato3";
        String user1 = "gato3@localhost";
        String pass1 = "gato3";

        String user2 = "gato4@localhost";

        XMPPConnection conn1 = null;

        try {
            // Connect to the server
            conn1 = new XMPPConnection(host);
            // User1 logs in
            conn1.login(server_user1, pass1);

            // User1 creates a chat with user2
            Chat chat1 = conn1.createChat(user2);

            // User1 creates a message to send to user2
            Message msg = chat1.createMessage();
            msg.setSubject("Any subject you want");
            msg.setBody("Hey John, this is my new green!!!!");

            // Create an XHTMLText to send with the message
            XHTMLText xhtmlText = new XHTMLText(null, null);
            xhtmlText.appendOpenParagraphTag("font-size:large");
            xhtmlText.append("Hey John, this is my new ");
            xhtmlText.appendOpenSpanTag("color:green");
            xhtmlText.append("green");
            xhtmlText.appendCloseSpanTag();
            xhtmlText.appendOpenEmTag();
            xhtmlText.append("!!!!");
            xhtmlText.appendCloseEmTag();
            xhtmlText.appendCloseParagraphTag();
            // Add the XHTML text to the message
            XHTMLManager.addBody(msg, xhtmlText.toString());

            // User1 sends the message that contains the XHTML to user2
            try {
                chat1.sendMessage(msg);
                Thread.sleep(250);
            } catch (Exception e) {
                fail("An error occured sending the message with XHTML");
            }
        } catch (Exception e) {
            fail(e.toString());
        } finally {
            if (conn1 != null)
                conn1.close();
        }
    }

    /**
    * High level API test.
    * 1. User_1 will send a message with XHTML to user_2
    * 2. User_2 will receive the message and iterate over the XHTML bodies to check if everything 
    *    is fine
    * 3. User_1 will wait several seconds for an ACK from user_2, if none is received then 
    *    something is wrong
    */
    public void testSendSimpleXHTMLMessageAndDisplayReceivedXHTMLMessage() {
        String host = "localhost";
        String server_user1 = "gato3";
        String user1 = "gato3@localhost";
        String pass1 = "gato3";

        String server_user2 = "gato4";
        String user2 = "gato4@localhost";
        String pass2 = "gato4";

        XMPPConnection conn1 = null;
        XMPPConnection conn2 = null;

        try {
            // Connect to the server and log in the users
            conn1 = new XMPPConnection(host);
            conn1.login(server_user1, pass1);
            // Wait a few milliseconds between each login
            Thread.sleep(250);
            conn2 = new XMPPConnection(host);
            conn2.login(server_user2, pass2);

            // Create a chat for each connection
            Chat chat1 = conn1.createChat(user2);
            final Chat chat2 = new Chat(conn2, user1, chat1.getChatID());

            // Create a listener for the chat that will check if the received message includes 
            // an XHTML extension. Answer an ACK if everything is ok
            PacketListener packetListener = new PacketListener() {
                public void processPacket(Packet packet) {
                    Message message = (Message) packet;
                    assertTrue(
                        "The received message is not an XHTML Message",
                        XHTMLManager.isXHTMLMessage(message));
                    try {
                        assertTrue(
                            "Message without XHTML bodies",
                            XHTMLManager.getBodies(message).hasNext());
                        for (Iterator it = XHTMLManager.getBodies(message); it.hasNext();) {
                            String body = (String) it.next();
                            System.out.println(body);
                        }
                    } catch (ClassCastException e) {
                        fail("ClassCastException - Most probable cause is that smack providers is misconfigured");
                    }
                    try {
                        chat2.sendMessage("ok");
                    } catch (Exception e) {
                        fail("An error occured sending ack " + e.getMessage());
                    }
                }
            };
            chat2.addMessageListener(packetListener);

            // User1 creates a message to send to user2
            Message msg = chat1.createMessage();
            msg.setSubject("Any subject you want");
            msg.setBody("Hey John, this is my new green!!!!");

            // Create an XHTMLText to send with the message
            XHTMLText xhtmlText = new XHTMLText(null, null);
            xhtmlText.appendOpenParagraphTag("font-size:large");
            xhtmlText.append("Hey John, this is my new ");
            xhtmlText.appendOpenSpanTag("color:green");
            xhtmlText.append("green");
            xhtmlText.appendCloseSpanTag();
            xhtmlText.appendOpenEmTag();
            xhtmlText.append("!!!!");
            xhtmlText.appendCloseEmTag();
            xhtmlText.appendCloseParagraphTag();
            // Add the XHTML text to the message
            XHTMLManager.addBody(msg, xhtmlText.toString());

            // User1 sends the message that contains the XHTML to user2
            try {
                chat1.sendMessage(msg);
            } catch (Exception e) {
                fail("An error occured sending the message with XHTML");
            }
            // Wait for 2 seconds for a reply
            msg = chat1.nextMessage(1000);
            assertNotNull("No reply received", msg);
        } catch (Exception e) {
            fail(e.toString());
        } finally {
            if (conn1 != null)
                conn1.close();
            if (conn2 != null)
                conn2.close();
        }
    }

    /**
    * Low level API test. Test a message with two XHTML bodies and several XHTML tags.
    * 1. User_1 will send a message with XHTML to user_2
    * 2. User_2 will receive the message and iterate over the XHTML bodies to check if everything 
    *    is fine
    * 3. User_1 will wait several seconds for an ACK from user_2, if none is received then 
    *    something is wrong
    */
    public void testSendComplexXHTMLMessageAndDisplayReceivedXHTMLMessage() {
        String host = "localhost";
        String server_user1 = "gato3";
        String user1 = "gato3@localhost";
        String pass1 = "gato3";

        String server_user2 = "gato4";
        String user2 = "gato4@localhost";
        String pass2 = "gato4";

        XMPPConnection conn1 = null;
        XMPPConnection conn2 = null;

        try {
            // Connect to the server and log in the users
            conn1 = new XMPPConnection(host);
            conn1.login(server_user1, pass1);
            // Wait a few milliseconds between each login
            Thread.sleep(250);
            conn2 = new XMPPConnection(host);
            conn2.login(server_user2, pass2);

            // Create a chat for each connection
            Chat chat1 = conn1.createChat(user2);
            final Chat chat2 = new Chat(conn2, user1, chat1.getChatID());

            // Create a listener for the chat that will check if the received message includes 
            // an XHTML extension. Answer an ACK if everything is ok
            PacketListener packetListener = new PacketListener() {
                public void processPacket(Packet packet) {
                    int received = 0;
                    Message message = (Message) packet;
                    assertTrue(
                        "The received message is not an XHTML Message",
                        XHTMLManager.isXHTMLMessage(message));
                    try {
                        assertTrue(
                            "Message without XHTML bodies",
                            XHTMLManager.getBodies(message).hasNext());
                        for (Iterator it = XHTMLManager.getBodies(message); it.hasNext();) {
                            received++;
                            String body = (String) it.next();
                            System.out.println(body);
                        }
                        bodiesReceived = received;
                    } catch (ClassCastException e) {
                        fail("ClassCastException - Most probable cause is that smack providers is misconfigured");
                    }
                }
            };
            chat2.addMessageListener(packetListener);

            // User1 creates a message to send to user2
            Message msg = chat1.createMessage();
            msg.setSubject("Any subject you want");
            msg.setBody("awesome! As Emerson once said: A foolish consistency is the hobgoblin of little minds.");
            
            // Create an XHTMLText to send with the message (in Spanish)
            XHTMLText xhtmlText = new XHTMLText(null, "es-ES");
            xhtmlText.appendOpenHeaderTag(1, null);
            xhtmlText.append("impresionante!");
            xhtmlText.appendCloseHeaderTag(1);
            xhtmlText.appendOpenParagraphTag(null);
            xhtmlText.append("Como Emerson dijo una vez:");
            xhtmlText.appendCloseParagraphTag();
            xhtmlText.appendOpenBlockQuoteTag(null);
            xhtmlText.appendOpenParagraphTag(null);
            xhtmlText.append("Una consistencia ridícula es el espantajo de mentes pequeñas.");
            xhtmlText.appendCloseParagraphTag();
            xhtmlText.appendCloseBlockQuoteTag();
            // Add the XHTML text to the message
            XHTMLManager.addBody(msg, xhtmlText.toString());

            // Create an XHTMLText to send with the message (in English)
            xhtmlText = new XHTMLText(null, "en-US");
            xhtmlText.appendOpenHeaderTag(1, null);
            xhtmlText.append("awesome!");
            xhtmlText.appendCloseHeaderTag(1);
            xhtmlText.appendOpenParagraphTag(null);
            xhtmlText.append("As Emerson once said:");
            xhtmlText.appendCloseParagraphTag();
            xhtmlText.appendOpenBlockQuoteTag(null);
            xhtmlText.appendOpenParagraphTag(null);
            xhtmlText.append("A foolish consistency is the hobgoblin of little minds.");
            xhtmlText.appendCloseParagraphTag();
            xhtmlText.appendCloseBlockQuoteTag();
            // Add the XHTML text to the message
            XHTMLManager.addBody(msg, xhtmlText.toString());

            // User1 sends the message that contains the XHTML to user2
            try {
                bodiesSent = 2;
                bodiesReceived = 0;
                chat1.sendMessage(msg);
            } catch (Exception e) {
                fail("An error occured sending the message with XHTML");
            }
            // Wait half second so that the complete test can run
            Thread.sleep(500);
            assertEquals("Number of sent and received XHTMP bodies does not match", bodiesSent, bodiesReceived);
        } catch (Exception e) {
            fail(e.toString());
        } finally {
            if (conn1 != null)
                conn1.close();
            if (conn2 != null)
                conn2.close();
        }
    }
}