/***********************************************************
Copyright (C) 2004 VeriSign, Inc.

This library 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 library 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 library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

http://www.verisign.com/nds/naming/namestore/techdocs.html
***********************************************************/
package com.verisign.epp.interfaces;

import java.util.Calendar;
import java.util.Random;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.verisign.epp.codec.domain.EPPDomainInfoResp;
import com.verisign.epp.codec.gen.EPPResponse;
import com.verisign.epp.codec.gen.EPPResult;
import com.verisign.epp.codec.syncext.EPPSyncExtUpdate;
import com.verisign.epp.transport.EPPClientCon;
import com.verisign.epp.util.Environment;
import com.verisign.epp.util.TestThread;

import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;

/**
 * Is a unit test of the <code>EPPDomain</code> class with RGP update, inf data
 * and report extensions.
 *
 * The unit test will initialize a session with an EPP Server, will invoke
 * <code>EPPDomain</code> operations, and will end a session with an EPP Server.
 * The configuration file used by the unit test defaults to epp.config, but can
 * be changed by passing the file path as the first command line argument. The
 * unit test can be run in multiple threads by setting the "threads" system
 * property. For example, the unit test can be run in 2 threads with the
 * configuration file ../../epp.config with the following command: <br>
 * <br>
 * java com.verisign.epp.interfaces.EPPSyncDomainTst -Dthreads=2
 * ../../epp.config <br>
 * <br>
 * The unit test is dependent on the use of <a
 * href=http://www.mcwestcorp.com/Junit.html>JUNIT 3.5</a><br>
 * <br>
 * <br>
 * <br>
 */
public class EPPSyncDomainTst {
  /**
   * Handle to the Singleton EPP Application instance
   * (<code>EPPApplicationSingle</code>)
   */
  private static EPPApplicationSingle app = EPPApplicationSingle.getInstance();

  /** Name of configuration file to use for test (default = epp.config). */
  private static String configFileName = "epp.config";

  /** Logging category */
  private static Logger cat = LoggerFactory.getLogger(EPPSyncDomainTst.class);

  /** EPP Domain associated with test */
  private EPPDomain domain = null;

  /** EPP Session associated with test */
  private EPPSession session = null;

  /** Connection to the EPP Server. */
  private EPPClientCon connection = null;

  /** Current test iteration */
  private int iteration = 0;

  /**
   * Random instance for the generation of unique objects (hosts, IP addresses,
   * etc.).
   */
  private Random rd = new Random(System.currentTimeMillis());

  /**
   * JUNIT test method to implement the <code>EPPSyncDomainTst TestCase</code>.
   * Each sub-test will be invoked in order to satisfy testing the EPPDomain
   * interface.
   */
  @Test
  public void testDomain() {
    int numIterations = 1;

    String iterationsStr = System.getProperty("iterations");

    if (iterationsStr != null) {
      numIterations = Integer.parseInt(iterationsStr);
    }

    for (iteration = 0; (numIterations == 0) || (iteration < numIterations); iteration++) {
      printStart("Test Suite");

      domainSync();

      domainInfo();
      printEnd("Test Suite");
    }
  }

  // End EPPSyncDomainTst.testDomain()

  /**
   * Unit test of <code>EPPDomain.sendInfo</code>.
   */
  public void domainInfo() {
    printStart("domainInfo");

    EPPDomainInfoResp response;

    try {
      System.out.println("\ndomainInfo: Domain info");

      domain.setTransId("ABC-12345-XYZ");

      domain.addDomainName(this.makeDomainName());

      response = domain.sendInfo();

      // -- Output all of the response attributes
      System.out.println("domainInfo: Response = [" + response + "]\n\n");

      // -- Output required response attributes using accessors
      System.out.println("domainInfo: name = " + response.getName());

      System.out.println("domainInfo: client id = " + response.getClientId());

      System.out.println("domainInfo: created by = " + response.getCreatedBy());

      System.out.println("domainInfo: create date = " + response.getCreatedDate());

      System.out.println("domainInfo: expiration date = " + response.getExpirationDate());
    }

    catch (EPPCommandException e) {
      handleException(e);
    }

    printEnd("domainInfo");
  }

  // End EPPSyncDomainTst.domainInfo()

  /**
   * Unit test of <code>EPPDomain.sendUpdate</code>.
   */
  public void domainSync() {
    printStart("domainSync");

    EPPResponse response;

    try {
      System.out.println("\ndomainSync: Domain sync");

      domain.setTransId("ABC-12345-XYZ");

      String myDomainName = this.makeDomainName();

      domain.addDomainName(myDomainName);

      EPPSyncExtUpdate syncUpdate = new EPPSyncExtUpdate();
      syncUpdate.setDay(26);
      syncUpdate.setMonth(Calendar.AUGUST);

      domain.addExtension(syncUpdate);

      // Execute update
      response = domain.sendUpdate();

      // -- Output all of the response attributes
      System.out.println("domainSync: Response = [" + response + "]\n\n");

      /**
       * Result Set
       */
      for (int i = 0; i < response.getResults().size(); i++) {
        EPPResult myResult = (EPPResult) response.getResults().elementAt(i);

        System.out.println("Result Code    : " + myResult.getCode());

        System.out.println("Result Message : " + myResult.getMessage());

        System.out.println("Result Lang    : " + myResult.getLang());

        if (myResult.isSuccess()) {
          System.out.println("Command Passed ");
        }

        else {
          System.out.println("Command Failed ");
        }

        if (myResult.getAllValues() != null) {
          for (int k = 0; k < myResult.getAllValues().size(); k++) {
            System.out.println("Result Values  : " + myResult.getAllValues().elementAt(k));
          }
        }
      }
    }

    catch (EPPCommandException e) {
      handleException(e);
    }

    printEnd("domainSync");
  }

  // End EPPSyncDomainTst.domainSync()

  /**
   * Unit test of <code>EPPSession.initSession</code>. The session attribute is
   * initialized with the attributes defined in the EPP sample files.
   */
  private void initSession() {
    printStart("initSession");

    // Set attributes for initSession
    session.setTransId("ABC-12345-XYZ");

    session.setVersion("1.0");

    session.setLang("en");

    // Initialize the session
    try {
      session.initSession();
    }

    catch (EPPCommandException e) {
      EPPResponse response = session.getResponse();

      // Is a server specified error?
      if ((response != null) && (!response.isSuccess())) {
        Assert.fail("Server Error : " + response);
      }
      else {
        e.printStackTrace();

        Assert.fail("initSession Error : " + e);
      }
    }

    printEnd("initSession");
  }

  // End EPPSyncDomainTst.initSession()

  /**
   * Unit test of <code>EPPSession.endSession</code>. The session with the EPP
   * Server will be terminated.
   */
  private void endSession() {
    printStart("endSession");

    session.setTransId("ABC-12345-XYZ");

    // End the session
    try {
      session.endSession();
    }

    catch (EPPCommandException e) {
      EPPResponse response = session.getResponse();

      // Is a server specified error?
      if ((response != null) && (!response.isSuccess())) {
        Assert.fail("Server Error : " + response);
      }

      else // Other error
      {
        e.printStackTrace();

        Assert.fail("initSession Error : " + e);
      }
    }

    printEnd("endSession");
  }

  // End EPPSyncDomainTst.endSession()

  /**
   * JUNIT <code>setUp</code> method, which sets the default client Id to
   * "theRegistrar".
   */
  @Before
  public void setUp() {
    try {
      String theSessionClassName = System.getProperty("EPP.SessionClass");

      if (theSessionClassName != null) {
        try {
          Class theSessionClass = Class.forName(theSessionClassName);

          if (!EPPSession.class.isAssignableFrom((theSessionClass))) {
            Assert.fail(theSessionClassName + " is not a subclass of EPPSession");
          }

          session = (EPPSession) theSessionClass.getDeclaredConstructor().newInstance();
        }
        catch (Exception ex) {
          Assert.fail("Exception instantiating EPP.SessionClass value " + theSessionClassName + ": " + ex);
        }
      }
      else {
        session = new EPPSession();
      }

      session.setClientID(Environment.getProperty("EPP.Test.clientId", "ClientX"));
      session.setPassword(Environment.getProperty("EPP.Test.password", "foo-BAR2"));
    }

    catch (Exception e) {
      e.printStackTrace();

      Assert.fail("Error initializing the session: " + e);
    }

    initSession();

    // System.out.println("out init");
    domain = new EPPDomain(session);
  }

  // End EPPSyncDomainTst.setUp();

  /**
   * JUNIT <code>tearDown</code>, which currently does nothing.
   */
  @After
  public void tearDown() {
    endSession();
  }

  // End EPPSyncDomainTst.tearDown();

  /**
   * JUNIT <code>suite</code> static method, which returns the tests associated
   * with <code>EPPSyncDomainTst</code>.
   */
  @BeforeClass
  public static void beforeClass() {
    String theConfigFileName = System.getProperty("EPP.ConfigFile");
    if (theConfigFileName != null)
      configFileName = theConfigFileName;

    try {
      app.initialize(configFileName);
    }

    catch (EPPCommandException e) {
      e.printStackTrace();

      Assert.fail("Error initializing the EPP Application: " + e);
    }
  }

  /**
   * Handle an <code>EPPCommandException</code>, which can be either a server
   * generated error or a general exception. If the exception was caused by a
   * server error, "Server Error :&lt;Response XML&gt;" will be specified. If
   * the exception was caused by a general algorithm error, "General Error
   * :&lt;Exception Description&gt;" will be specified.
   *
   * @param aException
   *           Exception thrown during test
   */
  public void handleException(Exception aException) {
    EPPResponse response = session.getResponse();

    aException.printStackTrace();

    // Is a server specified error?
    if ((response != null) && (!response.isSuccess())) {
      Assert.fail("Server Error : " + response);
    }

    else {
      Assert.fail("General Error : " + aException);
    }
  }

  // End EPPSyncDomainTst.handleException(EPPCommandException)

  /**
   * This method tries to generate a unique String as Domain Name and Name
   * Server
   *
   * @return DOCUMENT ME!
   */
  public String makeDomainName() {
    long tm = System.currentTimeMillis();

    return new String(Thread.currentThread() + String.valueOf(tm + rd.nextInt(12)).substring(10) + ".com");
  }

  /**
   * Makes a unique IP address based off of the current time.
   *
   * @return Unique IP address <code>String</code>
   */
  public String makeIP() {
    long tm = System.currentTimeMillis();

    return new String(
          String.valueOf(tm + rd.nextInt(50)).substring(10) + "." + String.valueOf(tm + rd.nextInt(50)).substring(10)
                + "." + String.valueOf(tm + rd.nextInt(50)).substring(10) + "."
                + String.valueOf(tm + rd.nextInt(50)).substring(10));
  }

  /**
   * Makes a unique host name for a domain using the current time.
   *
   * @param newDomainName
   *           DOCUMENT ME!
   *
   * @return Unique host name <code>String</code>
   */
  public String makeHostName(String newDomainName) {
    long tm = System.currentTimeMillis();

    return new String(String.valueOf(tm + rd.nextInt(10)).substring(10) + "." + newDomainName);
  }

  /**
   * Makes a unique contact name using the current time.
   *
   * @return Unique contact name <code>String</code>
   */
  public String makeContactName() {
    long tm = System.currentTimeMillis();

    return new String("Con" + String.valueOf(tm + rd.nextInt(5)).substring(7));
  }

  /**
   * Print the start of a test with the <code>Thread</code> name if the current
   * thread is a <code>TestThread</code>.
   *
   * @param aTest
   *           name for the test
   */
  private void printStart(String aTest) {
    if (Thread.currentThread() instanceof TestThread) {
      System.out.print(Thread.currentThread().getName() + ", iteration " + iteration + ": ");

      cat.info(Thread.currentThread().getName() + ", iteration " + iteration + ": " + aTest + " Start");
    }

    System.out.println("Start of " + aTest);

    System.out.println("****************************************************************\n");
  }

  // End EPPSyncDomainTst.testStart(String)

  /**
   * Print the end of a test with the <code>Thread</code> name if the current
   * thread is a <code>TestThread</code>.
   *
   * @param aTest
   *           name for the test
   */
  private void printEnd(String aTest) {
    System.out.println("****************************************************************");

    if (Thread.currentThread() instanceof TestThread) {
      System.out.print(Thread.currentThread().getName() + ", iteration " + iteration + ": ");

      cat.info(Thread.currentThread().getName() + ", iteration " + iteration + ": " + aTest + " End");
    }

    System.out.println("End of " + aTest);

    System.out.println("\n");
  }

  // End EPPSyncDomainTst.testEnd(String)

  /**
   * Print message
   *
   * @param aMsg
   *           message to print
   */
  private void printMsg(String aMsg) {
    if (Thread.currentThread() instanceof TestThread) {
      System.out.println(Thread.currentThread().getName() + ", iteration " + iteration + ": " + aMsg);

      cat.info(Thread.currentThread().getName() + ", iteration " + iteration + ": " + aMsg);
    }

    else {
      System.out.println(aMsg);

      cat.info(aMsg);
    }
  }

  // End EPPSyncDomainTst.printMsg(String)

  /**
   * Print error message
   *
   * @param aMsg
   *           errpr message to print
   */
  private void printError(String aMsg) {
    if (Thread.currentThread() instanceof TestThread) {
      System.err.println(Thread.currentThread().getName() + ", iteration " + iteration + ": " + aMsg);

      cat.error(Thread.currentThread().getName() + ", iteration " + iteration + ": " + aMsg);
    }

    else {
      System.err.println(aMsg);

      cat.error(aMsg);
    }
  }

  // End EPPSyncDomainTst.printError(String)
}

// End class EPPSyncDomainTst
