CallControllerSipUnitTest.java

/*
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.mobicents.servlet.sip.testsuite.callcontroller;

import java.util.Properties;

import javax.sip.message.Response;

import org.apache.log4j.Logger;
import org.cafesip.sipunit.SipCall;
import org.cafesip.sipunit.SipPhone;
import org.cafesip.sipunit.SipStack;
import org.mobicents.servlet.sip.SipUnitServletTestCase;

public class CallControllerSipUnitTest extends SipUnitServletTestCase {

	private static transient Logger logger = Logger.getLogger(CallControllerSipUnitTest.class);	
	
	private SipStack sipStackSender;
	private SipPhone sipPhoneSender;	
	
	private SipStack sipStackReceiver;
	private SipPhone sipPhoneReceiver;

	private static final int TIMEOUT = 20000;
	private static final int TIMEOUT_FORBIDDEN = 30000;	
//	private static final int TIMEOUT = 1000000;

	public CallControllerSipUnitTest(String name) {
		super(name);
	}
	
	@Override
	public void setUp() throws Exception {
		autoDeployOnStartup = false;		
		super.setUp();		
	}

	@Override
	public void tearDown() throws Exception {
		Thread.sleep(1000);
		sipPhoneSender.dispose();		
		sipPhoneReceiver.dispose();		
		sipStackSender.dispose();				
		sipStackReceiver.dispose();
		super.tearDown();
	}

	@Override
	public void deployApplication() {
		deployCallBlocking();
		deployCallForwarding();
	}

	private void deployCallBlocking() {
		assertTrue(tomcat.deployContext(
				projectHome + "/sip-servlets-test-suite/applications/call-blocking-servlet/src/main/sipapp",
				"call-blocking-context", 
				"call-blocking"));
	}
	
	private void deployCallForwarding() {
		assertTrue(tomcat.deployContext(
				projectHome + "/sip-servlets-test-suite/applications/call-forwarding-b2bua-servlet/src/main/sipapp",
				"call-forwarding-b2bua-context", 
				"call-forwarding-b2bua"));
	}
	
	
	@Override
	protected String getDarConfigurationFile() {
		return "file:///"
				+ projectHome
				+ "/sip-servlets-test-suite/testsuite/src/test/resources/"
				+ "org/mobicents/servlet/sip/testsuite/callcontroller/call-controller-servlet-dar.properties";
	}

	public SipStack makeStack(String transport, int port) throws Exception {
		Properties properties = new Properties();
		String peerHostPort1 = "127.0.0.1:5070";
		properties.setProperty("javax.sip.OUTBOUND_PROXY", peerHostPort1 + "/"
				+ "udp");
		properties.setProperty("javax.sip.STACK_NAME", "UAC_" + transport + "_"
				+ port);
		properties.setProperty("sipunit.BINDADDR", "127.0.0.1");
		properties.setProperty("gov.nist.javax.sip.DEBUG_LOG",
				"logs/callforwarding_debug_" + port + ".txt");
		properties.setProperty("gov.nist.javax.sip.SERVER_LOG",
				"logs/callforwarding_server_" + port + ".xml");
		properties.setProperty("gov.nist.javax.sip.TRACE_LEVEL", "32");
		
		return new SipStack(transport, port, properties);		
	}

	public void setupPhone(String fromAddress, String toAddress) throws Exception {			
			sipStackSender = makeStack(SipStack.PROTOCOL_UDP, 5080);			
			sipPhoneSender = sipStackSender.createSipPhone("localhost",
					SipStack.PROTOCOL_UDP, 5070, fromAddress);		
			sipStackReceiver = makeStack(SipStack.PROTOCOL_UDP, 5090);			
			sipPhoneReceiver = sipStackReceiver.createSipPhone("localhost",
					SipStack.PROTOCOL_UDP, 5070, toAddress);
	}


	// Check if we receive a FORBIDDEN response for our invite
	public void testCallBlockingInvite() throws Exception {
		deployCallBlocking();
		setupPhone("sip:blocked-sender@sip-servlets.com", "sip:receiver@sip-servlets.com");
		SipCall sender = sipPhoneSender.createSipCall();
		assertTrue(sender.initiateOutgoingCall("sip:receiver@sip-servlets.com", null));
		int trial = 0;
		while(findResponse(sender, Response.FORBIDDEN) == null && trial < 5) {
			assertTrue(sender.waitOutgoingCallResponse(TIMEOUT_FORBIDDEN));
			trial ++;
		}
	}
	
	// 
	public void testCallForwarding() throws Exception {
		deployCallForwarding();
		setupPhone("sip:forward-sender@sip-servlets.com", "sip:forward-receiver@sip-servlets.com");
		
		SipCall sender = sipPhoneSender.createSipCall();
		SipCall receiver  = sipPhoneReceiver.createSipCall();		
		
		receiver.listenForIncomingCall();
		Thread.sleep(300);
		sender.initiateOutgoingCall("sip:receiver@sip-servlets.com", null);
				
		assertTrue(receiver.waitForIncomingCall(TIMEOUT));					
		assertTrue(receiver.sendIncomingCallResponse(Response.OK, "OK", 0));
		assertTrue(sender.waitOutgoingCallResponse(TIMEOUT));
		assertTrue(receiver.waitForAck(TIMEOUT));
		
//		assertTrue(sender.sendInviteOkAck());
		sender.sendInviteOkAck();
		assertTrue(sender.disconnect());
		assertTrue(receiver.waitForDisconnect(TIMEOUT));
		assertTrue(receiver.respondToDisconnect());
	}
	
	// 
	public void testCallForwardingBothDeployed() throws Exception {
		deployCallBlocking();
		deployCallForwarding();
		setupPhone("sip:forward-sender@sip-servlets.com", "sip:forward-receiver@sip-servlets.com");
		
		SipCall sender = sipPhoneSender.createSipCall();
		SipCall receiver  = sipPhoneReceiver.createSipCall();		
		
		receiver.listenForIncomingCall();
		Thread.sleep(300);
		sender.initiateOutgoingCall("sip:receiver@sip-servlets.com", null);
				
		assertTrue(receiver.waitForIncomingCall(TIMEOUT));		
		assertTrue(receiver.sendIncomingCallResponse(Response.OK, "OK", 0));
		assertTrue(receiver.waitForAck(TIMEOUT));
		assertTrue(sender.waitOutgoingCallResponse(TIMEOUT));
		//sipunit doesn't succeed to send the ACK since it tries to do it with 
		//Dialog.createRequest(Request.ACK)
//		assertTrue(sender.sendInviteOkAck());		
		sender.sendInviteOkAck();		
		assertTrue(sender.disconnect());
		assertTrue(receiver.waitForDisconnect(TIMEOUT));
		assertTrue(receiver.respondToDisconnect());
	}
	
	// Check if we receive a FORBIDDEN response for our invite
	public void testCallBlockingBothDeployed() throws Exception {
		deployCallBlocking();
		deployCallForwarding();
		setupPhone("sip:blocked-sender@sip-servlets.com", "sip:receiver@sip-servlets.com");
		SipCall sender = sipPhoneSender.createSipCall();
		assertTrue(sender.initiateOutgoingCall("sip:receiver@sip-servlets.com", null));
		int trial = 0;
		while(findResponse(sender, Response.FORBIDDEN) == null && trial < 5) {
			assertTrue(sender.waitOutgoingCallResponse(TIMEOUT_FORBIDDEN));
			trial ++;
		}			
	}		 
}