Implementing SIP support (work in progress)

Tests installation of a SIP account

test/net/java/sip/communicator/slick/protocol/sip/TestAccountInstallation.java

@@ -0,0 +1,237 @@
+/*
+ * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
+ *
+ * Distributable under LGPL license.
+ * See terms of license at gnu.org.
+ */
+package net.java.sip.communicator.slick.protocol.sip;
+
+import junit.framework.*;
+import net.java.sip.communicator.util.*;
+import org.osgi.framework.*;
+import net.java.sip.communicator.service.protocol.*;
+import net.java.sip.communicator.slick.protocol.icq.*;
+import java.util.*;
+
+public class TestAccountInstallation
+    extends TestCase
+{
+    private static final Logger logger =
+        Logger.getLogger(TestAccountInstallation.class);
+
+    /**
+     * Creates the test with the specified method name.
+     * @param name the name of the method to execute.
+     */
+    public TestAccountInstallation(String name)
+    {
+        super(name);
+    }
+
+    /**
+     * JUnit setup method.
+     * @throws Exception in case anything goes wrong.
+     */
+    protected void setUp() throws Exception
+    {
+        super.setUp();
+    }
+
+    /**
+     * JUnit teardown method.
+     * @throws Exception in case anything goes wrong.
+     */
+    protected void tearDown() throws Exception
+    {
+        super.tearDown();
+    }
+
+    /**
+     * Installs an account and verifies whether the installation has gone well.
+     */
+    public void testInstallAccount()
+    {
+        // first obtain a reference to the provider factory
+        ServiceReference[] serRefs = null;
+        String osgiFilter = "(" + ProtocolProviderFactory.PROTOCOL
+                            + "="+ProtocolNames.SIP+")";
+        try{
+            serRefs = SipSlickFixture.bc.getServiceReferences(
+                    ProtocolProviderFactory.class.getName(), osgiFilter);
+        }
+        catch (InvalidSyntaxException ex){
+            //this really shouldhn't occur as the filter expression is static.
+            fail(osgiFilter + " is not a valid osgi filter");
+        }
+
+        assertTrue(
+            "Failed to find an provider factory service for protocol SIP",
+            serRefs != null || serRefs.length >  0);
+
+        //Keep the reference for later usage.
+        ProtocolProviderFactory sipProviderFactory = (ProtocolProviderFactory)
+            SipSlickFixture.bc.getService(serRefs[0]);
+
+        //make sure the account is empty
+        assertTrue("There was an account registered with the account mananger "
+                   +"before we've installed any",
+                   sipProviderFactory.getRegisteredAccounts().size() == 0);
+
+
+        //Prepare the properties of the first sip account.
+
+        Hashtable sipAccount1Properties = getAccountProperties(
+            SipProtocolProviderServiceLick.ACCOUNT_1_PREFIX);
+        Hashtable sipAccount2Properties = getAccountProperties(
+            SipProtocolProviderServiceLick.ACCOUNT_2_PREFIX);
+
+        //try to install an account with a null account id
+        try{
+            sipProviderFactory.installAccount(
+                null, sipAccount1Properties);
+            fail("installing an account with a null account id must result "
+                 +"in a NullPointerException");
+        }catch(NullPointerException exc){
+            //that's what had to happen
+        }
+
+        //now really install the accounts
+        sipProviderFactory.installAccount(
+            (String)sipAccount1Properties.get(ProtocolProviderFactory.USER_ID)
+            , sipAccount1Properties);
+        sipProviderFactory.installAccount(
+            (String)sipAccount2Properties.get(ProtocolProviderFactory.USER_ID)
+            , sipAccount2Properties);
+
+
+        //try to install one of the accounts one more time and verify that an
+        //excepion is thrown.
+        try{
+            sipProviderFactory.installAccount(
+                (String)sipAccount1Properties.get(ProtocolProviderFactory.USER_ID)
+                , sipAccount1Properties);
+
+            fail("An IllegalStateException must be thrown when trying to "+
+                 "install a duplicate account");
+
+        }catch(IllegalStateException exc)
+        {
+            //that's what supposed to happen.
+        }
+
+        //Verify that the provider factory is aware of our installation
+        assertTrue(
+            "The newly installed account was not in the acc man's "
+            +"registered accounts!",
+            sipProviderFactory.getRegisteredAccounts().size() == 1);
+
+        //Verify protocol providers corresponding to the new account have
+        //been properly registered with the osgi framework.
+
+        osgiFilter =
+            "(&("+ProtocolProviderFactory.PROTOCOL +"="+ProtocolNames.SIP+")"
+             +"(" + ProtocolProviderFactory.USER_ID
+             + "=" + (String)sipAccount1Properties.get(
+                            ProtocolProviderFactory.USER_ID)
+             + "))";
+
+        try
+        {
+            serRefs = IcqSlickFixture.bc.getServiceReferences(
+                    ProtocolProviderService.class.getName(),
+                    osgiFilter);
+        }
+        catch (InvalidSyntaxException ex)
+        {
+            //this really shouldhn't occur as the filter expression is static.
+            fail(osgiFilter + "is not a valid osgi filter");
+        }
+
+        assertTrue("An ICQ protocol provider was apparently not installed as "
+                + "requested."
+                , serRefs != null && serRefs.length > 0);
+
+        Object icqProtocolProvider
+            = IcqSlickFixture.bc.getService(serRefs[0]);
+
+        assertTrue("The installed protocol provider does not implement "
+                  + "the protocol provider service."
+                  ,icqProtocolProvider instanceof ProtocolProviderService);
+    }
+
+    /**
+     * Returns all properties necessary for the intialization of the account
+     * with <tt>accountPrefix</tt>.
+     * @param accountPrefix the prefix contained by all property names for the
+     * the account we'd like to initialized
+     * @return a Hashtable that can be used when creating the account in a
+     * protocol provider factory.
+     */
+    private Hashtable getAccountProperties(String accountPrefix)
+    {
+        Hashtable table = new Hashtable();
+
+        String userID = System.getProperty(
+            accountPrefix + ProtocolProviderFactory.USER_ID, null);
+
+        assertNotNull(
+            "The system property named "
+            + accountPrefix + ProtocolProviderFactory.USER_ID
+            +" has to tontain a valid SIP address that could be used during "
+            +"SIP Communicator's tests."
+            , userID);
+
+        table.put(ProtocolProviderFactory.USER_ID, userID);
+
+        String passwd = System.getProperty(
+            accountPrefix + ProtocolProviderFactory.PASSWORD, null );
+
+        assertNotNull(
+            "The system property named "
+            + accountPrefix + ProtocolProviderFactory.PASSWORD
+            +" has to contain the password corresponding to the account "
+            + "specified in "
+            + accountPrefix + ProtocolProviderFactory.USER_ID
+            , passwd);
+
+        table.put(ProtocolProviderFactory.PASSWORD, passwd);
+
+        String serverAddress = System.getProperty(
+            accountPrefix + ProtocolProviderFactory.SERVER_ADDRESS, null );
+
+        assertNotNull(
+            "The system property named "
+            + accountPrefix + ProtocolProviderFactory.SERVER_ADDRESS
+            +" has to contain a valid server address to use for testing."
+            , serverAddress);
+
+        table.put(ProtocolProviderFactory.SERVER_ADDRESS, serverAddress);
+
+        String serverPort = System.getProperty(
+            accountPrefix + ProtocolProviderFactory.SERVER_PORT, null );
+
+        if(serverPort != null)
+        {
+            table.put(ProtocolProviderFactory.SERVER_PORT, serverPort);
+        }
+
+        String proxyAddress = System.getProperty(
+            accountPrefix + ProtocolProviderFactory.PROXY_ADDRESS, null );
+
+        if(serverPort != null)
+        {
+            table.put(ProtocolProviderFactory.PROXY_ADDRESS, proxyAddress);
+
+            String proxyPort = System.getProperty(
+            accountPrefix + ProtocolProviderFactory.PROXY_PORT, null );
+
+            if(proxyPort != null)
+            {
+                table.put(ProtocolProviderFactory.PROXY_PORT, proxyPort);
+            }
+        }
+
+
+        return table;
+    }
+}