/**
    * Copyright 2005-2006 the original author or authors.
    *
    * Licensed under the Gnu General Pubic License, Version 2.0 (the
    * "License"); you may not use this file except in compliance with
    * the License. You may obtain a copy of the License at
    *
    *      http://www.opensource.org/licenses/gpl-license.php
    *
   * 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.
   */
  package org.figure8.join.services.remoting.xmlrpc;
  
  import org.figure8.join.services.remoting.ArtifactService;
  import org.figure8.join.services.remoting.ProcessControlService;
  import org.figure8.join.services.remoting.beans.RemoteRelease;
  
  import junit.framework.Test;
  import junit.framework.TestCase;
  import junit.framework.TestSuite;
  import org.apache.xmlrpc.WebServer;
  import org.apache.xmlrpc.XmlRpcClient;
  import org.easymock.MockControl;
  
  import java.util.Map;
  import java.util.Date;
  import java.util.Vector;
  /**
   * JUnit test case for testing DefaultXmlRpcHandler and its interaction with services.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.1 $
   */
  public class DefaultXmlRpcHandlerTest extends TestCase{
  
     // Static -------------------------------------------------------------------
  
     /** Constant representing security token used for tests */
     protected static final String TOKEN = "securitytoken@jdoe";
     /** Constant representing serverl url used for tests */
     protected static final String SERVER_URL = "http://localhost:6666";
  
  
     // Attributes ---------------------------------------------------------------
  
     /** Instance of class under test */
     private DefaultXmlRpcHandler handler = null;
     /** Embedded instance of Xml-Rpc server */
     private WebServer xmlrpc = null;
  
     /** Control for mock artifact service */
     private MockControl artifactControl = null;
     /** ArtifactService mock implementation */
     private ArtifactService artifactService = null;
  
     /** Control for mock process control service */
     private MockControl controlControl = null;
     /** ProcessControlService mockImplementation */
     private ProcessControlService controlService = null;
  
  
     // Constructors -------------------------------------------------------------
  
     /** Default constructor. Build a test case using a name. */
     public DefaultXmlRpcHandlerTest(String testName){
        super(testName);
     }
  
  
     // Override of TestCase -----------------------------------------------------
  
     /**
      * Make this class a TestSuite.
      * @return A TestSuite containing this TestCase.
      */
     public static Test suite(){
        TestSuite suite = new TestSuite(DefaultXmlRpcHandlerTest.class);
        return suite;
     }
     
     
     // Public -------------------------------------------------------------------
  
     /** Creates mock objects and starts XmlRpc server */
     public void setUp(){
        // Mock an artifactService.
        artifactControl = MockControl.createControl(ArtifactService.class);
        artifactService = (ArtifactService)artifactControl.getMock();
        // Mock a processControlService.
        controlControl = MockControl.createControl(ProcessControlService.class);
        controlService = (ProcessControlService)controlControl.getMock();
  
        // Set common expectations.
        try{
           controlService.login("jdoe", "password");
           controlControl.setReturnValue(TOKEN);
           controlService.logout(TOKEN);
       }
       catch (Exception e){
          fail("Setting up Mock services fails !");
       }
       // Create a default handler and assign services.
       handler = new DefaultXmlRpcHandler();
       handler.setArtifactService(artifactService);
       handler.setProcessControlService(controlService);
       // Start Xml-Rpc server and register handler.
       xmlrpc = new WebServer(6666);
       xmlrpc.addHandler("join", handler);
       xmlrpc.start();
    }
 
    /** Test login() and logout() methods */
    public void testLoginLogout(){
       // No more expectations.
       controlControl.replay();
       artifactControl.replay();
 
       try{
          // Call login, logout.
          XmlRpcClient client = new XmlRpcClient(SERVER_URL);
          String token = (String)client.execute("join.login", makeParams("jdoe", "password"));
          client.execute("join.logout", makeParam(token));
       }
       catch (Exception e){
          e.printStackTrace();
          fail("Exception thrown during Xml-Rpc invocation.");
       }
       // Verify mock controls.
       controlControl.verify();
       artifactControl.verify();
    }
 
    /** Test the retrieval of releases */
    public void testGetReleases(){
       Vector releases = null;
       // Add return expectations.
       try{
          artifactService.getReleases(TOKEN);
          artifactControl.setReturnValue(new RemoteRelease[]{
             new RemoteRelease("1.0", new Date()), new RemoteRelease("2.0", new Date())
          });
       }
       catch (Exception e){
          fail("Setting up Mock services fails !");
       }
       controlControl.replay();
       artifactControl.replay();
 
       try{
          // Call login, getReleases and logout.
          XmlRpcClient client = new XmlRpcClient(SERVER_URL);
          String token = (String)client.execute("join.login", makeParams("jdoe", "password"));
          releases = (Vector)client.execute("join.getReleases", makeParam(token));
          client.execute("join.logout", makeParam(token));
       }
       catch (Exception e){
          e.printStackTrace();
          fail("Exception thrown during Xml-Rpc invocation.");
       }
       // Verify mock controls.
       controlControl.verify();
       artifactControl.verify();
       // Assert on releases content.
       assertNotNull("Found some releases", releases);
       assertEquals("Found the correct number of releases", 2, releases.size());
       assertEquals("Found the correct releases", "1.0", ((Map)releases.get(0)).get("name"));
       assertEquals("Found the correct releases", "2.0", ((Map)releases.get(1)).get("name"));
    }
 
    /** Shutdown XmlRpc server */
    public void tearDown(){
       xmlrpc.shutdown();
    }
 
 
    // Private ------------------------------------------------------------------
 
    /** Make a param vector */
    private Vector makeParam(Object obj){
       Vector params = new Vector();
       params.add(obj);
       return params;
    }
 
    /** Make a params vector */
    private Vector makeParams(Object obj1, Object obj2){
       Vector params = makeParam(obj1);
       params.add(obj2);
       return params;
    }
 }